Compression API: Unterschied zwischen den Versionen

Aus Contao Community Documentation

(Komprimierungsverfahren)
Zeile 168: Zeile 168:
 
===Komprimierungsverfahren===
 
===Komprimierungsverfahren===
  
* gzip - GzipCompressor
+
* gzip - GzipCompressor (buildin)
* bzip2 - Bzip2Compressor
+
* bzip2 - Bzip2Compressor (buildin)
 
* ''lzma - LzmaCompressor (geplant)''
 
* ''lzma - LzmaCompressor (geplant)''
  

Version vom 20. Januar 2011, 17:50 Uhr

Die Compression API ist eine Komprimierungs und Minimierungs API für Entwickler.

betrifft
Contao Version 2.9.x

Compression API

Das Ziel der Compression API ist es, eine einheitliche Schnittstelle zu liefern, um Entwicklern von Erweiterungen und Templates einen vereinfachten Zugriff auf verschiedene Komprimierungs und Minimierungsverfahren zu geben.

Die API

Die API selbst besteht aus folgenden Basisklassen:

class Compression

Die Basisklasse, welche zentraler Zugriffspunkt für den Entwickler ist und im Idealfall die einzige, die explizit angesprochen wird.

class Compression
{
    /**
     * Gibt alle verfügbaren Kompressoren zurück.
     */
    array getCompressors()
 
    /**
     * Gibt die Klasse des Kompressors zurück.
     */
    string getCompressorClass($strKey)
 
    /**
     * Gibt den in den Systemeinstellungen vorausgewählten Kompressor zurück.
     */
    string getDefaultCompressor()
 
    /**
     * Gibt die Klasse des in den Systemeinstellungen vorausgewählten Kompressor zurück
     */
    string getDefaultCompressorClass()
 
    /**
     * Gibt alle verfügbaren JavaScript Minimizer zurück.
     */
    aray getJsMinimizers()
 
    /**
     * Gibt die Klasse des JavaScript Minimizer zurück.
     */
    string getJsMinimizerClass($strKey)
 
    /**
     * Gibt den in den Systemeinstellungen vorausgewählten JavaScript Minimizer zurück.
     */
    string getDefaultJsMinimizer()
 
    /**
     * Gibt die Klasse des in den Systemeinstellungen vorausgewählten JavaScript Minimizer zurück
     */
    string getDefaultJsMinimizerClass()
 
    /**
     * Gibt alle verfügbaren CSS Minimizer zurück.
     */
    aray getCssMinimizers()
 
    /**
     * Gibt die Klasse des CSS Minimizer zurück.
     */
    string getCssMinimizerClass($strKey)
 
    /**
     * Gibt den in den Systemeinstellungen vorausgewählten CSS Minimizer zurück.
     */
    string getDefaultCssMinimizer()
 
    /**
     * Gibt die Klasse des in den Systemeinstellungen vorausgewählten CSS Minimizer zurück
     */
    string getDefaultCssMinimizerClass()
}

interface Compressor

Das Compressor Interface ist die einheitliche Schnittstelle zu allen Komprimierungsverfahren. Jeder Kompressor implementiert dieses Interface und kann so einheitlich benutzt werden.

interface Compressor
{
    /**
     * Konfiguriert den Kompressor.
     */
    void configure($arrConfig)
 
    /**
     * Gibt die aktuelle Kompressor Konfiguration zurück.
     */
    array getConfig()
 
    /**
     * Komprimiert die Datei $strSource und schreibt die komprimierten Daten in die Datei $strTarget.
     */
    bool compress($strSource, $strTarget)
 
    /**
     * Komprimiert die Datei $strSource und gibt die komprimierten Daten zurück.
     * Im Fehlerfall wird false zurück gegeben.
     */
    mixed compressFromFile($strSource)
 
    /**
     * Komprimiert die Daten $varData und schreibt diese in die Datei $strFile.
     */
    bool compressToFile($strFile, $varData)
 
    /**
     * Komprimiert die Daten $varData und gibt diese zurück.
     * Im Fehlerfall wird false zurück gegeben.
     */
    mixed compressData($varData)
}

interface Minimizer

Das Minimizer Interface ist die einheitliche Schnittstelle zu allen Minimierungsverfahren für CSS und JavaScript Code. Jeder Minimizer implementiert dieses Interface und kann so einheitlich benutzt werden.

interface Minimizer
{
    /**
     * Konfiguriert den Kompressor.
     */
    void configure($arrConfig)
 
    /**
     * Gibt die aktuelle Kompressor Konfiguration zurück.
     */
    array getConfig()
 
    /**
     * Minimiert die Datei $strSource und schreibt den minimierten Code in die Datei $strTarget.
     */
    bool minimize($strSource, $strTarget)
 
    /**
     * Minimiert die Datei $strSource und gibt die minimierten Daten zurück.
     * Im Fehlerfall wird false zurück gegeben.
     */
    mixed minimizeFromFile($strSource)
 
    /**
     * Minimiert den Code $strCode und schreibt diesen in die Datei $strFile.
     */
    bool minimizeToFile($strFile, $varData)
 
    /**
     * Minimiert den Code $strCode und gibt diesen zurück.
     * Im Fehlerfall wird false zurück gegeben.
     */
    mixed minimizeCode($strCode)
}

Unterstützte Verfahren

Komprimierungsverfahren

  • gzip - GzipCompressor (buildin)
  • bzip2 - Bzip2Compressor (buildin)
  • lzma - LzmaCompressor (geplant)

Minimierungsverfahren

  • yui - YUI Compressor
  • cssmin - cssMinimizer (geplant)
  • jsmin - jsMinimizer
  • dep - Dean Edwards Packer

Beispielcode

Datei komprimieren mit Bzip2

class MyExtension extends Controller
{
    protected $strCompressionMethod = 'bzip2';
 
    public function compress($strFile, $strFileBzip2)
    {
        $this->import('Compression');
        $strClass = $this->Compression->getCompressorClass($this->strCompressionMethod);
        $this->import($strClass, 'Compressor');
        return $this->Compressor->compress($strFile, $strFileBzip2);
    }
}

CSS Code minimieren

class MyExtension extends Controller
{
    protected $strMinimisationMethod = 'yui';
 
    public function minimize($strFile, $strCssCode)
    {
        $this->import('Compression');
        $strClass = $this->Compression->getCssMinimizerClass($this->strMinimisationMethod);
        $this->import($strClass, 'CssMinimizer');
        return $this->CssMinimizer->minimizeToFile($strFile, $strCssCode);
    }
}
Ansichten
Meine Werkzeuge

Contao Community Documentation

Nein, der Hangout ist noch nicht vorbei, wir schweigen nur. Es heisst ja auch hangout und nicht bryll out.

Christian Schiffler
Navigation
Verstehen
Verwenden
Entwickeln
Verschiedenes
Werkzeuge