1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-11 08:49:52 +01:00
psalm/src/Psalm/Internal/Analyzer/FunctionLikeAnalyzer.php

1863 lines
65 KiB
PHP
Raw Normal View History

2016-08-14 05:26:45 +02:00
<?php
2018-11-06 03:57:36 +01:00
namespace Psalm\Internal\Analyzer;
2016-08-14 05:26:45 +02:00
use PhpParser;
use PhpParser\Node\Expr\ArrowFunction;
2016-10-15 06:12:57 +02:00
use PhpParser\Node\Expr\Closure;
use PhpParser\Node\Stmt\ClassMethod;
2016-11-02 07:29:00 +01:00
use PhpParser\Node\Stmt\Function_;
2018-11-06 03:57:36 +01:00
use Psalm\Codebase;
use Psalm\Internal\Analyzer\FunctionLike\ReturnTypeAnalyzer;
use Psalm\Internal\Analyzer\FunctionLike\ReturnTypeCollector;
use Psalm\Internal\Analyzer\Statements\ExpressionAnalyzer;
2020-07-22 01:40:35 +02:00
use Psalm\Internal\Type\Comparator\TypeComparisonResult;
use Psalm\Internal\Type\Comparator\UnionTypeComparator;
use Psalm\CodeLocation;
2016-11-02 07:29:00 +01:00
use Psalm\Context;
use Psalm\Internal\FileManipulation\FunctionDocblockManipulator;
2019-02-27 22:00:44 +01:00
use Psalm\Issue\InvalidDocblockParamName;
use Psalm\Issue\InvalidParamDefault;
use Psalm\Issue\MismatchingDocblockParamType;
use Psalm\Issue\MissingClosureParamType;
use Psalm\Issue\MissingParamType;
use Psalm\Issue\MissingThrowsDocblock;
use Psalm\Issue\ReferenceConstraintViolation;
use Psalm\Issue\ReservedWord;
use Psalm\Issue\UnusedClosureParam;
use Psalm\Issue\UnusedParam;
2016-11-02 07:29:00 +01:00
use Psalm\IssueBuffer;
2016-08-14 05:26:45 +02:00
use Psalm\StatementsSource;
use Psalm\Storage\FunctionLikeParameter;
2017-09-04 02:52:54 +02:00
use Psalm\Storage\FunctionLikeStorage;
use Psalm\Storage\MethodStorage;
2016-08-14 05:26:45 +02:00
use Psalm\Type;
use Psalm\Type\Atomic\TNamedObject;
use function md5;
use function strtolower;
use function array_merge;
use function array_filter;
use function array_key_exists;
use function substr;
use function strpos;
use function array_search;
use function array_keys;
use function end;
2020-05-22 04:47:58 +02:00
use Psalm\Internal\Taint\TaintNode;
use Psalm\Storage\FunctionStorage;
2016-08-14 05:26:45 +02:00
/**
* @internal
*/
abstract class FunctionLikeAnalyzer extends SourceAnalyzer
2016-08-14 05:26:45 +02:00
{
2016-10-14 06:53:43 +02:00
/**
* @var Closure|Function_|ClassMethod|ArrowFunction
2016-10-14 06:53:43 +02:00
*/
2016-08-14 05:26:45 +02:00
protected $function;
2016-10-14 06:53:43 +02:00
2018-11-06 03:57:36 +01:00
/**
* @var Codebase
*/
protected $codebase;
2016-10-14 06:53:43 +02:00
/**
2017-01-07 20:35:07 +01:00
* @var array<string>
2016-10-14 06:53:43 +02:00
*/
2017-01-07 20:35:07 +01:00
protected $suppressed_issues;
2016-10-14 06:53:43 +02:00
/**
* @var bool
*/
2016-08-14 05:26:45 +02:00
protected $is_static = false;
2016-10-14 06:53:43 +02:00
/**
* @var StatementsSource
*/
2016-08-14 05:26:45 +02:00
protected $source;
2016-10-14 06:53:43 +02:00
2016-10-15 06:12:57 +02:00
/**
* @var ?array<string, Type\Union>
2016-10-15 06:12:57 +02:00
*/
2016-08-14 05:26:45 +02:00
protected $return_vars_in_scope = [];
2016-10-15 06:12:57 +02:00
/**
* @var ?array<string, bool>
2016-10-15 06:12:57 +02:00
*/
2016-08-14 05:26:45 +02:00
protected $return_vars_possibly_in_scope = [];
2016-11-01 05:39:41 +01:00
2018-01-14 18:09:40 +01:00
/**
* @var Type\Union|null
*/
private $local_return_type;
2016-11-01 05:39:41 +01:00
/**
* @var array<string, bool>
2016-11-01 05:39:41 +01:00
*/
2016-08-14 05:26:45 +02:00
protected static $no_effects_hashes = [];
/**
* @var bool
*/
public $track_mutations = false;
/**
* @var bool
*/
public $inferred_impure = false;
/**
* @var bool
*/
public $inferred_has_mutation = false;
/**
* @var FunctionLikeStorage
*/
protected $storage;
2016-10-15 06:12:57 +02:00
/**
* @param Closure|Function_|ClassMethod|ArrowFunction $function
2016-10-15 06:12:57 +02:00
*/
protected function __construct($function, SourceAnalyzer $source, FunctionLikeStorage $storage)
2016-08-14 05:26:45 +02:00
{
$this->function = $function;
$this->source = $source;
$this->suppressed_issues = $source->getSuppressedIssues();
2018-11-06 03:57:36 +01:00
$this->codebase = $source->getCodebase();
$this->storage = $storage;
2016-08-14 05:26:45 +02:00
}
2016-11-02 07:29:00 +01:00
/**
2017-01-12 03:37:53 +01:00
* @param bool $add_mutations whether or not to add mutations to this method
* @param ?array<string, bool> $byref_uses
2017-05-27 02:16:18 +02:00
*
2016-11-02 07:29:00 +01:00
* @return false|null
*/
public function analyze(
Context $context,
\Psalm\Internal\Provider\NodeDataProvider $type_provider,
?Context $global_context = null,
bool $add_mutations = false,
?array $byref_uses = null
): ?bool {
$storage = $this->storage;
2016-12-07 20:13:39 +01:00
$function_stmts = $this->function->getStmts() ?: [];
2016-09-02 00:02:09 +02:00
2016-12-07 20:13:39 +01:00
$hash = null;
2018-04-25 20:45:51 +02:00
$real_method_id = null;
$method_id = null;
2016-08-14 05:26:45 +02:00
$cased_method_id = null;
2016-11-02 07:29:00 +01:00
2019-12-18 15:43:15 +01:00
$appearing_class_storage = null;
2017-02-10 02:35:17 +01:00
if ($global_context) {
foreach ($global_context->constants as $const_name => $var_type) {
if (!$context->hasVariable($const_name)) {
$context->vars_in_scope[$const_name] = clone $var_type;
}
}
}
2018-11-06 03:57:36 +01:00
$codebase = $this->codebase;
2018-11-11 18:01:14 +01:00
$project_analyzer = $this->getProjectAnalyzer();
$implemented_docblock_param_types = [];
2018-11-06 03:57:36 +01:00
$classlike_storage_provider = $codebase->classlike_storage_provider;
if ($codebase->track_unused_suppressions && !isset($storage->suppressed_issues[0])) {
foreach ($storage->suppressed_issues as $offset => $issue_name) {
IssueBuffer::addUnusedSuppression($this->getFilePath(), $offset, $issue_name);
}
}
foreach ($storage->docblock_issues as $docblock_issue) {
IssueBuffer::add($docblock_issue);
}
$overridden_method_ids = [];
if ($this->function instanceof ClassMethod) {
if (!$storage instanceof MethodStorage || !$this instanceof MethodAnalyzer) {
throw new \UnexpectedValueException('$storage must be MethodStorage');
}
$real_method_id = $this->getMethodId();
2017-01-12 06:54:41 +01:00
$method_id = $this->getMethodId($context->self);
2017-01-12 06:54:41 +01:00
$fq_class_name = (string)$context->self;
$appearing_class_storage = $classlike_storage_provider->get($fq_class_name);
2017-01-12 03:37:53 +01:00
if ($add_mutations) {
if (!$context->collect_initializations) {
$hash = md5($real_method_id . '::' . $context->getScopeSummary());
2016-08-14 05:26:45 +02:00
// if we know that the function has no effects on vars, we don't bother rechecking
if (isset(self::$no_effects_hashes[$hash])) {
return null;
}
2016-11-07 05:29:54 +01:00
}
2016-12-07 20:13:39 +01:00
} elseif ($context->self) {
if ($appearing_class_storage->template_types) {
$template_params = [];
foreach ($appearing_class_storage->template_types as $param_name => $template_map) {
$key = array_keys($template_map)[0];
$template_params[] = new Type\Union([
new Type\Atomic\TTemplateParam(
$param_name,
2019-11-08 18:49:53 +01:00
\reset($template_map)[0],
$key
)
]);
}
$this_object_type = new Type\Atomic\TGenericObject(
$context->self,
$template_params
);
$this_object_type->was_static = !$storage->final;
} else {
$this_object_type = new TNamedObject($context->self);
$this_object_type->was_static = !$storage->final;
}
$context->vars_in_scope['$this'] = new Type\Union([$this_object_type]);
2020-07-23 08:40:35 +02:00
if ($storage->external_mutation_free
&& !$storage->mutation_free_inferred
) {
2020-03-14 06:09:12 +01:00
$context->vars_in_scope['$this']->reference_free = true;
2020-03-14 06:09:12 +01:00
if ($this->function->name->name !== '__construct') {
$context->vars_in_scope['$this']->allow_mutations = false;
}
}
2017-02-08 08:23:17 +01:00
$context->vars_possibly_in_scope['$this'] = true;
2016-12-07 20:13:39 +01:00
}
2016-11-07 05:29:54 +01:00
if ($appearing_class_storage->has_visitor_issues) {
return null;
}
$cased_method_id = $fq_class_name . '::' . $storage->cased_name;
2018-02-04 00:52:35 +01:00
$overridden_method_ids = $codebase->methods->getOverriddenMethodIds($method_id);
if ($this->function->name->name === '__construct') {
$context->inside_constructor = true;
}
$codeLocation = new CodeLocation(
$this,
$this->function,
null,
true
);
if ($overridden_method_ids
&& !$context->collect_initializations
&& !$context->collect_mutations
) {
foreach ($overridden_method_ids as $overridden_method_id) {
2018-02-04 00:52:35 +01:00
$parent_method_storage = $codebase->methods->getStorage($overridden_method_id);
$overridden_fq_class_name = $overridden_method_id->fq_class_name;
2016-12-07 20:13:39 +01:00
$parent_storage = $classlike_storage_provider->get($overridden_fq_class_name);
2016-12-07 20:13:39 +01:00
if ($this->function->name->name === '__construct'
&& !$parent_storage->preserve_constructor_signature
) {
continue;
}
$implementer_visibility = $storage->visibility;
$implementer_appearing_method_id = $codebase->methods->getAppearingMethodId($method_id);
$implementer_declaring_method_id = $real_method_id;
$declaring_class_storage = $appearing_class_storage;
if ($implementer_appearing_method_id
&& $implementer_appearing_method_id !== $implementer_declaring_method_id
) {
$appearing_fq_class_name = $implementer_appearing_method_id->fq_class_name;
$appearing_method_name = $implementer_appearing_method_id->method_name;
$declaring_fq_class_name = $implementer_declaring_method_id->fq_class_name;
$appearing_class_storage = $classlike_storage_provider->get(
$appearing_fq_class_name
);
$declaring_class_storage = $classlike_storage_provider->get(
$declaring_fq_class_name
);
if (isset($appearing_class_storage->trait_visibility_map[$appearing_method_name])) {
$implementer_visibility
= $appearing_class_storage->trait_visibility_map[$appearing_method_name];
}
}
// we've already checked this in the class checker
if (!isset($appearing_class_storage->class_implements[strtolower($overridden_fq_class_name)])) {
2020-03-12 04:38:49 +01:00
MethodComparator::compare(
$codebase,
2020-08-14 21:25:21 +02:00
\count($overridden_method_ids) === 1 ? $this->function : null,
$declaring_class_storage,
$parent_storage,
$storage,
$parent_method_storage,
$fq_class_name,
$implementer_visibility,
$codeLocation,
$storage->suppressed_issues
);
}
foreach ($parent_method_storage->params as $i => $guide_param) {
2018-12-21 17:01:24 +01:00
if ($guide_param->type
&& (!$guide_param->signature_type
|| ($guide_param->signature_type !== $guide_param->type
&& $storage->inheritdoc)
|| !$parent_storage->user_defined
)
) {
if (!isset($implemented_docblock_param_types[$i])) {
$implemented_docblock_param_types[$i] = $guide_param->type;
}
}
}
}
2016-12-07 20:13:39 +01:00
}
2018-11-06 03:57:36 +01:00
MethodAnalyzer::checkMethodSignatureMustOmitReturnType($storage, $codeLocation);
if (!$context->calling_method_id || !$context->collect_initializations) {
$context->calling_method_id = strtolower((string) $method_id);
}
} elseif ($this->function instanceof Function_) {
$function_name = $this->function->name->name;
$namespace_prefix = $this->getNamespace();
$cased_method_id = ($namespace_prefix !== null ? $namespace_prefix . '\\' : '') . $function_name;
$context->calling_function_id = strtolower($cased_method_id);
} else { // Closure
if ($storage->return_type) {
2020-05-11 04:45:01 +02:00
$closure_return_type = \Psalm\Internal\Type\TypeExpander::expandUnion(
2018-11-06 03:57:36 +01:00
$codebase,
$storage->return_type,
$context->self,
$context->self,
$this->getParentFQCLN()
);
} else {
$closure_return_type = Type::getMixed();
}
$closure_type = new Type\Atomic\TFn(
'Closure',
$storage->params,
$closure_return_type
);
if ($storage instanceof FunctionStorage) {
$closure_type->byref_uses = $storage->byref_uses;
2020-08-26 22:51:22 +02:00
$closure_type->is_pure = $storage->pure;
}
$type_provider->setType(
$this->function,
new Type\Union([
$closure_type,
])
);
2016-12-07 20:13:39 +01:00
}
2016-09-02 00:02:09 +02:00
$this->suppressed_issues = $this->getSource()->getSuppressedIssues() + $storage->suppressed_issues;
if ($storage instanceof MethodStorage && $storage->is_static) {
$this->is_static = true;
}
$statements_analyzer = new StatementsAnalyzer($this, $type_provider);
if ($byref_uses) {
$statements_analyzer->setByRefUses($byref_uses);
}
if ($storage->template_types) {
foreach ($storage->template_types as $param_name => $_) {
$fq_classlike_name = Type::getFQCLNFromString(
$param_name,
$this->getAliases()
);
if ($codebase->classOrInterfaceExists($fq_classlike_name)) {
if (IssueBuffer::accepts(
new ReservedWord(
'Cannot use ' . $param_name . ' as template name since the class already exists',
new CodeLocation($this, $this->function),
'resource'
),
$this->getSuppressedIssues()
)) {
// fall through
}
}
}
}
2017-02-10 02:35:17 +01:00
$template_types = $storage->template_types;
2019-12-18 15:43:15 +01:00
if ($appearing_class_storage && $appearing_class_storage->template_types) {
$template_types = array_merge($template_types ?: [], $appearing_class_storage->template_types);
2017-02-10 02:35:17 +01:00
}
$params = $storage->params;
if ($storage instanceof MethodStorage) {
2019-01-31 23:48:48 +01:00
$non_null_param_types = array_filter(
$storage->params,
function (FunctionLikeParameter $p): bool {
2019-01-31 23:48:48 +01:00
return $p->type !== null && $p->has_docblock_type;
}
);
} else {
$non_null_param_types = array_filter(
$storage->params,
function (FunctionLikeParameter $p): bool {
2019-01-31 23:48:48 +01:00
return $p->type !== null;
}
);
}
if ($storage instanceof MethodStorage
&& $method_id instanceof \Psalm\Internal\MethodIdentifier
&& $overridden_method_ids
) {
$types_without_docblocks = array_filter(
$storage->params,
function (FunctionLikeParameter $p): bool {
return !$p->type || !$p->has_docblock_type;
}
);
if ($types_without_docblocks) {
$params = $codebase->methods->getMethodParams(
$method_id,
$this
);
}
}
2019-06-04 22:36:32 +02:00
if ($codebase->alter_code) {
2019-08-22 16:29:21 +02:00
$this->alterParams($codebase, $storage, $params, $context);
}
2019-06-01 16:32:49 +02:00
2019-08-22 16:29:21 +02:00
foreach ($codebase->methods_to_rename as $original_method_id => $new_method_name) {
if ($this->function instanceof ClassMethod
&& $this instanceof MethodAnalyzer
&& strtolower((string) $this->getMethodId()) === $original_method_id
2019-08-22 16:29:21 +02:00
) {
$file_manipulations = [
new \Psalm\FileManipulation(
(int) $this->function->name->getAttribute('startFilePos'),
(int) $this->function->name->getAttribute('endFilePos') + 1,
$new_method_name
)
];
\Psalm\Internal\FileManipulation\FileManipulationBuffer::add(
$this->getFilePath(),
$file_manipulations
);
}
}
$check_stmts = $this->processParams(
$statements_analyzer,
$storage,
$cased_method_id,
$params,
$context,
$implemented_docblock_param_types,
(bool) $non_null_param_types,
(bool) $template_types
);
if ($storage->pure) {
$context->pure = true;
}
if ($storage->mutation_free
&& $cased_method_id
&& !strpos($cased_method_id, '__construct')
&& !($storage instanceof MethodStorage && $storage->mutation_free_inferred)
) {
2019-08-30 18:36:35 +02:00
$context->mutation_free = true;
}
if ($storage instanceof MethodStorage
&& $storage->external_mutation_free
&& !$storage->mutation_free_inferred
) {
2019-08-30 18:36:35 +02:00
$context->external_mutation_free = true;
}
2019-08-22 16:29:21 +02:00
if ($storage->unused_docblock_params) {
foreach ($storage->unused_docblock_params as $param_name => $param_location) {
if (IssueBuffer::accepts(
new InvalidDocblockParamName(
'Incorrect param name $' . $param_name . ' in docblock for ' . $cased_method_id,
$param_location
)
)) {
2019-06-01 16:32:49 +02:00
}
2019-08-22 16:29:21 +02:00
}
}
2019-06-01 16:32:49 +02:00
if ($storage->signature_return_type && $storage->signature_return_type_location) {
[$start, $end] = $storage->signature_return_type_location->getSelectionBounds();
$codebase->analyzer->addOffsetReference(
$this->getFilePath(),
$start,
$end,
(string) $storage->signature_return_type
);
}
2019-08-22 16:29:21 +02:00
if (ReturnTypeAnalyzer::checkReturnType(
$this->function,
$project_analyzer,
$this,
$storage,
$context
) === false) {
$check_stmts = false;
}
2019-06-01 16:32:49 +02:00
2019-08-22 16:29:21 +02:00
if (!$check_stmts) {
return false;
}
2019-06-01 16:32:49 +02:00
2019-08-22 16:29:21 +02:00
if ($context->collect_initializations || $context->collect_mutations) {
$statements_analyzer->addSuppressedIssues([
'DocblockTypeContradiction',
'InvalidReturnStatement',
'RedundantCondition',
'RedundantConditionGivenDocblockType',
'TypeDoesNotContainNull',
'TypeDoesNotContainType',
'LoopInvalidation',
]);
2019-06-01 16:32:49 +02:00
2019-08-22 16:29:21 +02:00
if ($context->collect_initializations) {
$statements_analyzer->addSuppressedIssues([
'UndefinedInterfaceMethod',
'UndefinedMethod',
'PossiblyUndefinedMethod',
]);
}
2020-02-07 05:10:18 +01:00
} elseif ($cased_method_id && strpos($cased_method_id, '__destruct')) {
$statements_analyzer->addSuppressedIssues([
'InvalidPropertyAssignmentValue',
'PossiblyNullPropertyAssignmentValue',
]);
2019-08-22 16:29:21 +02:00
}
$time = \microtime(true);
$project_analyzer = $statements_analyzer->getProjectAnalyzer();
if ($codebase->alter_code
&& (isset($project_analyzer->getIssuesToFix()['MissingPureAnnotation'])
|| isset($project_analyzer->getIssuesToFix()['MissingImmutableAnnotation']))
) {
$this->track_mutations = true;
} elseif ($this->function instanceof Closure
|| $this->function instanceof ArrowFunction
) {
$this->track_mutations = true;
}
2019-08-22 16:29:21 +02:00
$statements_analyzer->analyze($function_stmts, $context, $global_context, true);
if ($codebase->alter_code
&& isset($project_analyzer->getIssuesToFix()['MissingPureAnnotation'])
&& !$this->inferred_impure
&& ($this->function instanceof Function_
|| $this->function instanceof ClassMethod)
2020-08-24 00:41:31 +02:00
&& $storage->params
&& !$overridden_method_ids
) {
$manipulator = FunctionDocblockManipulator::getForFunction(
$project_analyzer,
$this->source->getFilePath(),
$this->function
);
$yield_types = [];
$inferred_return_types = ReturnTypeCollector::getReturnTypes(
$codebase,
$type_provider,
$function_stmts,
$yield_types,
true
);
$inferred_return_type = $inferred_return_types
? \Psalm\Type::combineUnionTypeArray(
$inferred_return_types,
$codebase
)
: null;
if ($inferred_return_type
&& !$inferred_return_type->isVoid()
&& !$inferred_return_type->isFalse()
&& !$inferred_return_type->isNull()
&& !$inferred_return_type->isSingleIntLiteral()
&& !$inferred_return_type->isSingleStringLiteral()
&& !$inferred_return_type->isTrue()
&& $inferred_return_type->getId() !== 'array<empty, empty>'
) {
$manipulator->makePure();
}
}
if ($this->inferred_has_mutation && $context->self) {
$this->codebase->analyzer->addMutableClass($context->self);
}
if (!$context->collect_initializations
&& !$context->collect_mutations
&& $project_analyzer->debug_performance
&& $cased_method_id
) {
$traverser = new PhpParser\NodeTraverser;
$node_counter = new \Psalm\Internal\PhpVisitor\NodeCounterVisitor();
$traverser->addVisitor($node_counter);
$traverser->traverse($function_stmts);
if ($node_counter->count > 5) {
$time_taken = \microtime(true) - $time;
$codebase->analyzer->addFunctionTiming($cased_method_id, $time_taken / $node_counter->count);
}
}
2019-08-22 16:29:21 +02:00
$this->examineParamTypes($statements_analyzer, $context, $codebase);
foreach ($storage->params as $offset => $function_param) {
// only complain if there's no type defined by a parent type
if (!$function_param->type
&& $function_param->location
&& !isset($implemented_docblock_param_types[$offset])
) {
if ($this->function instanceof Closure
|| $this->function instanceof ArrowFunction
) {
2019-08-22 16:29:21 +02:00
IssueBuffer::accepts(
new MissingClosureParamType(
'Parameter $' . $function_param->name . ' has no provided type',
$function_param->location
),
$storage->suppressed_issues + $this->getSuppressedIssues()
);
} else {
IssueBuffer::accepts(
new MissingParamType(
'Parameter $' . $function_param->name . ' has no provided type',
$function_param->location
),
$storage->suppressed_issues + $this->getSuppressedIssues()
2019-06-01 16:32:49 +02:00
);
}
}
2019-08-22 16:29:21 +02:00
}
if ($this->function instanceof Closure
|| $this->function instanceof ArrowFunction
) {
2019-08-22 16:29:21 +02:00
$this->verifyReturnType(
$function_stmts,
2019-08-22 16:29:21 +02:00
$statements_analyzer,
$storage->return_type,
$this->source->getFQCLN(),
$storage->return_type_location,
$context->has_returned,
2019-08-22 16:29:21 +02:00
$global_context && $global_context->inside_call
);
$closure_yield_types = [];
2019-08-22 16:29:21 +02:00
$closure_return_types = ReturnTypeCollector::getReturnTypes(
$codebase,
$type_provider,
$function_stmts,
2019-08-22 16:29:21 +02:00
$closure_yield_types,
true
);
$closure_return_type = $closure_return_types
? \Psalm\Type::combineUnionTypeArray(
$closure_return_types,
$codebase
)
: null;
$closure_yield_type = $closure_yield_types
? \Psalm\Type::combineUnionTypeArray(
$closure_yield_types,
$codebase
)
: null;
if ($closure_return_type || $closure_yield_type) {
if ($closure_yield_type) {
$closure_return_type = $closure_yield_type;
}
if ($function_type = $statements_analyzer->node_data->getType($this->function)) {
/**
* @var Type\Atomic\TFn
*/
$closure_atomic = \array_values($function_type->getAtomicTypes())[0];
if (($storage->return_type === $storage->signature_return_type)
&& (!$storage->return_type
|| $storage->return_type->hasMixed()
|| UnionTypeComparator::isContainedBy(
$codebase,
$closure_return_type,
$storage->return_type
))
) {
2019-08-22 16:29:21 +02:00
$closure_atomic->return_type = $closure_return_type;
}
$closure_atomic->is_pure = !$this->inferred_impure;
}
2019-08-22 16:29:21 +02:00
}
}
if ($codebase->collect_references
2019-08-22 16:29:21 +02:00
&& !$context->collect_initializations
&& !$context->collect_mutations
2019-08-22 16:29:21 +02:00
&& $codebase->find_unused_variables
&& $context->check_variables
) {
$this->checkParamReferences(
$statements_analyzer,
$storage,
2019-12-18 15:43:15 +01:00
$appearing_class_storage,
2019-08-22 16:29:21 +02:00
$context
);
}
2019-08-22 16:29:21 +02:00
foreach ($storage->throws as $expected_exception => $_) {
2020-01-31 00:00:31 +01:00
if (($expected_exception === 'self'
|| $expected_exception === 'static')
&& $context->self
) {
$expected_exception = $context->self;
}
2019-08-22 16:29:21 +02:00
if (isset($storage->throw_locations[$expected_exception])) {
if (ClassLikeAnalyzer::checkFullyQualifiedClassLikeName(
$statements_analyzer,
$expected_exception,
$storage->throw_locations[$expected_exception],
$context->self,
$context->calling_method_id,
2019-08-22 16:29:21 +02:00
$statements_analyzer->getSuppressedIssues(),
false,
false,
true,
true
)) {
$input_type = new Type\Union([new TNamedObject($expected_exception)]);
$container_type = new Type\Union([new TNamedObject('Exception'), new TNamedObject('Throwable')]);
2020-07-22 01:40:35 +02:00
if (!UnionTypeComparator::isContainedBy($codebase, $input_type, $container_type)) {
2019-08-22 16:29:21 +02:00
if (IssueBuffer::accepts(
new \Psalm\Issue\InvalidThrow(
'Class supplied for @throws ' . $expected_exception
. ' does not implement Throwable',
$storage->throw_locations[$expected_exception],
$expected_exception
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
}
2019-11-15 21:34:25 +01:00
if ($codebase->alter_code) {
$codebase->classlikes->handleDocblockTypeInMigration(
$codebase,
$this,
$input_type,
$storage->throw_locations[$expected_exception],
$context->calling_method_id
2019-11-15 21:34:25 +01:00
);
}
2019-08-22 16:29:21 +02:00
}
}
}
2019-08-22 16:29:21 +02:00
foreach ($statements_analyzer->getUncaughtThrows($context) as $possibly_thrown_exception => $codelocations) {
$is_expected = false;
foreach ($storage->throws as $expected_exception => $_) {
if ($expected_exception === $possibly_thrown_exception
|| $codebase->classExtendsOrImplements($possibly_thrown_exception, $expected_exception)
2019-08-22 16:29:21 +02:00
) {
$is_expected = true;
break;
}
}
2019-08-22 16:29:21 +02:00
if (!$is_expected) {
foreach ($codelocations as $codelocation) {
// issues are suppressed in ThrowAnalyzer, CallAnalyzer, etc.
if (IssueBuffer::accepts(
new MissingThrowsDocblock(
$possibly_thrown_exception . ' is thrown but not caught - please either catch'
. ' or add a @throws annotation',
$codelocation
)
)) {
// fall through
}
}
}
}
if ($codebase->taint
&& $this->function instanceof ClassMethod
&& $cased_method_id
2020-06-19 07:59:45 +02:00
&& $storage->specialize_call
&& isset($context->vars_in_scope['$this'])
&& $context->vars_in_scope['$this']->parent_nodes
) {
$method_source = TaintNode::getForMethodReturn(
(string) $method_id,
$cased_method_id,
$storage->location
);
$codebase->taint->addTaintNode($method_source);
foreach ($context->vars_in_scope['$this']->parent_nodes as $parent_node) {
$codebase->taint->addPath(
$parent_node,
$method_source,
'$this'
);
}
}
2019-08-22 16:29:21 +02:00
if ($add_mutations) {
if ($this->return_vars_in_scope !== null) {
$context->vars_in_scope = TypeAnalyzer::combineKeyedTypes(
$context->vars_in_scope,
$this->return_vars_in_scope
);
2019-08-22 16:29:21 +02:00
}
2019-08-22 16:29:21 +02:00
if ($this->return_vars_possibly_in_scope !== null) {
$context->vars_possibly_in_scope = array_merge(
$context->vars_possibly_in_scope,
$this->return_vars_possibly_in_scope
);
}
2019-06-01 22:57:33 +02:00
2019-08-22 16:29:21 +02:00
foreach ($context->vars_in_scope as $var => $_) {
if (strpos($var, '$this->') !== 0 && $var !== '$this') {
unset($context->vars_in_scope[$var]);
}
}
foreach ($context->vars_possibly_in_scope as $var => $_) {
if (strpos($var, '$this->') !== 0 && $var !== '$this') {
unset($context->vars_possibly_in_scope[$var]);
}
}
if ($hash
&& $real_method_id
&& $this instanceof MethodAnalyzer
&& !$context->collect_initializations
) {
2019-08-22 16:29:21 +02:00
$new_hash = md5($real_method_id . '::' . $context->getScopeSummary());
if ($new_hash === $hash) {
self::$no_effects_hashes[$hash] = true;
}
}
}
$plugin_classes = $codebase->config->after_functionlike_checks;
if ($plugin_classes) {
$file_manipulations = [];
foreach ($plugin_classes as $plugin_fq_class_name) {
if ($plugin_fq_class_name::afterStatementAnalysis(
$this->function,
$storage,
$this,
$codebase,
$file_manipulations
) === false) {
return false;
}
}
if ($file_manipulations) {
\Psalm\Internal\FileManipulation\FileManipulationBuffer::add(
$this->getFilePath(),
$file_manipulations
);
}
}
2019-08-22 16:29:21 +02:00
return null;
}
private function checkParamReferences(
StatementsAnalyzer $statements_analyzer,
FunctionLikeStorage $storage,
?\Psalm\Storage\ClassLikeStorage $class_storage,
Context $context
) : void {
$codebase = $statements_analyzer->getCodebase();
$unused_params = [];
foreach ($statements_analyzer->getUnusedVarLocations() as [$var_name, $original_location]) {
2020-06-24 17:48:27 +02:00
if (!array_key_exists(substr($var_name, 1), $storage->param_lookup)) {
2019-08-22 16:29:21 +02:00
continue;
}
if (strpos($var_name, '$_') === 0 || (strpos($var_name, '$unused') === 0 && $var_name !== '$unused')) {
continue;
}
2020-06-24 17:48:27 +02:00
$position = array_search(substr($var_name, 1), array_keys($storage->param_lookup), true);
2019-08-22 16:29:21 +02:00
if ($position === false) {
throw new \UnexpectedValueException('$position should not be false here');
}
if ($storage->params[$position]->by_ref) {
continue;
}
if (!($storage instanceof MethodStorage)
2019-11-25 21:20:31 +01:00
|| !$storage->cased_name
2019-08-22 16:29:21 +02:00
|| $storage->visibility === ClassLikeAnalyzer::VISIBILITY_PRIVATE
) {
if ($this->function instanceof Closure
|| $this->function instanceof ArrowFunction
) {
2019-08-22 16:29:21 +02:00
if (IssueBuffer::accepts(
new UnusedClosureParam(
'Param ' . $var_name . ' is never referenced in this method',
$original_location
),
$this->getSuppressedIssues()
)) {
// fall through
}
} else {
if (IssueBuffer::accepts(
new UnusedParam(
'Param ' . $var_name . ' is never referenced in this method',
$original_location
),
$this->getSuppressedIssues()
)) {
// fall through
}
}
} else {
$fq_class_name = (string)$context->self;
$class_storage = $codebase->classlike_storage_provider->get($fq_class_name);
$method_name_lc = strtolower($storage->cased_name);
if ($storage->abstract) {
2019-08-22 16:29:21 +02:00
continue;
}
if (isset($class_storage->overridden_method_ids[$method_name_lc])) {
$parent_method_id = end($class_storage->overridden_method_ids[$method_name_lc]);
2019-08-22 16:29:21 +02:00
if ($parent_method_id) {
$parent_method_storage = $codebase->methods->getStorage($parent_method_id);
2019-06-01 22:57:33 +02:00
// if the parent method has a param at that position and isn't abstract
if (!$parent_method_storage->abstract
&& isset($parent_method_storage->params[$position])
) {
continue;
}
2019-08-22 16:29:21 +02:00
}
2019-06-01 22:57:33 +02:00
}
2019-08-22 16:29:21 +02:00
$unused_params[$position] = $original_location;
2019-06-01 22:57:33 +02:00
}
2019-06-01 16:32:49 +02:00
}
2019-08-22 16:29:21 +02:00
if ($storage instanceof MethodStorage
&& $this instanceof MethodAnalyzer
2019-08-22 16:29:21 +02:00
&& $class_storage
2019-11-25 21:20:31 +01:00
&& $storage->cased_name
2019-08-22 16:29:21 +02:00
&& $storage->visibility !== ClassLikeAnalyzer::VISIBILITY_PRIVATE
) {
$method_id_lc = strtolower((string) $this->getMethodId());
2019-08-22 16:29:21 +02:00
foreach ($storage->params as $i => $_) {
if (!isset($unused_params[$i])) {
$codebase->file_reference_provider->addMethodParamUse(
$method_id_lc,
$i,
$method_id_lc
);
2019-06-02 18:02:32 +02:00
2019-08-22 16:29:21 +02:00
$method_name_lc = strtolower($storage->cased_name);
if (!isset($class_storage->overridden_method_ids[$method_name_lc])) {
continue;
}
foreach ($class_storage->overridden_method_ids[$method_name_lc] as $parent_method_id) {
$codebase->file_reference_provider->addMethodParamUse(
strtolower((string) $parent_method_id),
2019-08-22 16:29:21 +02:00
$i,
$method_id_lc
);
}
}
2019-06-02 18:02:32 +02:00
}
}
2019-08-22 16:29:21 +02:00
}
/**
* @param array<int, \Psalm\Storage\FunctionLikeParameter> $params
* @param array<int, Type\Union> $implemented_docblock_param_types
*/
private function processParams(
StatementsAnalyzer $statements_analyzer,
FunctionLikeStorage $storage,
?string $cased_method_id,
array $params,
Context $context,
array $implemented_docblock_param_types,
bool $non_null_param_types,
bool $has_template_types
) : bool {
$check_stmts = true;
$codebase = $statements_analyzer->getCodebase();
$project_analyzer = $statements_analyzer->getProjectAnalyzer();
2019-06-02 18:02:32 +02:00
foreach ($params as $offset => $function_param) {
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
$signature_type = $function_param->signature_type;
$signature_type_location = $function_param->signature_type_location;
2019-02-24 07:33:25 +01:00
if ($signature_type && $signature_type_location && $signature_type->hasObjectType()) {
$referenced_type = $signature_type;
if ($referenced_type->isNullable()) {
$referenced_type = clone $referenced_type;
$referenced_type->removeType('null');
}
[$start, $end] = $signature_type_location->getSelectionBounds();
$codebase->analyzer->addOffsetReference(
$this->getFilePath(),
$start,
$end,
(string) $referenced_type
);
}
2018-02-01 05:27:25 +01:00
if ($signature_type) {
2020-05-11 04:45:01 +02:00
$signature_type = \Psalm\Internal\Type\TypeExpander::expandUnion(
$codebase,
$signature_type,
$context->self,
$context->self,
$this->getParentFQCLN()
);
}
if ($function_param->type) {
2018-12-21 17:01:24 +01:00
$is_signature_type = $function_param->type === $function_param->signature_type;
if ($is_signature_type
&& $storage instanceof MethodStorage
&& $storage->inheritdoc
&& isset($implemented_docblock_param_types[$offset])
) {
$param_type = clone $implemented_docblock_param_types[$offset];
} else {
$param_type = clone $function_param->type;
}
2020-05-11 04:45:01 +02:00
$param_type = \Psalm\Internal\Type\TypeExpander::expandUnion(
2018-11-06 03:57:36 +01:00
$codebase,
$param_type,
$context->self,
$context->self,
$this->getParentFQCLN()
);
if ($function_param->type_location) {
if ($param_type->check(
$this,
$function_param->type_location,
$storage->suppressed_issues,
[],
false,
false,
$this->function instanceof ClassMethod
&& strtolower($this->function->name->name) !== '__construct'
) === false) {
$check_stmts = false;
}
}
} else {
if (!$non_null_param_types && isset($implemented_docblock_param_types[$offset])) {
$param_type = clone $implemented_docblock_param_types[$offset];
2020-05-11 04:45:01 +02:00
$param_type = \Psalm\Internal\Type\TypeExpander::expandUnion(
2018-11-06 03:57:36 +01:00
$codebase,
$param_type,
$context->self,
$context->self,
$this->getParentFQCLN()
);
} else {
$param_type = Type::getMixed();
}
}
if ($param_type->hasTemplate() && $param_type->isSingle()) {
/** @var Type\Atomic\TTemplateParam */
$template_type = \array_values($param_type->getAtomicTypes())[0];
if ($template_type->as->getTemplateTypes()) {
$param_type = $template_type->as;
}
}
$var_type = $param_type;
if ($function_param->is_variadic) {
$var_type = new Type\Union([
2019-10-10 23:46:20 +02:00
new Type\Atomic\TList($param_type),
]);
}
if ($cased_method_id && $codebase->taint) {
2020-05-22 04:47:58 +02:00
$type_source = TaintNode::getForMethodArgument(
$cased_method_id,
$cased_method_id,
$offset,
$function_param->location,
null
);
2020-05-22 04:47:58 +02:00
$var_type->parent_nodes = [$type_source];
}
$context->vars_in_scope['$' . $function_param->name] = $var_type;
2017-07-09 03:19:16 +02:00
$context->vars_possibly_in_scope['$' . $function_param->name] = true;
if ($codebase->find_unused_variables && $function_param->location) {
2018-06-17 02:01:33 +02:00
$context->unreferenced_vars['$' . $function_param->name] = [
$function_param->location->getHash() => $function_param->location
];
}
if ($function_param->by_ref) {
$context->vars_in_scope['$' . $function_param->name]->by_ref = true;
}
$parser_param = $this->function->getParams()[$offset];
if (!$function_param->type_location || !$function_param->location) {
if ($parser_param->default) {
ExpressionAnalyzer::analyze($statements_analyzer, $parser_param->default, $context);
}
continue;
}
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
if ($signature_type) {
2019-07-10 07:35:57 +02:00
$union_comparison_result = new TypeComparisonResult();
2020-07-22 01:40:35 +02:00
if (!UnionTypeComparator::isContainedBy(
2018-06-09 05:54:07 +02:00
$codebase,
$param_type,
$signature_type,
false,
false,
2019-07-10 07:35:57 +02:00
$union_comparison_result
) && !$union_comparison_result->type_coerced_from_mixed
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
) {
2018-11-06 03:57:36 +01:00
if ($codebase->alter_code
2018-11-11 18:01:14 +01:00
&& isset($project_analyzer->getIssuesToFix()['MismatchingDocblockParamType'])
2018-01-07 16:23:02 +01:00
) {
2018-11-11 18:01:14 +01:00
$this->addOrUpdateParamType($project_analyzer, $function_param->name, $signature_type, true);
2018-01-07 16:23:02 +01:00
2018-01-07 18:53:25 +01:00
continue;
2018-01-07 16:23:02 +01:00
}
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
if (IssueBuffer::accepts(
new MismatchingDocblockParamType(
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
'Parameter $' . $function_param->name . ' has wrong type \'' . $param_type .
'\', should be \'' . $signature_type . '\'',
$function_param->type_location
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
),
$storage->suppressed_issues,
true
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
)) {
2019-08-22 16:29:21 +02:00
// do nothing
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
}
if ($signature_type->check(
2018-01-10 04:46:55 +01:00
$this,
$function_param->type_location,
$storage->suppressed_issues,
[],
false
) === false) {
$check_stmts = false;
}
2018-01-10 04:46:55 +01:00
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
continue;
}
2019-08-22 16:29:21 +02:00
}
2019-08-22 16:29:21 +02:00
if ($parser_param->default) {
ExpressionAnalyzer::analyze($statements_analyzer, $parser_param->default, $context);
$default_type = $statements_analyzer->node_data->getType($parser_param->default);
2019-08-22 16:29:21 +02:00
if ($default_type
&& !$default_type->hasMixed()
2020-07-22 01:40:35 +02:00
&& !UnionTypeComparator::isContainedBy(
2018-11-06 03:57:36 +01:00
$codebase,
2019-08-22 16:29:21 +02:00
$default_type,
$param_type,
false,
false,
null,
true
2018-04-10 04:00:36 +02:00
)
) {
2019-08-22 16:29:21 +02:00
if (IssueBuffer::accepts(
new InvalidParamDefault(
'Default value type ' . $default_type->getId() . ' for argument ' . ($offset + 1)
2019-08-22 16:29:21 +02:00
. ' of method ' . $cased_method_id
. ' does not match the given type ' . $param_type->getId(),
2019-08-22 16:29:21 +02:00
$function_param->type_location
)
)) {
// fall through
}
2016-08-14 05:26:45 +02:00
}
}
2019-08-22 16:29:21 +02:00
if ($has_template_types) {
$substituted_type = clone $param_type;
if ($substituted_type->check(
$this->source,
$function_param->type_location,
$this->suppressed_issues,
[],
false
) === false) {
$check_stmts = false;
}
2019-08-22 16:29:21 +02:00
} else {
if ($param_type->isVoid()) {
if (IssueBuffer::accepts(
new ReservedWord(
'Parameter cannot be void',
$function_param->type_location,
'void'
),
$this->suppressed_issues
)) {
// fall through
}
}
2019-08-22 16:29:21 +02:00
if ($param_type->check(
$this->source,
$function_param->type_location,
$this->suppressed_issues,
[],
false
) === false) {
$check_stmts = false;
}
2019-08-22 16:29:21 +02:00
}
if ($codebase->collect_locations) {
2019-08-22 16:29:21 +02:00
if ($function_param->type_location !== $function_param->signature_type_location &&
$function_param->signature_type_location &&
$function_param->signature_type
) {
2019-08-22 16:29:21 +02:00
if ($function_param->signature_type->check(
$this->source,
$function_param->signature_type_location,
$this->suppressed_issues,
[],
false
) === false) {
$check_stmts = false;
}
2019-08-22 16:29:21 +02:00
}
}
2019-08-22 16:29:21 +02:00
if ($function_param->by_ref) {
// register by ref params as having been used, to avoid false positives
// @todo change the assignment analysis *just* for byref params
// so that we don't have to do this
$context->hasVariable('$' . $function_param->name);
}
2019-08-22 16:29:21 +02:00
$statements_analyzer->registerVariable(
'$' . $function_param->name,
$function_param->location,
null
);
}
2019-08-22 16:29:21 +02:00
return $check_stmts;
}
2019-08-22 16:29:21 +02:00
/**
* @param \Psalm\Storage\FunctionLikeParameter[] $params
*/
private function alterParams(
Codebase $codebase,
FunctionLikeStorage $storage,
array $params,
Context $context
) : void {
foreach ($this->function->params as $param) {
$param_name_node = null;
if ($param->type instanceof PhpParser\Node\Name) {
$param_name_node = $param->type;
} elseif ($param->type instanceof PhpParser\Node\NullableType
&& $param->type->type instanceof PhpParser\Node\Name
) {
2019-08-22 16:29:21 +02:00
$param_name_node = $param->type->type;
}
2019-08-22 16:29:21 +02:00
if ($param_name_node) {
$resolved_name = ClassLikeAnalyzer::getFQCLNFromNameObject($param_name_node, $this->getAliases());
2019-08-22 16:29:21 +02:00
$parent_fqcln = $this->getParentFQCLN();
2019-08-22 16:29:21 +02:00
if ($resolved_name === 'self' && $context->self) {
$resolved_name = (string) $context->self;
} elseif ($resolved_name === 'parent' && $parent_fqcln) {
$resolved_name = $parent_fqcln;
}
2019-08-22 16:29:21 +02:00
$codebase->classlikes->handleClassLikeReferenceInMigration(
$codebase,
$this,
$param_name_node,
$resolved_name,
$context->calling_method_id,
2019-11-17 01:59:08 +01:00
false,
true
2019-08-22 16:29:21 +02:00
);
}
}
2019-08-22 16:29:21 +02:00
if ($this->function->returnType) {
$return_name_node = null;
2019-08-22 16:29:21 +02:00
if ($this->function->returnType instanceof PhpParser\Node\Name) {
$return_name_node = $this->function->returnType;
} elseif ($this->function->returnType instanceof PhpParser\Node\NullableType
&& $this->function->returnType->type instanceof PhpParser\Node\Name
) {
$return_name_node = $this->function->returnType->type;
}
2019-08-22 16:29:21 +02:00
if ($return_name_node) {
$resolved_name = ClassLikeAnalyzer::getFQCLNFromNameObject($return_name_node, $this->getAliases());
2019-08-22 16:29:21 +02:00
$parent_fqcln = $this->getParentFQCLN();
2019-08-22 16:29:21 +02:00
if ($resolved_name === 'self' && $context->self) {
$resolved_name = (string) $context->self;
} elseif ($resolved_name === 'parent' && $parent_fqcln) {
$resolved_name = $parent_fqcln;
}
2016-12-07 20:13:39 +01:00
2019-08-22 16:29:21 +02:00
$codebase->classlikes->handleClassLikeReferenceInMigration(
$codebase,
$this,
$return_name_node,
$resolved_name,
$context->calling_method_id,
2019-11-17 01:59:08 +01:00
false,
true
2017-01-12 03:37:53 +01:00
);
}
2019-08-22 16:29:21 +02:00
}
2016-12-07 20:13:39 +01:00
2019-08-22 16:29:21 +02:00
if ($storage->return_type
&& $storage->return_type_location
&& $storage->return_type_location !== $storage->signature_return_type_location
) {
2020-05-11 04:45:01 +02:00
$replace_type = \Psalm\Internal\Type\TypeExpander::expandUnion(
2019-08-22 16:29:21 +02:00
$codebase,
$storage->return_type,
$context->self,
2019-11-15 22:50:43 +01:00
'static',
2019-08-22 16:29:21 +02:00
$this->getParentFQCLN(),
false
);
2016-08-14 05:26:45 +02:00
2019-08-22 16:29:21 +02:00
$codebase->classlikes->handleDocblockTypeInMigration(
$codebase,
$this,
$replace_type,
$storage->return_type_location,
$context->calling_method_id
2019-08-22 16:29:21 +02:00
);
}
2016-11-02 07:29:00 +01:00
2019-08-22 16:29:21 +02:00
foreach ($params as $function_param) {
if ($function_param->type
&& $function_param->type_location
&& $function_param->type_location !== $function_param->signature_type_location
&& $function_param->type_location->file_path === $this->getFilePath()
) {
2020-05-11 04:45:01 +02:00
$replace_type = \Psalm\Internal\Type\TypeExpander::expandUnion(
2019-08-22 16:29:21 +02:00
$codebase,
$function_param->type,
$context->self,
2019-11-15 22:50:43 +01:00
'static',
2019-08-22 16:29:21 +02:00
$this->getParentFQCLN(),
false
);
2019-08-22 16:29:21 +02:00
$codebase->classlikes->handleDocblockTypeInMigration(
$codebase,
$this,
$replace_type,
$function_param->type_location,
$context->calling_method_id
2019-08-22 16:29:21 +02:00
);
2017-01-12 03:37:53 +01:00
}
2016-12-07 20:13:39 +01:00
}
2016-08-14 05:26:45 +02:00
}
/**
* @param array<PhpParser\Node\Stmt> $function_stmts
*
2018-02-22 00:59:31 +01:00
* @return false|null
*/
2018-02-22 00:59:31 +01:00
public function verifyReturnType(
array $function_stmts,
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
?Type\Union $return_type = null,
?string $fq_class_name = null,
?CodeLocation $return_type_location = null,
bool $did_explicitly_return = false,
bool $closure_inside_call = false
) {
2018-11-06 03:57:36 +01:00
ReturnTypeAnalyzer::verifyReturnType(
2018-02-22 00:59:31 +01:00
$this->function,
$function_stmts,
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$statements_analyzer->node_data,
2018-02-22 00:59:31 +01:00
$this,
$return_type,
$fq_class_name,
$return_type_location,
[],
$did_explicitly_return,
$closure_inside_call
2018-02-22 00:59:31 +01:00
);
}
public function addOrUpdateParamType(
2018-11-11 18:01:14 +01:00
ProjectAnalyzer $project_analyzer,
string $param_name,
2018-02-22 00:59:31 +01:00
Type\Union $inferred_return_type,
bool $docblock_only = false
): void {
2018-02-22 00:59:31 +01:00
$manipulator = FunctionDocblockManipulator::getForFunction(
2018-11-11 18:01:14 +01:00
$project_analyzer,
2018-02-22 00:59:31 +01:00
$this->source->getFilePath(),
$this->function
);
$codebase = $project_analyzer->getCodebase();
$is_final = true;
$fqcln = $this->source->getFQCLN();
if ($fqcln !== null && $this->function instanceof ClassMethod) {
$class_storage = $codebase->classlike_storage_provider->get($fqcln);
$is_final = $this->function->isFinal() || $class_storage->final;
}
$allow_native_type = !$docblock_only
&& $codebase->php_major_version >= 7
&& (
$codebase->allow_backwards_incompatible_changes
|| $is_final
|| !$this->function instanceof PhpParser\Node\Stmt\ClassMethod
);
2018-02-22 00:59:31 +01:00
$manipulator->setParamType(
$param_name,
$allow_native_type
2018-02-22 00:59:31 +01:00
? $inferred_return_type->toPhpString(
$this->source->getNamespace(),
$this->source->getAliasedClassesFlipped(),
$this->source->getFQCLN(),
$project_analyzer->getCodebase()->php_major_version,
$project_analyzer->getCodebase()->php_minor_version
2018-02-22 00:59:31 +01:00
) : null,
$inferred_return_type->toNamespacedString(
$this->source->getNamespace(),
$this->source->getAliasedClassesFlipped(),
$this->source->getFQCLN(),
false
),
$inferred_return_type->toNamespacedString(
$this->source->getNamespace(),
$this->source->getAliasedClassesFlipped(),
$this->source->getFQCLN(),
true
)
2018-02-22 00:59:31 +01:00
);
}
2016-08-14 05:26:45 +02:00
/**
* Adds return types for the given function
2016-11-02 07:29:00 +01:00
*
* @param string $return_type
2017-05-27 02:16:18 +02:00
*
2016-08-14 05:26:45 +02:00
*/
public function addReturnTypes(Context $context): void
2016-08-14 05:26:45 +02:00
{
if ($this->return_vars_in_scope !== null) {
$this->return_vars_in_scope = TypeAnalyzer::combineKeyedTypes(
2016-11-02 07:29:00 +01:00
$context->vars_in_scope,
$this->return_vars_in_scope
2016-11-02 07:29:00 +01:00
);
} else {
$this->return_vars_in_scope = $context->vars_in_scope;
2016-08-14 05:26:45 +02:00
}
if ($this->return_vars_possibly_in_scope !== null) {
$this->return_vars_possibly_in_scope = array_merge(
2016-11-02 07:29:00 +01:00
$context->vars_possibly_in_scope,
$this->return_vars_possibly_in_scope
2016-11-02 07:29:00 +01:00
);
} else {
$this->return_vars_possibly_in_scope = $context->vars_possibly_in_scope;
2016-08-14 05:26:45 +02:00
}
}
public function examineParamTypes(
StatementsAnalyzer $statements_analyzer,
Context $context,
Codebase $codebase,
PhpParser\Node $stmt = null
): void {
$storage = $this->getFunctionLikeStorage($statements_analyzer);
2020-06-24 17:51:24 +02:00
foreach ($storage->params as $param) {
if ($param->by_ref && isset($context->vars_in_scope['$' . $param->name]) && !$param->is_variadic) {
$actual_type = $context->vars_in_scope['$' . $param->name];
2020-06-24 17:48:27 +02:00
$param_out_type = $param->out_type ?: $param->type;
if ($param_out_type && !$actual_type->hasMixed() && $param->location) {
2020-07-22 01:40:35 +02:00
if (!UnionTypeComparator::isContainedBy(
$codebase,
$actual_type,
$param_out_type,
$actual_type->ignore_nullable_issues,
$actual_type->ignore_falsable_issues
)
) {
if (IssueBuffer::accepts(
new ReferenceConstraintViolation(
'Variable ' . '$' . $param->name . ' is limited to values of type '
. $param_out_type->getId()
. ' because it is passed by reference, '
. $actual_type->getId() . ' type found. Use @param-out to specify '
. 'a different output type',
$stmt
? new CodeLocation($this, $stmt)
: $param->location
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
}
}
}
}
}
/**
* @return null|string
*/
public function getMethodName()
{
if ($this->function instanceof ClassMethod) {
return (string)$this->function->name;
}
}
public function getCorrectlyCasedMethodId(?string $context_self = null): string
{
if ($this->function instanceof ClassMethod) {
$function_name = (string)$this->function->name;
return ($context_self ?: $this->source->getFQCLN()) . '::' . $function_name;
}
if ($this->function instanceof Function_) {
$namespace = $this->source->getNamespace();
return ($namespace ? $namespace . '\\' : '') . $this->function->name;
}
if (!$this instanceof ClosureAnalyzer) {
throw new \UnexpectedValueException('This is weird');
}
return $this->getClosureId();
}
public function getFunctionLikeStorage(?StatementsAnalyzer $statements_analyzer = null): FunctionLikeStorage
2017-09-04 02:52:54 +02:00
{
2018-11-06 03:57:36 +01:00
$codebase = $this->codebase;
2017-09-04 02:52:54 +02:00
if ($this->function instanceof ClassMethod && $this instanceof MethodAnalyzer) {
$method_id = $this->getMethodId();
2018-02-04 00:52:35 +01:00
$codebase_methods = $codebase->methods;
try {
2018-02-04 00:52:35 +01:00
return $codebase_methods->getStorage($method_id);
} catch (\UnexpectedValueException $e) {
$declaring_method_id = $codebase_methods->getDeclaringMethodId($method_id);
if ($declaring_method_id === null) {
throw new \UnexpectedValueException('Cannot get storage for function that doesnt exist');
}
2017-09-04 02:52:54 +02:00
// happens for fake constructors
2018-02-04 00:52:35 +01:00
return $codebase_methods->getStorage($declaring_method_id);
2017-09-04 02:52:54 +02:00
}
}
if ($this instanceof FunctionAnalyzer) {
$function_id = $this->getFunctionId();
} elseif ($this instanceof ClosureAnalyzer) {
$function_id = $this->getClosureId();
} else {
throw new \UnexpectedValueException('This is weird');
}
2020-05-15 16:18:05 +02:00
return $codebase->functions->getStorage($statements_analyzer, $function_id);
}
2020-05-15 16:18:05 +02:00
/** @return non-empty-string */
public function getId() : string
{
if ($this instanceof MethodAnalyzer) {
return (string) $this->getMethodId();
}
if ($this instanceof FunctionAnalyzer) {
return $this->getFunctionId();
}
if ($this instanceof ClosureAnalyzer) {
return $this->getClosureId();
}
throw new \UnexpectedValueException('This is weird');
2017-09-04 02:52:54 +02:00
}
2016-11-13 00:51:48 +01:00
/**
* @return array<string, string>
*/
public function getAliasedClassesFlipped(): array
2016-11-13 00:51:48 +01:00
{
2018-11-06 03:57:36 +01:00
if ($this->source instanceof NamespaceAnalyzer ||
$this->source instanceof FileAnalyzer ||
$this->source instanceof ClassLikeAnalyzer
) {
2016-11-13 17:24:46 +01:00
return $this->source->getAliasedClassesFlipped();
}
return [];
2016-11-13 00:51:48 +01:00
}
2019-06-06 04:13:33 +02:00
/**
* @return array<string, string>
*/
public function getAliasedClassesFlippedReplaceable(): array
2019-06-06 04:13:33 +02:00
{
if ($this->source instanceof NamespaceAnalyzer ||
$this->source instanceof FileAnalyzer ||
$this->source instanceof ClassLikeAnalyzer
) {
return $this->source->getAliasedClassesFlippedReplaceable();
}
return [];
}
public function getFQCLN(): ?string
2016-08-14 05:26:45 +02:00
{
2017-01-07 20:35:07 +01:00
return $this->source->getFQCLN();
2016-08-14 05:26:45 +02:00
}
public function getClassName(): ?string
2016-08-14 05:26:45 +02:00
{
2017-01-07 20:35:07 +01:00
return $this->source->getClassName();
2016-08-14 05:26:45 +02:00
}
/**
* @return array<string, array<string, array{Type\Union}>>|null
*/
public function getTemplateTypeMap(): ?array
{
if ($this->source instanceof ClassLikeAnalyzer) {
return ($this->source->getTemplateTypeMap() ?: [])
+ ($this->storage->template_types ?: []);
}
return $this->storage->template_types;
}
public function getParentFQCLN(): ?string
2016-08-14 05:26:45 +02:00
{
2017-01-07 20:35:07 +01:00
return $this->source->getParentFQCLN();
2016-08-14 05:26:45 +02:00
}
public function getNodeTypeProvider() : \Psalm\NodeTypeProvider
{
return $this->source->getNodeTypeProvider();
}
public function isStatic(): bool
2016-08-14 05:26:45 +02:00
{
return $this->is_static;
}
public function getSource(): StatementsSource
2016-08-14 05:26:45 +02:00
{
return $this->source;
}
2018-11-06 03:57:36 +01:00
public function getCodebase() : Codebase
{
return $this->codebase;
}
2017-01-07 20:35:07 +01:00
/**
* Get a list of suppressed issues
*
* @return array<string>
*/
public function getSuppressedIssues(): array
2017-01-07 20:35:07 +01:00
{
return $this->suppressed_issues;
}
/**
* @param array<int, string> $new_issues
*
* @return void
*/
public function addSuppressedIssues(array $new_issues)
{
if (isset($new_issues[0])) {
$new_issues = \array_combine($new_issues, $new_issues);
}
$this->suppressed_issues = $new_issues + $this->suppressed_issues;
}
/**
* @param array<int, string> $new_issues
*
* @return void
*/
public function removeSuppressedIssues(array $new_issues)
{
if (isset($new_issues[0])) {
$new_issues = \array_combine($new_issues, $new_issues);
}
$this->suppressed_issues = \array_diff_key($this->suppressed_issues, $new_issues);
}
2017-07-26 22:09:09 +02:00
/**
* Adds a suppressed issue, useful when creating a method checker from scratch
*
*/
public function addSuppressedIssue(string $issue_name): void
2017-07-26 22:09:09 +02:00
{
$this->suppressed_issues[] = $issue_name;
}
public static function clearCache(): void
{
self::$no_effects_hashes = [];
}
public function getLocalReturnType(Type\Union $storage_return_type, bool $final = false): Type\Union
2018-01-14 18:09:40 +01:00
{
if ($this->local_return_type) {
return $this->local_return_type;
}
2020-05-11 04:45:01 +02:00
$this->local_return_type = \Psalm\Internal\Type\TypeExpander::expandUnion(
2018-11-06 03:57:36 +01:00
$this->codebase,
2018-01-14 18:09:40 +01:00
$storage_return_type,
$this->getFQCLN(),
$this->getFQCLN(),
$this->getParentFQCLN(),
true,
true,
$final
2018-01-14 18:09:40 +01:00
);
return $this->local_return_type;
}
2016-08-14 05:26:45 +02:00
}