Skip to content

Fix class method signatures #5360

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

Open
lacatoire wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix class method signatures #5360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c56c43c
Fix 5 class method signatures to match php-src stubs
lacatoire Feb 6, 2026
47736da
Use explicit 8.4.0 changelog rows instead of &return.type.true; (whic…
lacatoire Apr 22, 2026
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
2 changes: 1 addition & 1 deletion reference/intl/intlbreakiterator/getpartsiterator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis role="IntlBreakIterator">
<modifier>public</modifier> <type>IntlPartsIterator</type><methodname>IntlBreakIterator::getPartsIterator</methodname>
<methodparam choice="opt"><type>string</type><parameter>type</parameter><initializer><constant>IntlPartsIterator::KEY_SEQUENTIAL</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer><constant>IntlPartsIterator::KEY_SEQUENTIAL</constant></initializer></methodparam>
</methodsynopsis>
<para>

Expand Down
32 changes: 27 additions & 5 deletions reference/pdo/pdostatement/setfetchmode.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,25 @@
&reftitle.description;

<methodsynopsis role="PDOStatement">
<modifier>public</modifier> <type>bool</type><methodname>PDOStatement::setFetchMode</methodname>
<modifier>public</modifier> <type>true</type><methodname>PDOStatement::setFetchMode</methodname>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>

<methodsynopsis role="PDOStatement">
<modifier>public</modifier> <type>bool</type><methodname>PDOStatement::setFetchMode</methodname>
<modifier>public</modifier> <type>true</type><methodname>PDOStatement::setFetchMode</methodname>
<methodparam><type>int</type><parameter>mode</parameter><initializer>PDO::FETCH_COLUMN</initializer></methodparam>
<methodparam><type>int</type><parameter>colno</parameter></methodparam>
</methodsynopsis>

<methodsynopsis role="PDOStatement">
<modifier>public</modifier> <type>bool</type><methodname>PDOStatement::setFetchMode</methodname>
<modifier>public</modifier> <type>true</type><methodname>PDOStatement::setFetchMode</methodname>
<methodparam><type>int</type><parameter>mode</parameter><initializer>PDO::FETCH_CLASS</initializer></methodparam>
<methodparam><type>string</type><parameter>class</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>null</type></type><parameter>constructorArgs</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>

<methodsynopsis role="PDOStatement">
<modifier>public</modifier> <type>bool</type><methodname>PDOStatement::setFetchMode</methodname>
<modifier>public</modifier> <type>true</type><methodname>PDOStatement::setFetchMode</methodname>
<methodparam><type>int</type><parameter>mode</parameter><initializer>PDO::FETCH_INTO</initializer></methodparam>
<methodparam><type>object</type><parameter>object</parameter></methodparam>
</methodsynopsis>
Expand Down Expand Up @@ -88,10 +88,32 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
The return type is &true; now; previously, it was <type>bool</type>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
Expand Down
10 changes: 8 additions & 2 deletions reference/phar/Phar/setStub.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Phar">
<modifier>public</modifier> <type>bool</type><methodname>Phar::setStub</methodname>
<modifier>public</modifier> <type>true</type><methodname>Phar::setStub</methodname>
<methodparam><type class="union"><type>resource</type><type>string</type></type><parameter>stub</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
Expand Down Expand Up @@ -72,7 +72,7 @@ include 'phar://myphar.phar/somefile.php';
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand All @@ -98,6 +98,12 @@ include 'phar://myphar.phar/somefile.php';
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
The return type is &true; now; previously, it was <type>bool</type>.
</entry>
</row>
<row>
<entry>8.3.0</entry>
<entry>
Expand Down
30 changes: 26 additions & 4 deletions reference/phar/PharData/setStub.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="PharData">
<modifier>public</modifier> <type>bool</type><methodname>PharData::setStub</methodname>
<modifier>public</modifier> <type>true</type><methodname>PharData::setStub</methodname>
<methodparam><type>string</type><parameter>stub</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>len</parameter><initializer>-1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>


Expand All @@ -34,7 +34,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>len</parameter></term>
<term><parameter>length</parameter></term>
<listitem>
<para>

Expand All @@ -49,7 +49,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand All @@ -60,6 +60,28 @@
</para>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
The return type is &true; now; previously, it was <type>bool</type>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<para>
Expand Down
4 changes: 2 additions & 2 deletions reference/reflection/reflectionclass/getstaticpropertyvalue.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<methodsynopsis role="ReflectionClass">
<modifier>public</modifier> <type>mixed</type><methodname>ReflectionClass::getStaticPropertyValue</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">def_value</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">default</parameter></methodparam>
</methodsynopsis>
<para>
Gets the value of a static property on this class.
Expand All @@ -33,7 +33,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>def_value</parameter></term>
<term><parameter>default</parameter></term>
<listitem>
<para>
A default value to return in case the class does not declare a static
Expand Down