reference/pcre/constants.xml
e62b1e3989a5049c052bc547bb6bf175ada8e48d
e62b1e3989a5049c052bc547bb6bf175ada8e48d
...
...
@@ -8,68 +8,89 @@
8
8
<tgroup cols="2">
9
9
<thead>
10
10
<row>
11
-
<entry>constant</entry>
12
-
<entry>description</entry>
13
-
<entry>since</entry>
11
+
<entry>&Constants;</entry>
12
+
<entry>&Description;</entry>
13
+
<entry>As of</entry>
14
14
</row>
15
15
</thead>
16
16
<tbody>
17
17
<row xml:id="constant.preg-pattern-order">
18
-
<entry><constant>PREG_PATTERN_ORDER</constant></entry>
18
+
<entry>
19
+
<constant>PREG_PATTERN_ORDER</constant>
20
+
(<type>int</type>)
21
+
</entry>
19
22
<entry>
20
23
Orders results so that <varname>$matches[0]</varname> is an array of full pattern
21
24
matches, <varname>$matches[1]</varname> is an array of strings matched by the first
22
25
parenthesized subpattern, and so on. This flag is only used with
23
26
<function>preg_match_all</function>.
24
27
</entry>
25
-
<entry></entry>
28
+
<entry/>
26
29
</row>
27
30
<row xml:id="constant.preg-set-order">
28
-
<entry><constant>PREG_SET_ORDER</constant></entry>
31
+
<entry>
32
+
<constant>PREG_SET_ORDER</constant>
33
+
(<type>int</type>)
34
+
</entry>
29
35
<entry>
30
36
Orders results so that <varname>$matches[0]</varname> is an array of first set of
31
37
matches, <varname>$matches[1]</varname> is an array of second set of matches, and so
32
38
on. This flag is only used with <function>preg_match_all</function>.
33
39
</entry>
34
-
<entry></entry>
40
+
<entry/>
35
41
</row>
36
42
<row xml:id="constant.preg-offset-capture">
37
-
<entry><constant>PREG_OFFSET_CAPTURE</constant></entry>
38
43
<entry>
39
-
See the description of
40
-
<constant>PREG_SPLIT_OFFSET_CAPTURE</constant>.
44
+
<constant>PREG_OFFSET_CAPTURE</constant>
45
+
(<type>int</type>)
46
+
</entry>
47
+
<entry>
48
+
If this flag is set, for every occurring match the appendant byte
49
+
offset will also be returned. Note that this changes the return
50
+
values in an array where every element is an array consisting of the
51
+
matched string at offset 0 and its string offset within subject at
52
+
offset 1.
41
53
</entry>
42
-
<entry>4.3.0</entry>
54
+
<entry/>
43
55
</row>
44
56
<row xml:id="constant.preg-split-no-empty">
45
-
<entry><constant>PREG_SPLIT_NO_EMPTY</constant></entry>
57
+
<entry>
58
+
<constant>PREG_SPLIT_NO_EMPTY</constant>
59
+
(<type>int</type>)
60
+
</entry>
46
61
<entry>
47
62
This flag tells <function>preg_split</function> to return only non-empty
48
63
pieces.
49
64
</entry>
50
-
<entry></entry>
65
+
<entry/>
51
66
</row>
52
67
<row xml:id="constant.preg-split-delim-capture">
53
-
<entry><constant>PREG_SPLIT_DELIM_CAPTURE</constant></entry>
68
+
<entry>
69
+
<constant>PREG_SPLIT_DELIM_CAPTURE</constant>
70
+
(<type>int</type>)
71
+
</entry>
54
72
<entry>
55
73
This flag tells <function>preg_split</function> to capture
56
74
parenthesized expression in the delimiter pattern as well.
57
75
</entry>
58
-
<entry>4.0.5</entry>
76
+
<entry/>
59
77
</row>
60
78
<row xml:id="constant.preg-split-offset-capture">
61
-
<entry><constant>PREG_SPLIT_OFFSET_CAPTURE</constant></entry>
62
79
<entry>
63
-
If this flag is set, for every occurring match the appendant string
64
-
offset will also be returned. Note that this changes the return
65
-
values in an array where every element is an array consisting of the
66
-
matched string at offset 0 and its string offset within subject at
67
-
offset 1. This flag is only used for <function>preg_split</function>.
80
+
<constant>PREG_SPLIT_OFFSET_CAPTURE</constant>
81
+
(<type>int</type>)
82
+
</entry>
83
+
<entry>
84
+
See the description of <constant>PREG_OFFSET_CAPTURE</constant>.
85
+
This flag is only used for <function>preg_split</function>.
68
86
</entry>
69
-
<entry>4.3.0</entry>
87
+
<entry/>
70
88
</row>
71
89
<row xml:id="constant.preg-unmatched-as-null">
72
-
<entry><constant>PREG_UNMATCHED_AS_NULL</constant></entry>
90
+
<entry>
91
+
<constant>PREG_UNMATCHED_AS_NULL</constant>
92
+
(<type>int</type>)
93
+
</entry>
73
94
<entry>
74
95
This flag tells <function>preg_match</function> and
75
96
<function>preg_match_all</function> to include unmatched subpatterns in
...
...
@@ -80,7 +101,10 @@
80
101
<entry>7.2.0</entry>
81
102
</row>
82
103
<row xml:id="constant.preg-no-error">
83
-
<entry><constant>PREG_NO_ERROR</constant></entry>
104
+
<entry>
105
+
<constant>PREG_NO_ERROR</constant>
106
+
(<type>int</type>)
107
+
</entry>
84
108
<entry>
85
109
Returned by <function>preg_last_error</function> if there were no
86
110
errors.
...
...
@@ -88,7 +112,10 @@
88
112
<entry>5.2.0</entry>
89
113
</row>
90
114
<row xml:id="constant.preg-internal-error">
91
-
<entry><constant>PREG_INTERNAL_ERROR</constant></entry>
115
+
<entry>
116
+
<constant>PREG_INTERNAL_ERROR</constant>
117
+
(<type>int</type>)
118
+
</entry>
92
119
<entry>
93
120
Returned by <function>preg_last_error</function> if there was an
94
121
internal PCRE error.
...
...
@@ -96,32 +123,41 @@
96
123
<entry>5.2.0</entry>
97
124
</row>
98
125
<row xml:id="constant.preg-backtrack-limit-error">
99
-
<entry><constant>PREG_BACKTRACK_LIMIT_ERROR</constant></entry>
100
126
<entry>
101
-
Returned by <function>preg_last_error</function> if <link
102
-
linkend="ini.pcre.backtrack-limit">backtrack limit</link> was exhausted.
127
+
<constant>PREG_BACKTRACK_LIMIT_ERROR</constant>
128
+
(<type>int</type>)
129
+
</entry>
130
+
<entry>
131
+
Returned by <function>preg_last_error</function> if <link linkend="ini.pcre.backtrack-limit">backtrack limit</link> was exhausted.
103
132
</entry>
104
133
<entry>5.2.0</entry>
105
134
</row>
106
135
<row xml:id="constant.preg-recursion-limit-error">
107
-
<entry><constant>PREG_RECURSION_LIMIT_ERROR</constant></entry>
108
136
<entry>
109
-
Returned by <function>preg_last_error</function> if <link
110
-
linkend="ini.pcre.recursion-limit">recursion limit</link> was exhausted.
137
+
<constant>PREG_RECURSION_LIMIT_ERROR</constant>
138
+
(<type>int</type>)
139
+
</entry>
140
+
<entry>
141
+
Returned by <function>preg_last_error</function> if <link linkend="ini.pcre.recursion-limit">recursion limit</link> was exhausted.
111
142
</entry>
112
143
<entry>5.2.0</entry>
113
144
</row>
114
145
<row xml:id="constant.preg-bad-utf8-error">
115
-
<entry><constant>PREG_BAD_UTF8_ERROR</constant></entry>
146
+
<entry>
147
+
<constant>PREG_BAD_UTF8_ERROR</constant>
148
+
(<type>int</type>)
149
+
</entry>
116
150
<entry>
117
151
Returned by <function>preg_last_error</function> if the last error was
118
-
caused by malformed UTF-8 data (only when running a regex in <link
119
-
linkend="reference.pcre.pattern.modifiers">UTF-8 mode</link>).
152
+
caused by malformed UTF-8 data (only when running a regex in <link linkend="reference.pcre.pattern.modifiers">UTF-8 mode</link>).
120
153
</entry>
121
154
<entry>5.2.0</entry>
122
155
</row>
123
156
<row xml:id="constant.preg-bad-utf8-offset-error">
124
-
<entry><constant>PREG_BAD_UTF8_OFFSET_ERROR</constant></entry>
157
+
<entry>
158
+
<constant>PREG_BAD_UTF8_OFFSET_ERROR</constant>
159
+
(<type>int</type>)
160
+
</entry>
125
161
<entry>
126
162
Returned by <function>preg_last_error</function> if the offset didn't
127
163
correspond to the begin of a valid UTF-8 code point (only when running
...
...
@@ -131,7 +167,10 @@
131
167
<entry>5.3.0</entry>
132
168
</row>
133
169
<row xml:id="constant.preg-jit-stacklimit-error">
134
-
<entry><constant>PREG_JIT_STACKLIMIT_ERROR</constant></entry>
170
+
<entry>
171
+
<constant>PREG_JIT_STACKLIMIT_ERROR</constant>
172
+
(<type>int</type>)
173
+
</entry>
135
174
<entry>
136
175
Returned by <function>preg_last_error</function> if the last PCRE function
137
176
failed due to limited JIT stack space.
...
...
@@ -139,17 +178,59 @@
139
178
<entry>7.0.0</entry>
140
179
</row>
141
180
<row xml:id="constant.pcre-version">
142
-
<entry><constant>PCRE_VERSION</constant></entry>
181
+
<entry>
182
+
<constant>PCRE_VERSION</constant>
183
+
(<type>string</type>)
184
+
</entry>
143
185
<entry>
144
186
PCRE version and release date (e.g. "<literal>7.0 18-Dec-2006</literal>").
145
187
</entry>
146
188
<entry>5.2.4</entry>
147
189
</row>
190
+
<row xml:id="constant.pcre-version-major">
191
+
<entry>
192
+
<constant>PCRE_VERSION_MAJOR</constant>
193
+
(<type>int</type>)
194
+
</entry>
195
+
<entry>
196
+
PCRE major version number.
197
+
</entry>
198
+
<entry></entry>
199
+
</row>
200
+
<row xml:id="constant.pcre-version-minor">
201
+
<entry>
202
+
<constant>PCRE_VERSION_MINOR</constant>
203
+
(<type>int</type>)
204
+
</entry>
205
+
<entry>
206
+
PCRE minor version number.
207
+
</entry>
208
+
<entry></entry>
209
+
</row>
210
+
<row xml:id="constant.pcre-jit-support">
211
+
<entry>
212
+
<constant>PCRE_JIT_SUPPORT</constant>
213
+
(<type>bool</type>)
214
+
</entry>
215
+
<entry>
216
+
Indicates whether PCRE JIT support is available.
217
+
</entry>
218
+
<entry></entry>
219
+
</row>
220
+
<row xml:id="constant.preg-grep-invert">
221
+
<entry>
222
+
<constant>PREG_GREP_INVERT</constant>
223
+
(<type>int</type>)
224
+
</entry>
225
+
<entry>
226
+
Return the elements that do not match a given pattern.
227
+
</entry>
228
+
<entry></entry>
229
+
</row>
148
230
</tbody>
149
231
</tgroup>
150
232
</table>
151
233
</appendix>
152
-
153
234
<!-- Keep this comment at the end of the file
154
235
Local variables:
155
236
mode: sgml
156
237