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 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="pcre.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<table>
<title>PREG constants</title>
<tgroup cols="2">
<thead>
<row>
<entry>&Constants;</entry>
<entry>&Description;</entry>
<entry>As of</entry>
</row>
</thead>
<tbody>
<row xml:id="constant.preg-pattern-order">
<entry>
<constant>PREG_PATTERN_ORDER</constant>
(<type>int</type>)
</entry>
<entry>
Orders results so that <varname>$matches[0]</varname> is an array of full pattern
matches, <varname>$matches[1]</varname> is an array of strings matched by the first
parenthesized subpattern, and so on. This flag is only used with
<function>preg_match_all</function>.
</entry>
<entry/>
</row>
<row xml:id="constant.preg-set-order">
<entry>
<constant>PREG_SET_ORDER</constant>
(<type>int</type>)
</entry>
<entry>
Orders results so that <varname>$matches[0]</varname> is an array of first set of
matches, <varname>$matches[1]</varname> is an array of second set of matches, and so
on. This flag is only used with <function>preg_match_all</function>.
</entry>
<entry/>
</row>
<row xml:id="constant.preg-offset-capture">
<entry>
<constant>PREG_OFFSET_CAPTURE</constant>
(<type>int</type>)
</entry>
<entry>
See the description of
<constant>PREG_SPLIT_OFFSET_CAPTURE</constant>.
</entry>
<entry/>
</row>
<row xml:id="constant.preg-split-no-empty">
<entry>
<constant>PREG_SPLIT_NO_EMPTY</constant>
(<type>int</type>)
</entry>
<entry>
This flag tells <function>preg_split</function> to return only non-empty
pieces.
</entry>
<entry/>
</row>
<row xml:id="constant.preg-split-delim-capture">
<entry>
<constant>PREG_SPLIT_DELIM_CAPTURE</constant>
(<type>int</type>)
</entry>
<entry>
This flag tells <function>preg_split</function> to capture
parenthesized expression in the delimiter pattern as well.
</entry>
<entry/>
</row>
<row xml:id="constant.preg-split-offset-capture">
<entry>
<constant>PREG_SPLIT_OFFSET_CAPTURE</constant>
(<type>int</type>)
</entry>
<entry>
If this flag is set, for every occurring match the appendant string
offset will also be returned. Note that this changes the return
values in an array where every element is an array consisting of the
matched string at offset 0 and its string offset within subject at
offset 1. This flag is only used for <function>preg_split</function>.
</entry>
<entry/>
</row>
<row xml:id="constant.preg-unmatched-as-null">
<entry>
<constant>PREG_UNMATCHED_AS_NULL</constant>
(<type>int</type>)
</entry>
<entry>
This flag tells <function>preg_match</function> and
<function>preg_match_all</function> to include unmatched subpatterns in
<varname>$matches</varname> as &null; values. Without this flag, unmatched
subpatterns are reported as empty strings, as if they were empty matches.
Setting this flag allows to distinguish between these two cases.
</entry>
<entry>7.2.0</entry>
</row>
<row xml:id="constant.preg-no-error">
<entry>
<constant>PREG_NO_ERROR</constant>
(<type>int</type>)
</entry>
<entry>
Returned by <function>preg_last_error</function> if there were no
errors.
</entry>
<entry>5.2.0</entry>
</row>
<row xml:id="constant.preg-internal-error">
<entry>
<constant>PREG_INTERNAL_ERROR</constant>
(<type>int</type>)
</entry>
<entry>
Returned by <function>preg_last_error</function> if there was an
internal PCRE error.
</entry>
<entry>5.2.0</entry>
</row>
<row xml:id="constant.preg-backtrack-limit-error">
<entry>
<constant>PREG_BACKTRACK_LIMIT_ERROR</constant>
(<type>int</type>)
</entry>
<entry>
Returned by <function>preg_last_error</function> if <link linkend="ini.pcre.backtrack-limit">backtrack limit</link> was exhausted.
</entry>
<entry>5.2.0</entry>
</row>
<row xml:id="constant.preg-recursion-limit-error">
<entry>
<constant>PREG_RECURSION_LIMIT_ERROR</constant>
(<type>int</type>)
</entry>
<entry>
Returned by <function>preg_last_error</function> if <link linkend="ini.pcre.recursion-limit">recursion limit</link> was exhausted.
</entry>
<entry>5.2.0</entry>
</row>
<row xml:id="constant.preg-bad-utf8-error">
<entry>
<constant>PREG_BAD_UTF8_ERROR</constant>
(<type>int</type>)
</entry>
<entry>
Returned by <function>preg_last_error</function> if the last error was
caused by malformed UTF-8 data (only when running a regex in <link linkend="reference.pcre.pattern.modifiers">UTF-8 mode</link>).
</entry>
<entry>5.2.0</entry>
</row>
<row xml:id="constant.preg-bad-utf8-offset-error">
<entry>
<constant>PREG_BAD_UTF8_OFFSET_ERROR</constant>
(<type>int</type>)
</entry>
<entry>
Returned by <function>preg_last_error</function> if the offset didn't
correspond to the begin of a valid UTF-8 code point (only when running
a regex in <link linkend="reference.pcre.pattern.modifiers">UTF-8
mode</link>).
</entry>
<entry>5.3.0</entry>
</row>
<row xml:id="constant.preg-jit-stacklimit-error">
<entry>
<constant>PREG_JIT_STACKLIMIT_ERROR</constant>
(<type>int</type>)
</entry>
<entry>
Returned by <function>preg_last_error</function> if the last PCRE function
failed due to limited JIT stack space.
</entry>
<entry>7.0.0</entry>
</row>
<row xml:id="constant.pcre-version">
<entry>
<constant>PCRE_VERSION</constant>
(<type>string</type>)
</entry>
<entry>
PCRE version and release date (e.g. "<literal>7.0 18-Dec-2006</literal>").
</entry>
<entry>5.2.4</entry>
</row>
<row xml:id="constant.pcre-version-major">
<entry>
<constant>PCRE_VERSION_MAJOR</constant>
(<type>int</type>)
</entry>
<entry>
PCRE major version number.
</entry>
<entry></entry>
</row>
<row xml:id="constant.pcre-version-minor">
<entry>
<constant>PCRE_VERSION_MINOR</constant>
(<type>int</type>)
</entry>
<entry>
PCRE minor version number.
</entry>
<entry></entry>
</row>
<row xml:id="constant.pcre-jit-support">
<entry>
<constant>PCRE_JIT_SUPPORT</constant>
(<type>bool</type>)
</entry>
<entry>
Indicates whether PCRE JIT support is available.
</entry>
<entry></entry>
</row>
<row xml:id="constant.preg-grep-invert">
<entry>
<constant>PREG_GREP_INVERT</constant>
(<type>int</type>)
</entry>
<entry>
Return the elements that do not match a given pattern.
</entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</appendix>
<!-- 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
-->
|