pollita Sun Jun 15 21:55:34 2003 EDT
Modified files:
/phpdoc/en/reference/stream/functions stream-filter-register.xml
Log:
Put return codes into a nice table
Index: phpdoc/en/reference/stream/functions/stream-filter-register.xml
diff -u phpdoc/en/reference/stream/functions/stream-filter-register.xml:1.1
phpdoc/en/reference/stream/functions/stream-filter-register.xml:1.2
--- phpdoc/en/reference/stream/functions/stream-filter-register.xml:1.1 Mon May 19
13:30:43 2003
+++ phpdoc/en/reference/stream/functions/stream-filter-register.xml Sun Jun 15
21:55:34 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.stream-filter-register">
<refnamediv>
<refname>stream_filter_register</refname>
@@ -57,13 +57,40 @@
If the stream is in the process of closing (and therefore this is the last pass
through the filterchain), the <parameter>closing</parameter> parameter will be
set to &true; The <methodname>filter</methodname> method must return one of
- three values upon completion. <constant>PSFS_PASS_ON</constant> indicates
- success with data available in the <parameter>out</parameter> <literal>bucket
brigade</literal>.
- <constant>PSFS_FEED_ME</constant> indicates that the filter has no data
- available to return and requires additional data from the stream.
- <constant>PSFS_ERR_FATAL</constant> indicates that the filter experienced an
- unrecoverable error and cannot continue. If no value is returned by this method,
- <constant>PSFS_ERR_FATAL</constant> will be assumed.
+ three values upon completion.
+
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Return Value</entry>
+ <entry>Meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><constant>PSFS_PASS_ON</constant></entry>
+ <entry>
+ Filter processed successfully with data available in the
+ <parameter>out</parameter> <literal>bucket brigade</literal>.
+ </entry>
+ </row>
+ <row>
+ <entry><constant>PSFS_FEED_ME</constant></entry>
+ <entry>
+ Filter processed successfully, however no data was available to
+ return. More data is required from the stream or prior filter.
+ </entry>
+ </row>
+ <row>
+ <entry><constant>PSFS_ERR_FATAL</constant> (default)</entry>
+ <entry>
+ The filter experienced an unrecoverable error and cannot continue.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</para>
<methodsynopsis>
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
