php_user_filter::filter

(PHP 5, PHP 7, PHP 8)

php_user_filter::filter — Llamado cuando se aplica un filtro

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

Este método es llamado siempre que los datos son leídos desde o escritos en el flujo adjunto (como con fread() o fwrite()).

in: in es un recurso que apunta a una cadena de recipientes que contiene uno o más objetos recipiente que contienen información que va a ser filtrada.
out: out es un recurso que apunta a una segunda cadena de recipientes dentro de la cual se deberían ubicar los recipientes modificados.
consumed: consumed, el cual siempre debe ser declarado por referencia, debería ser incrementado por la longitud de la información que el filtro lee y altera. En la mayoría de los casos esto significa que se incrementará consumed por $recipiente->datalen para cada $recipiente.
closing: Si el flujo está en el proceso de cierre (y por lo tanto éste es el último pase a través de la cadena de filtros), el parámetro closing será establecido a true.

El método filter() debe devolver uno de estos tres valores cuando se complete.

Valor Devuelto	Significado
`PSFS_PASS_ON`	El filtró se procesó con éxito con información disponible en la `cadena de recipientes` `out`.
`PSFS_FEED_ME`	El filtró se procesó con éxito, sin embargo no había información disponible que devolver. Se requiere más información del flujo o del filtro previo.
`PSFS_ERR_FATAL` (predeterminado)	El filtro experimentó un error irrecuperable y no puede continuar.

There are no user contributed notes for this page.