pollita Mon Jan 6 20:57:08 2003 EDT
Modified files:
/phpdoc/en/reference/stream/functions stream-filter-append.xml
stream-filter-prepend.xml
stream-get-filters.xml
Log:
Document optional parameters
Index: phpdoc/en/reference/stream/functions/stream-filter-append.xml
diff -u phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.1
phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.2
--- phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.1 Sat Jan 4
02:17:18 2003
+++ phpdoc/en/reference/stream/functions/stream-filter-append.xml Mon Jan 6
+20:57:08 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.stream-filter-append">
<refnamediv>
<refname>stream_filter_append</refname>
@@ -11,11 +11,13 @@
<type>bool</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>string</type><parameter>params</parameter></methodparam>
</methodsynopsis>
<para>
Adds <parameter>filtername</parameter> to the list of filters
attached to <parameter>stream</parameter>. This filter will be
- added to the <emphasis>end</emphasis> of the list and
+ added with the specified <parameter>params</parameter>
+ to the <emphasis>end</emphasis> of the list and
will therefore be called last during stream opperations. To
add a filter to the beginning of the list, use
<function>stream_filter_prepend</function>.
Index: phpdoc/en/reference/stream/functions/stream-filter-prepend.xml
diff -u phpdoc/en/reference/stream/functions/stream-filter-prepend.xml:1.1
phpdoc/en/reference/stream/functions/stream-filter-prepend.xml:1.2
--- phpdoc/en/reference/stream/functions/stream-filter-prepend.xml:1.1 Sat Jan 4
02:17:18 2003
+++ phpdoc/en/reference/stream/functions/stream-filter-prepend.xml Mon Jan 6
+20:57:08 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.stream-filter-prepend">
<refnamediv>
<refname>stream_filter_prepend</refname>
@@ -11,11 +11,13 @@
<type>bool</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>string</type><parameter>params</parameter></methodparam>
</methodsynopsis>
<para>
Adds <parameter>filtername</parameter> to the list of filters
attached to <parameter>stream</parameter>. This filter will be
- added to the <emphasis>beginning</emphasis> of the list and
+ added with the specified <parameter>params</parameter>
+ to the <emphasis>beginning</emphasis> of the list and
will therefore be called first during stream opperations. To
add a filter to the end of the list, use
<function>stream_filter_append</function>.
Index: phpdoc/en/reference/stream/functions/stream-get-filters.xml
diff -u phpdoc/en/reference/stream/functions/stream-get-filters.xml:1.1
phpdoc/en/reference/stream/functions/stream-get-filters.xml:1.2
--- phpdoc/en/reference/stream/functions/stream-get-filters.xml:1.1 Sat Jan 4
23:25:06 2003
+++ phpdoc/en/reference/stream/functions/stream-get-filters.xml Mon Jan 6 20:57:08
+2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.stream-get-filters">
<refnamediv>
<refname>stream_get_filters</refname>
@@ -9,11 +9,13 @@
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>stream_get_filters</methodname>
- <void/>
+ <methodparam
+choice="opt"><type>bool</type><parameter>system</parameter></methodparam>
</methodsynopsis>
<para>
- Returns an indexed array containing the name of all stream filters
- available on the running system.
+ Returns an indexed array containing the name of all user-defined stream filters
+ available on the running system. If the <parameter>system</parameter>
+ parameter is set to true, then system defined filters will be included in the
+returned
+ array as well.
</para>
<para>
See Also:
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
