mirror_php/wordpress
1
0
Fork 0
mirror of git://develop.git.wordpress.org/ synced 2025-04-07 13:43:25 +02:00
Code Issues Actions20 Packages Projects Releases Wiki Activity

General: Introduce polyfills for array_key_first() and array_key_last() added in PHP 7.3.0.

Browse Source 
PHP 7.3.0 introduced two new functions: `array_key_first()` and `array_key_last()`. These two functions return the first and last key of each array respectively, without affecting the internal state of the array.

The polyfills make these two functions available for use in Core on PHP versions less than 7.3.0.

Ref:
* PHP RFC https://wiki.php.net/rfc/array_key_first_last
* PHP manual `array_key_first()` https://www.php.net/manual/en/function.array-key-first.php
* PHP manual `array_key_last()` https://www.php.net/manual/en/function.array-key-last.php

Props desrosj, pbearne, costdev, hellofromTonya, ayeshrajans, manzoorwanijk, audrasjb, sergeybiryukov.
Fixes .

git-svn-id: https://develop.svn.wordpress.org/trunk@52038 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Tonya Mork 2021-11-08 13:50:35 +00:00
parent 2648a5f984
commit b21d748b41
3 changed files with 199 additions and 0 deletions
src/wp-includes
compat.php
tests/phpunit/tests/compat
arrayKeyFirst.phparrayKeyLast.php

42
src/wp-includes/compat.php

@ -375,6 +375,48 @@ if ( ! function_exists( 'is_iterable' ) ) {
}
}
if ( ! function_exists( 'array_key_first' ) ) {
/**
* Polyfill for array_key_first() function added in PHP 7.3.
*
* Get the first key of the given array without affecting
* the internal array pointer.
*
* @since 5.9.0
*
* @param array $arr An array.
* @return string|int|null The first key of array if the array
* is not empty; `null` otherwise.
*/
function array_key_first( array $arr ) {
foreach ( $arr as $key => $value ) {
return $key;
}
}
}
if ( ! function_exists( 'array_key_last' ) ) {
/**
* Polyfill for `array_key_last()` function added in PHP 7.3.
*
* Get the last key of the given array without affecting the
* internal array pointer.
*
* @since 5.9.0
*
* @param array $arr An array.
* @return string|int|null The last key of array if the array
*. is not empty; `null` otherwise.
*/
function array_key_last( array $arr ) {
if ( empty( $arr ) ) {
return null;
}
end( $arr );
return key( $arr );
}
}
// IMAGETYPE_WEBP constant is only defined in PHP 7.1 or later.
if ( ! defined( 'IMAGETYPE_WEBP' ) ) {
define( 'IMAGETYPE_WEBP', 18 );

76
tests/phpunit/tests/compat/arrayKeyFirst.php Normal file

@ -0,0 +1,76 @@
<?php
/**
* @group compat
*
* @covers ::array_key_first
*/
class Tests_Compat_arrayKeyFirst extends WP_UnitTestCase {
/**
* Test that array_key_first() is always available (either from PHP or WP).
* @ticket 45055
*/
public function test_array_key_first_availability() {
$this->assertTrue( function_exists( 'array_key_first' ) );
}
/**
* @dataProvider data_array_key_first
*
* @ticket 45055
*
* @param bool $expected The value of the key extracted to extracted from given array.
* @param array $arr The array to get first key from.
*/
public function test_array_key_first( $expected, $arr ) {
if ( ! function_exists( 'array_key_first' ) ) {
$this->markTestSkipped( 'array_key_first() is not available.' );
} else {
$this->assertSame(
$expected,
array_key_first( $arr )
);
}
}
/**
* Data provider.
*
* @return array[]
*/
public function data_array_key_first() {
return array(
'string key' => array(
'expected' => 'key1',
'arr' => array(
'key1' => 'val1',
'key2' => 'val2',
),
),
'int key' => array(
'expected' => 99,
'arr' => array(
99 => 'val1',
1 => 'val2',
),
),
'no key' => array(
'expected' => 0,
'arr' => array( 'val1', 'val2' ),
),
'multi array' => array(
'expected' => 99,
'arr' => array(
99 => array( 22 => 'val1' ),
1 => 'val2',
),
),
'empty array' => array(
'expected' => null,
'arr' => array(),
),
);
}
}

81
tests/phpunit/tests/compat/arrayKeyLast.php Normal file

@ -0,0 +1,81 @@
<?php
/**
* @group compat
*
* @covers ::array_key_last
*/
class Tests_Compat_ArrayKeyLast extends WP_UnitTestCase {
/**
* Test that array_key_last() is always available (either from PHP or WP).
*
* @ticket 45055
*/
public function test_array_key_last_availability() {
$this->assertTrue( function_exists( 'array_key_last' ) );
}
/**
* @dataProvider data_array_key_last
*
* @ticket 45055
*
* @param bool $expected The value of the key extracted to extracted from given array.
* @param array $arr The array to get last key from.
*/
public function test_array_key_last( $expected, $arr ) {
if ( ! function_exists( 'array_key_last' ) ) {
$this->markTestSkipped( 'array_key_last() is not available.' );
} else {
$this->assertSame( $expected, array_key_last( $arr ) );
}
}
/**
* Data provider for test_array_key_last().
*
* @return array
*/
public function data_array_key_last() {
return array(
'string key' => array(
'expected' => 'key2',
'arr' => array(
'key1' => 'val1',
'key2' => 'val2',
),
),
'int key' => array(
'expected' => 1,
'arr' => array(
99 => 'val1',
1 => 'val2',
),
),
'no key' => array(
'expected' => 1,
'arr' => array( 'val1', 'val2' ),
),
'multi array' => array(
'expected' => 1,
'arr' => array(
99 => array( 22 => 'val1' ),
1 => 'val2',
),
),
'mixed keys' => array(
'expected' => 1,
'arr' => array(
'val1',
'key2' => 'val2',
'val3',
),
),
'empty array' => array(
'expected' => null,
'arr' => array(),
),
);
}
}