Documentation du code de SPIP et de ses plugins

Compresseur

Fonctions

Table of Contents

Functions

minifier()  : string
Minifier un fichier JS ou CSS
compacte()  : string
Synonyme historique de minifier, pour compatibilite
compacte_head()  : string
Compacte les éléments CSS et JS d'un <head> HTML
filtre_embarque_fichier()  : string
Embarquer sous forme URI Scheme un fichier
filtre_embarque_src()  : string
Embarquer le 'src' d'une balise html en URI Scheme
compresseur_ecrire_balise_js_dist()  : string
Ecrire la balise javascript pour insérer le fichier compressé
compresseur_ecrire_balise_css_dist()  : string
Ecrire la balise CSS pour insérer le fichier compressé
compresseur_extraire_balises_css_dist()  : array<string|int, mixed>
Extraire les balises CSS à compacter
compresseur_extraire_balises_js_dist()  : array<string|int, mixed>
Extraire les balises JS à compacter
compacte_head_files()  : string
Compacter (concaténer+minifier) les fichiers format CSS ou JS du head.
compresseur_liste_fonctions_prepare_css()  : array<string|int, mixed>
Lister les fonctions de préparation des feuilles css avant minification
compresseur_callback_prepare_css()  : bool|int|null|string
Préparer un fichier CSS avant sa minification
compresseur_callback_prepare_css_inline()  : string
Préparer du contenu CSS inline avant minification
css_resolve_atimport()  : string
Resoudre et inliner les @import ceux-ci ne peuvent etre presents qu'en debut de CSS et on ne veut pas changer l'ordre des directives
css_regroup_atimport()  : bool|string
Regrouper les @import restants dans la CSS concatenee en debut de celle-ci
css_url_statique_ressources()  : mixed
Remplacer l'URL du site par une url de ressource genre static.example.org qui evite les echanges de cookie pour les ressources images (peut aussi etre l'URL d'un CDN ou autre provider de ressources statiques)

Functions

minifier()

Minifier un fichier JS ou CSS

minifier(string $source[, string $format = null ]) : string

Si la source est un chemin, on retourne un chemin avec le contenu minifié dans DIR_VAR/cache$format/ Si c'est un flux on le renvoit compacté Si on ne sait pas compacter, on renvoie ce qu'on a recu

Parameters
$source : string

Contenu à minifier ou chemin vers un fichier dont on veut minifier le contenu

$format : string = null

Format de la source (js|css).

Return values
string
  • Contenu minifié (si la source est un contenu)
  • Chemin vers un fichier ayant le contenu minifié (si source est un fichier)

compacte()

Synonyme historique de minifier, pour compatibilite

compacte(string $source[, string $format = null ]) : string
Parameters
$source : string
$format : string = null
Tags
deprecated
1.6

(SPIP3.1)

see
minifier()
uses
minifier()
Return values
string

compacte_head()

Compacte les éléments CSS et JS d'un <head> HTML

compacte_head(string $flux) : string

Cette fonction vérifie les réglages du site et traite le compactage des css et/ou js d'un

Parameters
$flux : string

Partie de contenu du head HTML

Tags
see
compacte_head_files()
Return values
string

Partie de contenu du head HTML

filtre_embarque_fichier()

Embarquer sous forme URI Scheme un fichier

filtre_embarque_fichier(string $src[, string $base = '' ][, int $maxsize = 4096 ]) : string

Une URI Scheme est de la forme data:xxx/yyy;base64,....

Experimental

Parameters
$src : string

Chemin du fichier

$base : string = ''

Le chemin de base à partir duquel chercher $src

$maxsize : int = 4096

Taille maximale des fichiers à traiter

Tags
filtre
staticvar

array $mime Couples (extension de fichier => type myme)

Return values
string

URI Scheme du fichier si la compression est faite, URL du fichier sinon (la source)

filtre_embarque_src()

Embarquer le 'src' d'une balise html en URI Scheme

filtre_embarque_src(string $img[, int $maxsize = 4096 ]) : string

Experimental

Parameters
$img : string

Code HTML d'une image

$maxsize : int = 4096

Taille maximale des fichiers à traiter

Return values
string

Code HTML de l'image, avec la source en URI Scheme si cela a été possible.

compresseur_ecrire_balise_js_dist()

Ecrire la balise javascript pour insérer le fichier compressé

compresseur_ecrire_balise_js_dist(string &$flux, int $pos, string $src[, string $comments = '' ]) : string

