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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 293874 $ -->
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.regexiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The RegexIterator class</title>
<titleabbrev>RegexIterator</titleabbrev>
<partintro>
<!-- {{{ intro -->
<section xml:id="regexiterator.intro">
&reftitle.intro;
<para>
This iterator can be used to filter another iterator based on a regular expression.
</para>
</section>
<!-- }}} -->
<section xml:id="regexiterator.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>RegexIterator</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>RegexIterator</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>FilterIterator</classname>
</ooclass>
</classsynopsisinfo>
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="regexiterator.constants.match">MATCH</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="regexiterator.constants.get-match">GET_MATCH</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="regexiterator.constants.all-matches">ALL_MATCHES</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="regexiterator.constants.split">SPLIT</varname>
<initializer>3</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="regexiterator.constants.replace">REPLACE</varname>
<initializer>4</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="regexiterator.constants.use-key">USE_KEY</varname>
<initializer>1</initializer>
</fieldsynopsis>
<!-- }}} -->
<!-- {{{ If the property is documented below (xml:id=regexiterator.props) use this
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="regexiterator.props.name">name</varname>
</fieldsynopsis>
}}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.regexiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.regexiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.filteriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
</section>
<section xml:id="regexiterator.constants">
&reftitle.constants;
<section xml:id="regexiterator.constants.operation-modes">
<title>RegexIterator operation modes</title>
<variablelist>
<varlistentry xml:id="regexiterator.constants.all-matches">
<term><constant>RegexIterator::ALL_MATCHES</constant></term>
<listitem>
<para>
Return all matches for the current entry
(see <function>preg_match_all</function>).
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="regexiterator.constants.get-match">
<term><constant>RegexIterator::GET_MATCH</constant></term>
<listitem>
<para>
Return the first match for the current entry
(see <function>preg_match</function>).
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="regexiterator.constants.match">
<term><constant>RegexIterator::MATCH</constant></term>
<listitem>
<para>
Only execute match (filter) for the current entry
(see <function>preg_match</function>).
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="regexiterator.constants.replace">
<term><constant>RegexIterator::REPLACE</constant></term>
<listitem>
<para>
Replace the current entry
(see <function>preg_replace</function>; Not fully implemented yet)
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="regexiterator.constants.split">
<term><constant>RegexIterator::SPLIT</constant></term>
<listitem>
<para>
Returns the split values for the current entry (see <function>preg_split</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="regexiterator.constants.flags">
<title>RegexIterator Flags</title>
<variablelist>
<varlistentry xml:id="regexiterator.constants.use-key">
<term><constant>RegexIterator::USE_KEY</constant></term>
<listitem>
<para>
Special flag: Match the entry key instead of the entry value.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<!-- {{{ properties
<section xml:id="regexiterator.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="regexiterator.props.name">
<term><varname>name</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
</variablelist>
</section>
}}} -->
</partintro>
&reference.spl.entities.regexiterator;
</phpdoc:classref>
<!-- 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
-->
|
