array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'fr', ), 'this' => array ( 0 => 'php-user-filter.filter.php', 1 => 'php_user_filter::filter', 2 => 'Appelé lors de l\'application d\'un filtre', ), 'up' => array ( 0 => 'class.php-user-filter.php', 1 => 'php_user_filter', ), 'prev' => array ( 0 => 'class.php-user-filter.php', 1 => 'php_user_filter', ), 'next' => array ( 0 => 'php-user-filter.onclose.php', 1 => 'php_user_filter::onClose', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'fr', 'path' => 'reference/stream/php_user_filter/filter.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

php_user_filter::filter

(PHP 5, PHP 7, PHP 8)

php_user_filter::filter — Appelé lors de l'application d'un filtre

Description

public php_user_filter::filter(
    resource $in,
    resource $out,
    int &$consumed,
    bool $closing
): int

Cette méthode est appelée lorsque les données sont lues depuis le flux attaché, ou écrites sur le flux attaché (lors de l'utilisation de la fonction fread() ou la fonction fwrite()).

Liste de paramètres

in

Le paramètre in est une ressource pointant vers un bucket brigade qui contient un ou plusieurs objets bucket contenant les données à filtrer.

out

Le paramètre out est une ressource pointant vers un second bucket brigade dans lequel les bucket modifiés doivent être placés.

consumed

Le paramètre consumed, qui doit toujours être déclaré par référence, doit être incrémenté par la longueur des données filtrées par le filtre. Dans la plupart des cas, cela signifie qu'il faut incrémenter le paramètre consumed par $bucket->datalen pour chaque $bucket.

closing

Si le flux est dans un processus de fermeture (et donc, c'est la dernière passe via la chaîne de filtrage), le paramètre closing sera défini à true.

Valeurs de retour

La méthode filter() doit retourner au final une de ces trois valeurs.
Valeur retournée Signification
PSFS_PASS_ON Le processus de filtrage s'est terminé avec succès, et les données sont disponibles dans le paramètre out bucket brigade.
PSFS_FEED_ME Le processus de filtrage s'est terminé avec succès, cependant, aucune donnée n'est disponible pour être retournée. Plus de données sont requises depuis le flux ou avant filtrage.
PSFS_ERR_FATAL (défaut) Le filtre a rencontré une erreur fatale et ne peut continuer.