1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-16 11:26:55 +01:00
psalm/src/Psalm/Internal/Analyzer/Statements/Expression/Call/MethodCallAnalyzer.php

1429 lines
55 KiB
PHP
Raw Normal View History

2018-01-29 00:29:38 +01:00
<?php
2018-11-06 03:57:36 +01:00
namespace Psalm\Internal\Analyzer\Statements\Expression\Call;
2018-01-29 00:29:38 +01:00
use PhpParser;
2018-11-06 03:57:36 +01:00
use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
use Psalm\Internal\Analyzer\FunctionLikeAnalyzer;
use Psalm\Internal\Analyzer\MethodAnalyzer;
use Psalm\Internal\Analyzer\Statements\ExpressionAnalyzer;
use Psalm\Internal\Analyzer\StatementsAnalyzer;
use Psalm\Internal\Analyzer\TypeAnalyzer;
use Psalm\Internal\Codebase\CallMap;
use Psalm\Codebase;
2018-01-29 00:29:38 +01:00
use Psalm\CodeLocation;
use Psalm\Context;
use Psalm\Internal\FileManipulation\FileManipulationBuffer;
2018-01-29 00:29:38 +01:00
use Psalm\Issue\InvalidMethodCall;
use Psalm\Issue\InvalidPropertyAssignmentValue;
2018-01-29 00:29:38 +01:00
use Psalm\Issue\InvalidScope;
use Psalm\Issue\MixedMethodCall;
use Psalm\Issue\MixedTypeCoercion;
2018-01-29 00:29:38 +01:00
use Psalm\Issue\NullReference;
use Psalm\Issue\PossiblyFalseReference;
use Psalm\Issue\PossiblyInvalidMethodCall;
use Psalm\Issue\PossiblyInvalidPropertyAssignmentValue;
2018-01-29 00:29:38 +01:00
use Psalm\Issue\PossiblyNullReference;
use Psalm\Issue\PossiblyUndefinedMethod;
use Psalm\Issue\TypeCoercion;
use Psalm\Issue\UndefinedInterfaceMethod;
2018-01-29 00:29:38 +01:00
use Psalm\Issue\UndefinedMethod;
use Psalm\Issue\UndefinedThisPropertyAssignment;
use Psalm\Issue\UndefinedThisPropertyFetch;
2018-01-29 00:29:38 +01:00
use Psalm\IssueBuffer;
use Psalm\Storage\Assertion;
use Psalm\Storage\ClassLikeStorage;
2018-01-29 00:29:38 +01:00
use Psalm\Type;
use Psalm\Type\Atomic\TGenericObject;
use Psalm\Type\Atomic\TNamedObject;
/**
* @internal
*/
2018-11-06 03:57:36 +01:00
class MethodCallAnalyzer extends \Psalm\Internal\Analyzer\Statements\Expression\CallAnalyzer
2018-01-29 00:29:38 +01:00
{
/**
2018-11-11 18:01:14 +01:00
* @param StatementsAnalyzer $statements_analyzer
2018-01-29 00:29:38 +01:00
* @param PhpParser\Node\Expr\MethodCall $stmt
* @param Context $context
*
* @return false|null
*/
public static function analyze(
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
2018-01-29 00:29:38 +01:00
PhpParser\Node\Expr\MethodCall $stmt,
Context $context
) {
$stmt->inferredType = null;
2018-11-11 18:01:14 +01:00
if (ExpressionAnalyzer::analyze($statements_analyzer, $stmt->var, $context) === false) {
2018-01-29 00:29:38 +01:00
return false;
}
if (!$stmt->name instanceof PhpParser\Node\Identifier) {
2018-11-11 18:01:14 +01:00
if (ExpressionAnalyzer::analyze($statements_analyzer, $stmt->name, $context) === false) {
return false;
}
}
2018-01-29 00:29:38 +01:00
if ($stmt->var instanceof PhpParser\Node\Expr\Variable) {
2018-11-11 18:01:14 +01:00
if (is_string($stmt->var->name) && $stmt->var->name === 'this' && !$statements_analyzer->getFQCLN()) {
2018-01-29 00:29:38 +01:00
if (IssueBuffer::accepts(
new InvalidScope(
'Use of $this in non-class context',
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
2018-01-29 00:29:38 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2018-01-29 00:29:38 +01:00
)) {
return false;
}
}
}
$lhs_var_id = ExpressionAnalyzer::getArrayVarId(
2018-01-29 00:29:38 +01:00
$stmt->var,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFQCLN(),
$statements_analyzer
2018-01-29 00:29:38 +01:00
);
$class_type = $lhs_var_id && $context->hasVariable($lhs_var_id, $statements_analyzer)
? $context->vars_in_scope[$lhs_var_id]
2018-01-29 00:29:38 +01:00
: null;
if (isset($stmt->var->inferredType)) {
$class_type = $stmt->var->inferredType;
} elseif (!$class_type) {
$stmt->inferredType = Type::getMixed();
}
if (!$context->check_classes) {
if (self::checkFunctionArguments(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$stmt->args,
null,
null,
$context
) === false) {
return false;
}
2018-01-29 00:29:38 +01:00
return null;
}
$has_mock = false;
if ($class_type && $stmt->name instanceof PhpParser\Node\Identifier && $class_type->isNull()) {
2018-01-29 00:29:38 +01:00
if (IssueBuffer::accepts(
new NullReference(
'Cannot call method ' . $stmt->name->name . ' on null value',
new CodeLocation($statements_analyzer->getSource(), $stmt->name)
2018-01-29 00:29:38 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2018-01-29 00:29:38 +01:00
)) {
return false;
}
return null;
}
if ($class_type
&& $stmt->name instanceof PhpParser\Node\Identifier
2018-01-29 00:29:38 +01:00
&& $class_type->isNullable()
&& !$class_type->ignore_nullable_issues
) {
if (IssueBuffer::accepts(
new PossiblyNullReference(
'Cannot call method ' . $stmt->name->name . ' on possibly null value',
new CodeLocation($statements_analyzer->getSource(), $stmt->name)
2018-01-29 00:29:38 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2018-01-29 00:29:38 +01:00
)) {
// fall through
2018-01-29 00:29:38 +01:00
}
}
if ($class_type
&& $stmt->name instanceof PhpParser\Node\Identifier
2018-01-29 00:29:38 +01:00
&& $class_type->isFalsable()
&& !$class_type->ignore_falsable_issues
) {
if (IssueBuffer::accepts(
new PossiblyFalseReference(
'Cannot call method ' . $stmt->name->name . ' on possibly false value',
new CodeLocation($statements_analyzer->getSource(), $stmt->name)
2018-01-29 00:29:38 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2018-01-29 00:29:38 +01:00
)) {
// fall through
2018-01-29 00:29:38 +01:00
}
}
2018-11-11 18:01:14 +01:00
$codebase = $statements_analyzer->getCodebase();
$config = $codebase->config;
2018-01-29 00:29:38 +01:00
$non_existent_class_method_ids = [];
$non_existent_interface_method_ids = [];
2018-01-29 00:29:38 +01:00
$existent_method_ids = [];
2018-12-10 17:28:05 +01:00
$has_mixed_method_call = false;
2018-01-29 00:29:38 +01:00
$invalid_method_call_types = [];
$has_valid_method_call_type = false;
$source = $statements_analyzer->getSource();
2018-01-29 00:29:38 +01:00
$returns_by_ref = false;
$no_method_id = false;
if ($class_type) {
2018-01-29 00:29:38 +01:00
$return_type = null;
$lhs_types = $class_type->getTypes();
foreach ($lhs_types as $lhs_type_part) {
$result = self::analyzeAtomicCall(
$statements_analyzer,
$stmt,
$codebase,
$context,
$lhs_type_part,
$lhs_var_id,
$return_type,
$returns_by_ref,
$has_mock,
$has_valid_method_call_type,
$has_mixed_method_call,
$invalid_method_call_types,
$existent_method_ids,
$non_existent_class_method_ids,
$non_existent_interface_method_ids
);
if ($result === false) {
return false;
}
if ($result === true) {
$no_method_id = true;
}
}
if ($invalid_method_call_types) {
$invalid_class_type = $invalid_method_call_types[0];
if ($has_valid_method_call_type || $has_mixed_method_call) {
if (IssueBuffer::accepts(
new PossiblyInvalidMethodCall(
'Cannot call method on possible ' . $invalid_class_type . ' variable ' . $lhs_var_id,
new CodeLocation($source, $stmt->name)
),
$statements_analyzer->getSuppressedIssues()
)) {
2019-02-24 07:33:25 +01:00
// keep going
}
} else {
if (IssueBuffer::accepts(
new InvalidMethodCall(
'Cannot call method on ' . $invalid_class_type . ' variable ' . $lhs_var_id,
new CodeLocation($source, $stmt->name)
),
$statements_analyzer->getSuppressedIssues()
)) {
2019-02-24 07:33:25 +01:00
// keep going
}
}
}
if ($non_existent_class_method_ids) {
if ($context->check_methods) {
if ($existent_method_ids || $has_mixed_method_call) {
if (IssueBuffer::accepts(
new PossiblyUndefinedMethod(
'Method ' . $non_existent_class_method_ids[0] . ' does not exist',
new CodeLocation($source, $stmt->name),
$non_existent_class_method_ids[0]
),
$statements_analyzer->getSuppressedIssues()
)) {
2019-02-24 07:33:25 +01:00
// keep going
}
} else {
if (IssueBuffer::accepts(
new UndefinedMethod(
'Method ' . $non_existent_class_method_ids[0] . ' does not exist',
new CodeLocation($source, $stmt->name),
$non_existent_class_method_ids[0]
),
$statements_analyzer->getSuppressedIssues()
)) {
2019-02-24 07:33:25 +01:00
// keep going
}
}
}
return null;
}
if ($non_existent_interface_method_ids) {
if ($context->check_methods) {
if ($existent_method_ids || $has_mixed_method_call) {
if (IssueBuffer::accepts(
new PossiblyUndefinedMethod(
'Method ' . $non_existent_interface_method_ids[0] . ' does not exist',
new CodeLocation($source, $stmt->name),
$non_existent_interface_method_ids[0]
),
$statements_analyzer->getSuppressedIssues()
)) {
2019-02-24 07:33:25 +01:00
// keep going
}
} else {
if (IssueBuffer::accepts(
new UndefinedInterfaceMethod(
'Method ' . $non_existent_interface_method_ids[0] . ' does not exist',
new CodeLocation($source, $stmt->name),
$non_existent_interface_method_ids[0]
),
$statements_analyzer->getSuppressedIssues()
)) {
2019-02-24 07:33:25 +01:00
// keep going
}
2018-01-29 00:29:38 +01:00
}
}
return null;
}
$stmt->inferredType = $return_type;
2018-01-29 00:29:38 +01:00
if ($returns_by_ref) {
if (!$stmt->inferredType) {
$stmt->inferredType = Type::getMixed();
}
2018-01-29 00:29:38 +01:00
$stmt->inferredType->by_ref = $returns_by_ref;
}
}
2018-01-29 00:29:38 +01:00
if ($no_method_id) {
return self::checkMethodArgs(
null,
$stmt->args,
$found_generic_params,
$context,
new CodeLocation($statements_analyzer->getSource(), $stmt),
$statements_analyzer
);
}
2018-01-29 00:29:38 +01:00
2019-02-24 07:33:25 +01:00
if ($codebase->store_node_types
&& (!$context->collect_initializations
&& !$context->collect_mutations)
&& isset($stmt->inferredType)
) {
$codebase->analyzer->addNodeType(
$statements_analyzer->getFilePath(),
$stmt->name,
(string) $stmt->inferredType
);
}
2018-01-29 00:29:38 +01:00
if (!$config->remember_property_assignments_after_call && !$context->collect_initializations) {
$context->removeAllObjectVars();
}
2018-01-29 00:29:38 +01:00
// if we called a method on this nullable variable, remove the nullable status here
// because any further calls must have worked
if ($lhs_var_id
&& $class_type
&& $has_valid_method_call_type
&& !$has_mixed_method_call
&& !$invalid_method_call_types
&& $existent_method_ids
&& ($class_type->from_docblock || $class_type->isNullable())
) {
$keys_to_remove = [];
2018-01-29 00:29:38 +01:00
foreach ($class_type->getTypes() as $key => $type) {
if (!$type instanceof TNamedObject) {
$keys_to_remove[] = $key;
2018-01-29 00:29:38 +01:00
} else {
$type->from_docblock = false;
2018-01-29 00:29:38 +01:00
}
}
2018-01-29 00:29:38 +01:00
foreach ($keys_to_remove as $key) {
$class_type->removeType($key);
}
$class_type->from_docblock = false;
$context->removeVarFromConflictingClauses($lhs_var_id, null, $statements_analyzer);
2018-01-29 00:29:38 +01:00
$context->vars_in_scope[$lhs_var_id] = $class_type;
}
}
/**
* [analyzeAtomicCall description]
* @param StatementsAnalyzer $statements_analyzer
* @param PhpParser\Node\Expr\MethodCall $stmt
* @param Codebase $codebase
* @param Context $context
* @param Type\Atomic $lhs_type_part
* @param ?string $lhs_var_id
* @param ?Type\Union &$return_type
* @param bool &$returns_by_ref
* @param bool &$has_mock
* @param bool &$has_valid_method_call_type
* @param bool &$has_mixed_method_call
* @param array<string> &$invalid_method_call_types
* @param array<string> &$existent_method_ids
* @param array<string> &$non_existent_class_method_ids
* @param array<string> &$non_existent_interface_method_ids
* @return null|bool
*/
private static function analyzeAtomicCall(
StatementsAnalyzer $statements_analyzer,
PhpParser\Node\Expr\MethodCall $stmt,
Codebase $codebase,
Context $context,
Type\Atomic $lhs_type_part,
$lhs_var_id,
&$return_type,
&$returns_by_ref,
&$has_mock,
&$has_valid_method_call_type,
&$has_mixed_method_call,
&$invalid_method_call_types,
&$existent_method_ids,
&$non_existent_class_method_ids,
&$non_existent_interface_method_ids
) {
$config = $codebase->config;
2019-02-22 03:40:06 +01:00
if ($lhs_type_part instanceof Type\Atomic\TTemplateParam
&& !$lhs_type_part->as->isMixed()
) {
$extra_types = $lhs_type_part->extra_types;
$lhs_type_part = array_values(
$lhs_type_part->as->getTypes()
)[0];
$lhs_type_part->from_docblock = true;
2018-01-29 00:29:38 +01:00
if ($lhs_type_part instanceof TNamedObject) {
$lhs_type_part->extra_types = $extra_types;
}
2018-03-21 21:55:31 +01:00
$has_mixed_method_call = true;
}
2018-03-21 21:55:31 +01:00
$source = $statements_analyzer->getSource();
2018-01-29 00:29:38 +01:00
if (!$lhs_type_part instanceof TNamedObject) {
switch (get_class($lhs_type_part)) {
case Type\Atomic\TNull::class:
case Type\Atomic\TFalse::class:
// handled above
return;
case Type\Atomic\TInt::class:
case Type\Atomic\TLiteralInt::class:
case Type\Atomic\TFloat::class:
case Type\Atomic\TLiteralFloat::class:
case Type\Atomic\TBool::class:
case Type\Atomic\TTrue::class:
case Type\Atomic\TArray::class:
case Type\Atomic\TNonEmptyArray::class:
case Type\Atomic\ObjectLike::class:
case Type\Atomic\TString::class:
case Type\Atomic\TSingleLetter::class:
case Type\Atomic\TLiteralString::class:
case Type\Atomic\TLiteralClassString::class:
2019-02-22 03:40:06 +01:00
case Type\Atomic\TTemplateParamClass::class:
case Type\Atomic\TNumericString::class:
case Type\Atomic\THtmlEscapedString::class:
case Type\Atomic\TClassString::class:
case Type\Atomic\TIterable::class:
$invalid_method_call_types[] = (string)$lhs_type_part;
return;
2019-02-22 03:40:06 +01:00
case Type\Atomic\TTemplateParam::class:
case Type\Atomic\TEmptyMixed::class:
case Type\Atomic\TMixed::class:
case Type\Atomic\TNonEmptyMixed::class:
case Type\Atomic\TObject::class:
case Type\Atomic\TObjectWithProperties::class:
$codebase->analyzer->incrementMixedCount($statements_analyzer->getFilePath());
$has_mixed_method_call = true;
if ($context->check_methods) {
if (IssueBuffer::accepts(
new MixedMethodCall(
'Cannot determine the type of the object on the left hand side of this expression',
new CodeLocation($source, $stmt->name)
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
}
if (self::checkFunctionArguments(
$statements_analyzer,
$stmt->args,
null,
null,
$context
) === false) {
return false;
}
$return_type = Type::getMixed();
return;
}
return;
}
2018-01-29 00:29:38 +01:00
$codebase->analyzer->incrementNonMixedCount($statements_analyzer->getFilePath());
$has_valid_method_call_type = true;
$fq_class_name = $lhs_type_part->value;
$intersection_types = $lhs_type_part->getIntersectionTypes();
$is_mock = ExpressionAnalyzer::isMock($fq_class_name);
$has_mock = $has_mock || $is_mock;
if ($fq_class_name === 'static') {
$fq_class_name = (string) $context->self;
}
if ($is_mock ||
$context->isPhantomClass($fq_class_name)
) {
$return_type = Type::getMixed();
if (self::checkFunctionArguments(
$statements_analyzer,
$stmt->args,
null,
null,
$context
) === false) {
return false;
}
return;
}
if ($lhs_var_id === '$this') {
$does_class_exist = true;
} else {
$does_class_exist = ClassLikeAnalyzer::checkFullyQualifiedClassLikeName(
$statements_analyzer,
$fq_class_name,
new CodeLocation($source, $stmt->var),
$statements_analyzer->getSuppressedIssues()
);
}
if (!$does_class_exist) {
return $does_class_exist;
}
if (!$stmt->name instanceof PhpParser\Node\Identifier) {
$return_type = Type::getMixed();
return true;
}
$method_name_lc = strtolower($stmt->name->name);
$method_id = $fq_class_name . '::' . $method_name_lc;
$intersection_method_id = $intersection_types
? '(' . $lhs_type_part . ')' . '::' . $stmt->name->name
: null;
$args = $stmt->args;
if (!$codebase->methods->methodExists($method_id)
|| !MethodAnalyzer::isMethodVisible(
$method_id,
$context->self,
$statements_analyzer->getSource()
)
) {
if ($codebase->methods->methodExists($fq_class_name . '::__call', $context->calling_method_id)) {
$class_storage = $codebase->classlike_storage_provider->get($fq_class_name);
if (isset($class_storage->pseudo_methods[$method_name_lc])) {
$has_valid_method_call_type = true;
$existent_method_ids[] = $method_id;
$pseudo_method_storage = $class_storage->pseudo_methods[$method_name_lc];
if (self::checkFunctionArguments(
$statements_analyzer,
$args,
$pseudo_method_storage->params,
$method_id,
$context
) === false) {
return false;
2018-01-29 00:29:38 +01:00
}
$generic_params = [];
if (self::checkFunctionLikeArgumentsMatch(
$statements_analyzer,
$args,
null,
$pseudo_method_storage->params,
$pseudo_method_storage,
null,
$generic_params,
new CodeLocation($source, $stmt),
$context
) === false) {
return false;
}
if ($pseudo_method_storage->return_type) {
$return_type_candidate = clone $pseudo_method_storage->return_type;
2018-01-29 00:29:38 +01:00
$return_type_candidate = ExpressionAnalyzer::fleshOutType(
$codebase,
$return_type_candidate,
$fq_class_name,
$fq_class_name
);
if (!$return_type) {
$return_type = $return_type_candidate;
} else {
$return_type = Type::combineUnionTypes($return_type_candidate, $return_type);
}
return;
}
} else {
if (self::checkFunctionArguments(
$statements_analyzer,
$args,
null,
null,
$context
) === false) {
return false;
}
if ($class_storage->sealed_methods) {
$non_existent_class_method_ids[] = $method_id;
return true;
}
}
$has_valid_method_call_type = true;
2018-01-29 00:29:38 +01:00
$existent_method_ids[] = $method_id;
$array_values = array_map(
/**
* @return PhpParser\Node\Expr\ArrayItem
*/
function (PhpParser\Node\Arg $arg) {
return new PhpParser\Node\Expr\ArrayItem($arg->value);
},
$args
);
$args = [
new PhpParser\Node\Arg(new PhpParser\Node\Scalar\String_($method_name_lc)),
new PhpParser\Node\Arg(new PhpParser\Node\Expr\Array_($array_values)),
];
$method_id = $fq_class_name . '::__call';
}
}
$source_source = $statements_analyzer->getSource();
2018-01-29 00:29:38 +01:00
/**
* @var \Psalm\Internal\Analyzer\ClassLikeAnalyzer|null
*/
$classlike_source = $source_source->getSource();
$classlike_source_fqcln = $classlike_source ? $classlike_source->getFQCLN() : null;
if ($lhs_var_id === '$this'
&& $context->self
&& $classlike_source_fqcln
&& $fq_class_name !== $context->self
&& $codebase->methodExists($context->self . '::' . $method_name_lc)
) {
$method_id = $context->self . '::' . $method_name_lc;
$fq_class_name = $context->self;
}
$check_visibility = true;
if ($intersection_types) {
foreach ($intersection_types as $intersection_type) {
if ($intersection_type instanceof TNamedObject
&& $codebase->interfaceExists($intersection_type->value)
2018-01-29 00:29:38 +01:00
) {
$interface_storage = $codebase->classlike_storage_provider->get($intersection_type->value);
2018-01-29 00:29:38 +01:00
$check_visibility = $check_visibility && !$interface_storage->override_method_visibility;
}
}
}
$is_interface = false;
if ($codebase->interfaceExists($fq_class_name)) {
$is_interface = true;
}
if ($intersection_types && !$codebase->methodExists($method_id)) {
if ($is_interface) {
$interface_storage = $codebase->classlike_storage_provider->get($fq_class_name);
2018-01-29 00:29:38 +01:00
$check_visibility = $check_visibility && !$interface_storage->override_method_visibility;
}
2018-01-29 00:29:38 +01:00
foreach ($intersection_types as $intersection_type) {
2019-02-22 03:40:06 +01:00
if ($intersection_type instanceof Type\Atomic\TTemplateParam) {
if (!$intersection_type->as->isMixed()
&& !$intersection_type->as->hasObject()
) {
$intersection_type = array_values(
$intersection_type->as->getTypes()
)[0];
2018-01-29 00:29:38 +01:00
if (!$intersection_type instanceof TNamedObject) {
throw new \UnexpectedValueException(
'Shouldnt get a non-object generic param here'
);
2019-01-11 14:54:10 +01:00
}
2018-01-29 00:29:38 +01:00
$intersection_type->from_docblock = true;
2018-01-29 00:29:38 +01:00
} else {
continue;
2018-01-29 00:29:38 +01:00
}
}
$method_id = $intersection_type->value . '::' . $method_name_lc;
$fq_class_name = $intersection_type->value;
$does_class_exist = ClassLikeAnalyzer::checkFullyQualifiedClassLikeName(
$statements_analyzer,
$fq_class_name,
new CodeLocation($source, $stmt->var),
$statements_analyzer->getSuppressedIssues()
);
if (!$does_class_exist) {
2018-01-29 00:29:38 +01:00
return false;
}
if ($codebase->methodExists($method_id)) {
$is_interface = $codebase->interfaceExists($fq_class_name);
break;
2018-01-29 00:29:38 +01:00
}
}
}
2018-01-29 00:29:38 +01:00
$source_method_id = $source instanceof FunctionLikeAnalyzer
? $source->getMethodId()
: null;
if (!$codebase->methods->methodExists(
$method_id,
$context->calling_method_id,
$method_id !== $source_method_id ? new CodeLocation($source, $stmt->name) : null
)) {
if ($config->use_phpdoc_method_without_magic_or_parent) {
$class_storage = $codebase->classlike_storage_provider->get($fq_class_name);
2018-02-01 05:27:25 +01:00
if (isset($class_storage->pseudo_methods[$method_name_lc])) {
$has_valid_method_call_type = true;
$existent_method_ids[] = $method_id;
2018-01-29 00:29:38 +01:00
$pseudo_method_storage = $class_storage->pseudo_methods[$method_name_lc];
2018-01-29 00:29:38 +01:00
if (self::checkFunctionArguments(
$statements_analyzer,
$args,
$pseudo_method_storage->params,
2018-01-29 00:29:38 +01:00
$method_id,
$context
2018-01-29 00:29:38 +01:00
) === false) {
return false;
}
$generic_params = [];
if (self::checkFunctionLikeArgumentsMatch(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$args,
null,
$pseudo_method_storage->params,
$pseudo_method_storage,
null,
$generic_params,
new CodeLocation($source, $stmt->name),
$context
) === false) {
return false;
}
if ($pseudo_method_storage->return_type) {
$return_type_candidate = clone $pseudo_method_storage->return_type;
2018-01-29 00:29:38 +01:00
if (!$return_type) {
$return_type = $return_type_candidate;
} else {
$return_type = Type::combineUnionTypes($return_type_candidate, $return_type);
}
2018-01-29 00:29:38 +01:00
return;
}
$return_type = Type::getMixed();
2018-05-09 04:01:05 +02:00
return;
}
}
2018-01-29 00:29:38 +01:00
if ($is_interface) {
$non_existent_interface_method_ids[] = $intersection_method_id ?: $method_id;
} else {
$non_existent_class_method_ids[] = $intersection_method_id ?: $method_id;
}
return true;
}
2018-01-29 00:29:38 +01:00
if ($context->collect_initializations && $context->calling_method_id) {
list($calling_method_class) = explode('::', $context->calling_method_id);
$codebase->file_reference_provider->addReferenceToClassMethod(
$calling_method_class . '::__construct',
strtolower($method_id)
);
}
2018-01-29 00:29:38 +01:00
$existent_method_ids[] = $method_id;
2018-01-29 00:29:38 +01:00
if ($stmt->var instanceof PhpParser\Node\Expr\Variable
&& ($context->collect_initializations || $context->collect_mutations)
&& $stmt->var->name === 'this'
&& $source instanceof FunctionLikeAnalyzer
) {
self::collectSpecialInformation($source, $stmt->name->name, $context);
}
2018-01-29 00:29:38 +01:00
$fq_class_name = $codebase->classlikes->getUnAliasedName($fq_class_name);
$class_storage = $codebase->methods->getClassLikeStorageForMethod($method_id);
$class_template_params = self::getClassTemplateParams(
$codebase,
$class_storage,
$fq_class_name,
$method_name_lc,
$lhs_type_part,
$lhs_var_id
);
if (self::checkMethodArgs(
$method_id,
$args,
$class_template_params,
$context,
new CodeLocation($source, $stmt->name),
$statements_analyzer
) === false) {
return false;
}
switch (strtolower($stmt->name->name)) {
case '__tostring':
$return_type = Type::getString();
return;
}
$call_map_id = strtolower(
$codebase->methods->getDeclaringMethodId($method_id) ?: $method_id
);
if ($method_name_lc === '__tostring') {
$return_type_candidate = Type::getString();
} else {
$return_type_candidate = null;
2018-04-28 19:46:01 +02:00
if ($codebase->methods->return_type_provider->has($fq_class_name)) {
$return_type_candidate = $codebase->methods->return_type_provider->getReturnType(
$statements_analyzer,
$fq_class_name,
$stmt->name->name,
$stmt->args,
$context,
new CodeLocation($statements_analyzer->getSource(), $stmt->name)
);
}
if (!$return_type_candidate) {
if ($call_map_id && CallMap::inCallMap($call_map_id)) {
if (($class_template_params || $class_storage->stubbed)
&& isset($class_storage->methods[$method_name_lc])
&& ($method_storage = $class_storage->methods[$method_name_lc])
&& $method_storage->return_type
) {
$return_type_candidate = clone $method_storage->return_type;
if ($class_template_params) {
$return_type_candidate->replaceTemplateTypesWithArgTypes(
$class_template_params,
$codebase
);
}
} else {
if ($call_map_id === 'domnode::appendchild'
&& isset($args[0]->value->inferredType)
&& $args[0]->value->inferredType->hasObjectType()
) {
$return_type_candidate = clone $args[0]->value->inferredType;
} elseif ($call_map_id === 'simplexmlelement::asxml' && !count($args)) {
$return_type_candidate = Type::parseString('string|false');
} else {
$return_type_candidate = CallMap::getReturnTypeFromCallMap($call_map_id);
if ($return_type_candidate->isFalsable()) {
$return_type_candidate->ignore_falsable_issues = true;
}
}
}
$return_type_candidate = ExpressionAnalyzer::fleshOutType(
$codebase,
$return_type_candidate,
$fq_class_name,
$lhs_type_part
);
} else {
$name_code_location = new CodeLocation($source, $stmt->name);
if ($check_visibility) {
if (MethodAnalyzer::checkMethodVisibility(
$method_id,
$context->self,
$statements_analyzer->getSource(),
$name_code_location,
$statements_analyzer->getSuppressedIssues()
) === false) {
return false;
}
}
if (MethodAnalyzer::checkMethodNotDeprecatedOrInternal(
$codebase,
$context,
$method_id,
$name_code_location,
$statements_analyzer->getSuppressedIssues()
) === false) {
return false;
}
if (!self::checkMagicGetterOrSetterProperty(
$statements_analyzer,
$stmt,
$fq_class_name
)) {
return false;
}
$self_fq_class_name = $fq_class_name;
$return_type_candidate = $codebase->methods->getMethodReturnType(
$method_id,
$self_fq_class_name,
$args
);
if ($codebase->store_node_types && $method_id) {
$codebase->analyzer->addNodeReference(
$statements_analyzer->getFilePath(),
$stmt->name,
$method_id . '()'
);
}
if (isset($stmt->inferredType)) {
$return_type_candidate = $stmt->inferredType;
}
if ($return_type_candidate) {
$return_type_candidate = clone $return_type_candidate;
if ($class_template_params) {
$return_type_candidate->replaceTemplateTypesWithArgTypes(
$class_template_params,
$codebase
);
}
$return_type_candidate = ExpressionAnalyzer::fleshOutType(
$codebase,
$return_type_candidate,
$self_fq_class_name,
$lhs_type_part
);
2018-01-29 00:29:38 +01:00
$return_type_location = $codebase->methods->getMethodReturnTypeLocation(
$method_id,
$secondary_return_type_location
);
2018-01-29 00:29:38 +01:00
if ($secondary_return_type_location) {
$return_type_location = $secondary_return_type_location;
}
2018-01-29 00:29:38 +01:00
// only check the type locally if it's defined externally
if ($return_type_location && !$config->isInProjectDirs($return_type_location->file_path)) {
$return_type_candidate->check(
$statements_analyzer,
new CodeLocation($source, $stmt),
$statements_analyzer->getSuppressedIssues(),
$context->phantom_classes
);
}
} else {
$returns_by_ref =
$returns_by_ref
|| $codebase->methods->getMethodReturnsByRef($method_id);
}
2018-01-29 00:29:38 +01:00
$method_storage = $codebase->methods->getUserMethodStorage($method_id);
if ($method_storage) {
if ($method_storage->assertions) {
self::applyAssertionsToContext(
$stmt->name,
$method_storage->assertions,
$args,
$class_template_params ?: [],
$context,
$statements_analyzer
);
}
if ($method_storage->if_true_assertions) {
$stmt->ifTrueAssertions = array_map(
function (Assertion $assertion) use ($class_template_params) : Assertion {
return $assertion->getUntemplatedCopy($class_template_params ?: []);
},
$method_storage->if_true_assertions
);
}
if ($method_storage->if_false_assertions) {
$stmt->ifFalseAssertions = array_map(
function (Assertion $assertion) use ($class_template_params) : Assertion {
return $assertion->getUntemplatedCopy($class_template_params ?: []);
},
$method_storage->if_false_assertions
);
}
}
}
2018-01-29 00:29:38 +01:00
}
}
2018-01-29 00:29:38 +01:00
if (!$args && $lhs_var_id) {
if ($config->memoize_method_calls) {
$method_var_id = $lhs_var_id . '->' . $method_name_lc . '()';
2018-01-29 00:29:38 +01:00
if (isset($context->vars_in_scope[$method_var_id])) {
$return_type_candidate = clone $context->vars_in_scope[$method_var_id];
} elseif ($return_type_candidate) {
$context->vars_in_scope[$method_var_id] = $return_type_candidate;
2018-01-29 00:29:38 +01:00
}
}
}
if ($config->after_method_checks) {
$file_manipulations = [];
$appearing_method_id = $codebase->methods->getAppearingMethodId($method_id);
$declaring_method_id = $codebase->methods->getDeclaringMethodId($method_id);
if ($appearing_method_id && $declaring_method_id) {
foreach ($config->after_method_checks as $plugin_fq_class_name) {
$plugin_fq_class_name::afterMethodCallAnalysis(
$stmt,
$method_id,
$appearing_method_id,
$declaring_method_id,
$context,
$source,
$codebase,
$file_manipulations,
$return_type_candidate
);
}
}
if ($file_manipulations) {
/** @psalm-suppress MixedTypeCoercion */
FileManipulationBuffer::add($statements_analyzer->getFilePath(), $file_manipulations);
}
2018-01-29 00:29:38 +01:00
}
if ($return_type_candidate) {
if (!$return_type) {
$return_type = $return_type_candidate;
} else {
$return_type = Type::combineUnionTypes($return_type_candidate, $return_type);
}
} else {
$return_type = Type::getMixed();
}
}
/**
* @return array<string, array{Type\Union, string|null, ?int}>|null
*/
public static function getClassTemplateParams(
Codebase $codebase,
ClassLikeStorage $class_storage,
string $fq_class_name,
string $method_name = null,
Type\Atomic $lhs_type_part = null,
string $lhs_var_id = null
) {
$calling_class_storage = $codebase->classlike_storage_provider->get($fq_class_name);
$template_types = $class_storage->template_types;
if (!$template_types) {
if ($calling_class_storage->template_type_extends
&& $method_name
&& !empty($class_storage->overridden_method_ids[$method_name])
&& !isset($class_storage->methods[$method_name]->return_type)
) {
foreach ($class_storage->overridden_method_ids[$method_name] as $overridden_method_id) {
$overridden_storage = $codebase->methods->getStorage($overridden_method_id);
if (!$overridden_storage->return_type) {
return null;
}
if ($overridden_storage->return_type->isNull()) {
return null;
}
list($fq_overridden_class) = explode('::', $overridden_method_id);
$overridden_class_storage = $codebase->classlike_storage_provider->get($fq_overridden_class);
$template_types = $overridden_class_storage->template_types;
$class_storage = $overridden_class_storage;
}
}
if (!$template_types) {
return null;
}
2018-01-29 00:29:38 +01:00
}
$class_template_params = [];
$e = $calling_class_storage->template_type_extends;
if ($lhs_type_part instanceof TGenericObject) {
if ($calling_class_storage->template_types && $class_storage === $calling_class_storage) {
$i = 0;
foreach ($calling_class_storage->template_types as $type_name => $_) {
if (isset($lhs_type_part->type_params[$i])) {
$class_template_params[$type_name] = [
$lhs_type_part->type_params[$i],
$calling_class_storage->name,
0,
];
}
2018-01-29 00:29:38 +01:00
$i++;
2018-01-29 00:29:38 +01:00
}
}
$i = 0;
foreach ($template_types as $type_name => $_) {
if (isset($class_template_params[$type_name])) {
$i++;
continue;
}
2018-01-29 00:29:38 +01:00
if ($class_storage !== $calling_class_storage
&& isset($e[strtolower($class_storage->name)][$type_name])
) {
$type_extends = $e[strtolower($class_storage->name)][$type_name];
2019-02-22 03:40:06 +01:00
if ($type_extends instanceof Type\Atomic\TTemplateParam) {
if (isset($calling_class_storage->template_types[$type_extends->param_name])) {
$mapped_offset = array_search(
$type_extends->param_name,
array_keys($calling_class_storage->template_types)
);
2019-01-28 18:27:04 +01:00
if (isset($lhs_type_part->type_params[(int) $mapped_offset])) {
$class_template_params[$type_name] = [
$lhs_type_part->type_params[(int) $mapped_offset],
$class_storage->name,
0,
2019-01-28 18:27:04 +01:00
];
}
2019-01-13 00:18:23 +01:00
} elseif ($type_extends->defining_class
&& isset(
$calling_class_storage
->template_type_extends
[strtolower($type_extends->defining_class)]
[$type_extends->param_name]
)
) {
$mapped_offset = array_search(
$type_extends->param_name,
array_keys($calling_class_storage
->template_type_extends
[strtolower($type_extends->defining_class)])
);
2019-01-28 18:27:04 +01:00
if (isset($lhs_type_part->type_params[(int) $mapped_offset])) {
$class_template_params[$type_name] = [
$lhs_type_part->type_params[(int) $mapped_offset],
$class_storage->name,
0,
2019-01-28 18:27:04 +01:00
];
}
}
} else {
$class_template_params[$type_name] = [
new Type\Union([$type_extends]),
$class_storage->name,
0,
];
}
}
if (!isset($class_template_params[$type_name])) {
$class_template_params[$type_name] = [Type::getMixed(), null, 0];
}
2018-01-29 00:29:38 +01:00
$i++;
}
} else {
foreach ($template_types as $type_name => list($type)) {
if ($class_storage !== $calling_class_storage
&& isset($e[strtolower($class_storage->name)][$type_name])
) {
$type_extends = $e[strtolower($class_storage->name)][$type_name];
2019-02-22 03:40:06 +01:00
if (!$type_extends instanceof Type\Atomic\TTemplateParam) {
$class_template_params[$type_name] = [
new Type\Union([$type_extends]),
$class_storage->name,
0,
];
} else {
$class_template_params[$type_name] = [
$type_extends->as,
$class_storage->name,
0,
];
}
}
if ($lhs_var_id !== '$this') {
if (!isset($class_template_params[$type_name])) {
$class_template_params[$type_name] = [$type, $class_storage->name, 0];
}
}
}
2018-01-29 00:29:38 +01:00
}
return $class_template_params;
2018-01-29 00:29:38 +01:00
}
/**
* Check properties accessed with magic getters and setters.
* If `@psalm-seal-properties` is set, they must be defined.
* If an `@property` annotation is specified, the setter must set something with the correct
* type.
*
2018-11-11 18:01:14 +01:00
* @param StatementsAnalyzer $statements_analyzer
* @param PhpParser\Node\Expr\MethodCall $stmt
* @param string $fq_class_name
*
* @return bool
*/
private static function checkMagicGetterOrSetterProperty(
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
PhpParser\Node\Expr\MethodCall $stmt,
$fq_class_name
) {
if (!$stmt->name instanceof PhpParser\Node\Identifier) {
return true;
}
$method_name = strtolower($stmt->name->name);
if (!in_array($method_name, ['__get', '__set'], true)) {
return true;
}
$first_arg_value = $stmt->args[0]->value;
if (!$first_arg_value instanceof PhpParser\Node\Scalar\String_) {
return true;
}
$prop_name = $first_arg_value->value;
$property_id = $fq_class_name . '::$' . $prop_name;
2018-11-11 18:01:14 +01:00
$codebase = $statements_analyzer->getCodebase();
2018-11-06 03:57:36 +01:00
$class_storage = $codebase->classlike_storage_provider->get($fq_class_name);
switch ($method_name) {
case '__set':
// If `@psalm-seal-properties` is set, the property must be defined with
// a `@property` annotation
if ($class_storage->sealed_properties
&& !isset($class_storage->pseudo_property_set_types['$' . $prop_name])
&& IssueBuffer::accepts(
new UndefinedThisPropertyAssignment(
'Instance property ' . $property_id . ' is not defined',
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt),
$property_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)
) {
return false;
}
// If a `@property` annotation is set, the type of the value passed to the
// magic setter must match the annotation.
$second_arg_type = isset($stmt->args[1]->value->inferredType)
? $stmt->args[1]->value->inferredType
: null;
if (isset($class_storage->pseudo_property_set_types['$' . $prop_name]) && $second_arg_type) {
2018-11-06 03:57:36 +01:00
$pseudo_set_type = ExpressionAnalyzer::fleshOutType(
$codebase,
$class_storage->pseudo_property_set_types['$' . $prop_name],
$fq_class_name,
new Type\Atomic\TNamedObject($fq_class_name)
);
2018-11-06 03:57:36 +01:00
$type_match_found = TypeAnalyzer::isContainedBy(
$codebase,
$second_arg_type,
$pseudo_set_type,
$second_arg_type->ignore_nullable_issues,
$second_arg_type->ignore_falsable_issues,
$has_scalar_match,
$type_coerced,
$type_coerced_from_mixed,
$to_string_cast
);
if ($type_coerced) {
if ($type_coerced_from_mixed) {
if (IssueBuffer::accepts(
new MixedTypeCoercion(
$prop_name . ' expects \'' . $pseudo_set_type . '\', '
. ' parent type `' . $second_arg_type . '` provided',
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// keep soldiering on
}
} else {
if (IssueBuffer::accepts(
new TypeCoercion(
$prop_name . ' expects \'' . $pseudo_set_type . '\', '
. ' parent type `' . $second_arg_type . '` provided',
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// keep soldiering on
}
}
}
if (!$type_match_found && !$type_coerced_from_mixed) {
2018-11-06 03:57:36 +01:00
if (TypeAnalyzer::canBeContainedBy(
$codebase,
$second_arg_type,
$pseudo_set_type
)) {
if (IssueBuffer::accepts(
new PossiblyInvalidPropertyAssignmentValue(
$prop_name . ' with declared type \''
. $pseudo_set_type
. '\' cannot be assigned possibly different type \'' . $second_arg_type . '\'',
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt),
$property_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
return false;
}
} else {
if (IssueBuffer::accepts(
new InvalidPropertyAssignmentValue(
$prop_name . ' with declared type \''
. $pseudo_set_type
. '\' cannot be assigned type \'' . $second_arg_type . '\'',
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt),
$property_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
return false;
}
}
}
}
break;
case '__get':
// If `@psalm-seal-properties` is set, the property must be defined with
// a `@property` annotation
if ($class_storage->sealed_properties
&& !isset($class_storage->pseudo_property_get_types['$' . $prop_name])
&& IssueBuffer::accepts(
new UndefinedThisPropertyFetch(
'Instance property ' . $property_id . ' is not defined',
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt),
$property_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)
) {
return false;
}
2018-05-09 04:01:05 +02:00
if (isset($class_storage->pseudo_property_get_types['$' . $prop_name])) {
$stmt->inferredType = clone $class_storage->pseudo_property_get_types['$' . $prop_name];
}
break;
}
return true;
}
2018-01-29 00:29:38 +01:00
}