stream_filter

Manuel PHP
Précédent		Suivant

Description

resource stream_filter_prepend ( resource stream, string filtername [, int read_write [, mixed params]] )

stream_filter_prepend() ajoute le filtre filtername à la liste de filtres attachés au flux stream. Ce filtre sera ajoutés avec les paramètres spécifiés dans params à la fin de cette liste et sera donc appelé en dernier durant les opérations de flux. Pour ajouter un filtre à la fin de la liste, utilisez la fonction stream_filter_prepend().

Par défaut, stream_filter_prepend() va ajouter le filtre à la liste de filtre de lecture si le fichier a été ouvert en mode lecture (r et/ou +). Le filtre sera aussi attaché à la liste des filtres de lecture si le fichier a été ouvert en mode lecture (w, a et/ou +). STREAM_FILTER_READ, STREAM_FILTER_WRITE, et/ou STREAM_FILTER_ALL peuvent aussi être utilisées dans le paramètre read_write pour contrôler ce comportement. Voyez la fonction stream_filter_append() pour un exemple de l'utilisation de ce paramètre.

Depuis PHP 5.0.1, cette fonction retourne une ressource qui peut être utilisée pour se référer à cette instance de filtre durant l'appel à la fonction stream_filter_remove(). Dans les versions antérieures à PHP 5.1.0, cette fonction retourne FALSE en cas de succès, FALSE sinon.

Quand vous utilisez des filtres personnalisés : stream_register_filter() doit être appelée avant stream_filter_prepend() pour enregistrer le filtre sous le nom de filtername.

Note : Les données du flux (locales et distantes) sont retournées en morceaux, les données non acheminées étant conservées dans le tampon interne. Lorsqu'un nouveau filtre est ajouté au début du flux, les données dans le tampon interne ne sont pas passées dans le nouveau filtre à ce moment là. Ceci est différent du comportement de stream_filter_append().

Voir aussi stream_register_filter() et stream_filter_append().

Précédent	Sommaire	Suivant
stream_filter_append	Niveau supérieur	stream_filter_register