Skip to content

Add preg_last_error_msg documentation #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions reference/pcre/functions/preg-last-error-msg.xml
Original file line number Diff line number Diff line change
@@ -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
-->
11 changes: 10 additions & 1 deletion reference/pcre/functions/preg-last-error.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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!';
}

?>
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions reference/pcre/functions/preg-match.xml
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,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>
Expand Down
3 changes: 2 additions & 1 deletion reference/pcre/versions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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'/>
Expand Down Expand Up @@ -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
-->
-->