From 6fe606eeda8b038bd24a02bad6ac2913e1d35f49 Mon Sep 17 00:00:00 2001 From: lacatoire Date: Wed, 18 Nov 2026 09:20:38 +0100 Subject: [PATCH] [Sync-En] filter, stream: document the exceptions of filter_var(), filter_input(), stream_context_*() and the stream filter functions --- reference/filter/functions/filter-has-var.xml | 36 +++++++++- .../filter/functions/filter-input-array.xml | 62 +++++++++++++++- reference/filter/functions/filter-input.xml | 54 +++++++++++--- .../filter/functions/filter-var-array.xml | 54 ++++++++++++-- reference/filter/functions/filter-var.xml | 13 +++- .../functions/stream-context-create.xml | 43 +++++++++++- .../functions/stream-context-get-default.xml | 20 +++++- .../functions/stream-context-get-options.xml | 44 ++++++++++-- .../functions/stream-context-get-params.xml | 38 +++++++++- .../functions/stream-context-set-default.xml | 38 +++++++++- .../functions/stream-context-set-option.xml | 62 +++++++++++++++- .../functions/stream-context-set-options.xml | 17 ++++- .../functions/stream-context-set-params.xml | 70 ++++++++++++++++++- .../stream/functions/stream-filter-append.xml | 49 ++++++++++--- .../functions/stream-filter-prepend.xml | 45 ++++++++++-- .../functions/stream-filter-register.xml | 35 +++++++++- 16 files changed, 635 insertions(+), 45 deletions(-) diff --git a/reference/filter/functions/filter-has-var.xml b/reference/filter/functions/filter-has-var.xml index b3e4a91f7b..a878eb3ed5 100644 --- a/reference/filter/functions/filter-has-var.xml +++ b/reference/filter/functions/filter-has-var.xml @@ -1,5 +1,5 @@ - + @@ -44,6 +44,40 @@ + + &reftitle.errors; + + Lanza una ValueError si + input_type no es una de las constantes + INPUT_*. + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + Ahora se lanza una ValueError si + input_type no es una de las constantes + INPUT_*; + anteriormente, se devolvía &false;. + + + + + + + + filter_input_array @@ -73,6 +73,66 @@ + + &reftitle.errors; + + Lanza una ValueError si + type no es una de las constantes + INPUT_*. + + + Si el array de entrada designado por type está + poblado, lanza una TypeError si + options es un &array; con una clave que no es un + &string;, y una ValueError si tiene una clave + vacía. + + + A partir de PHP 8.5.0, lanza una + Filter\FilterFailedException si se utiliza el + flag FILTER_THROW_ON_FAILURE para una entrada + presente en el array de entrada y su filtro falla, + y una ValueError si ese flag se utiliza junto + con FILTER_NULL_ON_FAILURE para dicha entrada. + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + Ahora se lanza una ValueError si + type no es una de las constantes + INPUT_*; + anteriormente, el array de entrada se trataba como no poblado. + + + + 8.0.0 + + Si el array de entrada designado por type está + poblado, ahora se lanza una TypeError si + options tiene una clave que no es un &string;, + y una ValueError si tiene una clave vacía; + anteriormente, se emitía un E_WARNING y se devolvía + &false;. + + + + + + + &reftitle.examples; diff --git a/reference/filter/functions/filter-input.xml b/reference/filter/functions/filter-input.xml index 3970259209..65f673f82a 100644 --- a/reference/filter/functions/filter-input.xml +++ b/reference/filter/functions/filter-input.xml @@ -1,6 +1,6 @@ - + @@ -34,7 +34,7 @@ "sin procesar" proporcionado por SAPI, antes de cualquier modificación del usuario a la superglobal. Para filtrar una superglobal modificada, utilice - filter_var_array en su lugar. + filter_var en su lugar. @@ -48,12 +48,8 @@ - - - - - - + + @@ -69,6 +65,48 @@ + + &reftitle.errors; + + Lanza una ValueError si + type no es una de las constantes + INPUT_*. + + + A partir de PHP 8.5.0, lanza una + Filter\FilterFailedException si se utiliza el + flag FILTER_THROW_ON_FAILURE y el filtro falla o la + variable var_name no está definida, + y una ValueError si ese flag se utiliza junto + con FILTER_NULL_ON_FAILURE. + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + Ahora se lanza una ValueError si + type no es una de las constantes + INPUT_*; + anteriormente, la variable se trataba como no definida. + + + + + + + &reftitle.examples; diff --git a/reference/filter/functions/filter-var-array.xml b/reference/filter/functions/filter-var-array.xml index 1a48923fa5..ddb0de15f6 100644 --- a/reference/filter/functions/filter-var-array.xml +++ b/reference/filter/functions/filter-var-array.xml @@ -1,9 +1,9 @@ - + filter_var_array - Obtiene múltiple variables y opcionalmente las filtra + Obtiene múltiples variables y opcionalmente las filtra @@ -20,7 +20,7 @@ FILTER_VALIDATE_*, filtros de saneación FILTER_SANITIZE_*, - o filtros definidos por el usuario + o filtros definidos por el usuario. @@ -47,7 +47,7 @@ FILTER_SANITIZE_*. - La array de opciones es un array asociativo donde la clave corresponde + El array de opciones es un array asociativo donde la clave corresponde a una clave del array de entrada y el valor asociado es el filtro a aplicar a esta entrada, o un array asociativo que describe cómo y qué filtro se debe @@ -56,7 +56,7 @@ El array asociativo que describe cómo se debe aplicar un filtro debe contener la clave 'filter' cuyo valor asociado - es el filtro a aplicar, que puede ser uno de las constantes + es el filtro a aplicar, que puede ser una de las constantes FILTER_VALIDATE_*, FILTER_SANITIZE_*, FILTER_UNSAFE_RAW, o @@ -102,6 +102,50 @@ + + &reftitle.errors; + + Lanza una TypeError si + options es un &array; con una clave que no es un + &string;, y una ValueError si tiene una clave + vacía. + + + A partir de PHP 8.5.0, lanza una + Filter\FilterFailedException si se utiliza el + flag FILTER_THROW_ON_FAILURE para una entrada + presente en array y su filtro falla, + y una ValueError si ese flag se utiliza junto + con FILTER_NULL_ON_FAILURE para dicha entrada. + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + Ahora se lanza una TypeError si + options tiene una clave que no es un &string;, + y una ValueError si tiene una clave vacía; + anteriormente, se emitía un E_WARNING y se devolvía + &false;. + + + + + + + &reftitle.examples; diff --git a/reference/filter/functions/filter-var.xml b/reference/filter/functions/filter-var.xml index 239f4bf066..32f08580b9 100644 --- a/reference/filter/functions/filter-var.xml +++ b/reference/filter/functions/filter-var.xml @@ -1,6 +1,6 @@ - + @@ -92,6 +92,17 @@ + + &reftitle.errors; + + A partir de PHP 8.5.0, lanza una + Filter\FilterFailedException si se utiliza el + flag FILTER_THROW_ON_FAILURE y el filtro falla, + y una ValueError si ese flag se utiliza junto + con FILTER_NULL_ON_FAILURE. + + + &reftitle.examples; diff --git a/reference/stream/functions/stream-context-create.xml b/reference/stream/functions/stream-context-create.xml index c95d0c400d..afe7490a30 100644 --- a/reference/stream/functions/stream-context-create.xml +++ b/reference/stream/functions/stream-context-create.xml @@ -1,5 +1,5 @@ - + @@ -61,6 +61,27 @@ + + &reftitle.errors; + + Lanza una ValueError si + options, o la entrada options de + params, no tiene el formato + $arr['wrapper']['option'] = $value, + es decir, si uno de sus elementos no es un array o tiene una clave entera. + + + Lanza una TypeError si la entrada + options de params + no es un array. + + + Lanza una TypeError si la entrada + notification de params + no es un callback válido. + + + &reftitle.changelog; @@ -72,12 +93,32 @@ + + 8.5.0 + + Ahora lanza una TypeError si la entrada + notification de params + no es un callback válido. + + 8.0.0 options y params ahora son nullable. + + 8.0.0 + + Ahora lanza una ValueError si + options, o la entrada options de + params, no tiene el formato esperado, + y una TypeError si la entrada + options de params + no es un array. + Anteriormente, se emitía un E_WARNING. + + diff --git a/reference/stream/functions/stream-context-get-default.xml b/reference/stream/functions/stream-context-get-default.xml index 707b2e32d3..e61ed660a1 100644 --- a/reference/stream/functions/stream-context-get-default.xml +++ b/reference/stream/functions/stream-context-get-default.xml @@ -1,5 +1,5 @@ - + @@ -49,6 +49,16 @@ + + &reftitle.errors; + + Lanza una ValueError si + options no tiene el formato + $arr['wrapper']['option'] = $value, + es decir, si uno de sus elementos no es un array o tiene una clave entera. + + + &reftitle.changelog; @@ -66,6 +76,14 @@ options es ahora nullable. + + 8.0.0 + + Ahora lanza una ValueError si + options no tiene el formato esperado. + Anteriormente, se emitía un E_WARNING. + + diff --git a/reference/stream/functions/stream-context-get-options.xml b/reference/stream/functions/stream-context-get-options.xml index 6a260addaa..b191a41294 100644 --- a/reference/stream/functions/stream-context-get-options.xml +++ b/reference/stream/functions/stream-context-get-options.xml @@ -1,6 +1,6 @@ - + @@ -15,7 +15,7 @@ resourcestream_or_context - Devuelve una matriz de opciones del el flujo o contexto especificados. + Devuelve un array de opciones del flujo o contexto especificados. @@ -38,10 +38,44 @@ &reftitle.returnvalues; - Devuelve una matriz asociativa con las opciones. + Devuelve un array asociativo con las opciones. + + &reftitle.errors; + + Lanza una TypeError si + stream_or_context no es un resource + de flujo o de contexto de flujo válido. + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + Ahora lanza una TypeError si + stream_or_context no es un resource + de flujo o de contexto de flujo válido. + Anteriormente, se emitía un E_WARNING y se devolvía &false;. + + + + + + + &reftitle.examples; @@ -50,7 +84,7 @@ "POST"); +$params = array("method" => "POST"); stream_context_set_default(array("http" => $params)); @@ -65,7 +99,7 @@ var_dump(stream_context_get_options(stream_context_get_default())); array(1) { ["http"]=> array(1) { - ["método"]=> + ["method"]=> string(4) "POST" } } diff --git a/reference/stream/functions/stream-context-get-params.xml b/reference/stream/functions/stream-context-get-params.xml index 5fdf235faf..4b52cddb20 100644 --- a/reference/stream/functions/stream-context-get-params.xml +++ b/reference/stream/functions/stream-context-get-params.xml @@ -1,6 +1,6 @@ - + @@ -16,7 +16,7 @@ stream_context_get_params lee los parámetros - del contexto o del flujo stream_or_context. + del contexto o del flujo context. @@ -45,6 +45,40 @@ + + &reftitle.errors; + + Lanza una TypeError si + context no es un resource + de flujo o de contexto de flujo válido. + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + Ahora lanza una TypeError si + context no es un resource + de flujo o de contexto de flujo válido. + Anteriormente, se emitía un E_WARNING y se devolvía &false;. + + + + + + + &reftitle.examples; diff --git a/reference/stream/functions/stream-context-set-default.xml b/reference/stream/functions/stream-context-set-default.xml index 74a30b18dd..fa32a76ae1 100644 --- a/reference/stream/functions/stream-context-set-default.xml +++ b/reference/stream/functions/stream-context-set-default.xml @@ -1,5 +1,5 @@ - + @@ -36,7 +36,7 @@ options debe ser un array asociativo de arrays asociativos, en el formato - $arr['gestor']['opción'] = $valor. + $arr['wrapper']['option'] = $value. @@ -52,6 +52,40 @@ + + &reftitle.errors; + + Lanza una ValueError si + options no tiene el formato + $arr['wrapper']['option'] = $value, + es decir, si uno de sus elementos no es un array o tiene una clave entera. + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + Ahora lanza una ValueError si + options no tiene el formato esperado. + Anteriormente, se emitía un E_WARNING. + + + + + + + &reftitle.examples; diff --git a/reference/stream/functions/stream-context-set-option.xml b/reference/stream/functions/stream-context-set-option.xml index ebc8b78c58..1b439a32ac 100644 --- a/reference/stream/functions/stream-context-set-option.xml +++ b/reference/stream/functions/stream-context-set-option.xml @@ -1,6 +1,6 @@ - + @@ -102,6 +102,28 @@ &return.success; + + + &reftitle.errors; + + Lanza una TypeError si + stream_or_context no es un resource + de flujo o de contexto de flujo válido. + + + Lanza una ValueError si + falta option_name o value + cuando wrapper es un string, o si alguno de ellos + se proporciona junto con un array options. + + + Lanza una ValueError si + options no tiene el formato + $arr['wrapper']['option'] = $value, + es decir, si uno de sus elementos no es un array o tiene una clave entera. + + + &reftitle.changelog; @@ -120,6 +142,44 @@ Utilice stream_context_set_options en su lugar. + + 8.0.9 + + Ahora lanza una ValueError si no se + proporciona value cuando + wrapper es un string. + + + + 8.0.0 + + Ahora lanza una TypeError si + stream_or_context no es un resource + de flujo o de contexto de flujo válido. + Anteriormente, se emitía un E_WARNING y se devolvía &false;. + + + + 8.0.0 + + Ahora lanza una ValueError si + options no tiene el formato esperado. + Anteriormente, se emitía un E_WARNING. + + + + 8.0.0 + + Ahora lanza una ValueError si + option_name es &null; cuando + wrapper es un string, o si + option_name o value + se proporciona junto con un array options. + Anteriormente, se emitía un E_WARNING y se devolvía &false;, + excepto cuando option_name era &null; y + se proporcionaba value, lo cual era aceptado. + + diff --git a/reference/stream/functions/stream-context-set-options.xml b/reference/stream/functions/stream-context-set-options.xml index 2eb07908d3..8fc1a9c852 100644 --- a/reference/stream/functions/stream-context-set-options.xml +++ b/reference/stream/functions/stream-context-set-options.xml @@ -1,5 +1,5 @@ - + @@ -60,6 +60,21 @@ + + &reftitle.errors; + + Lanza una TypeError si + context no es un resource + de flujo o de contexto de flujo válido. + + + Lanza una ValueError si + options no tiene el formato + $arr['wrapper']['option'] = $value, + es decir, si uno de sus elementos no es un array o tiene una clave entera. + + + &reftitle.examples; diff --git a/reference/stream/functions/stream-context-set-params.xml b/reference/stream/functions/stream-context-set-params.xml index 87a54167a9..769701d4d3 100644 --- a/reference/stream/functions/stream-context-set-params.xml +++ b/reference/stream/functions/stream-context-set-params.xml @@ -1,6 +1,6 @@ - + @@ -86,6 +86,74 @@ + + &reftitle.errors; + + Lanza una TypeError si + context no es un resource + de flujo o de contexto de flujo válido. + + + Lanza una ValueError si la entrada + options de params + no tiene el formato $arr['wrapper']['option'] = $value, + es decir, si uno de sus elementos no es un array o tiene una clave entera. + + + Lanza una TypeError si la entrada + options de params + no es un array. + + + Lanza una TypeError si la entrada + notification de params + no es un callback válido. + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.5.0 + + Ahora lanza una TypeError si la entrada + notification de params + no es un callback válido. + + + + 8.0.0 + + Ahora lanza una TypeError si + context no es un resource + de flujo o de contexto de flujo válido. + Anteriormente, se emitía un E_WARNING y se devolvía &false;. + + + + 8.0.0 + + Ahora lanza una ValueError si la entrada + options de params + no tiene el formato esperado, y una TypeError + si no es un array. + Anteriormente, se emitía un E_WARNING. + + + + + + + &reftitle.seealso; diff --git a/reference/stream/functions/stream-filter-append.xml b/reference/stream/functions/stream-filter-append.xml index 0727cea97b..c0e1640842 100644 --- a/reference/stream/functions/stream-filter-append.xml +++ b/reference/stream/functions/stream-filter-append.xml @@ -1,6 +1,6 @@ - + @@ -86,10 +86,43 @@ El recurso puede ser utilizado para referirse a la instancia de este filtro durante una llamada a la función stream_filter_remove. - - &false; es devuelto si stream no es un recurso - o si filter_name no puede ser alcanzado. - + + Se devuelve &false;, y se emite un E_WARNING, si + filter_name no puede ser localizado o el filtro no + puede ser creado. + + + + + &reftitle.errors; + + Lanza una TypeError si + stream no es un resource de flujo abierto. + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + Ahora lanza una TypeError si + stream no es un resource de flujo abierto. + Anteriormente, se emitía un E_WARNING y se devolvía &false;. + + + + + @@ -109,7 +142,7 @@ stream_filter_append($fp, "string.rot13", STREAM_FILTER_WRITE); /* Se añade una simple cadena al fichero, será * transformada por ROT13 al escribir */ -fwrite($fp, "Ceci est un test\n"); +fwrite($fp, "This is a test\n"); /* Se vuelve al principio del fichero */ rewind($fp); @@ -139,7 +172,7 @@ Guvf vf n grfg Cuando se utilizan filtros personalizados - stream_register_filter debe ser llamada antes + stream_filter_register debe ser llamada antes de stream_filter_append para registrar el filtro bajo el nombre de filter_name. @@ -157,7 +190,7 @@ Guvf vf n grfg Cuando un filtro es añadido para lectura y escritura, se crean dos instancias - del filtro. stream_filter_prepend debe ser + del filtro. stream_filter_append debe ser llamada dos veces con STREAM_FILTER_READ y STREAM_FILTER_WRITE para obtener los recursos de los filtros. diff --git a/reference/stream/functions/stream-filter-prepend.xml b/reference/stream/functions/stream-filter-prepend.xml index 8a3bf19227..9592b3a5fc 100644 --- a/reference/stream/functions/stream-filter-prepend.xml +++ b/reference/stream/functions/stream-filter-prepend.xml @@ -1,6 +1,6 @@ - + @@ -87,10 +87,43 @@ durante una llamada a la función stream_filter_remove. - - &false; es devuelto si stream no es un recurso, - o si filter_name no puede ser alcanzado. - + + Se devuelve &false;, y se emite un E_WARNING, si + filter_name no puede ser localizado o el filtro no + puede ser creado. + + + + + &reftitle.errors; + + Lanza una TypeError si + stream no es un resource de flujo abierto. + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + Ahora lanza una TypeError si + stream no es un resource de flujo abierto. + Anteriormente, se emitía un E_WARNING y se devolvía &false;. + + + + + @@ -98,7 +131,7 @@ Cuando se utilizan filtros personalizados - stream_register_filter debe ser llamada antes + stream_filter_register debe ser llamada antes que stream_filter_prepend para registrar el filtro bajo el nombre de filter_name. diff --git a/reference/stream/functions/stream-filter-register.xml b/reference/stream/functions/stream-filter-register.xml index cbde9654bd..7eb239a47b 100644 --- a/reference/stream/functions/stream-filter-register.xml +++ b/reference/stream/functions/stream-filter-register.xml @@ -1,6 +1,6 @@ - + @@ -65,6 +65,39 @@ + + &reftitle.errors; + + Lanza una ValueError si + filter_name o class está vacío. + + + + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.0.0 + + Ahora lanza una ValueError si + filter_name o class + está vacío. + Anteriormente, se emitía un E_WARNING y se devolvía &false;. + + + + + + + &reftitle.examples;