cvs: phpdoc /en/reference/stream/functions stream-filter-append.xml stream-filter-prepend.xml stream-filter-remove.xml

pollita Tue Sep 14 00:04:01 2004 EDT Added files: /phpdoc/en/reference/stream/functions stream-filter-remove.xml Modified files: /phpdoc/en/reference/stream/functions stream-filter-append.xml stream-filter-prepend.xml Log: Document stream_filter_remove() http://cvs.php.net/diff.php/phpdoc/en/reference/stream/functions/stream-filter-append.xml?r1=1.12&r2=1.13&ty=u Index: phpdoc/en/reference/stream/functions/stream-filter-append.xml diff -u phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.12 phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.13 --- phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.12 Tue Jul 27 00:48:55 2004 +++ phpdoc/en/reference/stream/functions/stream-filter-append.xml Tue Sep 14 00:04:00 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> +<!-- $Revision: 1.13 $ --> <refentry id="function.stream-filter-append"> <refnamediv> <refname>stream_filter_append</refname> @@ -8,7 +8,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>bool</type><methodname>stream_filter_append</methodname> + <type>resource</type><methodname>stream_filter_append</methodname> <methodparam><type>resource</type><parameter>stream</parameter></methodparam> <methodparam><type>string</type><parameter>filtername</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>read_write</parameter></methodparam> @@ -35,6 +35,13 @@ <constant>STREAM_FILTER_WRITE</constant>, and/or <constant>STREAM_FILTER_ALL</constant> can also be passed to the <parameter>read_write</parameter> parameter to override this behavior. + </para> + <para> + 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 <function>stream_filter_remove</function>. + Prior to PHP 5.1.0, this function returns &true; on success + or &false; on failure. </para> <para> <example> http://cvs.php.net/diff.php/phpdoc/en/reference/stream/functions/stream-filter-prepend.xml?r1=1.10&r2=1.11&ty=u Index: phpdoc/en/reference/stream/functions/stream-filter-prepend.xml diff -u phpdoc/en/reference/stream/functions/stream-filter-prepend.xml:1.10 phpdoc/en/reference/stream/functions/stream-filter-prepend.xml:1.11 --- phpdoc/en/reference/stream/functions/stream-filter-prepend.xml:1.10 Tue Jul 27 00:48:55 2004 +++ phpdoc/en/reference/stream/functions/stream-filter-prepend.xml Tue Sep 14 00:04:00 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.stream-filter-prepend"> <refnamediv> <refname>stream_filter_prepend</refname> @@ -8,7 +8,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>bool</type><methodname>stream_filter_prepend</methodname> + <type>resource</type><methodname>stream_filter_prepend</methodname> <methodparam><type>resource</type><parameter>stream</parameter></methodparam> <methodparam><type>string</type><parameter>filtername</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>read_write</parameter></methodparam> @@ -37,6 +37,13 @@ <parameter>read_write</parameter> parameter to override this behavior. See <function>stream_filter_append</function> for an example of using this parameter. + </para> + <para> + 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 <function>stream_filter_remove</function>. + Prior to PHP 5.1.0, this function returns &true; on success + or &false; on failure. </para> <note> <title>When using custom (user) filters</title> http://cvs.php.net/co.php/phpdoc/en/reference/stream/functions/stream-filter-remove.xml?r=1.1&p=1 Index: phpdoc/en/reference/stream/functions/stream-filter-remove.xml +++ phpdoc/en/reference/stream/functions/stream-filter-remove.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-filter-remove"> <refnamediv> <refname>stream_filter_remove</refname> <refpurpose>Remove a filter from a stream</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>bool</type><methodname>stream_filter_append</methodname> <methodparam><type>resource</type><parameter>stream_filter</parameter></methodparam> </methodsynopsis> <simpara> Removes a stream filter previously added to a stream with <function>stream_filter_prepend</function> or <function>stream_filter_append</function>. Any data remaining in the filter's internal buffer will be flushed through to the next filter before removing it. </simpara> <para> <example> <title>Dynamicly refiltering a stream</title> <programlisting role="php"> <![CDATA[ <?php /* Open a test file for reading and writing */ $fp = fopen("test.txt", "rw"); $rot13_filter = stream_filter_append($fp, "string.rot13", STREAM_FILTER_WRITE); fwrite($fp, "This is "); stream_filter_remove($rot13_filter); fwrite($fp, "a test\n"); rewind($fp); fpassthru($fp); fclose($fp); /* Expected Output --------------- Guvf vf a test */ ?> ]]> </programlisting> </example> </para> <simpara> See also <function>stream_filter_register</function>, <function>stream_filter_append</function>, and <function>stream_filter_prepend</function>. </simpara> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->