Skip to content

Sync return type changes #5075

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
kocsismate wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Sync return type changes #5075

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1fed5db
Sync return type changes
kocsismate Jan 4, 2026
1ca2eb3
Update reference/fileinfo/functions/finfo-close.xml
kocsismate Jan 4, 2026
17f18ea
Update finfo-close documentation for PHP 8.0 changes
kocsismate Jan 4, 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
8 changes: 5 additions & 3 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,12 +13,14 @@
&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>

<para>
This function closes the instance opened by <function>finfo_open</function>.
This function used to close the instance opened by <function>finfo_open</function> until PHP 7.4,
but it's a no-op since the <classname>finfo</classname> resource to object conversion done in PHP 8.0,
and has been deprecated in PHP 8.5.
</para>

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

Expand Down
17 changes: 12 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 @@ -78,13 +78,20 @@
</variablelist>
</para>
</refsect1>

<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>

<refsect1 role="errors">
&reftitle.errors;
<para>
A <exceptionname>ValueError</exceptionname> is thrown if the <parameter>option</parameter>
is not supported. A <exceptionname>TypeError</exceptionname> is thrown if the passed
<parameter>value</parameter> doesn't match the expected type for the given <parameter>option</parameter>.
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagealphablending.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>imagealphablending</methodname>
<type>true</type><methodname>imagealphablending</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>bool</type><parameter>enable</parameter></methodparam>
</methodsynopsis>
Expand Down Expand Up @@ -45,7 +45,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imageantialias.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>imageantialias</methodname>
<type>true</type><methodname>imageantialias</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>bool</type><parameter>enable</parameter></methodparam>
</methodsynopsis>
Expand Down Expand Up @@ -46,7 +46,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagearc.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>imagearc</methodname>
<type>true</type><methodname>imagearc</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>center_x</parameter></methodparam>
<methodparam><type>int</type><parameter>center_y</parameter></methodparam>
Expand Down Expand Up @@ -92,7 +92,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagechar.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>imagechar</methodname>
<type>true</type><methodname>imagechar</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type class="union"><type>GdFont</type><type>int</type></type><parameter>font</parameter></methodparam>
<methodparam><type>int</type><parameter>x</parameter></methodparam>
Expand Down Expand Up @@ -68,7 +68,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagecharup.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>imagecharup</methodname>
<type>true</type><methodname>imagecharup</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type class="union"><type>GdFont</type><type>int</type></type><parameter>font</parameter></methodparam>
<methodparam><type>int</type><parameter>x</parameter></methodparam>
Expand Down Expand Up @@ -65,7 +65,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagecolordeallocate.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>imagecolordeallocate</methodname>
<type>true</type><methodname>imagecolordeallocate</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>color</parameter></methodparam>
</methodsynopsis>
Expand Down Expand Up @@ -37,7 +37,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagecolormatch.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>imagecolormatch</methodname>
<type>true</type><methodname>imagecolormatch</methodname>
<methodparam><type>GdImage</type><parameter>image1</parameter></methodparam>
<methodparam><type>GdImage</type><parameter>image2</parameter></methodparam>
</methodsynopsis>
Expand Down Expand Up @@ -43,7 +43,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagecopy.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>imagecopy</methodname>
<type>true</type><methodname>imagecopy</methodname>
<methodparam><type>GdImage</type><parameter>dst_image</parameter></methodparam>
<methodparam><type>GdImage</type><parameter>src_image</parameter></methodparam>
<methodparam><type>int</type><parameter>dst_x</parameter></methodparam>
Expand Down Expand Up @@ -94,7 +94,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagecopymerge.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>imagecopymerge</methodname>
<type>true</type><methodname>imagecopymerge</methodname>
<methodparam><type>GdImage</type><parameter>dst_image</parameter></methodparam>
<methodparam><type>GdImage</type><parameter>src_image</parameter></methodparam>
<methodparam><type>int</type><parameter>dst_x</parameter></methodparam>
Expand Down Expand Up @@ -108,7 +108,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagecopymergegray.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>imagecopymergegray</methodname>
<type>true</type><methodname>imagecopymergegray</methodname>
<methodparam><type>GdImage</type><parameter>dst_image</parameter></methodparam>
<methodparam><type>GdImage</type><parameter>src_image</parameter></methodparam>
<methodparam><type>int</type><parameter>dst_x</parameter></methodparam>
Expand Down Expand Up @@ -113,7 +113,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagecopyresampled.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>imagecopyresampled</methodname>
<type>true</type><methodname>imagecopyresampled</methodname>
<methodparam><type>GdImage</type><parameter>dst_image</parameter></methodparam>
<methodparam><type>GdImage</type><parameter>src_image</parameter></methodparam>
<methodparam><type>int</type><parameter>dst_x</parameter></methodparam>
Expand Down Expand Up @@ -127,7 +127,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagecopyresized.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>imagecopyresized</methodname>
<type>true</type><methodname>imagecopyresized</methodname>
<methodparam><type>GdImage</type><parameter>dst_image</parameter></methodparam>
<methodparam><type>GdImage</type><parameter>src_image</parameter></methodparam>
<methodparam><type>int</type><parameter>dst_x</parameter></methodparam>
Expand Down Expand Up @@ -127,7 +127,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagedashedline.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>imagedashedline</methodname>
<type>true</type><methodname>imagedashedline</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>x1</parameter></methodparam>
<methodparam><type>int</type><parameter>y1</parameter></methodparam>
Expand Down Expand Up @@ -73,7 +73,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagedestroy.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
&reftitle.description;
<methodsynopsis>
<modifier role="attribute">#[\Deprecated]</modifier>
<type>bool</type><methodname>imagedestroy</methodname>
<type>true</type><methodname>imagedestroy</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
</methodsynopsis>
&note.resource-migration-8.0-dead-function;
Expand All @@ -34,7 +34,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imageellipse.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>imageellipse</methodname>
<type>true</type><methodname>imageellipse</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>center_x</parameter></methodparam>
<methodparam><type>int</type><parameter>center_y</parameter></methodparam>
Expand Down Expand Up @@ -71,7 +71,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagefill.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>imagefill</methodname>
<type>true</type><methodname>imagefill</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>x</parameter></methodparam>
<methodparam><type>int</type><parameter>y</parameter></methodparam>
Expand Down Expand Up @@ -55,7 +55,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagefilledarc.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>imagefilledarc</methodname>
<type>true</type><methodname>imagefilledarc</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>center_x</parameter></methodparam>
<methodparam><type>int</type><parameter>center_y</parameter></methodparam>
Expand Down Expand Up @@ -116,7 +116,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/image/functions/imagefilledellipse.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>imagefilledellipse</methodname>
<type>true</type><methodname>imagefilledellipse</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>center_x</parameter></methodparam>
<methodparam><type>int</type><parameter>center_y</parameter></methodparam>
Expand Down Expand Up @@ -72,7 +72,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

Expand Down
Loading