mirror of
https://github.com/danog/psalm.git
synced 2024-12-17 03:47:04 +01:00
1062 lines
45 KiB
PHP
1062 lines
45 KiB
PHP
<?php
|
||
namespace Psalm\Internal\Analyzer\Statements\Expression\Fetch;
|
||
|
||
use PhpParser;
|
||
use Psalm\Internal\Analyzer\Statements\ExpressionAnalyzer;
|
||
use Psalm\Internal\Analyzer\StatementsAnalyzer;
|
||
use Psalm\Internal\Analyzer\TypeAnalyzer;
|
||
use Psalm\CodeLocation;
|
||
use Psalm\Context;
|
||
use Psalm\Issue\EmptyArrayAccess;
|
||
use Psalm\Issue\InvalidArrayAccess;
|
||
use Psalm\Issue\InvalidArrayAssignment;
|
||
use Psalm\Issue\InvalidArrayOffset;
|
||
use Psalm\Issue\MixedArrayAccess;
|
||
use Psalm\Issue\MixedArrayAssignment;
|
||
use Psalm\Issue\MixedArrayOffset;
|
||
use Psalm\Issue\MixedStringOffsetAssignment;
|
||
use Psalm\Issue\MixedArrayTypeCoercion;
|
||
use Psalm\Issue\NullArrayAccess;
|
||
use Psalm\Issue\NullArrayOffset;
|
||
use Psalm\Issue\PossiblyInvalidArrayAccess;
|
||
use Psalm\Issue\PossiblyInvalidArrayAssignment;
|
||
use Psalm\Issue\PossiblyInvalidArrayOffset;
|
||
use Psalm\Issue\PossiblyNullArrayAccess;
|
||
use Psalm\Issue\PossiblyNullArrayAssignment;
|
||
use Psalm\Issue\PossiblyNullArrayOffset;
|
||
use Psalm\Issue\PossiblyUndefinedArrayOffset;
|
||
use Psalm\IssueBuffer;
|
||
use Psalm\Type;
|
||
use Psalm\Type\Atomic\ObjectLike;
|
||
use Psalm\Type\Atomic\TArray;
|
||
use Psalm\Type\Atomic\TArrayKey;
|
||
use Psalm\Type\Atomic\TEmpty;
|
||
use Psalm\Type\Atomic\TLiteralInt;
|
||
use Psalm\Type\Atomic\TLiteralString;
|
||
use Psalm\Type\Atomic\TTemplateParam;
|
||
use Psalm\Type\Atomic\TInt;
|
||
use Psalm\Type\Atomic\TMixed;
|
||
use Psalm\Type\Atomic\TNamedObject;
|
||
use Psalm\Type\Atomic\TNonEmptyArray;
|
||
use Psalm\Type\Atomic\TNull;
|
||
use Psalm\Type\Atomic\TSingleLetter;
|
||
use Psalm\Type\Atomic\TString;
|
||
|
||
/**
|
||
* @internal
|
||
*/
|
||
class ArrayFetchAnalyzer
|
||
{
|
||
/**
|
||
* @param StatementsAnalyzer $statements_analyzer
|
||
* @param PhpParser\Node\Expr\ArrayDimFetch $stmt
|
||
* @param Context $context
|
||
*
|
||
* @return false|null
|
||
*/
|
||
public static function analyze(
|
||
StatementsAnalyzer $statements_analyzer,
|
||
PhpParser\Node\Expr\ArrayDimFetch $stmt,
|
||
Context $context
|
||
) {
|
||
$array_var_id = ExpressionAnalyzer::getArrayVarId(
|
||
$stmt->var,
|
||
$statements_analyzer->getFQCLN(),
|
||
$statements_analyzer
|
||
);
|
||
|
||
$keyed_array_var_id = ExpressionAnalyzer::getArrayVarId(
|
||
$stmt,
|
||
$statements_analyzer->getFQCLN(),
|
||
$statements_analyzer
|
||
);
|
||
|
||
if ($stmt->dim && ExpressionAnalyzer::analyze($statements_analyzer, $stmt->dim, $context) === false) {
|
||
return false;
|
||
}
|
||
|
||
$dim_var_id = null;
|
||
$new_offset_type = null;
|
||
|
||
if ($stmt->dim) {
|
||
if (isset($stmt->dim->inferredType)) {
|
||
$used_key_type = $stmt->dim->inferredType;
|
||
} else {
|
||
$used_key_type = Type::getMixed();
|
||
}
|
||
|
||
$dim_var_id = ExpressionAnalyzer::getArrayVarId(
|
||
$stmt->dim,
|
||
$statements_analyzer->getFQCLN(),
|
||
$statements_analyzer
|
||
);
|
||
} else {
|
||
$used_key_type = Type::getInt();
|
||
}
|
||
|
||
if (ExpressionAnalyzer::analyze(
|
||
$statements_analyzer,
|
||
$stmt->var,
|
||
$context
|
||
) === false) {
|
||
return false;
|
||
}
|
||
|
||
if ($keyed_array_var_id
|
||
&& $context->hasVariable($keyed_array_var_id)
|
||
&& !$context->vars_in_scope[$keyed_array_var_id]->possibly_undefined
|
||
&& !$context->vars_in_scope[$keyed_array_var_id]->isVanillaMixed()
|
||
) {
|
||
$stmt->inferredType = clone $context->vars_in_scope[$keyed_array_var_id];
|
||
|
||
return;
|
||
}
|
||
|
||
$codebase = $statements_analyzer->getCodebase();
|
||
|
||
if (isset($stmt->var->inferredType)) {
|
||
$var_type = $stmt->var->inferredType;
|
||
|
||
if ($var_type->isNull()) {
|
||
if (!$context->inside_isset) {
|
||
if (IssueBuffer::accepts(
|
||
new NullArrayAccess(
|
||
'Cannot access array value on null variable ' . $array_var_id,
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
}
|
||
|
||
if (isset($stmt->inferredType)) {
|
||
$stmt->inferredType = Type::combineUnionTypes($stmt->inferredType, Type::getNull());
|
||
} else {
|
||
$stmt->inferredType = Type::getNull();
|
||
}
|
||
|
||
return;
|
||
}
|
||
|
||
$stmt->inferredType = self::getArrayAccessTypeGivenOffset(
|
||
$statements_analyzer,
|
||
$stmt,
|
||
$stmt->var->inferredType,
|
||
$used_key_type,
|
||
false,
|
||
$array_var_id,
|
||
$context,
|
||
null
|
||
);
|
||
|
||
if ($context->inside_isset
|
||
&& $stmt->dim
|
||
&& isset($stmt->dim->inferredType)
|
||
&& $stmt->var->inferredType->hasArray()
|
||
&& ($stmt->var instanceof PhpParser\Node\Expr\ClassConstFetch
|
||
|| $stmt->var instanceof PhpParser\Node\Expr\ConstFetch)
|
||
) {
|
||
/** @var TArray|ObjectLike */
|
||
$array_type = $stmt->var->inferredType->getTypes()['array'];
|
||
|
||
if ($array_type instanceof TArray) {
|
||
$const_array_key_type = $array_type->type_params[0];
|
||
} else {
|
||
$const_array_key_type = $array_type->getGenericKeyType();
|
||
}
|
||
|
||
if ($dim_var_id
|
||
&& !$const_array_key_type->hasMixed()
|
||
&& !$stmt->dim->inferredType->hasMixed()
|
||
) {
|
||
$new_offset_type = clone $stmt->dim->inferredType;
|
||
$const_array_key_atomic_types = $const_array_key_type->getTypes();
|
||
|
||
foreach ($new_offset_type->getTypes() as $offset_key => $offset_atomic_type) {
|
||
if ($offset_atomic_type instanceof TString
|
||
|| $offset_atomic_type instanceof TInt
|
||
) {
|
||
if (!isset($const_array_key_atomic_types[$offset_key])
|
||
&& !TypeAnalyzer::isContainedBy(
|
||
$codebase,
|
||
new Type\Union([$offset_atomic_type]),
|
||
$const_array_key_type
|
||
)
|
||
) {
|
||
$new_offset_type->removeType($offset_key);
|
||
}
|
||
} elseif (!TypeAnalyzer::isContainedBy(
|
||
$codebase,
|
||
$const_array_key_type,
|
||
new Type\Union([$offset_atomic_type])
|
||
)) {
|
||
$new_offset_type->removeType($offset_key);
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
if ($keyed_array_var_id
|
||
&& $context->hasVariable($keyed_array_var_id, $statements_analyzer)
|
||
&& (!isset($stmt->inferredType) || $stmt->inferredType->isVanillaMixed())
|
||
) {
|
||
$stmt->inferredType = $context->vars_in_scope[$keyed_array_var_id];
|
||
}
|
||
|
||
if (!isset($stmt->inferredType)) {
|
||
$stmt->inferredType = Type::getMixed();
|
||
} else {
|
||
if ($stmt->inferredType->possibly_undefined && !$context->inside_isset && !$context->inside_unset) {
|
||
if (IssueBuffer::accepts(
|
||
new PossiblyUndefinedArrayOffset(
|
||
'Possibly undefined array key ' . $keyed_array_var_id,
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
}
|
||
|
||
$stmt->inferredType->possibly_undefined = false;
|
||
}
|
||
|
||
if ($context->inside_isset && $dim_var_id && $new_offset_type && $new_offset_type->getTypes()) {
|
||
$context->vars_in_scope[$dim_var_id] = $new_offset_type;
|
||
}
|
||
|
||
if ($keyed_array_var_id && !$context->inside_isset) {
|
||
$context->vars_in_scope[$keyed_array_var_id] = $stmt->inferredType;
|
||
$context->vars_possibly_in_scope[$keyed_array_var_id] = true;
|
||
|
||
// reference the variable too
|
||
$context->hasVariable($keyed_array_var_id, $statements_analyzer);
|
||
}
|
||
|
||
return null;
|
||
}
|
||
|
||
/**
|
||
* @param Type\Union $array_type
|
||
* @param Type\Union $offset_type
|
||
* @param bool $in_assignment
|
||
* @param null|string $array_var_id
|
||
*
|
||
* @return Type\Union
|
||
*/
|
||
public static function getArrayAccessTypeGivenOffset(
|
||
StatementsAnalyzer $statements_analyzer,
|
||
PhpParser\Node\Expr\ArrayDimFetch $stmt,
|
||
Type\Union $array_type,
|
||
Type\Union $offset_type,
|
||
$in_assignment,
|
||
$array_var_id,
|
||
Context $context,
|
||
PhpParser\Node\Expr $assign_value = null,
|
||
Type\Union $replacement_type = null
|
||
) {
|
||
$codebase = $statements_analyzer->getCodebase();
|
||
|
||
$has_array_access = false;
|
||
$non_array_types = [];
|
||
|
||
$has_valid_offset = false;
|
||
$expected_offset_types = [];
|
||
|
||
$key_value = null;
|
||
|
||
if ($stmt->dim instanceof PhpParser\Node\Scalar\String_
|
||
|| $stmt->dim instanceof PhpParser\Node\Scalar\LNumber
|
||
) {
|
||
$key_value = $stmt->dim->value;
|
||
} elseif (isset($stmt->dim->inferredType)) {
|
||
foreach ($stmt->dim->inferredType->getTypes() as $possible_value_type) {
|
||
if ($possible_value_type instanceof TLiteralString
|
||
|| $possible_value_type instanceof TLiteralInt
|
||
) {
|
||
if ($key_value !== null) {
|
||
$key_value = null;
|
||
break;
|
||
}
|
||
|
||
$key_value = $possible_value_type->value;
|
||
} elseif ($possible_value_type instanceof TString
|
||
|| $possible_value_type instanceof TInt
|
||
) {
|
||
$key_value = null;
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
|
||
$array_access_type = null;
|
||
|
||
if ($offset_type->isNull()) {
|
||
if (IssueBuffer::accepts(
|
||
new NullArrayOffset(
|
||
'Cannot access value on variable ' . $array_var_id . ' using null offset',
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
|
||
return Type::getMixed();
|
||
}
|
||
|
||
if ($offset_type->isNullable() && !$offset_type->ignore_nullable_issues && !$context->inside_isset) {
|
||
if (IssueBuffer::accepts(
|
||
new PossiblyNullArrayOffset(
|
||
'Cannot access value on variable ' . $array_var_id
|
||
. ' using possibly null offset ' . $offset_type,
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt->var)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
}
|
||
|
||
foreach ($array_type->getTypes() as $type_string => $type) {
|
||
$original_type = $type;
|
||
|
||
if ($type instanceof TMixed || $type instanceof TTemplateParam || $type instanceof TEmpty) {
|
||
if (!$type instanceof TTemplateParam || $type->as->isMixed() || !$type->as->isSingle()) {
|
||
if (!$context->collect_initializations
|
||
&& !$context->collect_mutations
|
||
&& $statements_analyzer->getFilePath() === $statements_analyzer->getRootFilePath()
|
||
&& (!(($parent_source = $statements_analyzer->getSource())
|
||
instanceof \Psalm\Internal\Analyzer\FunctionLikeAnalyzer)
|
||
|| !$parent_source->getSource() instanceof \Psalm\Internal\Analyzer\TraitAnalyzer)
|
||
) {
|
||
$codebase->analyzer->incrementMixedCount($statements_analyzer->getFilePath());
|
||
}
|
||
|
||
if (!$context->inside_isset) {
|
||
if ($in_assignment) {
|
||
if (IssueBuffer::accepts(
|
||
new MixedArrayAssignment(
|
||
'Cannot access array value on mixed variable ' . $array_var_id,
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
} else {
|
||
if (IssueBuffer::accepts(
|
||
new MixedArrayAccess(
|
||
'Cannot access array value on mixed variable ' . $array_var_id,
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
}
|
||
}
|
||
|
||
$has_valid_offset = true;
|
||
$array_access_type = Type::getMixed();
|
||
break;
|
||
}
|
||
|
||
$type = clone array_values($type->as->getTypes())[0];
|
||
}
|
||
|
||
if ($type instanceof TNull) {
|
||
if ($array_type->ignore_nullable_issues) {
|
||
continue;
|
||
}
|
||
|
||
if ($in_assignment) {
|
||
if ($replacement_type) {
|
||
if ($array_access_type) {
|
||
$array_access_type = Type::combineUnionTypes($array_access_type, $replacement_type);
|
||
} else {
|
||
$array_access_type = clone $replacement_type;
|
||
}
|
||
} else {
|
||
if (IssueBuffer::accepts(
|
||
new PossiblyNullArrayAssignment(
|
||
'Cannot access array value on possibly null variable ' . $array_var_id .
|
||
' of type ' . $array_type,
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
|
||
$array_access_type = new Type\Union([new TEmpty]);
|
||
}
|
||
} else {
|
||
if (!$context->inside_isset) {
|
||
if (IssueBuffer::accepts(
|
||
new PossiblyNullArrayAccess(
|
||
'Cannot access array value on possibly null variable ' . $array_var_id .
|
||
' of type ' . $array_type,
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
}
|
||
|
||
if ($array_access_type) {
|
||
$array_access_type = Type::combineUnionTypes($array_access_type, Type::getNull());
|
||
} else {
|
||
$array_access_type = Type::getNull();
|
||
}
|
||
}
|
||
|
||
continue;
|
||
}
|
||
|
||
if ($type instanceof TArray || $type instanceof ObjectLike) {
|
||
$has_array_access = true;
|
||
|
||
if ($in_assignment
|
||
&& $type instanceof TArray
|
||
&& $type->type_params[0]->isEmpty()
|
||
&& $key_value !== null
|
||
) {
|
||
// ok, type becomes an ObjectLike
|
||
$array_type->removeType($type_string);
|
||
$type = new ObjectLike([$key_value => new Type\Union([new TEmpty])]);
|
||
$array_type->addType($type);
|
||
}
|
||
|
||
$offset_type = self::replaceOffsetTypeWithInts($offset_type);
|
||
|
||
if ($type instanceof TArray) {
|
||
// if we're assigning to an empty array with a key offset, refashion that array
|
||
if ($in_assignment) {
|
||
if ($type->type_params[0]->isEmpty()) {
|
||
$type->type_params[0] = $offset_type;
|
||
}
|
||
} elseif (!$type->type_params[0]->isEmpty()) {
|
||
$expected_offset_type = $type->type_params[0]->hasMixed()
|
||
? new Type\Union([ new TArrayKey ])
|
||
: $type->type_params[0];
|
||
|
||
$templated_offset_type = null;
|
||
|
||
foreach ($offset_type->getTypes() as $offset_atomic_type) {
|
||
if ($offset_atomic_type instanceof TTemplateParam) {
|
||
$templated_offset_type = $offset_atomic_type;
|
||
}
|
||
}
|
||
|
||
if ($original_type instanceof TTemplateParam && $templated_offset_type) {
|
||
foreach ($templated_offset_type->as->getTypes() as $offset_as) {
|
||
if ($offset_as instanceof Type\Atomic\TTemplateKeyOf
|
||
&& $offset_as->param_name === $original_type->param_name
|
||
&& $offset_as->defining_class === $original_type->defining_class
|
||
) {
|
||
$type->type_params[1] = new Type\Union([
|
||
new Type\Atomic\TTemplateIndexedAccess(
|
||
$offset_as->param_name,
|
||
$templated_offset_type->param_name,
|
||
$offset_as->defining_class
|
||
)
|
||
]);
|
||
|
||
$has_valid_offset = true;
|
||
}
|
||
}
|
||
} elseif ((!TypeAnalyzer::isContainedBy(
|
||
$codebase,
|
||
$offset_type,
|
||
$expected_offset_type,
|
||
true,
|
||
$offset_type->ignore_falsable_issues,
|
||
$has_scalar_match,
|
||
$type_coerced,
|
||
$type_coerced_from_mixed,
|
||
$to_string_cast,
|
||
$type_coerced_from_scalar
|
||
) && !$type_coerced_from_scalar)
|
||
|| $to_string_cast
|
||
) {
|
||
if ($type_coerced_from_mixed && !$offset_type->isMixed()) {
|
||
if (IssueBuffer::accepts(
|
||
new MixedArrayTypeCoercion(
|
||
'Coercion from array offset type \'' . $offset_type->getId() . '\' '
|
||
. 'to the expected type \'' . $expected_offset_type->getId() . '\'',
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
} else {
|
||
$expected_offset_types[] = $expected_offset_type->getId();
|
||
}
|
||
|
||
if (TypeAnalyzer::canExpressionTypesBeIdentical(
|
||
$codebase,
|
||
$offset_type,
|
||
$expected_offset_type
|
||
)) {
|
||
$has_valid_offset = true;
|
||
}
|
||
} else {
|
||
$has_valid_offset = true;
|
||
}
|
||
}
|
||
|
||
if (!$stmt->dim && $type instanceof TNonEmptyArray && $type->count !== null) {
|
||
$type->count++;
|
||
}
|
||
|
||
if ($in_assignment && $replacement_type) {
|
||
$type->type_params[1] = Type::combineUnionTypes(
|
||
$type->type_params[1],
|
||
$replacement_type,
|
||
$codebase
|
||
);
|
||
}
|
||
|
||
if (!$array_access_type) {
|
||
$array_access_type = $type->type_params[1];
|
||
} else {
|
||
$array_access_type = Type::combineUnionTypes(
|
||
$array_access_type,
|
||
$type->type_params[1]
|
||
);
|
||
}
|
||
|
||
if ($array_access_type->isEmpty()
|
||
&& !$array_type->hasMixed()
|
||
&& !$in_assignment
|
||
&& !$context->inside_isset
|
||
) {
|
||
if (IssueBuffer::accepts(
|
||
new EmptyArrayAccess(
|
||
'Cannot access value on empty array variable ' . $array_var_id,
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
return Type::getMixed(true);
|
||
}
|
||
|
||
if (!IssueBuffer::isRecording()) {
|
||
$array_access_type = Type::getMixed(true);
|
||
}
|
||
}
|
||
} else {
|
||
$generic_key_type = $type->getGenericKeyType();
|
||
|
||
if ($key_value !== null) {
|
||
if (isset($type->properties[$key_value]) || $replacement_type) {
|
||
$has_valid_offset = true;
|
||
|
||
if ($replacement_type) {
|
||
if (isset($type->properties[$key_value])) {
|
||
$type->properties[$key_value] = Type::combineUnionTypes(
|
||
$type->properties[$key_value],
|
||
$replacement_type
|
||
);
|
||
} else {
|
||
$type->properties[$key_value] = $replacement_type;
|
||
}
|
||
}
|
||
|
||
if (!$array_access_type) {
|
||
$array_access_type = clone $type->properties[$key_value];
|
||
} else {
|
||
$array_access_type = Type::combineUnionTypes(
|
||
$array_access_type,
|
||
$type->properties[$key_value]
|
||
);
|
||
}
|
||
} elseif ($in_assignment) {
|
||
$type->properties[$key_value] = new Type\Union([new TEmpty]);
|
||
|
||
if (!$array_access_type) {
|
||
$array_access_type = clone $type->properties[$key_value];
|
||
} else {
|
||
$array_access_type = Type::combineUnionTypes(
|
||
$array_access_type,
|
||
$type->properties[$key_value]
|
||
);
|
||
}
|
||
} elseif ($type->had_mixed_value) {
|
||
$has_valid_offset = true;
|
||
|
||
$type->properties[$key_value] = new Type\Union([new TMixed]);
|
||
|
||
$array_access_type = Type::getMixed();
|
||
} else {
|
||
if (!$context->inside_isset || $type->sealed) {
|
||
$object_like_keys = array_keys($type->properties);
|
||
|
||
if (count($object_like_keys) === 1) {
|
||
$expected_keys_string = '\'' . $object_like_keys[0] . '\'';
|
||
} else {
|
||
$last_key = array_pop($object_like_keys);
|
||
$expected_keys_string = '\'' . implode('\', \'', $object_like_keys) .
|
||
'\' or \'' . $last_key . '\'';
|
||
}
|
||
|
||
$expected_offset_types[] = $expected_keys_string;
|
||
}
|
||
|
||
$array_access_type = Type::getMixed();
|
||
}
|
||
} else {
|
||
$key_type = $generic_key_type->hasMixed()
|
||
? Type::getArrayKey()
|
||
: $generic_key_type;
|
||
|
||
$is_contained = TypeAnalyzer::isContainedBy(
|
||
$codebase,
|
||
$offset_type,
|
||
$key_type,
|
||
true,
|
||
$offset_type->ignore_falsable_issues,
|
||
$has_scalar_match,
|
||
$type_coerced,
|
||
$type_coerced_from_mixed,
|
||
$to_string_cast,
|
||
$type_coerced_from_scalar
|
||
);
|
||
|
||
if ($context->inside_isset && !$is_contained) {
|
||
$is_contained = TypeAnalyzer::canBeContainedBy(
|
||
$codebase,
|
||
$offset_type,
|
||
$key_type,
|
||
true,
|
||
$offset_type->ignore_falsable_issues
|
||
);
|
||
}
|
||
|
||
if (($is_contained
|
||
|| $type_coerced_from_scalar
|
||
|| $type_coerced_from_mixed
|
||
|| $in_assignment)
|
||
&& !$to_string_cast
|
||
) {
|
||
if ($replacement_type) {
|
||
$generic_params = Type::combineUnionTypes(
|
||
$type->getGenericValueType(),
|
||
$replacement_type
|
||
);
|
||
|
||
$new_key_type = Type::combineUnionTypes(
|
||
$generic_key_type,
|
||
$offset_type
|
||
);
|
||
|
||
$property_count = $type->sealed ? count($type->properties) : null;
|
||
|
||
if (!$stmt->dim && $property_count) {
|
||
++$property_count;
|
||
$array_type->removeType($type_string);
|
||
$type = new TNonEmptyArray([
|
||
$new_key_type,
|
||
$generic_params,
|
||
]);
|
||
$array_type->addType($type);
|
||
$type->count = $property_count;
|
||
} else {
|
||
$array_type->removeType($type_string);
|
||
$type = new TArray([
|
||
$new_key_type,
|
||
$generic_params,
|
||
]);
|
||
$array_type->addType($type);
|
||
}
|
||
|
||
if (!$array_access_type) {
|
||
$array_access_type = clone $generic_params;
|
||
} else {
|
||
$array_access_type = Type::combineUnionTypes(
|
||
$array_access_type,
|
||
$generic_params
|
||
);
|
||
}
|
||
} else {
|
||
if (!$array_access_type) {
|
||
$array_access_type = $type->getGenericValueType();
|
||
} else {
|
||
$array_access_type = Type::combineUnionTypes(
|
||
$array_access_type,
|
||
$type->getGenericValueType()
|
||
);
|
||
}
|
||
}
|
||
|
||
$has_valid_offset = true;
|
||
} else {
|
||
if (!$context->inside_isset || $type->sealed) {
|
||
$expected_offset_types[] = (string)$generic_key_type->getId();
|
||
}
|
||
|
||
$array_access_type = Type::getMixed();
|
||
}
|
||
}
|
||
}
|
||
continue;
|
||
}
|
||
|
||
if ($type instanceof TString) {
|
||
if ($in_assignment && $replacement_type) {
|
||
if ($replacement_type->hasMixed()) {
|
||
if (!$context->collect_initializations
|
||
&& !$context->collect_mutations
|
||
&& $statements_analyzer->getFilePath() === $statements_analyzer->getRootFilePath()
|
||
&& (!(($parent_source = $statements_analyzer->getSource())
|
||
instanceof \Psalm\Internal\Analyzer\FunctionLikeAnalyzer)
|
||
|| !$parent_source->getSource() instanceof \Psalm\Internal\Analyzer\TraitAnalyzer)
|
||
) {
|
||
$codebase->analyzer->incrementMixedCount($statements_analyzer->getFilePath());
|
||
}
|
||
|
||
if (IssueBuffer::accepts(
|
||
new MixedStringOffsetAssignment(
|
||
'Right-hand-side of string offset assignment cannot be mixed',
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
} else {
|
||
if (!$context->collect_initializations
|
||
&& !$context->collect_mutations
|
||
&& $statements_analyzer->getFilePath() === $statements_analyzer->getRootFilePath()
|
||
&& (!(($parent_source = $statements_analyzer->getSource())
|
||
instanceof \Psalm\Internal\Analyzer\FunctionLikeAnalyzer)
|
||
|| !$parent_source->getSource() instanceof \Psalm\Internal\Analyzer\TraitAnalyzer)
|
||
) {
|
||
$codebase->analyzer->incrementNonMixedCount($statements_analyzer->getFilePath());
|
||
}
|
||
}
|
||
}
|
||
|
||
if ($type instanceof TSingleLetter) {
|
||
$valid_offset_type = Type::getInt(false, 0);
|
||
} elseif ($type instanceof TLiteralString) {
|
||
if (!strlen($type->value)) {
|
||
$valid_offset_type = Type::getEmpty();
|
||
} elseif (strlen($type->value) < 10) {
|
||
$valid_offsets = [];
|
||
|
||
for ($i = -strlen($type->value), $l = strlen($type->value); $i < $l; $i++) {
|
||
$valid_offsets[] = new TLiteralInt($i);
|
||
}
|
||
|
||
$valid_offset_type = new Type\Union($valid_offsets);
|
||
} else {
|
||
$valid_offset_type = Type::getInt();
|
||
}
|
||
} else {
|
||
$valid_offset_type = Type::getInt();
|
||
}
|
||
|
||
if (!TypeAnalyzer::isContainedBy(
|
||
$codebase,
|
||
$offset_type,
|
||
$valid_offset_type,
|
||
true
|
||
)) {
|
||
$expected_offset_types[] = $valid_offset_type->getId();
|
||
|
||
$array_access_type = Type::getMixed();
|
||
} else {
|
||
$has_valid_offset = true;
|
||
|
||
if (!$array_access_type) {
|
||
$array_access_type = Type::getSingleLetter();
|
||
} else {
|
||
$array_access_type = Type::combineUnionTypes(
|
||
$array_access_type,
|
||
Type::getSingleLetter()
|
||
);
|
||
}
|
||
}
|
||
|
||
continue;
|
||
}
|
||
|
||
if (!$context->collect_initializations
|
||
&& !$context->collect_mutations
|
||
&& $statements_analyzer->getFilePath() === $statements_analyzer->getRootFilePath()
|
||
&& (!(($parent_source = $statements_analyzer->getSource())
|
||
instanceof \Psalm\Internal\Analyzer\FunctionLikeAnalyzer)
|
||
|| !$parent_source->getSource() instanceof \Psalm\Internal\Analyzer\TraitAnalyzer)
|
||
) {
|
||
$codebase->analyzer->incrementNonMixedCount($statements_analyzer->getFilePath());
|
||
}
|
||
|
||
if ($type instanceof Type\Atomic\TFalse && $array_type->ignore_falsable_issues) {
|
||
continue;
|
||
}
|
||
|
||
if ($type instanceof TNamedObject) {
|
||
if (strtolower($type->value) === 'simplexmlelement') {
|
||
$array_access_type = Type::getMixed();
|
||
} elseif (strtolower($type->value) === 'domnodelist' && $stmt->dim) {
|
||
$fake_method_call = new PhpParser\Node\Expr\MethodCall(
|
||
$stmt->var,
|
||
new PhpParser\Node\Identifier('item', $stmt->var->getAttributes()),
|
||
[
|
||
new PhpParser\Node\Arg($stmt->dim)
|
||
]
|
||
);
|
||
|
||
$suppressed_issues = $statements_analyzer->getSuppressedIssues();
|
||
|
||
if (!in_array('PossiblyInvalidMethodCall', $suppressed_issues, true)) {
|
||
$statements_analyzer->addSuppressedIssues(['PossiblyInvalidMethodCall']);
|
||
}
|
||
|
||
\Psalm\Internal\Analyzer\Statements\Expression\Call\MethodCallAnalyzer::analyze(
|
||
$statements_analyzer,
|
||
$fake_method_call,
|
||
$context
|
||
);
|
||
|
||
if (!in_array('PossiblyInvalidMethodCall', $suppressed_issues, true)) {
|
||
$statements_analyzer->removeSuppressedIssues(['PossiblyInvalidMethodCall']);
|
||
}
|
||
|
||
$iterator_class_type = $fake_method_call->inferredType ?? null;
|
||
$array_access_type = $iterator_class_type ?: Type::getMixed();
|
||
} else {
|
||
$suppressed_issues = $statements_analyzer->getSuppressedIssues();
|
||
|
||
if (!in_array('PossiblyInvalidMethodCall', $suppressed_issues, true)) {
|
||
$statements_analyzer->addSuppressedIssues(['PossiblyInvalidMethodCall']);
|
||
}
|
||
|
||
if ($in_assignment) {
|
||
$fake_set_method_call = new PhpParser\Node\Expr\MethodCall(
|
||
$stmt->var,
|
||
new PhpParser\Node\Identifier('offsetSet', $stmt->var->getAttributes()),
|
||
[
|
||
new PhpParser\Node\Arg(
|
||
$stmt->dim
|
||
? $stmt->dim
|
||
: new PhpParser\Node\Expr\ConstFetch(
|
||
new PhpParser\Node\Name('null'),
|
||
$stmt->var->getAttributes()
|
||
)
|
||
),
|
||
new PhpParser\Node\Arg(
|
||
$assign_value
|
||
?: new PhpParser\Node\Expr\ConstFetch(
|
||
new PhpParser\Node\Name('null'),
|
||
$stmt->var->getAttributes()
|
||
)
|
||
),
|
||
]
|
||
);
|
||
|
||
\Psalm\Internal\Analyzer\Statements\Expression\Call\MethodCallAnalyzer::analyze(
|
||
$statements_analyzer,
|
||
$fake_set_method_call,
|
||
$context
|
||
);
|
||
}
|
||
|
||
if ($stmt->dim) {
|
||
$fake_get_method_call = new PhpParser\Node\Expr\MethodCall(
|
||
$stmt->var,
|
||
new PhpParser\Node\Identifier('offsetGet', $stmt->var->getAttributes()),
|
||
[
|
||
new PhpParser\Node\Arg(
|
||
$stmt->dim
|
||
)
|
||
]
|
||
);
|
||
|
||
\Psalm\Internal\Analyzer\Statements\Expression\Call\MethodCallAnalyzer::analyze(
|
||
$statements_analyzer,
|
||
$fake_get_method_call,
|
||
$context
|
||
);
|
||
|
||
$iterator_class_type = $fake_get_method_call->inferredType ?? null;
|
||
} else {
|
||
$iterator_class_type = Type::getVoid();
|
||
}
|
||
|
||
$has_array_access = true;
|
||
|
||
$array_access_type = $iterator_class_type ?: Type::getMixed();
|
||
|
||
if (!in_array('PossiblyInvalidMethodCall', $suppressed_issues, true)) {
|
||
$statements_analyzer->removeSuppressedIssues(['PossiblyInvalidMethodCall']);
|
||
}
|
||
}
|
||
} elseif (!$array_type->hasMixed()) {
|
||
$non_array_types[] = (string)$type;
|
||
}
|
||
}
|
||
|
||
if ($non_array_types) {
|
||
if ($has_array_access) {
|
||
if ($in_assignment) {
|
||
if (IssueBuffer::accepts(
|
||
new PossiblyInvalidArrayAssignment(
|
||
'Cannot access array value on non-array variable ' .
|
||
$array_var_id . ' of type ' . $non_array_types[0],
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)
|
||
) {
|
||
// do nothing
|
||
}
|
||
} else {
|
||
if (IssueBuffer::accepts(
|
||
new PossiblyInvalidArrayAccess(
|
||
'Cannot access array value on non-array variable ' .
|
||
$array_var_id . ' of type ' . $non_array_types[0],
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)
|
||
) {
|
||
// do nothing
|
||
}
|
||
}
|
||
} else {
|
||
if ($in_assignment) {
|
||
if (IssueBuffer::accepts(
|
||
new InvalidArrayAssignment(
|
||
'Cannot access array value on non-array variable ' .
|
||
$array_var_id . ' of type ' . $non_array_types[0],
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
} else {
|
||
if (IssueBuffer::accepts(
|
||
new InvalidArrayAccess(
|
||
'Cannot access array value on non-array variable ' .
|
||
$array_var_id . ' of type ' . $non_array_types[0],
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
}
|
||
|
||
$array_access_type = Type::getMixed();
|
||
}
|
||
}
|
||
|
||
if ($offset_type->hasMixed()) {
|
||
if (!$context->collect_initializations
|
||
&& !$context->collect_mutations
|
||
&& $statements_analyzer->getFilePath() === $statements_analyzer->getRootFilePath()
|
||
&& (!(($parent_source = $statements_analyzer->getSource())
|
||
instanceof \Psalm\Internal\Analyzer\FunctionLikeAnalyzer)
|
||
|| !$parent_source->getSource() instanceof \Psalm\Internal\Analyzer\TraitAnalyzer)
|
||
) {
|
||
$codebase->analyzer->incrementMixedCount($statements_analyzer->getFilePath());
|
||
}
|
||
|
||
if (IssueBuffer::accepts(
|
||
new MixedArrayOffset(
|
||
'Cannot access value on variable ' . $array_var_id . ' using mixed offset',
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
} else {
|
||
if (!$context->collect_initializations
|
||
&& !$context->collect_mutations
|
||
&& $statements_analyzer->getFilePath() === $statements_analyzer->getRootFilePath()
|
||
&& (!(($parent_source = $statements_analyzer->getSource())
|
||
instanceof \Psalm\Internal\Analyzer\FunctionLikeAnalyzer)
|
||
|| !$parent_source->getSource() instanceof \Psalm\Internal\Analyzer\TraitAnalyzer)
|
||
) {
|
||
$codebase->analyzer->incrementNonMixedCount($statements_analyzer->getFilePath());
|
||
}
|
||
|
||
if ($expected_offset_types) {
|
||
$invalid_offset_type = $expected_offset_types[0];
|
||
|
||
$used_offset = 'using a ' . $offset_type->getId() . ' offset';
|
||
|
||
if ($key_value !== null) {
|
||
$used_offset = 'using offset value of '
|
||
. (is_int($key_value) ? $key_value : '\'' . $key_value . '\'');
|
||
}
|
||
|
||
if ($has_valid_offset && $context->inside_isset) {
|
||
// do nothing
|
||
} elseif ($has_valid_offset) {
|
||
if (IssueBuffer::accepts(
|
||
new PossiblyInvalidArrayOffset(
|
||
'Cannot access value on variable ' . $array_var_id . ' ' . $used_offset
|
||
. ', expecting ' . $invalid_offset_type,
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
} else {
|
||
if (IssueBuffer::accepts(
|
||
new InvalidArrayOffset(
|
||
'Cannot access value on variable ' . $array_var_id . ' ' . $used_offset
|
||
. ', expecting ' . $invalid_offset_type,
|
||
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
||
),
|
||
$statements_analyzer->getSuppressedIssues()
|
||
)) {
|
||
// fall through
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
if ($array_access_type === null) {
|
||
// shouldn’t happen, but don’t crash
|
||
return Type::getMixed();
|
||
}
|
||
|
||
if ($in_assignment) {
|
||
$array_type->bustCache();
|
||
}
|
||
|
||
return $array_access_type;
|
||
}
|
||
|
||
/**
|
||
* @return Type\Union
|
||
*/
|
||
public static function replaceOffsetTypeWithInts(Type\Union $offset_type)
|
||
{
|
||
$offset_string_types = $offset_type->getLiteralStrings();
|
||
|
||
$offset_type = clone $offset_type;
|
||
|
||
foreach ($offset_string_types as $key => $offset_string_type) {
|
||
if (preg_match('/^(0|[1-9][0-9]*)$/', $offset_string_type->value)) {
|
||
$offset_type->addType(new Type\Atomic\TLiteralInt((int) $offset_string_type->value));
|
||
$offset_type->removeType($key);
|
||
}
|
||
}
|
||
|
||
return $offset_type;
|
||
}
|
||
}
|