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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 293874 $ -->
<refentry xml:id="regexiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RegexIterator::__construct</refname>
<refpurpose>Create a new RegexIterator</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis>
<methodname>RegexIterator::__construct</methodname>
<methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
<methodparam><type>string</type><parameter>regex</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>preg_flags</parameter></methodparam>
</constructorsynopsis>
<para>
Create a new <classname>RegexIterator</classname> which filters an
<interfacename>Iterator</interfacename> using a regular expression.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>iterator</parameter></term>
<listitem>
<para>
The iterator to apply this regex filter to.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>regex</parameter></term>
<listitem>
<para>
The regular expression to match.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Operation mode, see <methodname>RegexIterator::setMode</methodname> for a list
of modes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Special flags, see <methodname>RegexIterator::setFlags</methodname> for a list
of available flags.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>preg_flags</parameter></term>
<listitem>
<para>
The regular expression flags. These flags depend on the operation mode parameter:
</para>
<para>
<table>
<title><classname>RegexIterator</classname> preg_flags</title>
<tgroup cols="2">
<thead>
<row>
<entry>operation mode</entry>
<entry>available flags</entry>
</row>
</thead>
<tbody>
<row>
<entry><varname linkend="regexiterator.constants.all-matches">RegexIterator::ALL_MATCHES</varname></entry>
<entry>
See <function>preg_match_all</function>.
</entry>
</row>
<row>
<entry><varname linkend="regexiterator.constants.get-match">RegexIterator::GET_MATCH</varname></entry>
<entry>
See <function>preg_match</function>.
</entry>
</row>
<row>
<entry><varname linkend="regexiterator.constants.match">RegexIterator::MATCH</varname></entry>
<entry>
See <function>preg_match</function>.
</entry>
</row>
<row>
<entry><varname linkend="regexiterator.constants.replace">RegexIterator::REPLACE</varname></entry>
<entry>
none.
</entry>
</row>
<row>
<entry><varname linkend="regexiterator.constants.split">RegexIterator::SPLIT</varname></entry>
<entry>
See <function>preg_split</function>.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>RegexIterator::__construct</function> example</title>
<para>
Creates a new RegexIterator that filters all strings that start with 'test'.
</para>
<programlisting role="php">
<![CDATA[
<?php
$arrayIterator = new ArrayIterator(array('test 1', 'another test', 'test 123'));
$regexIterator = new RegexIterator($arrayIterator, '/^test/');
foreach ($regexIterator as $value) {
echo $value . "\n";
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
test 1
test 123
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>preg_match</function></member>
<member><function>preg_match_all</function></member>
<member><function>preg_replace</function></member>
<member><function>preg_split</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- 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
-->
|
