1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-15 10:57:08 +01:00
psalm/src/Psalm/Internal/Analyzer/NamespaceAnalyzer.php

203 lines
5.9 KiB
PHP
Raw Normal View History

<?php
2018-11-06 03:57:36 +01:00
namespace Psalm\Internal\Analyzer;
2016-02-04 15:22:46 +01:00
use PhpParser;
use PhpParser\Node\Stmt\Namespace_;
2016-11-02 07:29:00 +01:00
use Psalm\Context;
use Psalm\StatementsSource;
2016-11-21 03:49:06 +01:00
use Psalm\Type;
use function implode;
use function strtolower;
use function trim;
use function strpos;
use function preg_replace;
/**
* @internal
*/
2018-11-06 03:57:36 +01:00
class NamespaceAnalyzer extends SourceAnalyzer implements StatementsSource
{
2017-01-07 20:35:07 +01:00
use CanAlias;
/**
2018-11-06 03:57:36 +01:00
* @var FileAnalyzer
2017-01-07 20:35:07 +01:00
*/
protected $source;
2016-10-15 06:12:57 +02:00
/**
* @var Namespace_
*/
private $namespace;
2016-10-15 06:12:57 +02:00
/**
* @var string
*/
private $namespace_name;
2016-10-15 06:12:57 +02:00
/**
2016-11-21 03:49:06 +01:00
* A lookup table for public namespace constants
*
* @var array<string, array<string, Type\Union>>
*/
2016-11-21 03:49:06 +01:00
protected static $public_namespace_constants = [];
2016-11-02 07:29:00 +01:00
/**
* @param Namespace_ $namespace
2018-11-06 03:57:36 +01:00
* @param FileAnalyzer $source
2016-11-02 07:29:00 +01:00
*/
2018-11-06 03:57:36 +01:00
public function __construct(Namespace_ $namespace, FileAnalyzer $source)
{
$this->source = $source;
$this->namespace = $namespace;
2016-10-15 06:12:57 +02:00
$this->namespace_name = $this->namespace->name ? implode('\\', $this->namespace->name->parts) : '';
}
2016-11-02 07:29:00 +01:00
/**
2016-11-13 00:51:48 +01:00
* @return void
2016-11-02 07:29:00 +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
public function collectAnalyzableInformation()
{
$leftover_stmts = [];
if (!isset(self::$public_namespace_constants[$this->namespace_name])) {
self::$public_namespace_constants[$this->namespace_name] = [];
}
2016-11-21 03:49:06 +01:00
2018-11-06 03:57:36 +01:00
$codebase = $this->getCodebase();
foreach ($this->namespace->stmts as $stmt) {
if ($stmt instanceof PhpParser\Node\Stmt\ClassLike) {
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
$this->collectAnalyzableClassLike($stmt);
2016-11-02 07:29:00 +01:00
} elseif ($stmt instanceof PhpParser\Node\Stmt\Use_) {
2016-11-21 03:49:06 +01:00
$this->visitUse($stmt);
2016-11-21 04:40:19 +01:00
} elseif ($stmt instanceof PhpParser\Node\Stmt\GroupUse) {
$this->visitGroupUse($stmt);
2016-11-21 03:49:06 +01:00
} elseif ($stmt instanceof PhpParser\Node\Stmt\Const_) {
foreach ($stmt->consts as $const) {
self::$public_namespace_constants[$this->namespace_name][$const->name->name] = Type::getMixed();
}
2016-11-21 03:49:06 +01:00
$leftover_stmts[] = $stmt;
2016-11-02 07:29:00 +01:00
} else {
$leftover_stmts[] = $stmt;
}
}
if ($leftover_stmts) {
$statements_analyzer = new StatementsAnalyzer($this, new \Psalm\Internal\Provider\NodeDataProvider());
$context = new Context();
$context->is_global = true;
2019-03-11 14:54:41 +01:00
$context->defineGlobals();
$context->collect_exceptions = $codebase->config->check_for_throws_in_global_scope;
2018-11-11 18:01:14 +01:00
$statements_analyzer->analyze($leftover_stmts, $context);
$file_context = $this->source->context;
if ($file_context) {
$file_context->mergeExceptions($context);
}
}
}
2016-11-21 04:02:26 +01:00
/**
* @param PhpParser\Node\Stmt\ClassLike $stmt
2017-05-27 02:16:18 +02:00
*
2016-11-21 04:02:26 +01:00
* @return void
*/
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
public function collectAnalyzableClassLike(PhpParser\Node\Stmt\ClassLike $stmt)
{
if (!$stmt->name) {
throw new \UnexpectedValueException('Did not expect anonymous class here');
}
2016-12-14 18:28:38 +01:00
$fq_class_name = Type::getFQCLNFromString($stmt->name->name, $this->getAliases());
2017-02-01 01:21:33 +01:00
2016-11-21 03:49:06 +01:00
if ($stmt instanceof PhpParser\Node\Stmt\Class_) {
2018-11-06 03:57:36 +01:00
$this->source->addNamespacedClassAnalyzer(
$fq_class_name,
2018-11-06 03:57:36 +01:00
new ClassAnalyzer($stmt, $this, $fq_class_name)
);
2016-11-21 03:49:06 +01:00
} elseif ($stmt instanceof PhpParser\Node\Stmt\Interface_) {
2018-11-06 03:57:36 +01:00
$this->source->addNamespacedInterfaceAnalyzer(
$fq_class_name,
2018-11-06 03:57:36 +01:00
new InterfaceAnalyzer($stmt, $this, $fq_class_name)
);
2016-11-21 03:49:06 +01:00
}
}
2016-11-02 07:29:00 +01:00
/**
* @return string
*/
2016-11-21 03:49:06 +01:00
public function getNamespace()
{
2016-11-21 03:49:06 +01:00
return $this->namespace_name;
}
/**
2016-11-21 03:49:06 +01:00
* @param string $const_name
* @param Type\Union $const_type
2017-05-27 02:16:18 +02:00
*
2016-11-02 07:29:00 +01:00
* @return void
*/
2016-11-21 03:49:06 +01:00
public function setConstType($const_name, Type\Union $const_type)
2016-08-25 01:00:44 +02:00
{
2016-11-21 03:49:06 +01:00
self::$public_namespace_constants[$this->namespace_name][$const_name] = $const_type;
2016-08-25 01:00:44 +02:00
}
2016-11-02 07:29:00 +01:00
/**
2016-11-21 03:49:06 +01:00
* @param string $namespace_name
* @param mixed $visibility
2017-05-27 02:16:18 +02:00
*
2016-11-21 03:49:06 +01:00
* @return array<string,Type\Union>
2016-11-02 07:29:00 +01:00
*/
2016-11-21 03:49:06 +01:00
public static function getConstantsForNamespace($namespace_name, $visibility)
2016-08-25 01:00:44 +02:00
{
2016-11-21 03:49:06 +01:00
// @todo this does not allow for loading in namespace constants not already defined in the current sweep
2016-11-21 04:40:19 +01:00
if (!isset(self::$public_namespace_constants[$namespace_name])) {
self::$public_namespace_constants[$namespace_name] = [];
}
2016-11-21 03:49:06 +01:00
if ($visibility === \ReflectionProperty::IS_PUBLIC) {
return self::$public_namespace_constants[$namespace_name];
}
2016-11-21 03:49:06 +01:00
throw new \InvalidArgumentException('Given $visibility not supported');
}
2018-11-06 03:57:36 +01:00
public function getFileAnalyzer() : FileAnalyzer
{
return $this->source;
}
/**
2019-08-11 23:13:43 +02:00
* Returns true if $className is the same as, or starts with $namespace, in a case-insensitive comparison.
*
* @return bool
2020-08-23 19:52:31 +02:00
*
* @psalm-pure
*/
public static function isWithin(string $calling_namespace, string $namespace): bool
{
if ($namespace === '') {
return true; // required to prevent a warning from strpos with empty needle in PHP < 8
}
$calling_namespace = strtolower(trim($calling_namespace, '\\') . '\\');
$namespace = strtolower(trim($namespace, '\\') . '\\');
return $calling_namespace === $namespace
|| strpos($calling_namespace, $namespace) === 0;
}
/**
* @param string $fullyQualifiedClassName, e.g. '\Psalm\Internal\Analyzer\NamespaceAnalyzer'
2020-08-23 19:52:31 +02:00
*
* @return string , e.g. 'Psalm'
2020-08-23 19:52:31 +02:00
*
* @psalm-pure
*/
public static function getNameSpaceRoot(string $fullyQualifiedClassName): string
{
return preg_replace('/^([^\\\]+).*/', '$1', $fullyQualifiedClassName);
}
}