1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-24 07:42:10 +01:00

Sync return type changes (#5075)

This commit is contained in:
Máté Kocsis
2026-03-08 21:03:56 +01:00
committed by GitHub
parent aa79a143fb
commit fcd9214294
37 changed files with 84 additions and 73 deletions

View File

@@ -18,7 +18,9 @@
</methodsynopsis>
<simpara>
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.
</simpara>
</refsect1>

View File

@@ -78,6 +78,7 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -85,6 +86,15 @@
</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>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>

View File

@@ -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>
@@ -45,7 +45,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -46,7 +46,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -92,7 +92,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -68,7 +68,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -65,7 +65,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -37,7 +37,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -43,7 +43,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -94,7 +94,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -108,7 +108,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -113,7 +113,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -127,7 +127,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -127,7 +127,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -73,7 +73,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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;
@@ -34,7 +34,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -71,7 +71,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -55,7 +55,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -116,7 +116,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -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>
@@ -72,7 +72,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagefilledrectangle</methodname>
<type>true</type><methodname>imagefilledrectangle</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>
@@ -73,7 +73,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagefilltoborder</methodname>
<type>true</type><methodname>imagefilltoborder</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>
@@ -66,7 +66,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imageflip</methodname>
<type>true</type><methodname>imageflip</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
@@ -71,7 +71,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagegammacorrect</methodname>
<type>true</type><methodname>imagegammacorrect</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>float</type><parameter>input_gamma</parameter></methodparam>
<methodparam><type>float</type><parameter>output_gamma</parameter></methodparam>
@@ -45,7 +45,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagelayereffect</methodname>
<type>true</type><methodname>imagelayereffect</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>effect</parameter></methodparam>
</methodsynopsis>
@@ -81,7 +81,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imageline</methodname>
<type>true</type><methodname>imageline</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>
@@ -71,7 +71,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagerectangle</methodname>
<type>true</type><methodname>imagerectangle</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>
@@ -73,7 +73,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -9,7 +9,7 @@
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>bool</type></type><methodname>imageresolution</methodname>
<type class="union"><type>array</type><type>true</type></type><methodname>imageresolution</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>resolution_x</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>resolution_y</parameter><initializer>&null;</initializer></methodparam>
@@ -58,9 +58,8 @@
<para>
When used as getter,
it returns an indexed array of the horizontal and vertical resolution on
success, &return.falseforfailure;.
When used as setter, it returns
&true; on success, &return.falseforfailure;.
success.
When used as setter, it always returns &true;.
</para>
</refsect1><!-- }}} -->

View File

@@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagesavealpha</methodname>
<type>true</type><methodname>imagesavealpha</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>bool</type><parameter>enable</parameter></methodparam>
</methodsynopsis>
@@ -56,7 +56,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagesetbrush</methodname>
<type>true</type><methodname>imagesetbrush</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>GdImage</type><parameter>brush</parameter></methodparam>
</methodsynopsis>
@@ -48,7 +48,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -9,7 +9,7 @@
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagesetclip</methodname>
<type>true</type><methodname>imagesetclip</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>
@@ -64,7 +64,7 @@
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1><!-- }}} -->

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagesetpixel</methodname>
<type>true</type><methodname>imagesetpixel</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>
@@ -54,7 +54,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagesetthickness</methodname>
<type>true</type><methodname>imagesetthickness</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>thickness</parameter></methodparam>
</methodsynopsis>
@@ -37,7 +37,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagesettile</methodname>
<type>true</type><methodname>imagesettile</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>GdImage</type><parameter>tile</parameter></methodparam>
</methodsynopsis>
@@ -51,7 +51,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagestring</methodname>
<type>true</type><methodname>imagestring</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>
@@ -64,7 +64,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagestringup</methodname>
<type>true</type><methodname>imagestringup</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>
@@ -65,7 +65,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
&return.true.always;
</para>
</refsect1>

View File

@@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pcntl_exec</methodname>
<type>false</type><methodname>pcntl_exec</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>args</parameter><initializer>[]</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>env_vars</parameter><initializer>[]</initializer></methodparam>
@@ -48,7 +48,7 @@
<listitem>
<para>
<parameter>env_vars</parameter> is an array of strings which are passed as
environment to the program. The array is in the format of name => value,
environment to the program. The array is in the format of name =&gt; value,
the key being the name of the environmental variable and the value being
the value of that variable.
</para>