Skip to content

Commit a4f367f

Browse files
sy-recordssy-records
authored
Update strpos docs with error handling details when offset exceeds length (#998)
1 parent 6eb32a6 commit a4f367f

File tree

9 files changed

+107
-20
lines changed

9 files changed

+107
-20
lines changed

‎reference/mbstring/functions/mb-stripos.xml‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: f63aa0afcde35bf8450e32128295d6e08cd6b120 Maintainer: daijie Status: ready -->
4-
<!-- CREDITS: mowangjuanzi -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: daijie Status: ready -->
4+
<!-- CREDITS: mowangjuanzi, Luffy -->
55
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
66
<refentry xml:id="function.mb-stripos" xmlns="http://docbook.org/ns/docbook">
77
<refnamediv>
@@ -71,6 +71,18 @@
7171
</para>
7272
</refsect1>
7373

74+
<refsect1 role="errors">
75+
&reftitle.errors;
76+
<itemizedlist>
77+
<listitem>
78+
<simpara>
79+
如果 <parameter>offset</parameter> 大于 <parameter>haystack</parameter>
80+
的长度，则会抛出 <classname>ValueError</classname> 异常。
81+
</simpara>
82+
</listitem>
83+
</itemizedlist>
84+
</refsect1>
85+
7486
<refsect1 role="changelog">
7587
&reftitle.changelog;
7688
<informaltable>

‎reference/mbstring/functions/mb-strpos.xml‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: f63aa0afcde35bf8450e32128295d6e08cd6b120 Maintainer: daijie Status: ready -->
4-
<!-- CREDITS: mowangjuanzi -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: daijie Status: ready -->
4+
<!-- CREDITS: mowangjuanzi, Luffy -->
55
<refentry xml:id="function.mb-strpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
66
<refnamediv>
77
<refname>mb_strpos</refname>
@@ -73,6 +73,17 @@
7373
</para>
7474
</refsect1>
7575

76+
<refsect1 role="errors">
77+
&reftitle.errors;
78+
<itemizedlist>
79+
<listitem>
80+
<simpara>
81+
如果 <parameter>offset</parameter> 大于 <parameter>haystack</parameter>
82+
的长度，则会抛出 <classname>ValueError</classname> 异常。
83+
</simpara>
84+
</listitem>
85+
</itemizedlist>
86+
</refsect1>
7687

7788
<refsect1 role="changelog">
7889
&reftitle.changelog;

‎reference/mbstring/functions/mb-strripos.xml‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: f63aa0afcde35bf8450e32128295d6e08cd6b120 Maintainer: daijie Status: ready -->
4-
<!-- CREDITS: mowangjuanzi -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: daijie Status: ready -->
4+
<!-- CREDITS: mowangjuanzi, Luffy -->
55
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
66
<refentry xml:id="function.mb-strripos" xmlns="http://docbook.org/ns/docbook">
77
<refnamediv>
@@ -71,14 +71,17 @@
7171
</para>
7272
</refsect1>
7373

74-
<!-- Use when ERRORS exist
7574
<refsect1 role="errors">
7675
&reftitle.errors;
77-
<para>
78-
When does this function throw E_* level errors, or exceptions?
79-
</para>
76+
<itemizedlist>
77+
<listitem>
78+
<simpara>
79+
如果 <parameter>offset</parameter> 大于 <parameter>haystack</parameter>
80+
的长度，则会抛出 <classname>ValueError</classname> 异常。
81+
</simpara>
82+
</listitem>
83+
</itemizedlist>
8084
</refsect1>
81-
-->
8285

8386
<refsect1 role="changelog">
8487
&reftitle.changelog;

‎reference/mbstring/functions/mb-strrpos.xml‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: f63aa0afcde35bf8450e32128295d6e08cd6b120 Maintainer: daijie Status: ready -->
4-
<!-- CREDITS: mowangjuanzi -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: daijie Status: ready -->
4+
<!-- CREDITS: mowangjuanzi, Luffy -->
55
<refentry xml:id="function.mb-strrpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
66
<refnamediv>
77
<refname>mb_strrpos</refname>
@@ -71,6 +71,19 @@
7171
</para>
7272
</refsect1>
7373

74+
<refsect1 role="errors">
75+
&reftitle.errors;
76+
<itemizedlist>
77+
<listitem>
78+
<simpara>
79+
If <parameter>offset</parameter> is greater than the length of
80+
<parameter>haystack</parameter>, a
81+
<classname>ValueError</classname> will be thrown.
82+
</simpara>
83+
</listitem>
84+
</itemizedlist>
85+
</refsect1>
86+
7487
<refsect1 role="changelog">
7588
&reftitle.changelog;
7689
<informaltable>

‎reference/stream/functions/stream-context-set-option.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: d5859815063bb6d3a0953c773920ce7425cf912e Maintainer: zhoumengkang Status: ready -->
3+
<!-- EN-Revision: e2d1e1f44c935cedfa0f98912d0b7c3b0166a087 Maintainer: zhoumengkang Status: ready -->
44
<!-- CREDITS: her-cat, Luffy -->
55
<refentry xml:id="function.stream-context-set-option" xmlns="http://docbook.org/ns/docbook">
66
<refnamediv>
@@ -14,7 +14,7 @@
1414
<type>bool</type><methodname>stream_context_set_option</methodname>
1515
<methodparam><type>resource</type><parameter>stream_or_context</parameter></methodparam>
1616
<methodparam><type>string</type><parameter>wrapper</parameter></methodparam>
17-
<methodparam><type>string</type><parameter>option</parameter></methodparam>
17+
<methodparam><type>string</type><parameter>option_name</parameter></methodparam>
1818
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
1919
</methodsynopsis>
2020
<para>
@@ -54,7 +54,7 @@
5454
</listitem>
5555
</varlistentry>
5656
<varlistentry>
57-
<term><parameter>option</parameter></term>
57+
<term><parameter>option_name</parameter></term>
5858
<listitem>
5959
<para>
6060
选项的名称。

‎reference/strings/functions/stripos.xml‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: 004fb3136a8ed6dd1065e0eca256d1e4edafcb2c Maintainer: daijie Status: ready -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: daijie Status: ready -->
44
<!-- CREDITS: mowangjuanzi, Luffy -->
55
<refentry xml:id="function.stripos" xmlns="http://docbook.org/ns/docbook">
66
<refnamediv>
@@ -69,6 +69,18 @@
6969
&return.falseproblem;
7070
</refsect1>
7171

72+
<refsect1 role="errors">
73+
&reftitle.errors;
74+
<itemizedlist>
75+
<listitem>
76+
<simpara>
77+
如果 <parameter>offset</parameter> 大于 <parameter>haystack</parameter>
78+
的长度，则会抛出 <classname>ValueError</classname> 异常。
79+
</simpara>
80+
</listitem>
81+
</itemizedlist>
82+
</refsect1>
83+
7284
<refsect1 role="changelog">
7385
&reftitle.changelog;
7486
<informaltable>

‎reference/strings/functions/strpos.xml‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: 45042fef652f1b4e904e809fcbfcf31f6c60670b Maintainer: daijie Status: ready -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: daijie Status: ready -->
44
<!-- CREDITS: mowangjuanzi, Luffy -->
55
<refentry xml:id="function.strpos" xmlns="http://docbook.org/ns/docbook">
66
<refnamediv>
@@ -67,6 +67,18 @@
6767
&return.falseproblem;
6868
</refsect1>
6969

70+
<refsect1 role="errors">
71+
&reftitle.errors;
72+
<itemizedlist>
73+
<listitem>
74+
<simpara>
75+
如果 <parameter>offset</parameter> 大于 <parameter>haystack</parameter>
76+
的长度，则会抛出 <classname>ValueError</classname> 异常。
77+
</simpara>
78+
</listitem>
79+
</itemizedlist>
80+
</refsect1>
81+
7082
<refsect1 role="changelog">
7183
&reftitle.changelog;
7284
<informaltable>

‎reference/strings/functions/strripos.xml‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: 71b1e926631d5f5bec9b2e2685553453349ae799 Maintainer: daijie Status: ready -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: daijie Status: ready -->
44
<!-- CREDITS: mowangjuanzi, Luffy -->
55
<refentry xml:id="function.strripos" xmlns="http://docbook.org/ns/docbook">
66
<refnamediv>
@@ -81,6 +81,18 @@
8181
&return.falseproblem;
8282
</refsect1>
8383

84+
<refsect1 role="errors">
85+
&reftitle.errors;
86+
<itemizedlist>
87+
<listitem>
88+
<simpara>
89+
如果 <parameter>offset</parameter> 大于 <parameter>haystack</parameter>
90+
的长度，则会抛出 <classname>ValueError</classname> 异常。
91+
</simpara>
92+
</listitem>
93+
</itemizedlist>
94+
</refsect1>
95+
8496
<refsect1 role="changelog">
8597
&reftitle.changelog;
8698
<informaltable>

‎reference/strings/functions/strrpos.xml‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: 45042fef652f1b4e904e809fcbfcf31f6c60670b Maintainer: HonestQiao Status: ready -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: HonestQiao Status: ready -->
44
<!-- CREDITS: mowangjuanzi, Luffy -->
55
<refentry xml:id="function.strrpos" xmlns="http://docbook.org/ns/docbook">
66
<refnamediv>
@@ -81,6 +81,18 @@
8181
&return.falseproblem;
8282
</refsect1>
8383

84+
<refsect1 role="errors">
85+
&reftitle.errors;
86+
<itemizedlist>
87+
<listitem>
88+
<simpara>
89+
如果 <parameter>offset</parameter> 大于 <parameter>haystack</parameter>
90+
的长度，则会抛出 <classname>ValueError</classname> 异常。
91+
</simpara>
92+
</listitem>
93+
</itemizedlist>
94+
</refsect1>
95+
8496
<refsect1 role="changelog">
8597
&reftitle.changelog;
8698
<informaltable>

0 commit comments

Comments
 (0)