Skip to content

Fix return type for 5 misc functions: bool -> true #5357

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

Merged
ndossche merged 4 commits into from
Mar 2, 2026
Merged

Fix return type for 5 misc functions: bool -> true #5357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9d534d6
Fix return type for 5 functions: bool -> true
lacatoire Feb 6, 2026
6ed7d25
Add changelog entries for return type change bool -> true
lacatoire Feb 7, 2026
63ce710
Merge upstream/master, resolve conflict in finfo-close.xml
lacatoire Mar 2, 2026
061fa04
Fix changelog version: use 8.5.0 instead of entity hardcoded to 8.2.0
lacatoire Mar 2, 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
26 changes: 24 additions & 2 deletions reference/array/functions/array-multisort.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>
<type>bool</type><methodname>array_multisort</methodname>
<type>true</type><methodname>array_multisort</methodname>
<methodparam><type>array</type><parameter role="reference">array1</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>array1_sort_order</parameter><initializer>SORT_ASC</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>array1_sort_flags</parameter><initializer>SORT_REGULAR</initializer></methodparam>
Expand Down Expand Up @@ -118,10 +118,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.5.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/fileinfo/functions/finfo-close.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<modifier role="attribute">#[\Deprecated]</modifier>
<type>bool</type><methodname>finfo_close</methodname>
<type>true</type><methodname>finfo_close</methodname>
<methodparam><type>finfo</type><parameter>finfo</parameter></methodparam>
</methodsynopsis>

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

Expand All @@ -57,6 +57,12 @@
This function has been deprecated.
</entry>
</row>
<row>
<entry>8.5.0</entry>
<entry>
The return type is &true; now; previously, it was <type>bool</type>.
</entry>
</row>
<row>
<entry>8.1.0</entry>
<entry>
Expand Down
13 changes: 8 additions & 5 deletions reference/ftp/functions/ftp-set-option.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>
<type>bool</type><methodname>ftp_set_option</methodname>
<type>true</type><methodname>ftp_set_option</methodname>
<methodparam><type>FTP\Connection</type><parameter>ftp</parameter></methodparam>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type class="union"><type>int</type><type>bool</type></type><parameter>value</parameter></methodparam>
Expand Down Expand Up @@ -81,10 +81,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the option could be set; &false; if not. A warning
message will be thrown if the <parameter>option</parameter> is not
supported or the passed <parameter>value</parameter> doesn't match the
expected value for the given <parameter>option</parameter>.
&return.true.always;
</para>
</refsect1>

Expand All @@ -99,6 +96,12 @@
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
The return type is &true; now; previously, it was <type>bool</type>.
</entry>
</row>
&ftp.changelog.ftp-param;
</tbody>
</tgroup>
Expand Down
26 changes: 24 additions & 2 deletions reference/libxml/functions/libxml-set-external-entity-loader.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>libxml_set_external_entity_loader</methodname>
<type>true</type><methodname>libxml_set_external_entity_loader</methodname>
<methodparam><type class="union"><type>callable</type><type>null</type></type><parameter>resolver_function</parameter></methodparam>
</methodsynopsis>
<para>
Expand Down Expand Up @@ -72,10 +72,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.5.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/sem/functions/shm-detach.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>shm_detach</methodname>
<type>true</type><methodname>shm_detach</methodname>
<methodparam><type>SysvSharedMemory</type><parameter>shm</parameter></methodparam>
</methodsynopsis>
<simpara>
Expand Down Expand Up @@ -37,7 +37,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.success;
&return.true.always;
</simpara>
</refsect1>

Expand All @@ -52,6 +52,12 @@
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
The return type is &true; now; previously, it was <type>bool</type>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
Expand Down