Skip to content

Commit 8a910da

Browse files
lacatoirelacatoire
authored
Fix various class method signatures to match stub (#5360)
* Fix 5 class method signatures to match php-src stubs - PDOStatement::setFetchMode: bool -> true - Phar::setStub: bool -> true - PharData::setStub: bool -> true, $len -> $length - ReflectionClass::getStaticPropertyValue: $def_value -> $default - IntlBreakIterator::getPartsIterator: param type string -> int * Use explicit 8.4.0 changelog rows instead of &return.type.true; (which is 8.2.0) * Address review feedback - IntlBreakIterator::getPartsIterator: revert param type to string; the int change in php-src (master only) is not backported to PHP-8.4/8.5, so documented versions must keep string. - Factor the 8.4.0 "return type true" changelog row into a new shared entity return.type.true.84, mirroring return.type.true. * Use simpara for return value paragraphs (style guide)
1 parent d56953f commit 8a910da

5 files changed

Lines changed: 61 additions & 19 deletions

File tree

‎language-snippets.ent‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -852,6 +852,13 @@ searched for within the <link xmlns="http://docbook.org/ns/docbook" linkend="ini
852852
</entry>
853853
</row>'>
854854

855+
<!ENTITY return.type.true.84 '<row xmlns="http://docbook.org/ns/docbook">
856+
<entry>8.4.0</entry>
857+
<entry>
858+
The return type is &true; now; previously, it was <type>bool</type>.
859+
</entry>
860+
</row>'>
861+
855862
<!ENTITY return.falseforfailure ' or &false; on failure'>
856863
<!ENTITY return.falseforfailure.style.procedural '&style.procedural; returns &false; on failure.'>
857864

‎reference/pdo/pdostatement/setfetchmode.xml‎

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,25 @@
1111
&reftitle.description;
1212

1313
<methodsynopsis role="PDOStatement">
14-
<modifier>public</modifier> <type>bool</type><methodname>PDOStatement::setFetchMode</methodname>
14+
<modifier>public</modifier> <type>true</type><methodname>PDOStatement::setFetchMode</methodname>
1515
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
1616
</methodsynopsis>
1717

1818
<methodsynopsis role="PDOStatement">
19-
<modifier>public</modifier> <type>bool</type><methodname>PDOStatement::setFetchMode</methodname>
19+
<modifier>public</modifier> <type>true</type><methodname>PDOStatement::setFetchMode</methodname>
2020
<methodparam><type>int</type><parameter>mode</parameter><initializer>PDO::FETCH_COLUMN</initializer></methodparam>
2121
<methodparam><type>int</type><parameter>colno</parameter></methodparam>
2222
</methodsynopsis>
2323

2424
<methodsynopsis role="PDOStatement">
25-
<modifier>public</modifier> <type>bool</type><methodname>PDOStatement::setFetchMode</methodname>
25+
<modifier>public</modifier> <type>true</type><methodname>PDOStatement::setFetchMode</methodname>
2626
<methodparam><type>int</type><parameter>mode</parameter><initializer>PDO::FETCH_CLASS</initializer></methodparam>
2727
<methodparam><type>string</type><parameter>class</parameter></methodparam>
2828
<methodparam><type class="union"><type>array</type><type>null</type></type><parameter>constructorArgs</parameter><initializer>&null;</initializer></methodparam>
2929
</methodsynopsis>
3030

3131
<methodsynopsis role="PDOStatement">
32-
<modifier>public</modifier> <type>bool</type><methodname>PDOStatement::setFetchMode</methodname>
32+
<modifier>public</modifier> <type>true</type><methodname>PDOStatement::setFetchMode</methodname>
3333
<methodparam><type>int</type><parameter>mode</parameter><initializer>PDO::FETCH_INTO</initializer></methodparam>
3434
<methodparam><type>object</type><parameter>object</parameter></methodparam>
3535
</methodsynopsis>
@@ -87,9 +87,26 @@
8787

8888
<refsect1 role="returnvalues">
8989
&reftitle.returnvalues;
90-
<para>
91-
&return.success;
92-
</para>
90+
<simpara>
91+
&return.true.always;
92+
</simpara>
93+
</refsect1>
94+
95+
<refsect1 role="changelog">
96+
&reftitle.changelog;
97+
<informaltable>
98+
<tgroup cols="2">
99+
<thead>
100+
<row>
101+
<entry>&Version;</entry>
102+
<entry>&Description;</entry>
103+
</row>
104+
</thead>
105+
<tbody>
106+
&return.type.true.84;
107+
</tbody>
108+
</tgroup>
109+
</informaltable>
93110
</refsect1>
94111

95112
<refsect1 role="examples">

‎reference/phar/Phar/setStub.xml‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<refsect1 role="description">
99
&reftitle.description;
1010
<methodsynopsis role="Phar">
11-
<modifier>public</modifier> <type>bool</type><methodname>Phar::setStub</methodname>
11+
<modifier>public</modifier> <type>true</type><methodname>Phar::setStub</methodname>
1212
<methodparam><type class="union"><type>resource</type><type>string</type></type><parameter>stub</parameter></methodparam>
1313
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>-1</initializer></methodparam>
1414
</methodsynopsis>
@@ -71,9 +71,9 @@ include 'phar://myphar.phar/somefile.php';
7171

7272
<refsect1 role="returnvalues">
7373
&reftitle.returnvalues;
74-
<para>
75-
&return.success;
76-
</para>
74+
<simpara>
75+
&return.true.always;
76+
</simpara>
7777
</refsect1>
7878

7979
<refsect1 role="errors">
@@ -98,6 +98,7 @@ include 'phar://myphar.phar/somefile.php';
9898
</row>
9999
</thead>
100100
<tbody>
101+
&return.type.true.84;
101102
<row>
102103
<entry>8.3.0</entry>
103104
<entry>

‎reference/phar/PharData/setStub.xml‎

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
<refsect1 role="description">
99
&reftitle.description;
1010
<methodsynopsis role="PharData">
11-
<modifier>public</modifier> <type>bool</type><methodname>PharData::setStub</methodname>
11+
<modifier>public</modifier> <type>true</type><methodname>PharData::setStub</methodname>
1212
<methodparam><type>string</type><parameter>stub</parameter></methodparam>
13-
<methodparam choice="opt"><type>int</type><parameter>len</parameter><initializer>-1</initializer></methodparam>
13+
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>-1</initializer></methodparam>
1414
</methodsynopsis>
1515

1616

@@ -34,7 +34,7 @@
3434
</listitem>
3535
</varlistentry>
3636
<varlistentry>
37-
<term><parameter>len</parameter></term>
37+
<term><parameter>length</parameter></term>
3838
<listitem>
3939
<para>
4040

@@ -48,9 +48,9 @@
4848

4949
<refsect1 role="returnvalues">
5050
&reftitle.returnvalues;
51-
<para>
52-
&return.success;
53-
</para>
51+
<simpara>
52+
&return.true.always;
53+
</simpara>
5454
</refsect1>
5555

5656
<refsect1 role="errors">
@@ -60,6 +60,23 @@
6060
</para>
6161
</refsect1>
6262

63+
<refsect1 role="changelog">
64+
&reftitle.changelog;
65+
<informaltable>
66+
<tgroup cols="2">
67+
<thead>
68+
<row>
69+
<entry>&Version;</entry>
70+
<entry>&Description;</entry>
71+
</row>
72+
</thead>
73+
<tbody>
74+
&return.type.true.84;
75+
</tbody>
76+
</tgroup>
77+
</informaltable>
78+
</refsect1>
79+
6380
<refsect1 role="seealso">
6481
&reftitle.seealso;
6582
<para>

‎reference/reflection/reflectionclass/getstaticpropertyvalue.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<methodsynopsis role="ReflectionClass">
1313
<modifier>public</modifier> <type>mixed</type><methodname>ReflectionClass::getStaticPropertyValue</methodname>
1414
<methodparam><type>string</type><parameter>name</parameter></methodparam>
15-
<methodparam choice="opt"><type>mixed</type><parameter role="reference">def_value</parameter></methodparam>
15+
<methodparam choice="opt"><type>mixed</type><parameter role="reference">default</parameter></methodparam>
1616
</methodsynopsis>
1717
<para>
1818
Gets the value of a static property on this class.
@@ -33,7 +33,7 @@
3333
</listitem>
3434
</varlistentry>
3535
<varlistentry>
36-
<term><parameter>def_value</parameter></term>
36+
<term><parameter>default</parameter></term>
3737
<listitem>
3838
<para>
3939
A default value to return in case the class does not declare a static

0 commit comments

Comments
 (0)