danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-11-30 04:39:00 +01:00
Code Issues Projects Releases Wiki Activity

improve array_splice inference (#5738)

Browse Source
This commit is contained in:
orklah 2021-05-10 17:45:52 +02:00 committed by GitHub
parent 859b4a2caa
commit 72022139fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 73 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/Psalm/Internal/Provider/FunctionReturnTypeProvider.php
View File

@ -52,6 +52,7 @@ class FunctionReturnTypeProvider
$this->registerClass(ReturnTypeProvider\ArrayRandReturnTypeProvider::class);
$this->registerClass(ReturnTypeProvider\ArrayReduceReturnTypeProvider::class);
$this->registerClass(ReturnTypeProvider\ArraySliceReturnTypeProvider::class);
$this->registerClass(ReturnTypeProvider\ArraySpliceReturnTypeProvider::class);
$this->registerClass(ReturnTypeProvider\ArrayReverseReturnTypeProvider::class);
$this->registerClass(ReturnTypeProvider\ArrayUniqueReturnTypeProvider::class);
$this->registerClass(ReturnTypeProvider\ArrayValuesReturnTypeProvider::class);

71
src/Psalm/Internal/Provider/ReturnTypeProvider/ArraySpliceReturnTypeProvider.php Normal file
View File

@ -0,0 +1,71 @@
<?php
namespace Psalm\Internal\Provider\ReturnTypeProvider;
use Psalm\Internal\Analyzer\StatementsAnalyzer;
use Psalm\Plugin\EventHandler\Event\FunctionReturnTypeProviderEvent;
use Psalm\Plugin\EventHandler\FunctionReturnTypeProviderInterface;
use Psalm\Type;
class ArraySpliceReturnTypeProvider implements FunctionReturnTypeProviderInterface
{
/**
* @return array<lowercase-string>
*/
public static function getFunctionIds() : array
{
return ['array_splice'];
}
public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $event) : Type\Union
{
$statements_source = $event->getStatementsSource();
$call_args = $event->getCallArgs();
if (!$statements_source instanceof StatementsAnalyzer) {
return Type::getMixed();
}
$first_arg = $call_args[0]->value ?? null;
$first_arg_array = $first_arg
&& ($first_arg_type = $statements_source->node_data->getType($first_arg))
&& $first_arg_type->hasType('array')
&& ($array_atomic_type = $first_arg_type->getAtomicTypes()['array'])
&& ($array_atomic_type instanceof Type\Atomic\TArray
|| $array_atomic_type instanceof Type\Atomic\TKeyedArray
|| $array_atomic_type instanceof Type\Atomic\TList)
? $array_atomic_type
: null;
if (!$first_arg_array) {
return Type::getArray();
}
$already_cloned = false;
if ($first_arg_array instanceof Type\Atomic\TKeyedArray) {
$already_cloned = true;
$first_arg_array = $first_arg_array->getGenericArrayType();
}
if ($first_arg_array instanceof Type\Atomic\TArray) {
if (!$already_cloned) {
$first_arg_array = clone $first_arg_array;
}
$array_type = new Type\Atomic\TArray($first_arg_array->type_params);
} else {
$array_type = new Type\Atomic\TArray([Type::getInt(), clone $first_arg_array->type_param]);
}
if (!$array_type->type_params[0]->hasString()) {
if ($array_type->type_params[1]->isString()) {
$array_type = new Type\Atomic\TList(Type::getString());
} elseif ($array_type->type_params[1]->isInt()) {
$array_type = new Type\Atomic\TList(Type::getInt());
} else {
$array_type = new Type\Atomic\TList(Type::getMixed());
}
}
return new Type\Union([$array_type]);
}
}

2
tests/ArrayFunctionCallTest.php
View File

@ -1350,7 +1350,7 @@ class ArrayFunctionCallTest extends TestCase
$d = [1, 2, 3];
$e = array_splice($d, -1, 1);',
'assertions' => [
'$e' => 'array<array-key, mixed>'
'$e' => 'list<int>'
],
],
'arraySpliceOtherType' => [