expand the pcre_last_error() page

add a new ini section
some linking


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@214313 c90b9560-bf6c-de11-be94-00142212c4b1

reference/pcre/constants.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
 <section id="pcre.constants">
  &reftitle.constants;
  &extension.constants;
@@ -80,22 +80,23 @@
     <row>
      <entry>PREG_BACKTRACK_LIMIT_ERROR</entry>
      <entry>
-      Returned by <function>preg_last_error</function> if backtrack limit was
-      exhausted.
+      Returned by <function>preg_last_error</function> if <link
+      linkend="ini.pcre.backtrack-limit">backtrack limit</link> was exhausted.
      </entry>
     </row>
     <row>
      <entry>PREG_RECURSION_LIMIT_ERROR</entry>
      <entry>
-      Returned by <function>preg_last_error</function> if recursion limit was
-      exhausted.
+      Returned by <function>preg_last_error</function> if <link
+      linkend="ini.pcre.recursion-limit">recursion limit</link> was exhausted.
      </entry>
     </row>
     <row>
      <entry>PREG_BAD_UTF8_ERROR</entry>
      <entry>
       Returned by <function>preg_last_error</function> if the last error was
-      caused by invalid UTF8 data.
+      caused by malformed UTF-8 data (only when running a regex in <link
+      linkend="reference.pcre.pattern.modifiers">UTF-8 mode</link>).
      </entry>
     </row>
    </tbody>

reference/pcre/functions/preg-last-error.xml

@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.preg-last-error">
  <refnamediv>
   <refname>preg_last_error</refname>
-  <refpurpose>Returns the error code of the last PCRE regexp execution.</refpurpose>
+  <refpurpose>Returns the error code of the last PCRE regex execution</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -13,25 +13,23 @@
    <void />
   </methodsynopsis>
   <para>
-   Returns the error code of the last PCRE regexp execution.
+   Returns the error code of the last PCRE regex execution.
   </para>
-
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   The error code on success.
-  </para>
- </refsect1>
-
- <refsect1 role="seealso">
-  &reftitle.seealso;
-  <para>
+   Returns one of the following constants (<link
+   linkend="pcre.constants">explained on their own page</link>):
    <simplelist>
-    <member><function>preg_replace</function></member>
+    <member><constant>PREG_NO_ERROR</constant></member>
+    <member><constant>PREG_INTERNAL_ERROR</constant></member>
+    <member><constant>PREG_BACKTRACK_LIMIT_ERROR</constant> (see also <link
+    linkend="ini.pcre.backtrack-limit">pcre.backtrack_limit</link></member>
+    <member><constant>PREG_RECURSION_LIMIT_ERROR</constant> (see also <link
+    linkend="ini.pcre.recursion-limit">pcre.recursion_limit</link></member>
+    <member><constant>PREG_BAD_UTF8_ERROR</constant></member>
    </simplelist>
   </para>
  </refsect1>

reference/pcre/ini.xml

@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<section id="pcre.configuration">
+ &reftitle.runtime;
+ &extension.runtime;
+ <para>
+  <table>
+   <title>PCRE Configuration Options</title>
+   <tgroup cols="4">
+    <thead>
+     <row>
+      <entry>Name</entry>
+      <entry>Default</entry>
+      <entry>Changeable</entry>
+      <entry>Changelog</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>pcre.backtrack_limit</entry>
+      <entry>100000</entry>
+      <entry>PHP_INI_ALL</entry>
+      <entry>Available since PHP 5.2.0.</entry>
+     </row>
+     <row>
+      <entry>pcre.recursion_limit</entry>
+      <entry>100000</entry>
+      <entry>PHP_INI_ALL</entry>
+      <entry>Available since PHP 5.2.0.</entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </table>
+  &ini.php.constants;
+ </para>
+
+ &ini.descriptions.title;
+
+ <para>
+  <variablelist>
+   <varlistentry id="ini.pcre.backtrack-limit">
+    <term>
+     <parameter>pcre.backtrack_limit</parameter>
+     <type>integer</type>
+    </term>
+    <listitem>
+     <para>
+      PCRE's bactracking limit.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry id="ini.pcre.recursion-limit">
+    <term>
+     <parameter>pcre.recursion_limit</parameter>
+     <type>integer</type>
+    </term>
+    <listitem>
+     <para>
+      PCRE's recursion limit. Please note that if you set this value to a high
+      number you may consume all the available process stack and eventually
+      crash PHP (due to reaching the stack size limit imposed by the Operating
+      System).
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </para>
+
+</section>
+
+<!-- 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:"../../../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
+-->

reference/pcre/reference.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.16 $ -->
+<!-- $Revision: 1.17 $ -->
 <!-- Purpose: basic.text -->
 <!-- Membership: bundled -->
 
@@ -51,11 +51,7 @@
    </section>
 
    &reference.pcre.configure;
-
-   <section id="pcre.configuration">
-    &reftitle.runtime;
-    &no.config;
-   </section>
+   &reference.pcre.ini;
 
    <section id="pcre.resources">
     &reftitle.resources;