stream_filter_prepend
(PHP 4 >= 4.3.0, PHP 5, PHP 7)
stream_filter_prepend — Attache un filtre à un flux en début de liste
Description
$stream
, string $filtername
[, int $read_write
[, mixed $params
]] )
stream_filter_prepend() ajoute le filtre
filtername
à la liste de filtres attachés au
flux stream
.
Liste de paramètres
-
stream
-
Le flux cible.
-
filtername
-
Le nom du filtre.
-
read_write
-
Par défaut, stream_filter_prepend() va attacher le filtre à la chaîne de filtre de lectures si le fichier a été ouvert en lecture (i.e. mode r, et/ou +). Le filtre va aussi être attaché à la chaîne de filtres d'écriture si le fichier a été ouvert en écriture (i.e. mode w, a, et/ou +).
STREAM_FILTER_READ
,STREAM_FILTER_WRITE
, et/ouSTREAM_FILTER_ALL
peuvent aussi être passés dans le paramètreread_write
pour imposer le comportement désiré. Voyez stream_filter_append() pour un exemple d'utilisation de ce paramètre. -
params
-
Le filtre sera ajouté avec les paramètres spécifiés dans
params
, au début de la liste, et sera ainsi appelé en premier dans les opérations du flux. Pour ajouter un filtre à la fin de la liste, utilisez stream_filter_append().
Valeurs de retour
Retourne une ressource en cas de succès, ou FALSE
si une erreur survient.
La ressource peut être utilisée pour se référer à cette instance de filtre
pendant un appel à la fonction stream_filter_remove().
FALSE
est retourné si stream
n'est pas une ressource,
ou si filtername
ne peut être atteint.
Historique
Version | Description |
---|---|
5.1.0 |
Avant PHP 5.1.0, cette fonction retourne TRUE en cas de
succès ou FALSE si une erreur survient.
|
Notes
Note: 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 defiltername
.
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().
Note: Quand un filtre est ajouté pour la lecture et l'écriture, deux instances du filtres sont créées. stream_filter_prepend() doit être appelée deux fois avec
STREAM_FILTER_READ
etSTREAM_FILTER_WRITE
pour obtenir les ressources de filtres.
Voir aussi
- stream_filter_register() - Enregistre un filtre de flux
- stream_filter_append() - Attache un filtre à un flux en fin de liste
Version en cache
22/11/2024 13:52:52 Cette version de la page est en cache (à la date du 22/11/2024 13:52:52) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 30/01/2003, dernière modification le 26/10/2018
Source du document imprimé : https://www.gaudry.be/php-rf-stream-filter-prepend.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.