Skip to content

Commit 1146f59

Browse files
committed
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
1 parent 53fb200 commit 1146f59

File tree

5 files changed

+49
-14
lines changed

5 files changed

+49
-14
lines changed

reference/intl/intlbreakiterator/getpartsiterator.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
&reftitle.description;
1111
<methodsynopsis role="IntlBreakIterator">
1212
<modifier>public</modifier> <type>IntlPartsIterator</type><methodname>IntlBreakIterator::getPartsIterator</methodname>
13-
<methodparam choice="opt"><type>string</type><parameter>type</parameter><initializer><constant>IntlPartsIterator::KEY_SEQUENTIAL</constant></initializer></methodparam>
13+
<methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer><constant>IntlPartsIterator::KEY_SEQUENTIAL</constant></initializer></methodparam>
1414
</methodsynopsis>
1515
<para>
1616

reference/pdo/pdostatement/setfetchmode.xml

Lines changed: 22 additions & 5 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>
@@ -88,10 +88,27 @@
8888
<refsect1 role="returnvalues">
8989
&reftitle.returnvalues;
9090
<para>
91-
&return.success;
91+
&return.true.always;
9292
</para>
9393
</refsect1>
9494

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;
107+
</tbody>
108+
</tgroup>
109+
</informaltable>
110+
</refsect1>
111+
95112
<refsect1 role="examples">
96113
&reftitle.examples;
97114
<para>

reference/phar/Phar/setStub.xml

Lines changed: 3 additions & 2 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>
@@ -72,7 +72,7 @@ include 'phar://myphar.phar/somefile.php';
7272
<refsect1 role="returnvalues">
7373
&reftitle.returnvalues;
7474
<para>
75-
&return.success;
75+
&return.true.always;
7676
</para>
7777
</refsect1>
7878

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

reference/phar/PharData/setStub.xml

Lines changed: 21 additions & 4 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

@@ -49,10 +49,27 @@
4949
<refsect1 role="returnvalues">
5050
&reftitle.returnvalues;
5151
<para>
52-
&return.success;
52+
&return.true.always;
5353
</para>
5454
</refsect1>
5555

56+
<refsect1 role="changelog">
57+
&reftitle.changelog;
58+
<informaltable>
59+
<tgroup cols="2">
60+
<thead>
61+
<row>
62+
<entry>&Version;</entry>
63+
<entry>&Description;</entry>
64+
</row>
65+
</thead>
66+
<tbody>
67+
&return.type.true;
68+
</tbody>
69+
</tgroup>
70+
</informaltable>
71+
</refsect1>
72+
5673
<refsect1 role="errors">
5774
&reftitle.errors;
5875
<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)