php-doc-en/reference/pcre/constants.xml

<?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></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></entry>
    </row>
    <row xml:id="constant.preg-set-order">
     <entry><constant>PREG_SET_ORDER</constant></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></entry>
    </row>
    <row xml:id="constant.preg-offset-capture">
     <entry><constant>PREG_OFFSET_CAPTURE</constant></entry>
     <entry>
      See the description of
      <constant>PREG_SPLIT_OFFSET_CAPTURE</constant>.
     </entry>
     <entry></entry>
    </row>
    <row xml:id="constant.preg-split-no-empty">
     <entry><constant>PREG_SPLIT_NO_EMPTY</constant></entry>
     <entry>
      This flag tells <function>preg_split</function> to return only non-empty
      pieces.
     </entry>
     <entry></entry>
    </row>
    <row xml:id="constant.preg-split-delim-capture">
     <entry><constant>PREG_SPLIT_DELIM_CAPTURE</constant></entry>
     <entry>
      This flag tells <function>preg_split</function> to capture
      parenthesized expression in the delimiter pattern as well.
     </entry>
     <entry></entry>
    </row>
    <row xml:id="constant.preg-split-offset-capture">
     <entry><constant>PREG_SPLIT_OFFSET_CAPTURE</constant></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></entry>
    </row>
    <row xml:id="constant.preg-unmatched-as-null">
     <entry><constant>PREG_UNMATCHED_AS_NULL</constant></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></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></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></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></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></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></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></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></entry>
     <entry>
      PCRE version and release date (e.g. "<literal>7.0 18-Dec-2006</literal>").
     </entry>
     <entry>5.2.4</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
-->