C'est cette fonction qui décide où il est le plus pertinent d'insérer le fichier, et dans quelle forme d'ecriture

Parameters
$flux : string

Contenu du head nettoyé des fichiers qui ont été compressé

$pos : int

Position initiale du premier fichier inclu dans le fichier compressé

$src : string

Nom du fichier compressé

$comments : string = ''

Commentaires à insérer devant

Return values
string

Code HTML de la balise <script>

compresseur_ecrire_balise_css_dist()

Ecrire la balise CSS pour insérer le fichier compressé

compresseur_ecrire_balise_css_dist(string &$flux, int $pos, string $src[, string $comments = '' ][, string $media = '' ]) : string

C'est cette fonction qui décide ou il est le plus pertinent d'insérer le fichier, et dans quelle forme d'écriture

Parameters
$flux : string

Contenu du head nettoyé des fichiers qui ont ete compressé

$pos : int

Position initiale du premier fichier inclu dans le fichier compressé

$src : string

Nom du fichier compressé

$comments : string = ''

Commentaires à insérer devant

$media : string = ''

Type de media si précisé (print|screen...)

Return values
string

Code HTML de la balise

compresseur_extraire_balises_css_dist()

Extraire les balises CSS à compacter

compresseur_extraire_balises_css_dist(string $flux, string $url_base) : array<string|int, mixed>
Parameters
$flux : string

Contenu HTML dont on extrait les balises CSS

$url_base : string
Return values
array<string|int, mixed>

Couples (balise => src)

compresseur_extraire_balises_js_dist()

Extraire les balises JS à compacter

compresseur_extraire_balises_js_dist(string $flux, string $url_base) : array<string|int, mixed>
Parameters
$flux : string

Contenu HTML dont on extrait les balises CSS

$url_base : string
Return values
array<string|int, mixed>

Couples (balise => src)

compacte_head_files()

Compacter (concaténer+minifier) les fichiers format CSS ou JS du head.

compacte_head_files(string $flux, string $format) : string

Repérer fichiers statiques vs. url squelettes Compacte le tout dans un fichier statique posé dans local/

Parameters
$flux : string

Contenu du de la page html

$format : string

css ou js

Return values
string

Contenu compressé du de la page html

compresseur_liste_fonctions_prepare_css()

Lister les fonctions de préparation des feuilles css avant minification

compresseur_liste_fonctions_prepare_css() : array<string|int, mixed>
Return values
array<string|int, mixed>

Liste des fonctions à appliquer sur les feuilles CSS

compresseur_callback_prepare_css()

Préparer un fichier CSS avant sa minification

& compresseur_callback_prepare_css(string &$css[, bool|string $is_inline = false ][, string $fonctions = null ]) : bool|int|null|string
Parameters
$css : string
$is_inline : bool|string = false
$fonctions : string = null
Return values
bool|int|null|string

compresseur_callback_prepare_css_inline()

Préparer du contenu CSS inline avant minification

& compresseur_callback_prepare_css_inline(string &$contenu, string $url_base[, string $filename = '' ][, array<string|int, mixed> $fonctions = null ]) : string
Parameters
$contenu : string

contenu de la CSS

$url_base : string

url de la CSS ou de la page si c'est un style inline

$filename : string = ''

nom du fichier de la CSS (ou vide si c'est un style inline)

$fonctions : array<string|int, mixed> = null

liste des fonctions appliquees a la CSS

Return values
string

css_resolve_atimport()

Resoudre et inliner les @import ceux-ci ne peuvent etre presents qu'en debut de CSS et on ne veut pas changer l'ordre des directives

css_resolve_atimport(string $contenu, string $url_base, string $filename) : string
Parameters
$contenu : string
$url_base : string
$filename : string
Return values
string

css_regroup_atimport()

Regrouper les @import restants dans la CSS concatenee en debut de celle-ci

css_regroup_atimport(string $nom_tmp, string $nom) : bool|string
Parameters
$nom_tmp : string
$nom : string
Return values
bool|string

css_url_statique_ressources()

Remplacer l'URL du site par une url de ressource genre static.example.org qui evite les echanges de cookie pour les ressources images (peut aussi etre l'URL d'un CDN ou autre provider de ressources statiques)

css_url_statique_ressources(string $contenu, string $url_base, string $filename) : mixed
Parameters
$contenu : string
$url_base : string
$filename : string

        
On this page

Search results