Compression API: Unterschied zwischen den Versionen

Aus Contao Community Documentation

(Unterstützte Verfahren)
(Compression API)
Zeile 7: Zeile 7:
 
|Version=2.9.x}}
 
|Version=2.9.x}}
 
=Compression API=
 
=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:
 +
 +
===Compression===
 +
 +
<source lang="php">
 +
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()
 +
}
 +
</source>
  
 
==Unterstützte Verfahren==
 
==Unterstützte Verfahren==

Version vom 20. Januar 2011, 16:02 Uhr

MsgError.png Unvollständiger Artikel: dieser Artikel ist noch nicht sauber bearbeitet.

Bitte erweitere ihn und entferne erst anschliessend diesen Hinweis.

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:

Compression

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()
}

Unterstützte Verfahren

Komprimierungsverfahren

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

Minimierungsverfahren

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

Contao Community Documentation

... aber beim nächsten Mal nehm ich einfach den Catalog... da hab ich weniger Arbeit mit.

MacKP
Navigation
Verstehen
Verwenden
Entwickeln
Verschiedenes
Werkzeuge