Skip to content

Update strpos docs with error handling details #998

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.

Sign up for GitHub

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

Merged
sy-records merged 1 commit into from
Nov 1, 2025
+107 −20
Merged

Update strpos docs with error handling details #998

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 14 additions & 2 deletions reference/mbstring/functions/mb-stripos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f63aa0afcde35bf8450e32128295d6e08cd6b120 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.mb-stripos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
Expand Down Expand Up @@ -71,6 +71,18 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
如果 <parameter>offset</parameter> 大于 <parameter>haystack</parameter>
的长度，则会抛出 <classname>ValueError</classname> 异常。
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand Down
15 changes: 13 additions & 2 deletions reference/mbstring/functions/mb-strpos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f63aa0afcde35bf8450e32128295d6e08cd6b120 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<refentry xml:id="function.mb-strpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_strpos</refname>
Expand Down Expand Up @@ -73,6 +73,17 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
如果 <parameter>offset</parameter> 大于 <parameter>haystack</parameter>
的长度，则会抛出 <classname>ValueError</classname> 异常。
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
Expand Down
17 changes: 10 additions & 7 deletions reference/mbstring/functions/mb-strripos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f63aa0afcde35bf8450e32128295d6e08cd6b120 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.mb-strripos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
Expand Down Expand Up @@ -71,14 +71,17 @@
</para>
</refsect1>

<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
<itemizedlist>
<listitem>
<simpara>
如果 <parameter>offset</parameter> 大于 <parameter>haystack</parameter>
的长度，则会抛出 <classname>ValueError</classname> 异常。
</simpara>
</listitem>
</itemizedlist>
</refsect1>
-->

<refsect1 role="changelog">
&reftitle.changelog;
Expand Down
17 changes: 15 additions & 2 deletions reference/mbstring/functions/mb-strrpos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f63aa0afcde35bf8450e32128295d6e08cd6b120 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<refentry xml:id="function.mb-strrpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_strrpos</refname>
Expand Down Expand Up @@ -71,6 +71,19 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
If <parameter>offset</parameter> is greater than the length of
<parameter>haystack</parameter>, a
<classname>ValueError</classname> will be thrown.
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand Down
6 changes: 3 additions & 3 deletions reference/stream/functions/stream-context-set-option.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d5859815063bb6d3a0953c773920ce7425cf912e Maintainer: zhoumengkang Status: ready -->
<!-- EN-Revision: e2d1e1f44c935cedfa0f98912d0b7c3b0166a087 Maintainer: zhoumengkang Status: ready -->
<!-- CREDITS: her-cat, Luffy -->
<refentry xml:id="function.stream-context-set-option" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
Expand All @@ -14,7 +14,7 @@
<type>bool</type><methodname>stream_context_set_option</methodname>
<methodparam><type>resource</type><parameter>stream_or_context</parameter></methodparam>
<methodparam><type>string</type><parameter>wrapper</parameter></methodparam>
<methodparam><type>string</type><parameter>option</parameter></methodparam>
<methodparam><type>string</type><parameter>option_name</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Expand Down Expand Up @@ -54,7 +54,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<term><parameter>option_name</parameter></term>
<listitem>
<para>
选项的名称。
Expand Down
14 changes: 13 additions & 1 deletion reference/strings/functions/stripos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 004fb3136a8ed6dd1065e0eca256d1e4edafcb2c Maintainer: daijie Status: ready -->
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<refentry xml:id="function.stripos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
Expand Down Expand Up @@ -69,6 +69,18 @@
&return.falseproblem;
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
如果 <parameter>offset</parameter> 大于 <parameter>haystack</parameter>
的长度，则会抛出 <classname>ValueError</classname> 异常。
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand Down
14 changes: 13 additions & 1 deletion reference/strings/functions/strpos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 45042fef652f1b4e904e809fcbfcf31f6c60670b Maintainer: daijie Status: ready -->
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<refentry xml:id="function.strpos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
Expand Down Expand Up @@ -67,6 +67,18 @@
&return.falseproblem;
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
如果 <parameter>offset</parameter> 大于 <parameter>haystack</parameter>
的长度，则会抛出 <classname>ValueError</classname> 异常。
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand Down
14 changes: 13 additions & 1 deletion reference/strings/functions/strripos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 71b1e926631d5f5bec9b2e2685553453349ae799 Maintainer: daijie Status: ready -->
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<refentry xml:id="function.strripos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
Expand Down Expand Up @@ -81,6 +81,18 @@
&return.falseproblem;
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
如果 <parameter>offset</parameter> 大于 <parameter>haystack</parameter>
的长度，则会抛出 <classname>ValueError</classname> 异常。
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand Down
14 changes: 13 additions & 1 deletion reference/strings/functions/strrpos.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 45042fef652f1b4e904e809fcbfcf31f6c60670b Maintainer: HonestQiao Status: ready -->
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: HonestQiao Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<refentry xml:id="function.strrpos" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
Expand Down Expand Up @@ -81,6 +81,18 @@
&return.falseproblem;
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<itemizedlist>
<listitem>
<simpara>
如果 <parameter>offset</parameter> 大于 <parameter>haystack</parameter>
的长度，则会抛出 <classname>ValueError</classname> 异常。
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand Down