Skip to content

Commit a684294

Browse files
lacatoirecweiske
authored andcommitted
Fix stream_filter_append and stream_filter_prepend parameter names
- stream_filter_append: $filtername -> $filter_name, $read_write -> $mode - stream_filter_prepend: $filtername -> $filter_name, $read_write -> $mode
1 parent 8d49e30 commit a684294

2 files changed

Lines changed: 16 additions & 16 deletions

File tree

reference/stream/functions/stream-filter-append.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010
<methodsynopsis>
1111
<type>resource</type><methodname>stream_filter_append</methodname>
1212
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
13-
<methodparam><type>string</type><parameter>filtername</parameter></methodparam>
14-
<methodparam choice="opt"><type>int</type><parameter>read_write</parameter></methodparam>
13+
<methodparam><type>string</type><parameter>filter_name</parameter></methodparam>
14+
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
1515
<methodparam choice="opt"><type>mixed</type><parameter>params</parameter></methodparam>
1616
</methodsynopsis>
1717
<para>
18-
Adds <parameter>filtername</parameter> to the list of filters
18+
Adds <parameter>filter_name</parameter> to the list of filters
1919
attached to <parameter>stream</parameter>.
2020
</para>
2121
</refsect1>
@@ -33,15 +33,15 @@
3333
</listitem>
3434
</varlistentry>
3535
<varlistentry>
36-
<term><parameter>filtername</parameter></term>
36+
<term><parameter>filter_name</parameter></term>
3737
<listitem>
3838
<para>
3939
The filter name.
4040
</para>
4141
</listitem>
4242
</varlistentry>
4343
<varlistentry>
44-
<term><parameter>read_write</parameter></term>
44+
<term><parameter>mode</parameter></term>
4545
<listitem>
4646
<para>
4747
By default, <function>stream_filter_append</function> will
@@ -54,7 +54,7 @@
5454
<constant>STREAM_FILTER_READ</constant>,
5555
<constant>STREAM_FILTER_WRITE</constant>, and/or
5656
<constant>STREAM_FILTER_ALL</constant> can also be passed to the
57-
<parameter>read_write</parameter> parameter to override this behavior.
57+
<parameter>mode</parameter> parameter to override this behavior.
5858
</para>
5959
</listitem>
6060
</varlistentry>
@@ -84,7 +84,7 @@
8484

8585
<para>
8686
&false; is returned if <parameter>stream</parameter> is not a resource or
87-
if <parameter>filtername</parameter> cannot be located.
87+
if <parameter>filter_name</parameter> cannot be located.
8888
</para>
8989
</refsect1>
9090

@@ -139,7 +139,7 @@ Guvf vf n grfg
139139
<title>When using custom (user) filters</title>
140140
<simpara>
141141
<function>stream_filter_register</function> must be called first
142-
in order to register the desired user filter to <parameter>filtername</parameter>.
142+
in order to register the desired user filter to <parameter>filter_name</parameter>.
143143
</simpara>
144144
</note>
145145
<note>

reference/stream/functions/stream-filter-prepend.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010
<methodsynopsis>
1111
<type>resource</type><methodname>stream_filter_prepend</methodname>
1212
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
13-
<methodparam><type>string</type><parameter>filtername</parameter></methodparam>
14-
<methodparam choice="opt"><type>int</type><parameter>read_write</parameter></methodparam>
13+
<methodparam><type>string</type><parameter>filter_name</parameter></methodparam>
14+
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
1515
<methodparam choice="opt"><type>mixed</type><parameter>params</parameter></methodparam>
1616
</methodsynopsis>
1717
<para>
18-
Adds <parameter>filtername</parameter> to the list of filters
18+
Adds <parameter>filter_name</parameter> to the list of filters
1919
attached to <parameter>stream</parameter>.
2020
</para>
2121
</refsect1>
@@ -33,15 +33,15 @@
3333
</listitem>
3434
</varlistentry>
3535
<varlistentry>
36-
<term><parameter>filtername</parameter></term>
36+
<term><parameter>filter_name</parameter></term>
3737
<listitem>
3838
<para>
3939
The filter name.
4040
</para>
4141
</listitem>
4242
</varlistentry>
4343
<varlistentry>
44-
<term><parameter>read_write</parameter></term>
44+
<term><parameter>mode</parameter></term>
4545
<listitem>
4646
<para>
4747
By default, <function>stream_filter_prepend</function> will
@@ -54,7 +54,7 @@
5454
<constant>STREAM_FILTER_READ</constant>,
5555
<constant>STREAM_FILTER_WRITE</constant>, and/or
5656
<constant>STREAM_FILTER_ALL</constant> can also be passed to the
57-
<parameter>read_write</parameter> parameter to override this behavior.
57+
<parameter>mode</parameter> parameter to override this behavior.
5858
See <function>stream_filter_append</function> for an example of
5959
using this parameter.
6060
</para>
@@ -85,7 +85,7 @@
8585

8686
<para>
8787
&false; is returned if <parameter>stream</parameter> is not a resource or
88-
if <parameter>filtername</parameter> cannot be located.
88+
if <parameter>filter_name</parameter> cannot be located.
8989
</para>
9090
</refsect1>
9191

@@ -95,7 +95,7 @@
9595
<title>When using custom (user) filters</title>
9696
<simpara>
9797
<function>stream_filter_register</function> must be called first
98-
in order to register the desired user filter to <parameter>filtername</parameter>.
98+
in order to register the desired user filter to <parameter>filter_name</parameter>.
9999
</simpara>
100100
</note>
101101
<note>

0 commit comments

Comments
 (0)