CLXII. Compression Zlib

Introduction

Ce module vous permet de lire et ecrire de manière transparente des fichiers compressés gzip (.gz), avec la plupart des fonctions fichier qui fonctionnent avec les fichiers compressés en gzip (et les fichiers décompressés aussi, mais pas avec les sockets).

Note : La version 4.0.4 a introduit la version étendue de fopen() pour les fichiers compressés avec GZ. Vous pouvez utiliser le préfixe spécial zlib: dans les URL pour accéder directement et de manière transparente aux fichiers compressés par GZ, avec toutes les fonctions f*() habituelles.
En version 4.3.0, ce préfixe spécial est remplacé par zlib:// pour éviter les ambiguités avec les noms de fichiers contenant des :.
Cette fonctionnalité requière une bibliothèque C qui fournit la fonction fopencookie(). A ma connaissance, la bibliothèque GNU libc est la seule à fournir cette fonctionnalité.

Pré-requis

Ce module utilise les fonctions de la bibliothèque zlib de Jean-loup Gailly et Mark Adler. Vous devez utiliser zlib version >= 1.0.9 avec ce module.

Installation

Le support de Zlib dans PHP n'est pas activé par défaut. Vous devez compiler PHP avec l'option --with-zlib[=DIR].

La version Windows de PHP dispose du support automatique de cette extension. Vous n'avez pas à ajouter de bibliothèque supplémentaire pour disposer de ces fonctions.

Note : Le support intégré de zlib est disponible depuis PHP 4.3.0.

Configuration à l'exécution

Le comportement de ces fonctions est affecté par la configuration dans le fichier php.ini.

L'extension zlib offre l'option de compresser de manière transparente les pages PHP à la volée, si le navigateur du visiteur le supporte. Voici donc les trois options à utiliser dans le php.ini.

Tableau 1. Options de configuration

Nom	Par défaut	Modifiable	Historique
zlib.output_compression	"0"	PHP_INI_ALL	Disponible depuis PHP 4.0.5.
zlib.output_compression_level	"-1"	PHP_INI_ALL	Disponible depuis PHP 4.3.0.
zlib.output_handler	""	PHP_INI_ALL	Disponible depuis PHP 4.3.0.

Pour plus de détails sur les constantes PHP_INI_*, reportez-vous à Annexe H.

Voici un éclaircissement sur l'utilisation des directives de configuration.

zlib.output_compression booléen/entier

Active ou pas la compression transparente des pages. Si cette option est mise à "On" dans php.ini ou dans la configuration Apache, les pages sont compressées si le navigateur envoie un en-tête "Accept-Encoding: gzip" ou "deflate". Les en-têtes "Content-Encoding: gzip" (respectivement "deflate") et "Vary: Accept-Encoding" sont ajoutés dans la page envoyée au navigateur. En fonctionnement, il peut être défini uniquement avant tout affichage.

Cette option accepte aussi des valeurs entières au lieu des booléens, "On"/"Off", ce qui vous permet de configurer la taille du tampon de sortie (par défaut, il vaut 4ko).

Note : output_handler doit être laissée à vide si cette option est activée. Sinon, vous devez utiliser zlib.output_handler.

zlib.output_compression_level entier

Niveau de compression utilisé pour la compression de sortie.

zlib.output_handler chaîne de caractères

Vous ne pouvez pas spécifier de gestionnaire de sortie supplémentaire si zlib.output_compression est activée. Cette configuration est la même que output_handler mais dans un ordre différent.

Types de ressources

Cette extension ne définit aucune ressource.

Constantes pré-définies

Ces constantes sont définies par cette extension, et ne sont disponibles que si cette extension a été compilée avec PHP, ou bien chargée au moment de l'exécution.

FORCE_GZIP (entier)
FORCE_DEFLATE (entier)

Exemples

Cet exemple ouvre un fichier temporaire, écrit une page de test dedans, puis affiche le contenu du fichier deux fois.

Exemple 1. Exemple de l'extension Zlib


<?php

$filename = tempnam('/tmp', 'zlibtest') . '.gz';
echo "<html>\n<head></head>\n<body>\n<pre>\n";
$s = "C'est juste un test, test, test, test, test, test, test, test!\n";

// ouvre le fichier en écriture avec la compression maximale
$zp = gzopen($filename, "w9");

// écrit une chaîne dans le fichier
gzwrite($zp, $s);

// ferme le fichier
gzclose($zp);

// ouvre le fichier en lecture
$zp = gzopen($filename, "r");

// lit 3 caractères
echo gzread($zp, 3);

// affiche le reste du fichier, puis le ferme
gzpassthru($zp);
gzclose($zp);

echo "\n";

// ouvre le fichier et affiche le fichier une seconde fois
if (readgzfile($filename) != strlen($s)) {
    echo "Erreur avec les fonctions zlib!";
}
unlink($filename);
echo "</pre>\n</body>\n</html>\n";

?>

Table des matières
gzclose -- Ferme un pointeur sur fichier gz ouvert
gzcompress -- Compresse une chaîne
gzdeflate -- Compresse une chaîne
gzencode -- Crée une chaîne compressée gzip
gzeof -- Indique si la fin d'un fichier compressé est atteinte
gzfile -- Lit la totalité d'un fichier compressé
gzgetc -- Lit un caractère dans un fichier compressé
gzgets -- Lit une ligne dans un fichier compressé
gzgetss -- Lit une ligne dans un fichier compressé, et supprime les balises HTML
gzinflate -- Décompresse une chaîne
gzopen -- Ouvre un fichier compressé avec gzip
gzpassthru -- Affiche toutes les données qui restent dans un pointeur gz
gzputs -- Alias de gzwrite()
gzread -- Lecture de fichier compressé binaire
gzrewind -- Replace le pointeur au début du fichier
gzseek -- Déplace le pointeur de lecture
gztell -- Lit la position courante du pointeur de lecture
gzuncompress -- Décompresse une chaîne compressée
gzwrite -- Ecrit dans un fichier compressé gzip
readgzfile -- Lit tout le fichier compressé
zlib_get_coding_type -- Retourne la méhode de compression utilisée avec Gzip