reference/stream/php-user-filter.xml
14767af0f05dffa6fdb9b49e1a1f4e9ca7022a60
14767af0f05dffa6fdb9b49e1a1f4e9ca7022a60
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
4
3
<phpdoc:classref xml:id="class.php-user-filter" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
5
4
6
5
<title>The php_user_filter class</title>
...
...
@@ -14,6 +13,9 @@
14
13
<para>
15
14
Children of this class are passed to
16
15
<function>stream_filter_register</function>.
16
+
Note that the <link linkend="object.construct">__construct</link> method is not called;
17
+
instead, <methodname>php_user_filter::onCreate</methodname> should be used for
18
+
initialization.
17
19
</para>
18
20
</section>
19
21
<!-- }}} -->
...
...
@@ -22,29 +24,35 @@
22
24
&reftitle.classsynopsis;
23
25
24
26
<!-- {{{ Synopsis -->
25
-
<classsynopsis>
26
-
<ooclass><classname>php_user_filter</classname></ooclass>
27
+
<classsynopsis class="class">
28
+
<ooclass>
29
+
<classname>php_user_filter</classname>
30
+
</ooclass>
27
31
28
-
<!-- {{{ Class synopsis -->
29
-
<classsynopsisinfo>
30
-
<ooclass>
31
-
<classname>php_user_filter</classname>
32
-
</ooclass>
33
-
</classsynopsisinfo>
34
-
<!-- }}} -->
35
32
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
36
33
<fieldsynopsis>
37
34
<modifier>public</modifier>
35
+
<type>string</type>
38
36
<varname linkend="php-user-filter.props.filtername">filtername</varname>
37
+
<initializer>""</initializer>
39
38
</fieldsynopsis>
40
39
<fieldsynopsis>
41
40
<modifier>public</modifier>
41
+
<type>mixed</type>
42
42
<varname linkend="php-user-filter.props.params">params</varname>
43
+
<initializer>""</initializer>
44
+
</fieldsynopsis>
45
+
<fieldsynopsis>
46
+
<modifier>public</modifier>
47
+
<type class="union"><type>resource</type><type>null</type></type>
48
+
<varname linkend="php-user-filter.props.stream">stream</varname>
49
+
<initializer>null</initializer>
43
50
</fieldsynopsis>
44
-
45
51
46
52
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
47
-
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.php-user-filter')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
53
+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.php-user-filter')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='php_user_filter'])">
54
+
<xi:fallback/>
55
+
</xi:include>
48
56
</classsynopsis>
49
57
<!-- }}} -->
50
58
...
...
@@ -67,7 +75,13 @@
67
75
<varlistentry xml:id="php-user-filter.props.params">
68
76
<term><varname>params</varname></term>
69
77
<listitem>
70
-
<para></para>
78
+
<para/>
79
+
</listitem>
80
+
</varlistentry>
81
+
<varlistentry xml:id="php-user-filter.props.stream">
82
+
<term><varname>stream</varname></term>
83
+
<listitem>
84
+
<para/>
71
85
</listitem>
72
86
</varlistentry>
73
87
</variablelist>
...
...
@@ -80,7 +94,6 @@
80
94
&reference.stream.entities.php-user-filter;
81
95
82
96
</phpdoc:classref>
83
-
84
97
<!-- Keep this comment at the end of the file
85
98
Local variables:
86
99
mode: sgml
87
100