Skip to content

Commit 89e170b

Browse files
committed
Update strpos docs with error handling details when offset exceeds length
php/doc-en@4b72b23
1 parent a494715 commit 89e170b

File tree

8 files changed

+110
-14
lines changed

8 files changed

+110
-14
lines changed

reference/mbstring/functions/mb-stripos.xml

Lines changed: 14 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: f63aa0afcde35bf8450e32128295d6e08cd6b120 Maintainer: takagi Status: ready -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: takagi Status: ready -->
44
<refentry xml:id="function.mb-stripos" xmlns="http://docbook.org/ns/docbook">
55
<refnamediv>
66
<refname>mb_stripos</refname>
@@ -78,6 +78,19 @@
7878
</para>
7979
</refsect1>
8080

81+
<refsect1 role="errors">
82+
&reftitle.errors;
83+
<itemizedlist>
84+
<listitem>
85+
<simpara>
86+
<parameter>offset</parameter> が <parameter>haystack</parameter>
87+
の長さより大きい場合、
88+
<classname>ValueError</classname> がスローされます。
89+
</simpara>
90+
</listitem>
91+
</itemizedlist>
92+
</refsect1>
93+
8194
<refsect1 role="changelog">
8295
&reftitle.changelog;
8396
<informaltable>

reference/mbstring/functions/mb-strpos.xml

Lines changed: 14 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: f63aa0afcde35bf8450e32128295d6e08cd6b120 Maintainer: hirokawa Status: ready -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: hirokawa Status: ready -->
44
<!-- CREDITS: takagi,mumumu -->
55
<refentry xml:id="function.mb-strpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
66
<refnamediv>
@@ -79,6 +79,19 @@
7979
</para>
8080
</refsect1>
8181

82+
<refsect1 role="errors">
83+
&reftitle.errors;
84+
<itemizedlist>
85+
<listitem>
86+
<simpara>
87+
<parameter>offset</parameter> が <parameter>haystack</parameter>
88+
の長さより大きい場合、
89+
<classname>ValueError</classname> がスローされます。
90+
</simpara>
91+
</listitem>
92+
</itemizedlist>
93+
</refsect1>
94+
8295
<refsect1 role="changelog">
8396
&reftitle.changelog;
8497
<informaltable>

reference/mbstring/functions/mb-strripos.xml

Lines changed: 10 additions & 6 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: f63aa0afcde35bf8450e32128295d6e08cd6b120 Maintainer: takagi Status: ready -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: takagi Status: ready -->
44
<refentry xml:id="function.mb-strripos" xmlns="http://docbook.org/ns/docbook">
55
<refnamediv>
66
<refname>mb_strripos</refname>
@@ -77,14 +77,18 @@
7777
</para>
7878
</refsect1>
7979

80-
<!-- Use when ERRORS exist
8180
<refsect1 role="errors">
8281
&reftitle.errors;
83-
<para>
84-
When does this function throw E_* level errors, or exceptions?
85-
</para>
82+
<itemizedlist>
83+
<listitem>
84+
<simpara>
85+
<parameter>offset</parameter> が <parameter>haystack</parameter>
86+
の長さより大きい場合、
87+
<classname>ValueError</classname> がスローされます。
88+
</simpara>
89+
</listitem>
90+
</itemizedlist>
8691
</refsect1>
87-
-->
8892

8993
<refsect1 role="changelog">
9094
&reftitle.changelog;

reference/mbstring/functions/mb-strrpos.xml

Lines changed: 14 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: f63aa0afcde35bf8450e32128295d6e08cd6b120 Maintainer: takagi Status: ready -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: takagi Status: ready -->
44
<!-- CREDITS: hirokawa,mumumu -->
55
<refentry xml:id="function.mb-strrpos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
66
<refnamediv>
@@ -75,6 +75,19 @@
7575
</para>
7676
</refsect1>
7777

