mirror of
https://github.com/danog/psalm.git
synced 2024-12-14 18:36:58 +01:00
2775 lines
108 KiB
PHP
2775 lines
108 KiB
PHP
<?php
|
|
namespace Psalm\Internal\Visitor;
|
|
|
|
use PhpParser;
|
|
use Psalm\Aliases;
|
|
use Psalm\Internal\Analyzer\ClassAnalyzer;
|
|
use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
|
|
use Psalm\Internal\Analyzer\CommentAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\Expression\CallAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\Expression\IncludeAnalyzer;
|
|
use Psalm\Internal\Analyzer\StatementsAnalyzer;
|
|
use Psalm\Codebase;
|
|
use Psalm\Internal\Codebase\CallMap;
|
|
use Psalm\Internal\Codebase\PropertyMap;
|
|
use Psalm\CodeLocation;
|
|
use Psalm\Config;
|
|
use Psalm\DocComment;
|
|
use Psalm\Exception\DocblockParseException;
|
|
use Psalm\Exception\FileIncludeException;
|
|
use Psalm\Exception\IncorrectDocblockException;
|
|
use Psalm\Exception\TypeParseTreeException;
|
|
use Psalm\FileSource;
|
|
use Psalm\Issue\DuplicateClass;
|
|
use Psalm\Issue\DuplicateFunction;
|
|
use Psalm\Issue\DuplicateMethod;
|
|
use Psalm\Issue\DuplicateParam;
|
|
use Psalm\Issue\InvalidDocblock;
|
|
use Psalm\Issue\MisplacedRequiredParam;
|
|
use Psalm\Issue\MissingDocblockType;
|
|
use Psalm\IssueBuffer;
|
|
use Psalm\Internal\Scanner\FileScanner;
|
|
use Psalm\Storage\ClassLikeStorage;
|
|
use Psalm\Storage\FileStorage;
|
|
use Psalm\Storage\FunctionLikeParameter;
|
|
use Psalm\Storage\FunctionLikeStorage;
|
|
use Psalm\Storage\MethodStorage;
|
|
use Psalm\Storage\PropertyStorage;
|
|
use Psalm\Type;
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
class ReflectorVisitor extends PhpParser\NodeVisitorAbstract implements PhpParser\NodeVisitor, FileSource
|
|
{
|
|
/** @var Aliases */
|
|
private $aliases;
|
|
|
|
/** @var Aliases */
|
|
private $file_aliases;
|
|
|
|
/**
|
|
* @var string[]
|
|
*/
|
|
private $fq_classlike_names = [];
|
|
|
|
/** @var FileScanner */
|
|
private $file_scanner;
|
|
|
|
/** @var Codebase */
|
|
private $codebase;
|
|
|
|
/** @var string */
|
|
private $file_path;
|
|
|
|
/** @var bool */
|
|
private $scan_deep;
|
|
|
|
/** @var Config */
|
|
private $config;
|
|
|
|
/** @var array<string, array{Type\Union, ?string}> */
|
|
private $class_template_types = [];
|
|
|
|
/** @var array<string, array{Type\Union, ?string}> */
|
|
private $function_template_types = [];
|
|
|
|
/** @var FunctionLikeStorage[] */
|
|
private $functionlike_storages = [];
|
|
|
|
/** @var FileStorage */
|
|
private $file_storage;
|
|
|
|
/** @var ClassLikeStorage[] */
|
|
private $classlike_storages = [];
|
|
|
|
/** @var class-string<\Psalm\Plugin\Hook\AfterClassLikeVisitInterface>[] */
|
|
private $after_classlike_check_plugins;
|
|
|
|
/** @var int */
|
|
private $php_major_version;
|
|
|
|
/** @var int */
|
|
private $php_minor_version;
|
|
|
|
/**
|
|
* @var array<string, array<int, string>>
|
|
*/
|
|
private $type_aliases = [];
|
|
|
|
public function __construct(
|
|
Codebase $codebase,
|
|
FileStorage $file_storage,
|
|
FileScanner $file_scanner
|
|
) {
|
|
$this->codebase = $codebase;
|
|
$this->file_scanner = $file_scanner;
|
|
$this->file_path = $file_scanner->file_path;
|
|
$this->scan_deep = $file_scanner->will_analyze;
|
|
$this->config = $codebase->config;
|
|
$this->aliases = $this->file_aliases = new Aliases();
|
|
$this->file_storage = $file_storage;
|
|
$this->after_classlike_check_plugins = $this->config->after_visit_classlikes;
|
|
$this->php_major_version = $codebase->php_major_version;
|
|
$this->php_minor_version = $codebase->php_minor_version;
|
|
}
|
|
|
|
/**
|
|
* @param PhpParser\Node $node
|
|
*
|
|
* @return null|int
|
|
*/
|
|
public function enterNode(PhpParser\Node $node)
|
|
{
|
|
foreach ($node->getComments() as $comment) {
|
|
if ($comment instanceof PhpParser\Comment\Doc) {
|
|
try {
|
|
$type_alias_tokens = CommentAnalyzer::getTypeAliasesFromComment(
|
|
(string) $comment,
|
|
$this->aliases,
|
|
$this->type_aliases
|
|
);
|
|
|
|
foreach ($type_alias_tokens as $type_tokens) {
|
|
// finds issues, if there are any
|
|
Type::parseTokens($type_tokens);
|
|
}
|
|
|
|
$this->type_aliases += $type_alias_tokens;
|
|
} catch (DocblockParseException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
(string)$e->getMessage(),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
// fall through
|
|
}
|
|
} catch (TypeParseTreeException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
(string)$e->getMessage(),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($node instanceof PhpParser\Node\Stmt\Namespace_) {
|
|
$this->file_aliases = $this->aliases;
|
|
$this->aliases = new Aliases(
|
|
$node->name ? implode('\\', $node->name->parts) : '',
|
|
$this->aliases->uses,
|
|
$this->aliases->functions,
|
|
$this->aliases->constants
|
|
);
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\Use_) {
|
|
foreach ($node->uses as $use) {
|
|
$use_path = implode('\\', $use->name->parts);
|
|
|
|
$use_alias = $use->alias ? $use->alias->name : $use->name->getLast();
|
|
|
|
switch ($use->type !== PhpParser\Node\Stmt\Use_::TYPE_UNKNOWN ? $use->type : $node->type) {
|
|
case PhpParser\Node\Stmt\Use_::TYPE_FUNCTION:
|
|
$this->aliases->functions[strtolower($use_alias)] = $use_path;
|
|
break;
|
|
|
|
case PhpParser\Node\Stmt\Use_::TYPE_CONSTANT:
|
|
$this->aliases->constants[$use_alias] = $use_path;
|
|
break;
|
|
|
|
case PhpParser\Node\Stmt\Use_::TYPE_NORMAL:
|
|
$this->aliases->uses[strtolower($use_alias)] = $use_path;
|
|
break;
|
|
}
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\GroupUse) {
|
|
$use_prefix = implode('\\', $node->prefix->parts);
|
|
|
|
foreach ($node->uses as $use) {
|
|
$use_path = $use_prefix . '\\' . implode('\\', $use->name->parts);
|
|
$use_alias = $use->alias ? $use->alias->name : $use->name->getLast();
|
|
|
|
switch ($use->type !== PhpParser\Node\Stmt\Use_::TYPE_UNKNOWN ? $use->type : $node->type) {
|
|
case PhpParser\Node\Stmt\Use_::TYPE_FUNCTION:
|
|
$this->aliases->functions[strtolower($use_alias)] = $use_path;
|
|
break;
|
|
|
|
case PhpParser\Node\Stmt\Use_::TYPE_CONSTANT:
|
|
$this->aliases->constants[$use_alias] = $use_path;
|
|
break;
|
|
|
|
case PhpParser\Node\Stmt\Use_::TYPE_NORMAL:
|
|
$this->aliases->uses[strtolower($use_alias)] = $use_path;
|
|
break;
|
|
}
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\ClassLike) {
|
|
if ($this->registerClassLike($node) === false) {
|
|
return PhpParser\NodeTraverser::STOP_TRAVERSAL;
|
|
}
|
|
} elseif (($node instanceof PhpParser\Node\Expr\New_
|
|
|| $node instanceof PhpParser\Node\Expr\Instanceof_
|
|
|| $node instanceof PhpParser\Node\Expr\StaticPropertyFetch
|
|
|| $node instanceof PhpParser\Node\Expr\ClassConstFetch
|
|
|| $node instanceof PhpParser\Node\Expr\StaticCall)
|
|
&& $node->class instanceof PhpParser\Node\Name
|
|
) {
|
|
$fq_classlike_name = ClassLikeAnalyzer::getFQCLNFromNameObject($node->class, $this->aliases);
|
|
|
|
if (!in_array(strtolower($fq_classlike_name), ['self', 'static', 'parent'], true)) {
|
|
$this->codebase->scanner->queueClassLikeForScanning(
|
|
$fq_classlike_name,
|
|
$this->file_path,
|
|
false,
|
|
!($node instanceof PhpParser\Node\Expr\ClassConstFetch)
|
|
|| !($node->name instanceof PhpParser\Node\Identifier)
|
|
|| strtolower($node->name->name) !== 'class'
|
|
);
|
|
$this->file_storage->referenced_classlikes[strtolower($fq_classlike_name)] = $fq_classlike_name;
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\TryCatch) {
|
|
foreach ($node->catches as $catch) {
|
|
foreach ($catch->types as $catch_type) {
|
|
$catch_fqcln = ClassLikeAnalyzer::getFQCLNFromNameObject($catch_type, $this->aliases);
|
|
|
|
if (!in_array(strtolower($catch_fqcln), ['self', 'static', 'parent'], true)) {
|
|
$this->codebase->scanner->queueClassLikeForScanning($catch_fqcln, $this->file_path);
|
|
$this->file_storage->referenced_classlikes[strtolower($catch_fqcln)] = $catch_fqcln;
|
|
}
|
|
}
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\FunctionLike) {
|
|
$this->registerFunctionLike($node);
|
|
|
|
if (!$this->scan_deep) {
|
|
return PhpParser\NodeTraverser::DONT_TRAVERSE_CHILDREN;
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\Global_) {
|
|
$function_like_storage = end($this->functionlike_storages);
|
|
|
|
if ($function_like_storage) {
|
|
foreach ($node->vars as $var) {
|
|
if ($var instanceof PhpParser\Node\Expr\Variable) {
|
|
if (is_string($var->name) && $var->name !== 'argv' && $var->name !== 'argc') {
|
|
$var_id = '$' . $var->name;
|
|
|
|
$function_like_storage->global_variables[$var_id] = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Expr\FuncCall && $node->name instanceof PhpParser\Node\Name) {
|
|
$function_id = implode('\\', $node->name->parts);
|
|
if (CallMap::inCallMap($function_id)) {
|
|
$this->registerClassMapFunctionCall($function_id, $node);
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\TraitUse) {
|
|
if (!$this->classlike_storages) {
|
|
throw new \LogicException('$this->classlike_storages should not be empty');
|
|
}
|
|
|
|
$storage = $this->classlike_storages[count($this->classlike_storages) - 1];
|
|
|
|
$method_map = $storage->trait_alias_map ?: [];
|
|
$visibility_map = $storage->trait_visibility_map ?: [];
|
|
|
|
foreach ($node->adaptations as $adaptation) {
|
|
if ($adaptation instanceof PhpParser\Node\Stmt\TraitUseAdaptation\Alias) {
|
|
$old_name = strtolower($adaptation->method->name);
|
|
$new_name = $old_name;
|
|
|
|
if ($adaptation->newName) {
|
|
$new_name = strtolower($adaptation->newName->name);
|
|
|
|
if ($new_name !== $old_name) {
|
|
$method_map[$new_name] = $old_name;
|
|
}
|
|
}
|
|
|
|
if ($adaptation->newModifier) {
|
|
switch ($adaptation->newModifier) {
|
|
case 1:
|
|
$visibility_map[$new_name] = ClassLikeAnalyzer::VISIBILITY_PUBLIC;
|
|
break;
|
|
|
|
case 2:
|
|
$visibility_map[$new_name] = ClassLikeAnalyzer::VISIBILITY_PROTECTED;
|
|
break;
|
|
|
|
case 4:
|
|
$visibility_map[$new_name] = ClassLikeAnalyzer::VISIBILITY_PRIVATE;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$storage->trait_alias_map = $method_map;
|
|
$storage->trait_visibility_map = $visibility_map;
|
|
|
|
foreach ($node->traits as $trait) {
|
|
$trait_fqcln = ClassLikeAnalyzer::getFQCLNFromNameObject($trait, $this->aliases);
|
|
$this->codebase->scanner->queueClassLikeForScanning($trait_fqcln, $this->file_path, $this->scan_deep);
|
|
$storage->used_traits[strtolower($trait_fqcln)] = $trait_fqcln;
|
|
$this->file_storage->required_classes[strtolower($trait_fqcln)] = $trait_fqcln;
|
|
}
|
|
|
|
if ($node_comment = $node->getDocComment()) {
|
|
$comments = DocComment::parse((string) $node_comment, 0);
|
|
|
|
if (isset($comments['specials']['template-use'])
|
|
|| isset($comments['specials']['use'])
|
|
) {
|
|
$all_inheritance = array_merge(
|
|
$comments['specials']['template-use'] ?? [],
|
|
$comments['specials']['use'] ?? []
|
|
);
|
|
|
|
foreach ($all_inheritance as $template_line) {
|
|
$this->useTemplatedType($storage, $node, $template_line);
|
|
}
|
|
}
|
|
|
|
if (isset($comments['specials']['template-extends'])
|
|
|| isset($comments['specials']['extends'])
|
|
|| isset($comments['specials']['template-implements'])
|
|
|| isset($comments['specials']['implements'])
|
|
) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'You must use @use or @template-use to parameterize traits',
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
}
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Expr\Include_) {
|
|
$this->visitInclude($node);
|
|
} elseif ($node instanceof PhpParser\Node\Expr\Assign
|
|
|| $node instanceof PhpParser\Node\Expr\AssignOp
|
|
|| $node instanceof PhpParser\Node\Expr\AssignRef
|
|
|| $node instanceof PhpParser\Node\Stmt\For_
|
|
|| $node instanceof PhpParser\Node\Stmt\Foreach_
|
|
|| $node instanceof PhpParser\Node\Stmt\While_
|
|
|| $node instanceof PhpParser\Node\Stmt\Do_
|
|
) {
|
|
if ($doc_comment = $node->getDocComment()) {
|
|
$var_comments = [];
|
|
|
|
try {
|
|
$var_comments = CommentAnalyzer::getTypeFromComment(
|
|
(string)$doc_comment,
|
|
$this->file_scanner,
|
|
$this->aliases,
|
|
null,
|
|
null,
|
|
null,
|
|
$this->type_aliases
|
|
);
|
|
} catch (DocblockParseException $e) {
|
|
// do nothing
|
|
}
|
|
|
|
foreach ($var_comments as $var_comment) {
|
|
$var_type = $var_comment->type;
|
|
$var_type->queueClassLikesForScanning($this->codebase, $this->file_storage);
|
|
}
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\Const_) {
|
|
foreach ($node->consts as $const) {
|
|
$const_type = StatementsAnalyzer::getSimpleType($this->codebase, $const->value, $this->aliases)
|
|
?: Type::getMixed();
|
|
|
|
$fq_const_name = Type::getFQCLNFromString($const->name->name, $this->aliases);
|
|
|
|
if ($this->codebase->register_stub_files || $this->codebase->register_autoload_files) {
|
|
$this->codebase->addGlobalConstantType($fq_const_name, $const_type);
|
|
}
|
|
|
|
$this->file_storage->constants[$fq_const_name] = $const_type;
|
|
$this->file_storage->declaring_constants[$fq_const_name] = $this->file_path;
|
|
}
|
|
} elseif ($this->codebase->register_autoload_files && $node instanceof PhpParser\Node\Stmt\If_) {
|
|
if ($node->cond instanceof PhpParser\Node\Expr\BooleanNot) {
|
|
if ($node->cond->expr instanceof PhpParser\Node\Expr\FuncCall
|
|
&& $node->cond->expr->name instanceof PhpParser\Node\Name
|
|
) {
|
|
if ($node->cond->expr->name->parts === ['function_exists']
|
|
&& isset($node->cond->expr->args[0])
|
|
&& $node->cond->expr->args[0]->value instanceof PhpParser\Node\Scalar\String_
|
|
&& function_exists($node->cond->expr->args[0]->value->value)
|
|
) {
|
|
$reflection_function = new \ReflectionFunction($node->cond->expr->args[0]->value->value);
|
|
|
|
if ($reflection_function->getFileName() !== $this->file_path) {
|
|
return PhpParser\NodeTraverser::DONT_TRAVERSE_CHILDREN;
|
|
}
|
|
}
|
|
|
|
if ($node->cond->expr->name->parts === ['class_exists']
|
|
&& isset($node->cond->expr->args[0])
|
|
&& $node->cond->expr->args[0]->value instanceof PhpParser\Node\Scalar\String_
|
|
&& class_exists($node->cond->expr->args[0]->value->value, false)
|
|
) {
|
|
$reflection_class = new \ReflectionClass($node->cond->expr->args[0]->value->value);
|
|
|
|
if ($reflection_class->getFileName() !== $this->file_path) {
|
|
$this->codebase->scanner->queueClassLikeForScanning(
|
|
$node->cond->expr->args[0]->value->value,
|
|
$this->file_path
|
|
);
|
|
|
|
return PhpParser\NodeTraverser::DONT_TRAVERSE_CHILDREN;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Expr\Yield_ || $node instanceof PhpParser\Node\Expr\YieldFrom) {
|
|
$function_like_storage = end($this->functionlike_storages);
|
|
|
|
if ($function_like_storage) {
|
|
$function_like_storage->has_yield = true;
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Expr\Cast\Object_) {
|
|
$this->codebase->scanner->queueClassLikeForScanning('stdClass', null, false, false);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return null
|
|
*/
|
|
public function leaveNode(PhpParser\Node $node)
|
|
{
|
|
if ($node instanceof PhpParser\Node\Stmt\Namespace_) {
|
|
$this->aliases = $this->file_aliases;
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\ClassLike) {
|
|
if (!$this->fq_classlike_names) {
|
|
throw new \LogicException('$this->fq_classlike_names should not be empty');
|
|
}
|
|
|
|
$fq_classlike_name = array_pop($this->fq_classlike_names);
|
|
|
|
if (PropertyMap::inPropertyMap($fq_classlike_name)) {
|
|
$public_mapped_properties = PropertyMap::getPropertyMap()[strtolower($fq_classlike_name)];
|
|
|
|
if (!$this->classlike_storages) {
|
|
throw new \UnexpectedValueException('$this->classlike_storages cannot be empty');
|
|
}
|
|
|
|
$storage = $this->classlike_storages[count($this->classlike_storages) - 1];
|
|
|
|
foreach ($public_mapped_properties as $property_name => $public_mapped_property) {
|
|
$property_type = Type::parseString($public_mapped_property);
|
|
|
|
$property_type->queueClassLikesForScanning($this->codebase, $this->file_storage);
|
|
|
|
if (!isset($storage->properties[$property_name])) {
|
|
$storage->properties[$property_name] = new PropertyStorage();
|
|
}
|
|
|
|
$storage->properties[$property_name]->type = $property_type;
|
|
$storage->properties[$property_name]->visibility = ClassLikeAnalyzer::VISIBILITY_PUBLIC;
|
|
|
|
$property_id = $fq_classlike_name . '::$' . $property_name;
|
|
|
|
$storage->declaring_property_ids[$property_name] = $fq_classlike_name;
|
|
$storage->appearing_property_ids[$property_name] = $property_id;
|
|
}
|
|
}
|
|
|
|
if (!$this->classlike_storages) {
|
|
throw new \LogicException('$this->classlike_storages should not be empty');
|
|
}
|
|
|
|
$classlike_storage = array_pop($this->classlike_storages);
|
|
|
|
if ($classlike_storage->has_visitor_issues) {
|
|
$this->file_storage->has_visitor_issues = true;
|
|
}
|
|
|
|
if ($classlike_storage->has_docblock_issues) {
|
|
$this->file_storage->has_docblock_issues = true;
|
|
}
|
|
|
|
$this->class_template_types = [];
|
|
|
|
if ($this->after_classlike_check_plugins) {
|
|
$file_manipulations = [];
|
|
|
|
foreach ($this->after_classlike_check_plugins as $plugin_fq_class_name) {
|
|
$plugin_fq_class_name::afterClassLikeVisit(
|
|
$node,
|
|
$classlike_storage,
|
|
$this,
|
|
$this->codebase,
|
|
$file_manipulations
|
|
);
|
|
}
|
|
}
|
|
|
|
if (!$this->file_storage->has_visitor_issues) {
|
|
$this->codebase->cacheClassLikeStorage($classlike_storage, $this->file_path);
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\Function_
|
|
|| $node instanceof PhpParser\Node\Stmt\ClassMethod
|
|
) {
|
|
$this->function_template_types = [];
|
|
} elseif ($node instanceof PhpParser\Node\FunctionLike) {
|
|
if (!$this->functionlike_storages) {
|
|
throw new \UnexpectedValueException('There should be function storages');
|
|
}
|
|
|
|
$functionlike_storage = array_pop($this->functionlike_storages);
|
|
|
|
if ($functionlike_storage->has_visitor_issues) {
|
|
$this->file_storage->has_visitor_issues = true;
|
|
}
|
|
|
|
if ($functionlike_storage->has_docblock_issues) {
|
|
$this->file_storage->has_docblock_issues = true;
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
private function registerClassMapFunctionCall(
|
|
string $function_id,
|
|
PhpParser\Node\Expr\FuncCall $node
|
|
) {
|
|
$function_params = CallMap::getParamsFromCallMap($function_id);
|
|
|
|
if ($function_params) {
|
|
foreach ($function_params as $function_param_group) {
|
|
foreach ($function_param_group as $function_param) {
|
|
if ($function_param->type) {
|
|
$function_param->type->queueClassLikesForScanning(
|
|
$this->codebase,
|
|
$this->file_storage
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$return_type = CallMap::getReturnTypeFromCallMap($function_id);
|
|
|
|
$return_type->queueClassLikesForScanning($this->codebase, $this->file_storage);
|
|
|
|
if ($function_id === 'define') {
|
|
$first_arg_value = isset($node->args[0]) ? $node->args[0]->value : null;
|
|
$second_arg_value = isset($node->args[1]) ? $node->args[1]->value : null;
|
|
if ($first_arg_value instanceof PhpParser\Node\Scalar\String_ && $second_arg_value) {
|
|
$const_type = StatementsAnalyzer::getSimpleType(
|
|
$this->codebase,
|
|
$second_arg_value,
|
|
$this->aliases
|
|
) ?: Type::getMixed();
|
|
$const_name = $first_arg_value->value;
|
|
|
|
if ($this->functionlike_storages && !$this->config->hoist_constants) {
|
|
$functionlike_storage =
|
|
$this->functionlike_storages[count($this->functionlike_storages) - 1];
|
|
$functionlike_storage->defined_constants[$const_name] = $const_type;
|
|
} else {
|
|
$this->file_storage->constants[$const_name] = $const_type;
|
|
$this->file_storage->declaring_constants[$const_name] = $this->file_path;
|
|
}
|
|
}
|
|
}
|
|
|
|
$mapping_function_ids = [];
|
|
|
|
if (($function_id === 'array_map' && isset($node->args[0]))
|
|
|| ($function_id === 'array_filter' && isset($node->args[1]))
|
|
) {
|
|
$node_arg_value = $function_id = 'array_map' ? $node->args[0]->value : $node->args[1]->value;
|
|
|
|
if ($node_arg_value instanceof PhpParser\Node\Scalar\String_
|
|
|| $node_arg_value instanceof PhpParser\Node\Expr\Array_
|
|
|| $node_arg_value instanceof PhpParser\Node\Expr\BinaryOp\Concat
|
|
) {
|
|
$mapping_function_ids = CallAnalyzer::getFunctionIdsFromCallableArg(
|
|
$this->file_scanner,
|
|
$node_arg_value
|
|
);
|
|
}
|
|
|
|
foreach ($mapping_function_ids as $potential_method_id) {
|
|
if (strpos($potential_method_id, '::') === false) {
|
|
continue;
|
|
}
|
|
|
|
list($callable_fqcln) = explode('::', $potential_method_id);
|
|
|
|
if (!in_array(strtolower($callable_fqcln), ['self', 'parent', 'static'], true)) {
|
|
$this->codebase->scanner->queueClassLikeForScanning(
|
|
$callable_fqcln,
|
|
$this->file_path
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($function_id === 'func_get_arg'
|
|
|| $function_id === 'func_get_args'
|
|
|| $function_id === 'func_num_args'
|
|
) {
|
|
$function_like_storage = end($this->functionlike_storages);
|
|
|
|
if ($function_like_storage) {
|
|
$function_like_storage->variadic = true;
|
|
}
|
|
}
|
|
|
|
if ($function_id === 'is_a' || $function_id === 'is_subclass_of') {
|
|
$second_arg = $node->args[1]->value ?? null;
|
|
|
|
if ($second_arg instanceof PhpParser\Node\Scalar\String_) {
|
|
$this->codebase->scanner->queueClassLikeForScanning(
|
|
$second_arg->value,
|
|
$this->file_path
|
|
);
|
|
}
|
|
}
|
|
|
|
if ($function_id === 'class_alias') {
|
|
$first_arg = $node->args[0]->value ?? null;
|
|
$second_arg = $node->args[1]->value ?? null;
|
|
|
|
if ($first_arg instanceof PhpParser\Node\Scalar\String_) {
|
|
$first_arg_value = $first_arg->value;
|
|
} elseif ($first_arg instanceof PhpParser\Node\Expr\ClassConstFetch
|
|
&& $first_arg->class instanceof PhpParser\Node\Name
|
|
&& $first_arg->name instanceof PhpParser\Node\Identifier
|
|
&& strtolower($first_arg->name->name) === 'class'
|
|
) {
|
|
/** @var string */
|
|
$first_arg_value = $first_arg->class->getAttribute('resolvedName');
|
|
} else {
|
|
$first_arg_value = null;
|
|
}
|
|
|
|
if ($second_arg instanceof PhpParser\Node\Scalar\String_) {
|
|
$second_arg_value = $second_arg->value;
|
|
} elseif ($second_arg instanceof PhpParser\Node\Expr\ClassConstFetch
|
|
&& $second_arg->class instanceof PhpParser\Node\Name
|
|
&& $second_arg->name instanceof PhpParser\Node\Identifier
|
|
&& strtolower($second_arg->name->name) === 'class'
|
|
) {
|
|
/** @var string */
|
|
$second_arg_value = $second_arg->class->getAttribute('resolvedName');
|
|
} else {
|
|
$second_arg_value = null;
|
|
}
|
|
|
|
if ($first_arg_value && $second_arg_value) {
|
|
$this->codebase->classlikes->addClassAlias(
|
|
$first_arg_value,
|
|
$second_arg_value
|
|
);
|
|
|
|
$this->file_storage->classlike_aliases[strtolower($second_arg_value)] = $first_arg_value;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return false|null
|
|
*/
|
|
private function registerClassLike(PhpParser\Node\Stmt\ClassLike $node)
|
|
{
|
|
$class_location = new CodeLocation($this->file_scanner, $node, null, true);
|
|
|
|
$storage = null;
|
|
|
|
$class_name = null;
|
|
|
|
if ($node->name === null) {
|
|
if (!$node instanceof PhpParser\Node\Stmt\Class_) {
|
|
throw new \LogicException('Anonymous classes are always classes');
|
|
}
|
|
|
|
$fq_classlike_name = ClassAnalyzer::getAnonymousClassName($node, $this->file_path);
|
|
} else {
|
|
$fq_classlike_name =
|
|
($this->aliases->namespace ? $this->aliases->namespace . '\\' : '') . $node->name->name;
|
|
|
|
$class_name = $node->name->name;
|
|
|
|
if ($this->codebase->classlike_storage_provider->has($fq_classlike_name)) {
|
|
$duplicate_storage = $this->codebase->classlike_storage_provider->get($fq_classlike_name);
|
|
|
|
if (!$this->codebase->register_stub_files) {
|
|
if (!$duplicate_storage->location
|
|
|| $duplicate_storage->location->file_path !== $this->file_path
|
|
|| $class_location->getHash() !== $duplicate_storage->location->getHash()
|
|
) {
|
|
if (IssueBuffer::accepts(
|
|
new DuplicateClass(
|
|
'Class ' . $fq_classlike_name . ' has already been defined'
|
|
. ($duplicate_storage->location
|
|
? ' in ' . $duplicate_storage->location->file_path
|
|
: ''),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$this->file_storage->has_visitor_issues = true;
|
|
|
|
$duplicate_storage->has_visitor_issues = true;
|
|
|
|
return false;
|
|
}
|
|
} elseif (!$duplicate_storage->location
|
|
|| $duplicate_storage->location->file_path !== $this->file_path
|
|
|| $class_location->getHash() !== $duplicate_storage->location->getHash()
|
|
) {
|
|
// we're overwriting some methods
|
|
$storage = $duplicate_storage;
|
|
$this->codebase->classlike_storage_provider->makeNew(strtolower($fq_classlike_name));
|
|
$storage->populated = false;
|
|
$storage->class_implements = []; // we do this because reflection reports
|
|
$storage->parent_interfaces = [];
|
|
|
|
foreach ($storage->dependent_classlikes as $dependent_name_lc => $_) {
|
|
$dependent_storage = $this->codebase->classlike_storage_provider->get($dependent_name_lc);
|
|
$dependent_storage->populated = false;
|
|
$this->codebase->classlike_storage_provider->makeNew($dependent_name_lc);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$fq_classlike_name_lc = strtolower($fq_classlike_name);
|
|
|
|
$this->file_storage->classlikes_in_file[$fq_classlike_name_lc] = $fq_classlike_name;
|
|
|
|
$this->fq_classlike_names[] = $fq_classlike_name;
|
|
|
|
if (!$storage) {
|
|
$storage = $this->codebase->classlike_storage_provider->create($fq_classlike_name);
|
|
}
|
|
|
|
if ($class_name
|
|
&& isset($this->aliases->uses[strtolower($class_name)])
|
|
&& $this->aliases->uses[strtolower($class_name)] !== $fq_classlike_name
|
|
) {
|
|
IssueBuffer::add(
|
|
new \Psalm\Issue\ParseError(
|
|
'Class name ' . $class_name . ' clashes with a use statement alias',
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
);
|
|
|
|
$storage->has_visitor_issues = true;
|
|
$this->file_storage->has_visitor_issues = true;
|
|
}
|
|
|
|
$storage->location = $class_location;
|
|
$storage->user_defined = !$this->codebase->register_stub_files;
|
|
$storage->stubbed = $this->codebase->register_stub_files;
|
|
|
|
$doc_comment = $node->getDocComment();
|
|
|
|
$this->classlike_storages[] = $storage;
|
|
|
|
if ($node instanceof PhpParser\Node\Stmt\Class_) {
|
|
$storage->abstract = (bool)$node->isAbstract();
|
|
$storage->final = (bool)$node->isFinal();
|
|
|
|
$this->codebase->classlikes->addFullyQualifiedClassName($fq_classlike_name, $this->file_path);
|
|
|
|
if ($node->extends) {
|
|
$parent_fqcln = ClassLikeAnalyzer::getFQCLNFromNameObject($node->extends, $this->aliases);
|
|
$this->codebase->scanner->queueClassLikeForScanning(
|
|
$parent_fqcln,
|
|
$this->file_path,
|
|
$this->scan_deep
|
|
);
|
|
$parent_fqcln_lc = strtolower($parent_fqcln);
|
|
$storage->parent_classes[$parent_fqcln_lc] = $parent_fqcln_lc;
|
|
$this->file_storage->required_classes[strtolower($parent_fqcln)] = $parent_fqcln;
|
|
}
|
|
|
|
foreach ($node->implements as $interface) {
|
|
$interface_fqcln = ClassLikeAnalyzer::getFQCLNFromNameObject($interface, $this->aliases);
|
|
$this->codebase->scanner->queueClassLikeForScanning($interface_fqcln, $this->file_path);
|
|
$storage->class_implements[strtolower($interface_fqcln)] = $interface_fqcln;
|
|
$this->file_storage->required_interfaces[strtolower($interface_fqcln)] = $interface_fqcln;
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\Interface_) {
|
|
$storage->is_interface = true;
|
|
$this->codebase->classlikes->addFullyQualifiedInterfaceName($fq_classlike_name, $this->file_path);
|
|
|
|
foreach ($node->extends as $interface) {
|
|
$interface_fqcln = ClassLikeAnalyzer::getFQCLNFromNameObject($interface, $this->aliases);
|
|
$this->codebase->scanner->queueClassLikeForScanning($interface_fqcln, $this->file_path);
|
|
$storage->parent_interfaces[strtolower($interface_fqcln)] = $interface_fqcln;
|
|
$this->file_storage->required_interfaces[strtolower($interface_fqcln)] = $interface_fqcln;
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\Trait_) {
|
|
$storage->is_trait = true;
|
|
$this->file_storage->has_trait = true;
|
|
$this->codebase->classlikes->addFullyQualifiedTraitName($fq_classlike_name, $this->file_path);
|
|
$this->codebase->classlikes->addTraitNode(
|
|
$fq_classlike_name,
|
|
$node,
|
|
$this->aliases
|
|
);
|
|
}
|
|
|
|
if ($doc_comment) {
|
|
$docblock_info = null;
|
|
try {
|
|
$docblock_info = CommentAnalyzer::extractClassLikeDocblockInfo(
|
|
(string)$doc_comment,
|
|
$doc_comment->getLine()
|
|
);
|
|
} catch (DocblockParseException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
$e->getMessage() . ' in docblock for ' . implode('.', $this->fq_classlike_names),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
}
|
|
|
|
if ($docblock_info) {
|
|
if ($docblock_info->templates) {
|
|
$storage->template_types = [];
|
|
|
|
foreach ($docblock_info->templates as $template_type) {
|
|
$template_name = $template_type[0];
|
|
if (count($template_type) === 3) {
|
|
if (trim($template_type[2])) {
|
|
try {
|
|
$template_type = Type::parseTokens(
|
|
Type::fixUpLocalType(
|
|
$template_type[2],
|
|
$this->aliases,
|
|
null,
|
|
$this->type_aliases
|
|
)
|
|
);
|
|
} catch (TypeParseTreeException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
$e->getMessage() . ' in docblock for '
|
|
. implode('.', $this->fq_classlike_names),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
continue;
|
|
}
|
|
|
|
if (!$template_type->isSingle()) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'Template type cannot be a union in docblock for '
|
|
. implode('.', $this->fq_classlike_names),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
$storage->has_docblock_issues = true;
|
|
continue;
|
|
}
|
|
}
|
|
|
|
$storage->template_types[$template_name] = [
|
|
$template_type,
|
|
$fq_classlike_name
|
|
];
|
|
} else {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'Template missing as type',
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
}
|
|
} else {
|
|
$storage->template_types[$template_name] = [Type::getMixed(), $fq_classlike_name];
|
|
}
|
|
}
|
|
|
|
$this->class_template_types = $storage->template_types;
|
|
}
|
|
|
|
foreach ($docblock_info->template_extends as $extended_class_name) {
|
|
$this->extendTemplatedType($storage, $node, $extended_class_name);
|
|
}
|
|
|
|
foreach ($docblock_info->template_implements as $implemented_class_name) {
|
|
$this->implementTemplatedType($storage, $node, $implemented_class_name);
|
|
}
|
|
|
|
if ($docblock_info->properties) {
|
|
foreach ($docblock_info->properties as $property) {
|
|
$pseudo_property_type_tokens = Type::fixUpLocalType(
|
|
$property['type'],
|
|
$this->aliases,
|
|
null,
|
|
$this->type_aliases
|
|
);
|
|
|
|
try {
|
|
$pseudo_property_type = Type::parseTokens($pseudo_property_type_tokens);
|
|
$pseudo_property_type->setFromDocblock();
|
|
$pseudo_property_type->queueClassLikesForScanning($this->codebase, $this->file_storage);
|
|
|
|
if ($property['tag'] !== 'property-read') {
|
|
$storage->pseudo_property_set_types[$property['name']] = $pseudo_property_type;
|
|
}
|
|
|
|
if ($property['tag'] !== 'property-write') {
|
|
$storage->pseudo_property_get_types[$property['name']] = $pseudo_property_type;
|
|
}
|
|
} catch (TypeParseTreeException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
$e->getMessage() . ' in docblock for ' . implode('.', $this->fq_classlike_names),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
$storage->deprecated = $docblock_info->deprecated;
|
|
$storage->internal = $docblock_info->internal;
|
|
|
|
$storage->sealed_properties = $docblock_info->sealed_properties;
|
|
$storage->sealed_methods = $docblock_info->sealed_methods;
|
|
|
|
$storage->override_property_visibility = $docblock_info->override_property_visibility;
|
|
$storage->override_method_visibility = $docblock_info->override_method_visibility;
|
|
|
|
$storage->suppressed_issues = $docblock_info->suppressed_issues;
|
|
|
|
foreach ($docblock_info->methods as $method) {
|
|
/** @var MethodStorage */
|
|
$pseudo_method_storage = $this->registerFunctionLike($method, true);
|
|
|
|
if ($pseudo_method_storage->is_static) {
|
|
$storage->pseudo_static_methods[strtolower($method->name->name)] = $pseudo_method_storage;
|
|
} else {
|
|
$storage->pseudo_methods[strtolower($method->name->name)] = $pseudo_method_storage;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
foreach ($node->stmts as $node_stmt) {
|
|
if ($node_stmt instanceof PhpParser\Node\Stmt\ClassConst) {
|
|
$this->visitClassConstDeclaration($node_stmt, $storage, $fq_classlike_name);
|
|
}
|
|
}
|
|
|
|
foreach ($node->stmts as $node_stmt) {
|
|
if ($node_stmt instanceof PhpParser\Node\Stmt\Property) {
|
|
$this->visitPropertyDeclaration($node_stmt, $this->config, $storage, $fq_classlike_name);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
private function extendTemplatedType(
|
|
ClassLikeStorage $storage,
|
|
PhpParser\Node\Stmt\ClassLike $node,
|
|
string $extended_class_name
|
|
) {
|
|
try {
|
|
$extended_union_type = Type::parseTokens(
|
|
Type::fixUpLocalType(
|
|
$extended_class_name,
|
|
$this->aliases,
|
|
$this->class_template_types,
|
|
$this->type_aliases
|
|
),
|
|
null,
|
|
$this->class_template_types
|
|
);
|
|
} catch (TypeParseTreeException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
$e->getMessage() . ' in docblock for ' . implode('.', $this->fq_classlike_names),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
return;
|
|
}
|
|
|
|
if (!$extended_union_type->isSingle()) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'@template-extends cannot be a union type',
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
}
|
|
|
|
foreach ($extended_union_type->getTypes() as $atomic_type) {
|
|
if (!$atomic_type instanceof Type\Atomic\TGenericObject) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'@template-extends has invalid class ' . $atomic_type->getId(),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
$generic_class_lc = strtolower($atomic_type->value);
|
|
|
|
if (!isset($storage->parent_classes[$generic_class_lc])
|
|
&& !isset($storage->parent_interfaces[$generic_class_lc])
|
|
) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'@template-extends must include the name of an extended class,'
|
|
. ' got ' . $atomic_type->getId(),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
}
|
|
|
|
$extended_type_parameters = [];
|
|
|
|
$storage->template_type_extends_count = count($atomic_type->type_params);
|
|
|
|
foreach ($atomic_type->type_params as $type_param) {
|
|
if (!$type_param->isSingle()) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'@template-extends type parameter cannot be a union type',
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
return;
|
|
}
|
|
|
|
foreach ($type_param->getTypes() as $type_param_atomic) {
|
|
$extended_type_parameters[] = $type_param_atomic;
|
|
}
|
|
}
|
|
|
|
if ($extended_type_parameters) {
|
|
$storage->template_type_extends[$generic_class_lc] = $extended_type_parameters;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
private function implementTemplatedType(
|
|
ClassLikeStorage $storage,
|
|
PhpParser\Node\Stmt\ClassLike $node,
|
|
string $implemented_class_name
|
|
) {
|
|
try {
|
|
$implemented_union_type = Type::parseTokens(
|
|
Type::fixUpLocalType(
|
|
$implemented_class_name,
|
|
$this->aliases,
|
|
$this->class_template_types,
|
|
$this->type_aliases
|
|
),
|
|
null,
|
|
$this->class_template_types
|
|
);
|
|
} catch (TypeParseTreeException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
$e->getMessage() . ' in docblock for ' . implode('.', $this->fq_classlike_names),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
return;
|
|
}
|
|
|
|
if (!$implemented_union_type->isSingle()) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'@template-implements cannot be a union type',
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
}
|
|
|
|
foreach ($implemented_union_type->getTypes() as $atomic_type) {
|
|
if (!$atomic_type instanceof Type\Atomic\TGenericObject) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'@template-implements has invalid class ' . $atomic_type->getId(),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
$generic_class_lc = strtolower($atomic_type->value);
|
|
|
|
if (!isset($storage->class_implements[$generic_class_lc])) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'@template-implements must include the name of an implemented class,'
|
|
. ' got ' . $atomic_type->getId(),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
}
|
|
|
|
$implemented_type_parameters = [];
|
|
|
|
$storage->template_type_implements_count[$generic_class_lc] = count($atomic_type->type_params);
|
|
|
|
foreach ($atomic_type->type_params as $type_param) {
|
|
if (!$type_param->isSingle()) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'@template-implements type parameter cannot be a union type',
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
return;
|
|
}
|
|
|
|
foreach ($type_param->getTypes() as $type_param_atomic) {
|
|
$implemented_type_parameters[] = $type_param_atomic;
|
|
}
|
|
}
|
|
|
|
if ($implemented_type_parameters) {
|
|
$storage->template_type_extends[$generic_class_lc] = $implemented_type_parameters;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
private function useTemplatedType(
|
|
ClassLikeStorage $storage,
|
|
PhpParser\Node\Stmt\TraitUse $node,
|
|
string $used_class_name
|
|
) {
|
|
try {
|
|
$used_union_type = Type::parseTokens(
|
|
Type::fixUpLocalType(
|
|
$used_class_name,
|
|
$this->aliases,
|
|
$this->class_template_types,
|
|
$this->type_aliases
|
|
),
|
|
null,
|
|
$this->class_template_types
|
|
);
|
|
} catch (TypeParseTreeException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
$e->getMessage() . ' in docblock for ' . implode('.', $this->fq_classlike_names),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
return;
|
|
}
|
|
|
|
if (!$used_union_type->isSingle()) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'@template-use cannot be a union type',
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
}
|
|
|
|
foreach ($used_union_type->getTypes() as $atomic_type) {
|
|
if (!$atomic_type instanceof Type\Atomic\TGenericObject) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'@template-use has invalid class ' . $atomic_type->getId(),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
$generic_class_lc = strtolower($atomic_type->value);
|
|
|
|
if (!isset($storage->used_traits[$generic_class_lc])) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'@template-use must include the name of an used class,'
|
|
. ' got ' . $atomic_type->getId(),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
}
|
|
|
|
$used_type_parameters = [];
|
|
|
|
$storage->template_type_uses_count[$generic_class_lc] = count($atomic_type->type_params);
|
|
|
|
foreach ($atomic_type->type_params as $type_param) {
|
|
if (!$type_param->isSingle()) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'@template-uses type parameter cannot be a union type',
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
return;
|
|
}
|
|
|
|
foreach ($type_param->getTypes() as $type_param_atomic) {
|
|
$used_type_parameters[] = $type_param_atomic;
|
|
}
|
|
}
|
|
|
|
if ($used_type_parameters) {
|
|
$storage->template_type_extends[$generic_class_lc] = $used_type_parameters;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param PhpParser\Node\FunctionLike $stmt
|
|
* @param bool $fake_method in the case of @method annotations we do something a little strange
|
|
*
|
|
* @return FunctionLikeStorage|false
|
|
*/
|
|
private function registerFunctionLike(PhpParser\Node\FunctionLike $stmt, $fake_method = false)
|
|
{
|
|
$class_storage = null;
|
|
$fq_classlike_name = null;
|
|
|
|
if ($fake_method && $stmt instanceof PhpParser\Node\Stmt\ClassMethod) {
|
|
$cased_function_id = '@method ' . $stmt->name->name;
|
|
|
|
$storage = new MethodStorage();
|
|
$storage->defining_fqcln = '';
|
|
$storage->is_static = (bool) $stmt->isStatic();
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Function_) {
|
|
$cased_function_id =
|
|
($this->aliases->namespace ? $this->aliases->namespace . '\\' : '') . $stmt->name->name;
|
|
$function_id = strtolower($cased_function_id);
|
|
|
|
$storage = new FunctionLikeStorage();
|
|
|
|
if ($this->codebase->register_stub_files || $this->codebase->register_autoload_files) {
|
|
if (isset($this->file_storage->functions[$function_id])) {
|
|
$this->codebase->functions->addGlobalFunction(
|
|
$function_id,
|
|
$this->file_storage->functions[$function_id]
|
|
);
|
|
|
|
return $this->file_storage->functions[$function_id];
|
|
}
|
|
} else {
|
|
if (isset($this->file_storage->functions[$function_id])) {
|
|
$duplicate_function_storage = $this->file_storage->functions[$function_id];
|
|
|
|
if ($duplicate_function_storage->location
|
|
&& $duplicate_function_storage->location->getLineNumber() === $stmt->getLine()
|
|
) {
|
|
return $this->file_storage->functions[$function_id];
|
|
}
|
|
|
|
if (IssueBuffer::accepts(
|
|
new DuplicateFunction(
|
|
'Method ' . $function_id . ' has already been defined'
|
|
. ($duplicate_function_storage->location
|
|
? ' in ' . $duplicate_function_storage->location->file_path
|
|
: ''),
|
|
new CodeLocation($this->file_scanner, $stmt, null, true)
|
|
)
|
|
)) {
|
|
// fall through
|
|
}
|
|
|
|
$this->file_storage->has_visitor_issues = true;
|
|
|
|
$duplicate_function_storage->has_visitor_issues = true;
|
|
|
|
return $this->file_storage->functions[$function_id];
|
|
} elseif (isset($this->config->getPredefinedFunctions()[$function_id])) {
|
|
$reflection_function = new \ReflectionFunction($function_id);
|
|
|
|
if ($reflection_function->getFileName() !== $this->file_path) {
|
|
if (IssueBuffer::accepts(
|
|
new DuplicateFunction(
|
|
'Method ' . $function_id . ' has already been defined as a core function',
|
|
new CodeLocation($this->file_scanner, $stmt, null, true)
|
|
)
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($this->codebase->register_stub_files || $this->codebase->register_autoload_files) {
|
|
$this->codebase->functions->addGlobalFunction($function_id, $storage);
|
|
}
|
|
|
|
$this->file_storage->functions[$function_id] = $storage;
|
|
$this->file_storage->declaring_function_ids[$function_id] = strtolower($this->file_path);
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\ClassMethod) {
|
|
if (!$this->fq_classlike_names) {
|
|
throw new \LogicException('$this->fq_classlike_names should not be null');
|
|
}
|
|
|
|
$fq_classlike_name = $this->fq_classlike_names[count($this->fq_classlike_names) - 1];
|
|
|
|
$function_id = $fq_classlike_name . '::' . strtolower($stmt->name->name);
|
|
$cased_function_id = $fq_classlike_name . '::' . $stmt->name->name;
|
|
|
|
if (!$this->classlike_storages) {
|
|
throw new \UnexpectedValueException('$class_storages cannot be empty for ' . $function_id);
|
|
}
|
|
|
|
$class_storage = $this->classlike_storages[count($this->classlike_storages) - 1];
|
|
|
|
$storage = null;
|
|
|
|
if (isset($class_storage->methods[strtolower($stmt->name->name)])) {
|
|
if (!$this->codebase->register_stub_files) {
|
|
$duplicate_method_storage = $class_storage->methods[strtolower($stmt->name->name)];
|
|
|
|
if (IssueBuffer::accepts(
|
|
new DuplicateMethod(
|
|
'Method ' . $function_id . ' has already been defined'
|
|
. ($duplicate_method_storage->location
|
|
? ' in ' . $duplicate_method_storage->location->file_path
|
|
: ''),
|
|
new CodeLocation($this->file_scanner, $stmt, null, true)
|
|
)
|
|
)) {
|
|
// fall through
|
|
}
|
|
|
|
$this->file_storage->has_visitor_issues = true;
|
|
|
|
$duplicate_method_storage->has_visitor_issues = true;
|
|
|
|
return false;
|
|
}
|
|
|
|
$storage = $class_storage->methods[strtolower($stmt->name->name)];
|
|
}
|
|
|
|
if (!$storage) {
|
|
$storage = $class_storage->methods[strtolower($stmt->name->name)] = new MethodStorage();
|
|
}
|
|
|
|
$storage->defining_fqcln = $fq_classlike_name;
|
|
|
|
$class_name_parts = explode('\\', $fq_classlike_name);
|
|
$class_name = array_pop($class_name_parts);
|
|
|
|
if (strtolower($stmt->name->name) === strtolower($class_name) &&
|
|
!isset($class_storage->methods['__construct']) &&
|
|
strpos($fq_classlike_name, '\\') === false
|
|
) {
|
|
$this->codebase->methods->setDeclaringMethodId(
|
|
$fq_classlike_name . '::__construct',
|
|
$function_id
|
|
);
|
|
$this->codebase->methods->setAppearingMethodId(
|
|
$fq_classlike_name . '::__construct',
|
|
$function_id
|
|
);
|
|
}
|
|
|
|
$class_storage->declaring_method_ids[strtolower($stmt->name->name)] = $function_id;
|
|
$class_storage->appearing_method_ids[strtolower($stmt->name->name)] = $function_id;
|
|
|
|
if (!$stmt->isPrivate() || $stmt->name->name === '__construct' || $class_storage->is_trait) {
|
|
$class_storage->inheritable_method_ids[strtolower($stmt->name->name)] = $function_id;
|
|
}
|
|
|
|
if (!isset($class_storage->overridden_method_ids[strtolower($stmt->name->name)])) {
|
|
$class_storage->overridden_method_ids[strtolower($stmt->name->name)] = [];
|
|
}
|
|
|
|
$storage->is_static = (bool) $stmt->isStatic();
|
|
$storage->abstract = (bool) $stmt->isAbstract();
|
|
|
|
$storage->final = $class_storage->final || $stmt->isFinal();
|
|
|
|
if ($stmt->isPrivate()) {
|
|
$storage->visibility = ClassLikeAnalyzer::VISIBILITY_PRIVATE;
|
|
} elseif ($stmt->isProtected()) {
|
|
$storage->visibility = ClassLikeAnalyzer::VISIBILITY_PROTECTED;
|
|
} else {
|
|
$storage->visibility = ClassLikeAnalyzer::VISIBILITY_PUBLIC;
|
|
}
|
|
} else {
|
|
$function_id = $cased_function_id = $this->file_path
|
|
. ':' . $stmt->getLine()
|
|
. ':' . (int) $stmt->getAttribute('startFilePos') . ':-:closure';
|
|
|
|
$storage = $this->file_storage->functions[$function_id] = new FunctionLikeStorage();
|
|
}
|
|
|
|
$this->functionlike_storages[] = $storage;
|
|
|
|
if ($stmt instanceof PhpParser\Node\Stmt\ClassMethod) {
|
|
$storage->cased_name = $stmt->name->name;
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Function_) {
|
|
$storage->cased_name =
|
|
($this->aliases->namespace ? $this->aliases->namespace . '\\' : '') . $stmt->name->name;
|
|
}
|
|
|
|
$storage->location = new CodeLocation($this->file_scanner, $stmt, null, true);
|
|
|
|
$required_param_count = 0;
|
|
$i = 0;
|
|
$has_optional_param = false;
|
|
|
|
$existing_params = [];
|
|
$storage->params = [];
|
|
|
|
/** @var PhpParser\Node\Param $param */
|
|
foreach ($stmt->getParams() as $param) {
|
|
if ($param->var instanceof PhpParser\Node\Expr\Error) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'Param' . ((int) $i + 1) . ' of ' . $cased_function_id . ' has invalid syntax',
|
|
new CodeLocation($this->file_scanner, $param, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
|
|
++$i;
|
|
|
|
continue;
|
|
}
|
|
|
|
$param_array = $this->getTranslatedFunctionParam($param);
|
|
|
|
if (isset($existing_params['$' . $param_array->name])) {
|
|
if (IssueBuffer::accepts(
|
|
new DuplicateParam(
|
|
'Duplicate param $' . $param_array->name . ' in docblock for ' . $cased_function_id,
|
|
new CodeLocation($this->file_scanner, $param, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
|
|
++$i;
|
|
|
|
continue;
|
|
}
|
|
|
|
$existing_params['$' . $param_array->name] = $i;
|
|
$storage->param_types[$param_array->name] = $param_array->type;
|
|
$storage->params[] = $param_array;
|
|
|
|
if (!$param_array->is_optional) {
|
|
$required_param_count = $i + 1;
|
|
|
|
if (!$param->variadic
|
|
&& $has_optional_param
|
|
&& is_string($param->var->name)
|
|
) {
|
|
if (IssueBuffer::accepts(
|
|
new MisplacedRequiredParam(
|
|
'Required param $' . $param->var->name . ' should come before any optional params in ' .
|
|
$cased_function_id,
|
|
new CodeLocation($this->file_scanner, $param, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_visitor_issues = true;
|
|
}
|
|
} else {
|
|
$has_optional_param = true;
|
|
}
|
|
|
|
++$i;
|
|
}
|
|
|
|
$storage->required_param_count = $required_param_count;
|
|
|
|
if (($stmt instanceof PhpParser\Node\Stmt\Function_
|
|
|| $stmt instanceof PhpParser\Node\Stmt\ClassMethod)
|
|
&& strpos($stmt->name->name, 'assert') === 0
|
|
&& $stmt->stmts
|
|
) {
|
|
$var_assertions = [];
|
|
|
|
foreach ($stmt->stmts as $function_stmt) {
|
|
if ($function_stmt instanceof PhpParser\Node\Stmt\If_) {
|
|
$final_actions = \Psalm\Internal\Analyzer\ScopeAnalyzer::getFinalControlActions(
|
|
$function_stmt->stmts,
|
|
$this->config->exit_functions,
|
|
false,
|
|
false
|
|
);
|
|
|
|
if ($final_actions !== [\Psalm\Internal\Analyzer\ScopeAnalyzer::ACTION_END]) {
|
|
$var_assertions = [];
|
|
break;
|
|
}
|
|
|
|
$if_clauses = \Psalm\Type\Algebra::getFormula(
|
|
$function_stmt->cond,
|
|
$this->fq_classlike_names
|
|
? $this->fq_classlike_names[count($this->fq_classlike_names) - 1]
|
|
: null,
|
|
$this->file_scanner,
|
|
null
|
|
);
|
|
|
|
$negated_formula = \Psalm\Type\Algebra::negateFormula($if_clauses);
|
|
|
|
$rules = \Psalm\Type\Algebra::getTruthsFromFormula($negated_formula);
|
|
|
|
if (!$rules) {
|
|
$var_assertions = [];
|
|
break;
|
|
}
|
|
|
|
foreach ($rules as $var_id => $rule) {
|
|
foreach ($rule as $rule_part) {
|
|
if (count($rule_part) > 1) {
|
|
continue 2;
|
|
}
|
|
}
|
|
|
|
if (isset($existing_params[$var_id])) {
|
|
$param_offset = $existing_params[$var_id];
|
|
|
|
$var_assertions[] = new \Psalm\Storage\Assertion(
|
|
$param_offset,
|
|
$rule
|
|
);
|
|
} elseif (strpos($var_id, '$this->') === 0) {
|
|
$var_assertions[] = new \Psalm\Storage\Assertion(
|
|
$var_id,
|
|
$rule
|
|
);
|
|
}
|
|
}
|
|
} else {
|
|
$var_assertions = [];
|
|
break;
|
|
}
|
|
}
|
|
|
|
$storage->assertions = $var_assertions;
|
|
}
|
|
|
|
if (!$this->scan_deep
|
|
&& ($stmt instanceof PhpParser\Node\Stmt\Function_
|
|
|| $stmt instanceof PhpParser\Node\Stmt\ClassMethod
|
|
|| $stmt instanceof PhpParser\Node\Expr\Closure)
|
|
&& $stmt->stmts
|
|
) {
|
|
// pick up func_get_args that would otherwise be missed
|
|
foreach ($stmt->stmts as $function_stmt) {
|
|
if ($function_stmt instanceof PhpParser\Node\Stmt\Expression
|
|
&& $function_stmt->expr instanceof PhpParser\Node\Expr\Assign
|
|
&& ($function_stmt->expr->expr instanceof PhpParser\Node\Expr\FuncCall)
|
|
&& ($function_stmt->expr->expr->name instanceof PhpParser\Node\Name)
|
|
) {
|
|
$function_id = implode('\\', $function_stmt->expr->expr->name->parts);
|
|
|
|
if ($function_id === 'func_get_arg'
|
|
|| $function_id === 'func_get_args'
|
|
|| $function_id === 'func_num_args'
|
|
) {
|
|
$storage->variadic = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$parser_return_type = $stmt->getReturnType();
|
|
|
|
if ($parser_return_type) {
|
|
$suffix = '';
|
|
|
|
if ($parser_return_type instanceof PhpParser\Node\NullableType) {
|
|
$suffix = '|null';
|
|
$parser_return_type = $parser_return_type->type;
|
|
}
|
|
|
|
if ($parser_return_type instanceof PhpParser\Node\Identifier) {
|
|
$return_type_string = $parser_return_type->name . $suffix;
|
|
} else {
|
|
$return_type_fq_classlike_name = ClassLikeAnalyzer::getFQCLNFromNameObject(
|
|
$parser_return_type,
|
|
$this->aliases
|
|
);
|
|
|
|
$return_type_string = $return_type_fq_classlike_name . $suffix;
|
|
}
|
|
|
|
$storage->return_type = Type::parseString(
|
|
$return_type_string,
|
|
[$this->php_major_version, $this->php_minor_version]
|
|
);
|
|
$storage->return_type->queueClassLikesForScanning($this->codebase, $this->file_storage);
|
|
|
|
$storage->return_type_location = new CodeLocation(
|
|
$this->file_scanner,
|
|
$stmt,
|
|
null,
|
|
false,
|
|
CodeLocation::FUNCTION_RETURN_TYPE
|
|
);
|
|
|
|
if ($stmt->returnsByRef()) {
|
|
$storage->return_type->by_ref = true;
|
|
}
|
|
|
|
$storage->signature_return_type = $storage->return_type;
|
|
$storage->signature_return_type_location = $storage->return_type_location;
|
|
}
|
|
|
|
if ($stmt->returnsByRef()) {
|
|
$storage->returns_by_ref = true;
|
|
}
|
|
|
|
$doc_comment = $stmt->getDocComment();
|
|
|
|
if (!$doc_comment) {
|
|
return $storage;
|
|
}
|
|
|
|
try {
|
|
$docblock_info = CommentAnalyzer::extractFunctionDocblockInfo(
|
|
(string)$doc_comment,
|
|
$doc_comment->getLine()
|
|
);
|
|
} catch (IncorrectDocblockException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new MissingDocblockType(
|
|
$e->getMessage() . ' in docblock for ' . $cased_function_id,
|
|
new CodeLocation($this->file_scanner, $stmt, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
$docblock_info = null;
|
|
} catch (DocblockParseException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
$e->getMessage() . ' in docblock for ' . $cased_function_id,
|
|
new CodeLocation($this->file_scanner, $stmt, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
|
|
$docblock_info = null;
|
|
}
|
|
|
|
if (!$docblock_info) {
|
|
return $storage;
|
|
}
|
|
|
|
if ($docblock_info->deprecated) {
|
|
$storage->deprecated = true;
|
|
}
|
|
|
|
if ($docblock_info->internal) {
|
|
$storage->internal = true;
|
|
}
|
|
|
|
if ($docblock_info->variadic) {
|
|
$storage->variadic = true;
|
|
}
|
|
|
|
if ($docblock_info->ignore_nullable_return && $storage->return_type) {
|
|
$storage->return_type->ignore_nullable_issues = true;
|
|
}
|
|
|
|
if ($docblock_info->ignore_falsable_return && $storage->return_type) {
|
|
$storage->return_type->ignore_falsable_issues = true;
|
|
}
|
|
|
|
$storage->suppressed_issues = $docblock_info->suppress;
|
|
|
|
if ($this->config->check_for_throws_docblock) {
|
|
foreach ($docblock_info->throws as $throw_class) {
|
|
$exception_fqcln = Type::getFQCLNFromString(
|
|
$throw_class,
|
|
$this->aliases
|
|
);
|
|
|
|
$this->codebase->scanner->queueClassLikeForScanning($exception_fqcln, $this->file_path);
|
|
$this->file_storage->referenced_classlikes[strtolower($exception_fqcln)] = $exception_fqcln;
|
|
|
|
$storage->throws[$exception_fqcln] = true;
|
|
}
|
|
}
|
|
|
|
if (!$this->config->use_docblock_types) {
|
|
return $storage;
|
|
}
|
|
|
|
if ($storage instanceof MethodStorage && $docblock_info->inheritdoc) {
|
|
$storage->inheritdoc = true;
|
|
}
|
|
|
|
$template_types = $class_storage && $class_storage->template_types ? $class_storage->template_types : null;
|
|
|
|
if ($docblock_info->templates) {
|
|
$storage->template_types = [];
|
|
|
|
foreach ($docblock_info->templates as $template_map) {
|
|
if (count($template_map) === 3) {
|
|
if (trim($template_map[2])) {
|
|
$template_type = Type::parseTokens(
|
|
Type::fixUpLocalType(
|
|
$template_map[2],
|
|
$this->aliases,
|
|
null,
|
|
$this->type_aliases
|
|
)
|
|
);
|
|
} else {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'Template missing as type',
|
|
new CodeLocation($this->file_scanner, $stmt, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$template_type = Type::getMixed();
|
|
}
|
|
|
|
if (!$template_type->isSingle()) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
'Template type cannot be a union in docblock for '
|
|
. implode('.', $this->fq_classlike_names),
|
|
new CodeLocation($this->file_scanner, $stmt, null, true)
|
|
)
|
|
)) {
|
|
$storage->has_docblock_issues = true;
|
|
}
|
|
|
|
$template_type = Type::getMixed();
|
|
}
|
|
} else {
|
|
$template_type = Type::getMixed();
|
|
}
|
|
|
|
$storage->template_types[$template_map[0]] = [
|
|
$template_type,
|
|
$fq_classlike_name
|
|
];
|
|
}
|
|
|
|
$template_types = array_merge($template_types ?: [], $storage->template_types);
|
|
|
|
$this->function_template_types = $template_types;
|
|
}
|
|
|
|
if ($docblock_info->assertions) {
|
|
$storage->assertions = [];
|
|
|
|
foreach ($docblock_info->assertions as $assertion) {
|
|
$assertion_type = $assertion['type'];
|
|
$prefix = '';
|
|
if ($assertion_type[0] === '!') {
|
|
$prefix = '!';
|
|
$assertion_type = substr($assertion_type, 1);
|
|
}
|
|
if ($assertion_type[0] === '~') {
|
|
$prefix .= '~';
|
|
$assertion_type = substr($assertion_type, 1);
|
|
}
|
|
if ($assertion_type[0] === '=') {
|
|
$prefix .= '=';
|
|
$assertion_type = substr($assertion_type, 1);
|
|
}
|
|
|
|
if ($assertion_type !== 'falsy'
|
|
&& !isset($template_types[$assertion_type])
|
|
&& !isset(Type::PSALM_RESERVED_WORDS[$assertion_type])
|
|
) {
|
|
$assertion_type = Type::getFQCLNFromString($assertion_type, $this->aliases);
|
|
}
|
|
|
|
foreach ($storage->params as $i => $param) {
|
|
if ($param->name === $assertion['param_name']) {
|
|
$storage->assertions[] = new \Psalm\Storage\Assertion(
|
|
$i,
|
|
[[$prefix . $assertion_type]]
|
|
);
|
|
continue 2;
|
|
}
|
|
}
|
|
|
|
$storage->assertions[] = new \Psalm\Storage\Assertion(
|
|
'$' . $assertion['param_name'],
|
|
[[$prefix . $assertion_type]]
|
|
);
|
|
}
|
|
}
|
|
|
|
if ($docblock_info->if_true_assertions) {
|
|
$storage->assertions = [];
|
|
|
|
foreach ($docblock_info->if_true_assertions as $assertion) {
|
|
foreach ($storage->params as $i => $param) {
|
|
if ($param->name === $assertion['param_name']) {
|
|
$storage->if_true_assertions[] = new \Psalm\Storage\Assertion(
|
|
$i,
|
|
[[$assertion['type']]]
|
|
);
|
|
continue 2;
|
|
}
|
|
}
|
|
|
|
$storage->if_true_assertions[] = new \Psalm\Storage\Assertion(
|
|
'$' . $assertion['param_name'],
|
|
[[$assertion['type']]]
|
|
);
|
|
}
|
|
}
|
|
|
|
if ($docblock_info->if_false_assertions) {
|
|
$storage->assertions = [];
|
|
|
|
foreach ($docblock_info->if_false_assertions as $assertion) {
|
|
foreach ($storage->params as $i => $param) {
|
|
if ($param->name === $assertion['param_name']) {
|
|
$storage->if_false_assertions[] = new \Psalm\Storage\Assertion(
|
|
$i,
|
|
[[$assertion['type']]]
|
|
);
|
|
continue 2;
|
|
}
|
|
}
|
|
|
|
$storage->if_false_assertions[] = new \Psalm\Storage\Assertion(
|
|
'$' . $assertion['param_name'],
|
|
[[$assertion['type']]]
|
|
);
|
|
}
|
|
}
|
|
|
|
if ($docblock_info->return_type) {
|
|
if (!$storage->return_type || $docblock_info->return_type !== $storage->return_type->getId()) {
|
|
$storage->has_template_return_type =
|
|
$template_types !== null &&
|
|
count(
|
|
array_intersect(
|
|
Type::tokenize($docblock_info->return_type),
|
|
array_keys($template_types)
|
|
)
|
|
) > 0;
|
|
|
|
$docblock_return_type = $docblock_info->return_type;
|
|
|
|
if (!$storage->return_type_location) {
|
|
$storage->return_type_location = new CodeLocation(
|
|
$this->file_scanner,
|
|
$stmt,
|
|
null,
|
|
false,
|
|
CodeLocation::FUNCTION_PHPDOC_RETURN_TYPE,
|
|
$docblock_info->return_type
|
|
);
|
|
}
|
|
|
|
if ($docblock_return_type) {
|
|
try {
|
|
$fixed_type_tokens = Type::fixUpLocalType(
|
|
$docblock_return_type,
|
|
$this->aliases,
|
|
$this->function_template_types + $this->class_template_types,
|
|
$this->type_aliases
|
|
);
|
|
|
|
$storage->return_type = Type::parseTokens(
|
|
$fixed_type_tokens,
|
|
null,
|
|
$this->function_template_types + $this->class_template_types
|
|
);
|
|
$storage->return_type->setFromDocblock();
|
|
|
|
if ($storage->signature_return_type) {
|
|
$all_typehint_types_match = true;
|
|
$signature_return_atomic_types = $storage->signature_return_type->getTypes();
|
|
|
|
foreach ($storage->return_type->getTypes() as $key => $type) {
|
|
if (isset($signature_return_atomic_types[$key])) {
|
|
$type->from_docblock = false;
|
|
} else {
|
|
$all_typehint_types_match = false;
|
|
}
|
|
}
|
|
|
|
if ($all_typehint_types_match) {
|
|
$storage->return_type->from_docblock = false;
|
|
}
|
|
|
|
if ($storage->signature_return_type->isNullable()
|
|
&& !$storage->return_type->isNullable()
|
|
) {
|
|
$storage->return_type->addType(new Type\Atomic\TNull());
|
|
}
|
|
}
|
|
|
|
$storage->return_type->queueClassLikesForScanning($this->codebase, $this->file_storage);
|
|
} catch (TypeParseTreeException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
$e->getMessage() . ' in docblock for ' . $cased_function_id,
|
|
new CodeLocation($this->file_scanner, $stmt, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
}
|
|
}
|
|
|
|
if ($storage->return_type && $docblock_info->ignore_nullable_return) {
|
|
$storage->return_type->ignore_nullable_issues = true;
|
|
}
|
|
|
|
if ($storage->return_type && $docblock_info->ignore_falsable_return) {
|
|
$storage->return_type->ignore_falsable_issues = true;
|
|
}
|
|
|
|
if ($stmt->returnsByRef() && $storage->return_type) {
|
|
$storage->return_type->by_ref = true;
|
|
}
|
|
|
|
if ($docblock_info->return_type_line_number) {
|
|
$storage->return_type_location->setCommentLine($docblock_info->return_type_line_number);
|
|
}
|
|
}
|
|
|
|
$storage->return_type_description = $docblock_info->return_type_description;
|
|
}
|
|
|
|
foreach ($docblock_info->globals as $global) {
|
|
try {
|
|
$storage->global_types[$global['name']] = Type::parseTokens(
|
|
Type::fixUpLocalType(
|
|
$global['type'],
|
|
$this->aliases,
|
|
null,
|
|
$this->type_aliases
|
|
),
|
|
null
|
|
);
|
|
} catch (TypeParseTreeException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
$e->getMessage() . ' in docblock for ' . $cased_function_id,
|
|
new CodeLocation($this->file_scanner, $stmt, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
|
|
continue;
|
|
}
|
|
}
|
|
|
|
if ($docblock_info->params) {
|
|
$this->improveParamsFromDocblock(
|
|
$storage,
|
|
$docblock_info->params,
|
|
$stmt
|
|
);
|
|
}
|
|
|
|
foreach ($docblock_info->params_out as $docblock_param_out) {
|
|
$param_name = substr($docblock_param_out['name'], 1);
|
|
|
|
foreach ($storage->params as $i => $param_storage) {
|
|
if ($param_storage->name === $param_name) {
|
|
$out_type = Type::parseTokens(
|
|
Type::fixUpLocalType(
|
|
$docblock_param_out['type'],
|
|
$this->aliases,
|
|
$this->function_template_types + $this->class_template_types,
|
|
$this->type_aliases
|
|
),
|
|
null,
|
|
$this->function_template_types + $this->class_template_types
|
|
);
|
|
|
|
$out_type->queueClassLikesForScanning(
|
|
$this->codebase,
|
|
$this->file_storage,
|
|
$storage->template_types ?: []
|
|
);
|
|
|
|
$storage->param_out_types[$i] = $out_type;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($docblock_info->template_typeofs) {
|
|
foreach ($docblock_info->template_typeofs as $template_typeof) {
|
|
foreach ($storage->params as $i => $param) {
|
|
if ($param->name === $template_typeof['param_name']) {
|
|
$param_type_nullable = $param->type && $param->type->isNullable();
|
|
|
|
$template_type = isset($template_types[$template_typeof['template_type']])
|
|
? $template_types[$template_typeof['template_type']][0]
|
|
: null;
|
|
|
|
$template_class = isset($template_types[$template_typeof['template_type']])
|
|
? $template_types[$template_typeof['template_type']][1]
|
|
: null;
|
|
|
|
$template_atomic_type = null;
|
|
|
|
if ($template_type) {
|
|
foreach ($template_type->getTypes() as $tat) {
|
|
if ($tat instanceof Type\Atomic\TNamedObject) {
|
|
$template_atomic_type = $tat;
|
|
}
|
|
}
|
|
}
|
|
|
|
$param->type = new Type\Union([
|
|
new Type\Atomic\TGenericParamClass(
|
|
$template_typeof['template_type'],
|
|
$template_type && !$template_type->isMixed()
|
|
? (string)$template_type
|
|
: 'object',
|
|
$template_atomic_type,
|
|
$template_class
|
|
)
|
|
]);
|
|
|
|
if ($param_type_nullable) {
|
|
$param->type->addType(new Type\Atomic\TNull);
|
|
}
|
|
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return $storage;
|
|
}
|
|
|
|
/**
|
|
* @param PhpParser\Node\Param $param
|
|
*
|
|
* @return FunctionLikeParameter
|
|
*/
|
|
public function getTranslatedFunctionParam(PhpParser\Node\Param $param)
|
|
{
|
|
$param_type = null;
|
|
|
|
$is_nullable = $param->default !== null &&
|
|
$param->default instanceof PhpParser\Node\Expr\ConstFetch &&
|
|
$param->default->name instanceof PhpParser\Node\Name &&
|
|
strtolower($param->default->name->parts[0]) === 'null';
|
|
|
|
$param_typehint = $param->type;
|
|
|
|
if ($param_typehint instanceof PhpParser\Node\NullableType) {
|
|
$is_nullable = true;
|
|
$param_typehint = $param_typehint->type;
|
|
}
|
|
|
|
if ($param_typehint) {
|
|
if ($param_typehint instanceof PhpParser\Node\Identifier) {
|
|
$param_type_string = $param_typehint->name;
|
|
} elseif ($param_typehint instanceof PhpParser\Node\Name\FullyQualified) {
|
|
$param_type_string = (string)$param_typehint;
|
|
$this->codebase->scanner->queueClassLikeForScanning($param_type_string, $this->file_path);
|
|
} elseif (strtolower($param_typehint->parts[0]) === 'self') {
|
|
$param_type_string = $this->fq_classlike_names[count($this->fq_classlike_names) - 1];
|
|
} else {
|
|
$param_type_string = ClassLikeAnalyzer::getFQCLNFromNameObject($param_typehint, $this->aliases);
|
|
|
|
if (!in_array(strtolower($param_type_string), ['self', 'static', 'parent'], true)) {
|
|
$this->codebase->scanner->queueClassLikeForScanning($param_type_string, $this->file_path);
|
|
$this->file_storage->referenced_classlikes[strtolower($param_type_string)] = $param_type_string;
|
|
}
|
|
}
|
|
|
|
if ($param_type_string) {
|
|
$param_type = Type::parseString(
|
|
$param_type_string,
|
|
[$this->php_major_version, $this->php_minor_version],
|
|
[]
|
|
);
|
|
|
|
if ($is_nullable) {
|
|
$param_type->addType(new Type\Atomic\TNull);
|
|
}
|
|
|
|
if ($param->variadic) {
|
|
$param_type = new Type\Union([
|
|
new Type\Atomic\TArray([
|
|
Type::getInt(),
|
|
$param_type,
|
|
]),
|
|
]);
|
|
}
|
|
}
|
|
} elseif ($param->variadic) {
|
|
$param_type = new Type\Union([
|
|
new Type\Atomic\TArray([
|
|
Type::getInt(),
|
|
Type::getMixed(),
|
|
]),
|
|
]);
|
|
}
|
|
|
|
$is_optional = $param->default !== null;
|
|
|
|
if ($param->var instanceof PhpParser\Node\Expr\Error || !is_string($param->var->name)) {
|
|
throw new \UnexpectedValueException('Not expecting param name to be non-string');
|
|
}
|
|
|
|
return new FunctionLikeParameter(
|
|
$param->var->name,
|
|
$param->byRef,
|
|
$param_type,
|
|
new CodeLocation($this->file_scanner, $param, null, false, CodeLocation::FUNCTION_PARAM_VAR),
|
|
$param_typehint
|
|
? new CodeLocation($this->file_scanner, $param, null, false, CodeLocation::FUNCTION_PARAM_TYPE)
|
|
: null,
|
|
$is_optional,
|
|
$is_nullable,
|
|
$param->variadic,
|
|
$param->default ? StatementsAnalyzer::getSimpleType($this->codebase, $param->default, $this->aliases) : null
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param FunctionLikeStorage $storage
|
|
* @param array<int, array{type:string,name:string,line_number:int}> $docblock_params
|
|
* @param PhpParser\Node\FunctionLike $function
|
|
*
|
|
* @return void
|
|
*/
|
|
private function improveParamsFromDocblock(
|
|
FunctionLikeStorage $storage,
|
|
array $docblock_params,
|
|
PhpParser\Node\FunctionLike $function
|
|
) {
|
|
$base = $this->fq_classlike_names
|
|
? $this->fq_classlike_names[count($this->fq_classlike_names) - 1] . '::'
|
|
: '';
|
|
|
|
$cased_method_id = $base . $storage->cased_name;
|
|
|
|
foreach ($docblock_params as $docblock_param) {
|
|
$param_name = $docblock_param['name'];
|
|
$docblock_param_variadic = false;
|
|
|
|
if (substr($param_name, 0, 3) === '...') {
|
|
$docblock_param_variadic = true;
|
|
$param_name = substr($param_name, 3);
|
|
}
|
|
|
|
$param_name = substr($param_name, 1);
|
|
|
|
$storage_param = null;
|
|
|
|
foreach ($storage->params as $function_signature_param) {
|
|
if ($function_signature_param->name === $param_name) {
|
|
$storage_param = $function_signature_param;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if ($storage_param === null) {
|
|
if (!$docblock_param_variadic || $storage->params || $this->scan_deep) {
|
|
continue;
|
|
}
|
|
|
|
$storage_param = new FunctionLikeParameter(
|
|
$param_name,
|
|
false,
|
|
null,
|
|
null,
|
|
null,
|
|
false,
|
|
false,
|
|
true,
|
|
null
|
|
);
|
|
|
|
$storage->params[] = $storage_param;
|
|
}
|
|
|
|
$code_location = new CodeLocation(
|
|
$this->file_scanner,
|
|
$function,
|
|
null,
|
|
true,
|
|
CodeLocation::FUNCTION_PHPDOC_PARAM_TYPE,
|
|
$docblock_param['type']
|
|
);
|
|
|
|
$code_location->setCommentLine($docblock_param['line_number']);
|
|
|
|
try {
|
|
$new_param_type = Type::parseTokens(
|
|
Type::fixUpLocalType(
|
|
$docblock_param['type'],
|
|
$this->aliases,
|
|
$this->function_template_types + $this->class_template_types,
|
|
$this->type_aliases
|
|
),
|
|
null,
|
|
$this->function_template_types + $this->class_template_types
|
|
);
|
|
} catch (TypeParseTreeException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
$e->getMessage() . ' in docblock for ' . $cased_method_id,
|
|
$code_location
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
|
|
continue;
|
|
}
|
|
|
|
$storage_param->has_docblock_type = true;
|
|
$new_param_type->setFromDocblock();
|
|
|
|
$new_param_type->queueClassLikesForScanning(
|
|
$this->codebase,
|
|
$this->file_storage,
|
|
$storage->template_types ?: []
|
|
);
|
|
|
|
if ($docblock_param_variadic) {
|
|
$new_param_type = new Type\Union([
|
|
new Type\Atomic\TArray([
|
|
Type::getInt(),
|
|
$new_param_type,
|
|
]),
|
|
]);
|
|
}
|
|
|
|
$existing_param_type_nullable = $storage_param->is_nullable;
|
|
|
|
if (!$storage_param->type || $storage_param->type->hasMixed() || $storage->template_types) {
|
|
if ($existing_param_type_nullable && !$new_param_type->isNullable()) {
|
|
$new_param_type->addType(new Type\Atomic\TNull());
|
|
}
|
|
|
|
if ($this->config->add_param_default_to_docblock_type
|
|
&& $storage_param->default_type
|
|
&& !$storage_param->default_type->hasMixed()
|
|
&& (!$storage_param->type || !$storage_param->type->hasMixed())
|
|
) {
|
|
$new_param_type = Type::combineUnionTypes($new_param_type, $storage_param->default_type);
|
|
}
|
|
|
|
$storage_param->type = $new_param_type;
|
|
$storage_param->type_location = $code_location;
|
|
continue;
|
|
}
|
|
|
|
$storage_param_atomic_types = $storage_param->type->getTypes();
|
|
|
|
$all_types_match = true;
|
|
$all_typehint_types_match = true;
|
|
|
|
foreach ($new_param_type->getTypes() as $key => $type) {
|
|
if (isset($storage_param_atomic_types[$key])) {
|
|
if ($storage_param_atomic_types[$key]->getId() !== $type->getId()) {
|
|
$all_types_match = false;
|
|
}
|
|
|
|
$type->from_docblock = false;
|
|
|
|
if ($storage_param_atomic_types[$key] instanceof Type\Atomic\TArray
|
|
&& $type instanceof Type\Atomic\TArray
|
|
&& $type->type_params[0]->hasArrayKey()
|
|
) {
|
|
$type->type_params[0]->from_docblock = false;
|
|
}
|
|
} else {
|
|
$all_types_match = false;
|
|
$all_typehint_types_match = false;
|
|
}
|
|
}
|
|
|
|
if ($all_types_match) {
|
|
continue;
|
|
}
|
|
|
|
if ($all_typehint_types_match) {
|
|
$new_param_type->from_docblock = false;
|
|
}
|
|
|
|
if ($existing_param_type_nullable && !$new_param_type->isNullable()) {
|
|
$new_param_type->addType(new Type\Atomic\TNull());
|
|
}
|
|
|
|
$storage_param->type = $new_param_type;
|
|
$storage_param->type_location = $code_location;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param PhpParser\Node\Stmt\Property $stmt
|
|
* @param Config $config
|
|
* @param string $fq_classlike_name
|
|
*
|
|
* @return void
|
|
*/
|
|
private function visitPropertyDeclaration(
|
|
PhpParser\Node\Stmt\Property $stmt,
|
|
Config $config,
|
|
ClassLikeStorage $storage,
|
|
$fq_classlike_name
|
|
) {
|
|
if (!$this->fq_classlike_names) {
|
|
throw new \LogicException('$this->fq_classlike_names should not be empty');
|
|
}
|
|
|
|
$comment = $stmt->getDocComment();
|
|
$var_comment = null;
|
|
|
|
$property_is_initialized = false;
|
|
|
|
$existing_constants = $storage->protected_class_constants
|
|
+ $storage->private_class_constants
|
|
+ $storage->public_class_constants;
|
|
|
|
if ($comment && $comment->getText() && ($config->use_docblock_types || $config->use_docblock_property_types)) {
|
|
if (preg_match('/[ \t\*]+@psalm-suppress[ \t]+PropertyNotSetInConstructor/', (string)$comment)) {
|
|
$property_is_initialized = true;
|
|
}
|
|
|
|
try {
|
|
$property_type_line_number = $comment->getLine();
|
|
$var_comments = CommentAnalyzer::getTypeFromComment(
|
|
$comment->getText(),
|
|
$this->file_scanner,
|
|
$this->aliases,
|
|
$this->function_template_types + $this->class_template_types,
|
|
$property_type_line_number,
|
|
null,
|
|
$this->type_aliases
|
|
);
|
|
|
|
$var_comment = array_pop($var_comments);
|
|
} catch (IncorrectDocblockException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new MissingDocblockType(
|
|
$e->getMessage(),
|
|
new CodeLocation($this->file_scanner, $stmt, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
} catch (DocblockParseException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
$e->getMessage(),
|
|
new CodeLocation($this->file_scanner, $stmt, null, true)
|
|
)
|
|
)) {
|
|
}
|
|
|
|
$storage->has_docblock_issues = true;
|
|
}
|
|
}
|
|
|
|
$signature_type = null;
|
|
$signature_type_location = null;
|
|
|
|
/** @var null|PhpParser\Node\Identifier|PhpParser\Node\Name|PhpParser\Node\NullableType */
|
|
$parser_property_type = isset($stmt->type) ? $stmt->type : null;
|
|
|
|
if ($parser_property_type) {
|
|
$suffix = '';
|
|
|
|
if ($parser_property_type instanceof PhpParser\Node\NullableType) {
|
|
$suffix = '|null';
|
|
$parser_property_type = $parser_property_type->type;
|
|
}
|
|
|
|
if ($parser_property_type instanceof PhpParser\Node\Identifier) {
|
|
$property_type_string = $parser_property_type->name . $suffix;
|
|
} else {
|
|
$property_type_fq_classlike_name = ClassLikeAnalyzer::getFQCLNFromNameObject(
|
|
$parser_property_type,
|
|
$this->aliases
|
|
);
|
|
|
|
$property_type_string = $property_type_fq_classlike_name . $suffix;
|
|
}
|
|
|
|
$signature_type = Type::parseString(
|
|
$property_type_string,
|
|
[$this->php_major_version, $this->php_minor_version]
|
|
);
|
|
$signature_type->queueClassLikesForScanning($this->codebase, $this->file_storage);
|
|
|
|
$signature_type_location = new CodeLocation(
|
|
$this->file_scanner,
|
|
$parser_property_type,
|
|
null,
|
|
false,
|
|
CodeLocation::FUNCTION_RETURN_TYPE
|
|
);
|
|
}
|
|
|
|
$doc_var_group_type = $var_comment ? $var_comment->type : null;
|
|
|
|
if ($doc_var_group_type) {
|
|
$doc_var_group_type->queueClassLikesForScanning($this->codebase, $this->file_storage);
|
|
$doc_var_group_type->setFromDocblock();
|
|
}
|
|
|
|
foreach ($stmt->props as $property) {
|
|
$doc_var_location = null;
|
|
|
|
$property_storage = $storage->properties[$property->name->name] = new PropertyStorage();
|
|
$property_storage->is_static = (bool)$stmt->isStatic();
|
|
$property_storage->type = $signature_type;
|
|
$property_storage->signature_type = $signature_type;
|
|
$property_storage->signature_type_location = $signature_type_location;
|
|
$property_storage->type_location = $signature_type_location;
|
|
$property_storage->location = new CodeLocation($this->file_scanner, $property->name);
|
|
$property_storage->has_default = $property->default ? true : false;
|
|
$property_storage->deprecated = $var_comment ? $var_comment->deprecated : false;
|
|
$property_storage->internal = $var_comment ? $var_comment->internal : false;
|
|
|
|
if (!$signature_type && !$doc_var_group_type) {
|
|
if ($property->default) {
|
|
$property_storage->suggested_type = StatementsAnalyzer::getSimpleType(
|
|
$this->codebase,
|
|
$property->default,
|
|
$this->aliases,
|
|
null,
|
|
$existing_constants,
|
|
$fq_classlike_name
|
|
);
|
|
}
|
|
|
|
$property_storage->type = null;
|
|
} else {
|
|
if ($var_comment && $var_comment->line_number) {
|
|
$doc_var_location = new CodeLocation(
|
|
$this->file_scanner,
|
|
$stmt,
|
|
null,
|
|
false,
|
|
CodeLocation::VAR_TYPE,
|
|
$var_comment->original_type
|
|
);
|
|
$doc_var_location->setCommentLine($var_comment->line_number);
|
|
}
|
|
|
|
if ($doc_var_group_type) {
|
|
$property_storage->type = count($stmt->props) === 1
|
|
? $doc_var_group_type
|
|
: clone $doc_var_group_type;
|
|
}
|
|
}
|
|
|
|
if ($property_storage->type
|
|
&& $property_storage->type !== $property_storage->signature_type
|
|
&& (!$property_storage->signature_type
|
|
|| $doc_var_group_type !== $property_storage->signature_type->getId())
|
|
) {
|
|
if (!$property_storage->signature_type) {
|
|
$property_storage->type_location = $doc_var_location;
|
|
}
|
|
|
|
if ($property_storage->signature_type) {
|
|
$all_typehint_types_match = true;
|
|
$signature_atomic_types = $property_storage->signature_type->getTypes();
|
|
|
|
foreach ($property_storage->type->getTypes() as $key => $type) {
|
|
if (isset($signature_atomic_types[$key])) {
|
|
$type->from_docblock = false;
|
|
} else {
|
|
$all_typehint_types_match = false;
|
|
}
|
|
}
|
|
|
|
if ($all_typehint_types_match) {
|
|
$property_storage->type->from_docblock = false;
|
|
}
|
|
|
|
if ($property_storage->signature_type->isNullable()
|
|
&& !$property_storage->type->isNullable()
|
|
) {
|
|
$property_storage->type->addType(new Type\Atomic\TNull());
|
|
}
|
|
}
|
|
|
|
$property_storage->type->queueClassLikesForScanning($this->codebase, $this->file_storage);
|
|
}
|
|
|
|
if ($stmt->isPublic()) {
|
|
$property_storage->visibility = ClassLikeAnalyzer::VISIBILITY_PUBLIC;
|
|
} elseif ($stmt->isProtected()) {
|
|
$property_storage->visibility = ClassLikeAnalyzer::VISIBILITY_PROTECTED;
|
|
} elseif ($stmt->isPrivate()) {
|
|
$property_storage->visibility = ClassLikeAnalyzer::VISIBILITY_PRIVATE;
|
|
}
|
|
|
|
$fq_classlike_name = $this->fq_classlike_names[count($this->fq_classlike_names) - 1];
|
|
|
|
$property_id = $fq_classlike_name . '::$' . $property->name->name;
|
|
|
|
$storage->declaring_property_ids[$property->name->name] = $fq_classlike_name;
|
|
$storage->appearing_property_ids[$property->name->name] = $property_id;
|
|
|
|
if ($property_is_initialized) {
|
|
$storage->initialized_properties[$property->name->name] = true;
|
|
}
|
|
|
|
if (!$stmt->isPrivate()) {
|
|
$storage->inheritable_property_ids[$property->name->name] = $property_id;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param PhpParser\Node\Stmt\ClassConst $stmt
|
|
* @param string $fq_classlike_name
|
|
*
|
|
* @return void
|
|
*/
|
|
private function visitClassConstDeclaration(
|
|
PhpParser\Node\Stmt\ClassConst $stmt,
|
|
ClassLikeStorage $storage,
|
|
$fq_classlike_name
|
|
) {
|
|
$existing_constants = $storage->protected_class_constants
|
|
+ $storage->private_class_constants
|
|
+ $storage->public_class_constants;
|
|
|
|
$comment = $stmt->getDocComment();
|
|
$deprecated = false;
|
|
$config = $this->config;
|
|
|
|
if ($comment && $comment->getText() && ($config->use_docblock_types || $config->use_docblock_property_types)) {
|
|
$comments = DocComment::parse($comment->getText(), 0);
|
|
|
|
if (isset($comments['specials']['deprecated'])) {
|
|
$deprecated = true;
|
|
}
|
|
}
|
|
|
|
foreach ($stmt->consts as $const) {
|
|
$const_type = StatementsAnalyzer::getSimpleType(
|
|
$this->codebase,
|
|
$const->value,
|
|
$this->aliases,
|
|
null,
|
|
$existing_constants,
|
|
$fq_classlike_name
|
|
);
|
|
|
|
if ($const_type) {
|
|
$existing_constants[$const->name->name] = $const_type;
|
|
|
|
if ($stmt->isProtected()) {
|
|
$storage->protected_class_constants[$const->name->name] = $const_type;
|
|
} elseif ($stmt->isPrivate()) {
|
|
$storage->private_class_constants[$const->name->name] = $const_type;
|
|
} else {
|
|
$storage->public_class_constants[$const->name->name] = $const_type;
|
|
}
|
|
|
|
$storage->class_constant_locations[$const->name->name] = new CodeLocation(
|
|
$this->file_scanner,
|
|
$const->name
|
|
);
|
|
} else {
|
|
if ($stmt->isProtected()) {
|
|
$storage->protected_class_constant_nodes[$const->name->name] = $const->value;
|
|
} elseif ($stmt->isPrivate()) {
|
|
$storage->private_class_constant_nodes[$const->name->name] = $const->value;
|
|
} else {
|
|
$storage->public_class_constant_nodes[$const->name->name] = $const->value;
|
|
}
|
|
|
|
$storage->aliases = $this->aliases;
|
|
}
|
|
|
|
if ($deprecated) {
|
|
$storage->deprecated_constants[$const->name->name] = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param PhpParser\Node\Expr\Include_ $stmt
|
|
*
|
|
* @return void
|
|
*/
|
|
public function visitInclude(PhpParser\Node\Expr\Include_ $stmt)
|
|
{
|
|
$config = Config::getInstance();
|
|
|
|
if (!$config->allow_includes) {
|
|
throw new FileIncludeException(
|
|
'File includes are not allowed per your Psalm config - check the allowFileIncludes flag.'
|
|
);
|
|
}
|
|
|
|
if ($stmt->expr instanceof PhpParser\Node\Scalar\String_) {
|
|
$path_to_file = $stmt->expr->value;
|
|
|
|
// attempts to resolve using get_include_path dirs
|
|
$include_path = IncludeAnalyzer::resolveIncludePath($path_to_file, dirname($this->file_path));
|
|
$path_to_file = $include_path ? $include_path : $path_to_file;
|
|
|
|
if (DIRECTORY_SEPARATOR === '/') {
|
|
$is_path_relative = $path_to_file[0] !== DIRECTORY_SEPARATOR;
|
|
} else {
|
|
$is_path_relative = !preg_match('~^[A-Z]:\\\\~i', $path_to_file);
|
|
}
|
|
|
|
if ($is_path_relative) {
|
|
$path_to_file = $config->base_dir . DIRECTORY_SEPARATOR . $path_to_file;
|
|
}
|
|
} else {
|
|
$path_to_file = IncludeAnalyzer::getPathTo($stmt->expr, $this->file_path, $this->config);
|
|
}
|
|
|
|
if ($path_to_file) {
|
|
$path_to_file = IncludeAnalyzer::normalizeFilePath($path_to_file);
|
|
|
|
if ($this->file_path === $path_to_file) {
|
|
return;
|
|
}
|
|
|
|
if ($this->codebase->fileExists($path_to_file)) {
|
|
if ($this->scan_deep) {
|
|
$this->codebase->scanner->addFileToDeepScan($path_to_file);
|
|
} else {
|
|
$this->codebase->scanner->addFileToShallowScan($path_to_file);
|
|
}
|
|
|
|
$this->file_storage->required_file_paths[strtolower($path_to_file)] = $path_to_file;
|
|
|
|
return;
|
|
}
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getFilePath()
|
|
{
|
|
return $this->file_path;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getFileName()
|
|
{
|
|
return $this->file_scanner->getFileName();
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getRootFilePath()
|
|
{
|
|
return $this->file_scanner->getRootFilePath();
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getRootFileName()
|
|
{
|
|
return $this->file_scanner->getRootFileName();
|
|
}
|
|
|
|
/**
|
|
* @return Aliases
|
|
*/
|
|
public function getAliases()
|
|
{
|
|
return $this->aliases;
|
|
}
|
|
|
|
public function afterTraverse(array $nodes)
|
|
{
|
|
$this->file_storage->type_aliases = $this->type_aliases;
|
|
}
|
|
}
|