(PHP 5, PHP 7, PHP 8)
stream_filter_register — Registra un filtro de flujo
stream_filter_register() permite implementar un filtro de flujo personalizado, para ser utilizado con las funciones de acceso a datos externos (como fopen(), fread(), etc.).
filter_nameEl nombre del filtro a registrar.
classPara crear una clase de filtro, se debe definir una clase que extienda la clase php_user_filter. Al realizar operaciones de lectura y escritura en el flujo al que esté adjunto el filtro, PHP pasará los datos a través del filtro (y de todos los otros filtros adjuntos), de manera que los datos sean modificados según lo deseado. Se deben implementar los métodos tal como se describe en php_user_filter, de lo contrario se producirán comportamientos indefinidos.
Esta función retorna true en caso de éxito o false si ocurre un error.
stream_filter_register() debe devolver siempre false si
el parámetro filter_name ya está definido.
Ejemplo #1 Filtro de letras mayúsculas en el flujo foo-bar.txt
El ejemplo siguiente implementa un filtro llamado
strtoupper, en el flujo foo-bar.txt,
que convierte a mayúsculas todas las letras escritas/leídas desde este flujo.
<?php
/* Definición de la clase */
class strtoupper_filter extends php_user_filter {
function filter($in, $out, &$consumed, $closing)
{
while ($bucket = stream_bucket_make_writeable($in)) {
$bucket->data = strtoupper($bucket->data);
$consumed += $bucket->datalen;
stream_bucket_append($out, $bucket);
}
return PSFS_PASS_ON;
}
}
/* Registro de nuestro filtro con PHP */
stream_filter_register("strtoupper", "strtoupper_filter")
or die("Error al registrar el filtro");
$fp = fopen("foo-bar.txt", "w");
/* Adjuntar el filtro registrado al flujo que acabamos de abrir */
stream_filter_append($fp, "strtoupper");
fwrite($fp, "Línea1\n");
fwrite($fp, "Palabra - 2\n");
fwrite($fp, "Fácil como 123\n");
fclose($fp);
/* Lectura del contenido */
readfile("foo-bar.txt");
?>El ejemplo anterior mostrará :
LÍNEA1 PALABRA - 2 FÁCIL COMO 123
Ejemplo #2 Registro de una clase de filtro genérica para coincidir con múltiples nombres de filtros
<?php
/* Definición de la clase */
class string_filter extends php_user_filter {
var $mode;
function filter($in, $out, &$consumed, $closing)
{
while ($bucket = stream_bucket_make_writeable($in)) {
if ($this->mode == 1) {
$bucket->data = strtoupper($bucket->data);
} elseif ($this->mode == 0) {
$bucket->data = strtolower($bucket->data);
}
$consumed += $bucket->datalen;
stream_bucket_append($out, $bucket);
}
return PSFS_PASS_ON;
}
function onCreate()
{
if ($this->filtername == 'str.toupper') {
$this->mode = 1;
} elseif ($this->filtername == 'str.tolower') {
$this->mode = 0;
} else {
/* Se solicitan algunos otros filtros str.*, manejo del error con PHP */
return false;
}
return true;
}
}
/* Registro de nuestro filtro con PHP */
stream_filter_register("str.*", "string_filter")
or die("Error al registrar el filtro");
$fp = fopen("foo-bar.txt", "w");
/* Adjuntar el filtro registrado al flujo que acabamos de abrir
Podemos alternativamente pasar a str.tolower aquí */
stream_filter_append($fp, "str.toupper");
fwrite($fp, "Línea1\n");
fwrite($fp, "Palabra - 2\n");
fwrite($fp, "Fácil como 123\n");
fclose($fp);
/* Lectura del contenido */
readfile("foo-bar.txt");
?>El ejemplo anterior mostrará :
LÍNEA1 PALABRA - 2 FÁCIL COMO 123