78+
<refsect1 role="errors">
79+
&reftitle.errors;
80+
<itemizedlist>
81+
<listitem>
82+
<simpara>
83+
<parameter>offset</parameter> が <parameter>haystack</parameter>
84+
の長さより大きい場合、
85+
<classname>ValueError</classname> がスローされます。
86+
</simpara>
87+
</listitem>
88+
</itemizedlist>
89+
</refsect1>
90+
7891
<refsect1 role="changelog">
7992
&reftitle.changelog;
8093
<informaltable>

reference/strings/functions/stripos.xml

Lines changed: 14 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: takagi Status: ready -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: takagi Status: ready -->
44
<!-- CREDITS: hirokawa,mumumu -->
55
<refentry xml:id="function.stripos" xmlns="http://docbook.org/ns/docbook">
66
<refnamediv>
@@ -73,6 +73,19 @@
7373
&return.falseproblem;
7474
</refsect1>
7575

76+
<refsect1 role="errors">
77+
&reftitle.errors;
78+
<itemizedlist>
79+
<listitem>
80+
<simpara>
81+
<parameter>offset</parameter> が <parameter>haystack</parameter>
82+
の長さより大きい場合、
83+
<classname>ValueError</classname> がスローされます。
84+
</simpara>
85+
</listitem>
86+
</itemizedlist>
87+
</refsect1>
88+
7689
<refsect1 role="changelog">
7790
&reftitle.changelog;
7891
<informaltable>

reference/strings/functions/strpos.xml

Lines changed: 14 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: takagi Status: ready -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: takagi Status: ready -->
44
<!-- CREDITS: hirokawa,mumumu -->
55
<refentry xml:id="function.strpos" xmlns="http://docbook.org/ns/docbook">
66
<refnamediv>
@@ -69,6 +69,19 @@
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+
の長さより大きい場合、
79+
<classname>ValueError</classname> がスローされます。
80+
</simpara>
81+
</listitem>
82+
</itemizedlist>
83+
</refsect1>
84+
7285
<refsect1 role="changelog">
7386
&reftitle.changelog;
7487
<informaltable>

reference/strings/functions/strripos.xml

Lines changed: 14 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: takagi Status: ready -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: takagi Status: ready -->
44
<!-- Credits: mumumu -->
55
<refentry xml:id="function.strripos" xmlns="http://docbook.org/ns/docbook">
66
<refnamediv>
@@ -93,6 +93,19 @@
9393
&return.falseproblem;
9494
</refsect1>
9595

96+
<refsect1 role="errors">
97+
&reftitle.errors;
98+
<itemizedlist>
99+
<listitem>
100+
<simpara>
101+
<parameter>offset</parameter> が <parameter>haystack</parameter>
102+
の長さより大きい場合、
103+
<classname>ValueError</classname> がスローされます。
104+
</simpara>
105+
</listitem>
106+
</itemizedlist>
107+
</refsect1>
108+
96109
<refsect1 role="changelog">
97110
&reftitle.changelog;
98111
<informaltable>

reference/strings/functions/strrpos.xml

Lines changed: 16 additions & 2 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: 45042fef652f1b4e904e809fcbfcf31f6c60670b Maintainer: takagi Status: ready -->
3+
<!-- EN-Revision: 4b72b23513caa3a8bc520d459a0417defc7b3880 Maintainer: takagi Status: ready -->
44
<!-- CREDITS: hirokawa,shimooka,mumumu -->
55
<refentry xml:id="function.strrpos" xmlns="http://docbook.org/ns/docbook">
66
<refnamediv>
@@ -87,8 +87,22 @@
8787
<para>
8888
needle が見つからない場合は &false; を返します。
8989
</para>
90+
&return.falseproblem;
9091
</refsect1>
91-
92+
93+
<refsect1 role="errors">
94+
&reftitle.errors;
95+
<itemizedlist>
96+
<listitem>
97+
<simpara>
98+
<parameter>offset</parameter> が <parameter>haystack</parameter>
99+
の長さより大きい場合、
100+
<classname>ValueError</classname> がスローされます。
101+
</simpara>
102+
</listitem>
103+
</itemizedlist>
104+
</refsect1>
105+
92106
<refsect1 role="changelog">
93107
&reftitle.changelog;
94108
<informaltable>

0 commit comments

Comments
 (0)