Add array_is_list(array $array) function (rebased)#6070

TysonAndre

This function tests if an array contains only sequential integer keys (increasing starting from 0). While this isn't an official type, this usage is consistent with the community usage of "list" as an annotation type, cf. https://psalm.dev/docs/annotating_code/type_syntax/array_types/#lists.

This functionality can be polyfilled, but this implementation should be much faster, as it can check for a packed array.

Rebased version of #4886

RFC: https://wiki.php.net/rfc/is_list

An earlier version of this returned false for non-arrays instead of throwing a TypeError - this was updated to prevent confusion with list-like object types

This accepts any type, and deliberately returns false (with no notices) for all non-arrays, e.g. see the test output in the files changed. This is similar to is_callable(), is_numeric(), is_iterable(), etc, which also accept any type:

non-array: throw TypeError
string key: false
mixed keys: false
ordered keys: true

itsjavi

I am concerned about the name because lists do not always contain sequential integers as indices https://www.php.net/manual/en/spl.datastructures.php

is_sequential_list would make more sense to me and would be more obvious

TysonAndre

I am concerned about the name because lists do not always contain sequential integers as indices https://www.php.net/manual/en/spl.datastructures.php

This is based on the definition of list in languages such as java/c - spl has a variety of issues
SplDoublyLinkedList maintains elements in order. It allows you to insert into the middle of the list, but that moves existing elements forwards - the traversal order is always 0..count-1 (Ignoring the fact that it implements Iterator instead of IteratorAggregate meaning that code iterating over the SplDoublyLinkedList or calling next() affects other code iterating over that SplDoublyLinkedList, which can't be changed easily for compatibility reasons)

» php -a
Interactive shell

php > $x = new SplDoublyLinkedList();
php > $x->add(1, 'out of range');

Warning: Uncaught OutOfRangeException: Offset invalid or out of range in php shell code:1
Stack trace:
#0 php shell code(1): SplDoublyLinkedList->add(1, 'out of range')
#1 {main}
  thrown in php shell code on line 1
php > $x->add('key', 'out of range');

Warning: Uncaught OutOfRangeException: Offset invalid or out of range in php shell code:1
Stack trace:
#0 php shell code(1): SplDoublyLinkedList->add('key', 'out of range')
#1 {main}
  thrown in php shell code on line 1
php > $x->add(0, 'in range');
php > $x->add(0, 'insert before old value at key 0');
php > var_export(iterator_to_array($x));
array (
  0 => 'insert before old value at key 0',
  1 => 'in range',
)
php > var_export($x[0]);
'insert before old value at key 0'
php > var_export($x[1]);
'in range'

This function tests if an array contains only sequential integer keys. While list isn't an official type, this usage is consistent with the community usage of "list" as an annotation type, cf. https://psalm.dev/docs/annotating_code/type_syntax/array_types/#lists Rebased and modified version of php#4886 - Use .stub.php files - Add opcache constant evaluation when argument is a constant - Change from is_list(mixed $value) to array_is_list(array $array) RFC: https://wiki.php.net/rfc/is_list Co-Authored-By: Tyson Andre <tysonandre775@hotmail.com> Co-Authored-By: Dusk <dusk@woofle.net>

staabm

This new function is not listed on php.net

https://www.php.net/manual-lookup.php?pattern=array_is_list&scope=quickref

The `nNextFreeElement` field is initialized with `ZEND_LONG_MIN` instead of zero since PHP 8.0. Adjust our `php_mp_is_hash()` check accordingly. See [1] and [2] for details. NB: PHP 8.1 introduces `zend_array_is_list()`, which may be used here. See [3] and [4] for details. [1]: https://wiki.php.net/rfc/negative_array_index [2]: php/php-src#3772 [3]: https://wiki.php.net/rfc/is_list [4]: php/php-src#6070 Since I don't observe any other problems on PHP 8.1, closing the relevant issue. Fixes tarantool#171

The `nNextFreeElement` field is initialized with `ZEND_LONG_MIN` instead of zero since PHP 8.0. Adjust our `php_mp_is_hash()` check accordingly. See [1] and [2] for details. NB: PHP 8.1 introduces `zend_array_is_list()`, which may be used here. See [3] and [4] for details. [1]: https://wiki.php.net/rfc/negative_array_index [2]: php/php-src#3772 [3]: https://wiki.php.net/rfc/is_list [4]: php/php-src#6070 Since I don't observe any other problems on PHP 8.1, closing the relevant issue. Fixes #171

carusogabriel added this to the PHP 8.1 milestone Sep 3, 2020

carusogabriel added the RFC label Sep 3, 2020

twose reviewed Sep 9, 2020

View reviewed changes

twose mentioned this pull request Oct 13, 2020

Add ArrayObject::isAssoc() swoole/library#58

Closed

Girgias mentioned this pull request Nov 4, 2020

Add is_list function #4886

Closed

TysonAndre force-pushed the is_list branch from 9ade78b to 293dc5f Compare December 12, 2020 00:58

TysonAndre force-pushed the is_list branch from 293dc5f to 5a2482b Compare December 19, 2020 21:59

morrisonlevi reviewed Dec 21, 2020

View reviewed changes

TysonAndre force-pushed the is_list branch from 5a2482b to 9b131d5 Compare January 6, 2021 00:41

TysonAndre changed the title ~~Add is_list function (rebased)~~ Jan 6, 2021

nikic reviewed Jan 6, 2021

View reviewed changes

php-pulls closed this in 13c430b Jan 20, 2021

TysonAndre deleted the is_list branch November 25, 2021 21:25

Totktonada mentioned this pull request Apr 11, 2022

PHP 8.0 compatibility tarantool/tarantool-php#172

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add array_is_list(array $array) function (rebased)#6070