Add preg_last_error_msg documentation

Patch contributed by Nicolas Oelgart <[email protected]>.


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

Author: cmb69

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

@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="function.preg-last-error-msg" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>preg_last_error_msg</refname>
+  <refpurpose>Returns the error message of the last PCRE regex execution</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>preg_last_error_msg</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Returns the error message of the last PCRE regex execution.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the error message on success, or <literal>"No error"</literal> if no
+   error has occurred.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><function>preg_last_error_msg</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+
+preg_match('/(?:\D+|<\d+>)*[!?]/', 'foobar foobar foobar');
+
+if (preg_last_error() !== PREG_NO_ERROR) {
+    echo preg_last_error_msg();
+}
+
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+Backtrack limit exhausted
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>preg_last_error</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
+-->

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

@@ -25,7 +25,7 @@
 preg_match('/(?:\D+|<\d+>)*[!?]/', 'foobar foobar foobar');
 
 if (preg_last_error() == PREG_BACKTRACK_LIMIT_ERROR) {
-    print 'Backtrack limit was exhausted!';
+    echo 'Backtrack limit was exhausted!';
 }
 
 ?>
@@ -60,6 +60,15 @@ Backtrack limit was exhausted!
   </para>
  </refsect1>
 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>preg_last_error_msg</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+
 </refentry>
 
 <!-- Keep this comment at the end of the file

reference/pcre/functions/preg-match.xml

@@ -405,6 +405,7 @@ Array
     <member><function>preg_replace</function></member>
     <member><function>preg_split</function></member>
     <member><function>preg_last_error</function></member>
+    <member><function>preg_last_error_msg</function></member>
    </simplelist>
   </para>
  </refsect1>

reference/pcre/versions.xml

@@ -7,6 +7,7 @@
  <function name='preg_filter' from='PHP 5 &gt;= 5.3.0, PHP 7'/>
  <function name='preg_grep' from='PHP 4, PHP 5, PHP 7'/>
  <function name='preg_last_error' from='PHP 5 &gt;= 5.2.0, PHP 7'/>
+ <function name='preg_last_error_msg' from='PHP 8'/>
  <function name='preg_match' from='PHP 4, PHP 5, PHP 7'/>
  <function name='preg_match_all' from='PHP 4, PHP 5, PHP 7'/>
  <function name='preg_quote' from='PHP 4, PHP 5, PHP 7'/>
@@ -35,4 +36,4 @@ End:
 vim600: syn=xml fen fdm=syntax fdl=2 si
 vim: et tw=78 syn=sgml
 vi: ts=1 sw=1
--->
+-->