Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:127478
Content-Type: text/plain;
	charset=utf-8
Content-Transfer-Encoding: quoted-printable
Precedence: bulk
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3826.600.51.1.1\))
Subject: Re: [PHP-DEV] ext/gd: changing signatures for functions returning
 true
Date: Tue, 27 May 2025 10:35:09 +0200
References: <CA+XhMqwywRcwgVSwSSHLVEpkLYjOSZWoDGW2v3FTLB72xDdWmw@mail.gmail.com>
 <639E0BE3-F1F7-49F3-801F-721C87134063@gmail.com>
To: PHP internals <internals@lists.php.net>
In-Reply-To: <639E0BE3-F1F7-49F3-801F-721C87134063@gmail.com>
Message-ID: <90661865-1EE7-445D-A5DC-DFD0C2558205@cschneid.com>
From: cschneid@cschneid.com (Christian Schneider)

Am 27.05.2025 um 10:00 schrieb Claude Pache <claude.pache@gmail.com>:
>> Le 27 mai 2025 =C3=A0 00:51, David CARLIER <devnexen@gmail.com> a =
=C3=A9crit :
>> Working through this https://github.com/php/php-src/pull/18651/files, =
do not mind waiting for PHP 9 if needs be. Let me know what you think.
>=20
>=20
> Those functions are documented to return false on failure (e.g. =
https://www.php.net/manual/en/function.imagesetthickness.php). For that =
reason, I typically check for failure (e.g., `if (! =
imagesetthickness(...)) { return false; }`).
>=20
> If some or all functions of the gd library do not or no longer return =
false, please amend the documentation, so that I (and everyone else, see =
e.g. https://phpstan.org/r/a69b0ad4-b4bd-4487-a6d1-a436ce142dc2 ) know =
that those checks are useless without needing to read the php source =
code.
>=20
> But don=E2=80=99t just change the return type from `bool` to `void`: =
you are needlessly breaking existing code. Thanks!

I agree. If you want to change this then it should go through a warning =
phase whenever the return value is not discarded. The engine has means =
to determine this, similar but opposite of #[\NoDiscard].

OTOH I'm not sure the change is even worth it, maybe just adapt the =
documentation saying that it always returns true and move on.

The current behavior also allows for constructs like
	file_exists($fn) && ($img =3D imagecreatefrompng($fn)) && =
imagesetthickness($img, 10) && ...

Not that I'm advocating this usage but it can be short form of chaining =
things.

Regards,
- Chris