(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
stream_filter_prepend — Adjunta un filtro a un flujo al inicio de la lista
$stream
,$filtername
,$read_write
= ?,$params
= ?
stream_filter_prepend() añade el filtro
filtername
a la lista de filtros adjuntos al
flujo stream
.
stream
El flujo de destino.
filtername
El nombre del filtro.
read_write
Por omisión, stream_filter_prepend()
adjuntará el filtro a la cadena de filtros de lectura
si el fichero ha sido abierto en modo lectura (es decir, modo
r
, y/o +
). El filtro
también será adjuntado a la cadena de filtros de escritura
si el fichero ha sido abierto en modo escritura (es decir, modo
w
, a
, y/o +
).
STREAM_FILTER_READ
,
STREAM_FILTER_WRITE
, y/o
STREAM_FILTER_ALL
pueden también ser pasados en el
parámetro read_write
para imponer el comportamiento
deseado. Véase stream_filter_append() para un ejemplo
de uso de este parámetro.
params
El filtro será añadido con los parámetros especificados en params
,
al inicio de la lista, y será llamado en primer lugar
en las operaciones del flujo. Para añadir un filtro al final de la lista,
utilice stream_filter_append().
Devuelve un recurso en caso de éxito, o false
en caso de error.
El recurso puede ser utilizado para referirse a esta instancia de filtro
durante una llamada a la función stream_filter_remove().
false
es devuelto si stream
no es un recurso,
o si filtername
no puede ser alcanzado.
Nota: Cuando se utilizan filtros personalizados
stream_register_filter() debe ser llamada antes que stream_filter_prepend() para registrar el filtro bajo el nombre defiltername
.
Nota: Los datos del flujo (locales y remotos) son devueltos en fragmentos, los datos no encaminados son conservados en el búfer interno. Cuando un nuevo filtro es añadido al inicio del flujo, los datos en el búfer interno no son pasados al nuevo filtro en ese momento. Esto es diferente del comportamiento de stream_filter_append().
Nota: Cuando un filtro es añadido para lectura y escritura, se crean dos instancias del filtro. stream_filter_prepend() debe ser llamada dos veces con
STREAM_FILTER_READ
ySTREAM_FILTER_WRITE
para obtener los recursos de los filtros.