From 35f1cd5a994c548427edad88f76eb258f25f790a Mon Sep 17 00:00:00 2001 From: Sara Golemon Date: Tue, 14 Sep 2004 04:04:00 +0000 Subject: [PATCH] Document stream_filter_remove() git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@168552 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../stream/functions/stream-filter-append.xml | 11 ++- .../functions/stream-filter-prepend.xml | 11 ++- .../stream/functions/stream-filter-remove.xml | 78 +++++++++++++++++++ 3 files changed, 96 insertions(+), 4 deletions(-) create mode 100644 reference/stream/functions/stream-filter-remove.xml diff --git a/reference/stream/functions/stream-filter-append.xml b/reference/stream/functions/stream-filter-append.xml index ac037704db..8c96315ad3 100644 --- a/reference/stream/functions/stream-filter-append.xml +++ b/reference/stream/functions/stream-filter-append.xml @@ -1,5 +1,5 @@ - + stream_filter_append @@ -8,7 +8,7 @@ Description - boolstream_filter_append + resourcestream_filter_append resourcestream stringfiltername intread_write @@ -36,6 +36,13 @@ STREAM_FILTER_ALL can also be passed to the read_write parameter to override this behavior. + + As of PHP 5.1.0, this function returns a resource which + can be used to refer to this filter instance during a call + to stream_filter_remove. + Prior to PHP 5.1.0, this function returns &true; on success + or &false; on failure. + Controlling where filters are applied diff --git a/reference/stream/functions/stream-filter-prepend.xml b/reference/stream/functions/stream-filter-prepend.xml index 54acb17176..31e6f4e7d8 100644 --- a/reference/stream/functions/stream-filter-prepend.xml +++ b/reference/stream/functions/stream-filter-prepend.xml @@ -1,5 +1,5 @@ - + stream_filter_prepend @@ -8,7 +8,7 @@ Description - boolstream_filter_prepend + resourcestream_filter_prepend resourcestream stringfiltername intread_write @@ -38,6 +38,13 @@ See stream_filter_append for an example of using this parameter. + + As of PHP 5.1.0, this function returns a resource which + can be used to refer to this filter instance during a call + to stream_filter_remove. + Prior to PHP 5.1.0, this function returns &true; on success + or &false; on failure. + When using custom (user) filters diff --git a/reference/stream/functions/stream-filter-remove.xml b/reference/stream/functions/stream-filter-remove.xml new file mode 100644 index 0000000000..4ebdf6a156 --- /dev/null +++ b/reference/stream/functions/stream-filter-remove.xml @@ -0,0 +1,78 @@ + + + + + stream_filter_remove + Remove a filter from a stream + + + Description + + boolstream_filter_append + resourcestream_filter + + + Removes a stream filter previously added to a stream + with stream_filter_prepend or + stream_filter_append. Any data + remaining in the filter's internal buffer will be flushed + through to the next filter before removing it. + + + + Dynamicly refiltering a stream + + +]]> + + + + + See also + stream_filter_register, + stream_filter_append, and + stream_filter_prepend. + + + + +