Skip to content

Add generic type signatures for array_first, array_last, array_any and array_all #11883

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
delolmo wants to merge 3 commits into
base: 6.x
Choose a base branch
from
+116 −0
Open

Add generic type signatures for array_first, array_last, array_any and array_all #11883

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c5db255
Add generic stubs for array_first, array_last, array_any, array_all
delolmo Jun 18, 2026
2ebe170
Add tests for generic array_first/last/any/all stubs
delolmo Jun 18, 2026
375524f
Mark array_any and array_all stubs as pure
delolmo Jun 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions stubs/CoreGenericFunctions.phpstub
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,54 @@ function array_key_last($array)
{
}

/**
* @psalm-template TArray as array
*
* @param TArray $array
*
* @return (TArray is array<never, never> ? null : (TArray is non-empty-array ? value-of<TArray> : value-of<TArray>|null))
* @psalm-pure
*/
function array_first($array)
{
}

/**
* @psalm-template TArray as array
*
* @param TArray $array
*
* @return (TArray is array<never, never> ? null : (TArray is non-empty-array ? value-of<TArray> : value-of<TArray>|null))
* @psalm-pure
*/
function array_last($array)
{
}

/**
* @psalm-template TKey of array-key
* @psalm-template TValue
*
* @param array<TKey, TValue> $array
* @param callable(TValue, TKey): bool $callback
* @psalm-pure
Comment thread
delolmo marked this conversation as resolved.
*/
function array_any(array $array, callable $callback): bool
{
}

/**
* @psalm-template TKey of array-key
* @psalm-template TValue
*
* @param array<TKey, TValue> $array
* @param callable(TValue, TKey): bool $callback
* @psalm-pure
*/
function array_all(array $array, callable $callback): bool
{
}

/**
* @psalm-template TArray as array
*
Expand Down
68 changes: 68 additions & 0 deletions tests/ArrayFunctionCallTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1453,6 +1453,74 @@ function makeArray(): array { return ["one" => 1, "two" => 3]; }
'$b' => 'null',
],
],
'arrayFirst' => [
'code' => '<?php
/** @return array<string, int> */
function makeArray(): array { return ["one" => 1, "two" => 3]; }
$a = makeArray();
$b = array_first($a);',
'assertions' => [
'$b' => 'int|null',
],
],
'arrayFirstNonEmpty' => [
'code' => '<?php
$a = ["one" => 1, "two" => 3];
$b = array_first($a);',
'assertions' => [
'$b' => 'int',
],
],
'arrayFirstEmpty' => [
'code' => '<?php
$a = [];
$b = array_first($a);',
'assertions' => [
'$b' => 'null',
],
],
'arrayLast' => [
'code' => '<?php
/** @return array<string, int> */
function makeArray(): array { return ["one" => 1, "two" => 3]; }
$a = makeArray();
$b = array_last($a);',
'assertions' => [
'$b' => 'int|null',
],
],
'arrayLastNonEmpty' => [
'code' => '<?php
$a = ["one" => 1, "two" => 3];
$b = array_last($a);',
'assertions' => [
'$b' => 'int',
],
],
'arrayLastEmpty' => [
'code' => '<?php
$a = [];
$b = array_last($a);',
'assertions' => [
'$b' => 'null',
],
],
'arrayAnyReturnsBoolWithTypedCallback' => [
'code' => '<?php
$a = ["one" => 1, "two" => 3];
$b = array_any($a, fn (int $value, string $key): bool => $value > 1);',
'assertions' => [
'$b' => 'bool',
],
],
'arrayAllReturnsBoolWithTypedCallback' => [
'code' => '<?php
$a = ["one" => 1, "two" => 3];
$b = array_all($a, fn (int $value, string $key): bool => $value > 1);',
'assertions' => [
'$b' => 'bool',
],
],
'arrayResetNonEmptyArray' => [
'code' => '<?php
/** @return non-empty-array<string, int> */
Expand Down
Loading