Broken Function: `array_combine`

[mvhirsch]

Function URL

https://www.php.net/manual/en/function.array-combine.php

PHP Version

8.3

Safe Version

3.0.2

Description

Returning array|false on thecodingmachine/safe does not make sense to me.

safe/generated/8.3/array.php

Line 15 in 6deb259

* @return array|false Returns the combined array.

array_combine on PHP 8.1 types @return array:

safe/generated/8.1/array.php

Line 15 in 6deb259

* @return array Returns the combined array, FALSE if the number of elements

Looks like this is happening since 8.2.

Starting with 8.2 this method is just a wrapper to PHP's array_combine. Is it still safe to use this lib's array_combine on 8.2+?

[shish]

Is it still safe to use this lib's array_combine on 8.2+?

tl;dr: yes

Seems to be a few levels of inconsistency...

• Today's docs say that array_combine hasn't returned false for error since 7.X, and 8.0.0 switched to throwing an exception - if that is correct, then the function doesn't need to be in Safe at all
• even in 8.5 (generated from the nightly docs) we still return array|false, which comes from https://github.com/phpstan/phpstan-src/blob/084a0a44f48539c26e5b8086b1b751c36383cd50/resources/functionMap.php#L262

My guess is that php 8.1 docs contained a mistake and said that it returned false on error (when in fact it raised an exception on error since 8.0), which caused the function to be added to Safe; and then even after the docs were corrected, we still keep the function around (as a no-op pass-through) for compatibility; and the type hint is wrong because there's a mistake in phpstan's database. So we need to add an override to our copy of the phpstan database to fix the type hint, and make sure that the function still exists (we don't want to remove it as that'd break compatibility), and add it to the list of hidden functions.