1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.php-user-filter" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The php_user_filter class</title>
<titleabbrev>php_user_filter</titleabbrev>
<partintro>
<!-- {{{ php_user_filter intro -->
<section xml:id="php-user-filter.intro">
&reftitle.intro;
<para>
Children of this class are passed to
<function>stream_filter_register</function>.
Note that the <link linkend="object.construct">__construct</link> method is not called;
instead, <methodname>php_user_filter::onCreate</methodname> should be used for
initialization.
</para>
</section>
<!-- }}} -->
<section xml:id="php-user-filter.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis class="class">
<ooclass>
<classname>php_user_filter</classname>
</ooclass>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="php-user-filter.props.filtername">filtername</varname>
<initializer>""</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type>mixed</type>
<varname linkend="php-user-filter.props.params">params</varname>
<initializer>""</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<type class="union"><type>resource</type><type>null</type></type>
<varname linkend="php-user-filter.props.stream">stream</varname>
<initializer>null</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<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'])">
<xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ php_user_filter properties -->
<section xml:id="php-user-filter.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="php-user-filter.props.filtername">
<term><varname>filtername</varname></term>
<listitem>
<para>
Name of the filter registered by
<function>stream_filter_append</function>.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="php-user-filter.props.params">
<term><varname>params</varname></term>
<listitem>
<para/>
</listitem>
</varlistentry>
<varlistentry xml:id="php-user-filter.props.stream">
<term><varname>stream</varname></term>
<listitem>
<para/>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.stream.entities.php-user-filter;
</reference>
<!-- 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:"~/.phpdoc/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
-->
|
