2016-01-20 00:27:06 +01:00
|
|
|
<?php
|
2018-11-06 03:57:36 +01:00
|
|
|
namespace Psalm\Internal\Analyzer;
|
2016-08-13 20:20:46 +02:00
|
|
|
|
2016-02-04 15:22:46 +01:00
|
|
|
use PhpParser;
|
2017-05-19 06:48:26 +02:00
|
|
|
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;
|
2019-06-26 22:52:29 +02:00
|
|
|
use function implode;
|
|
|
|
use function array_merge;
|
|
|
|
use function strtolower;
|
|
|
|
use function trim;
|
|
|
|
use function strpos;
|
|
|
|
use function preg_replace;
|
2016-01-20 00:27:06 +01:00
|
|
|
|
2018-12-02 00:37:49 +01:00
|
|
|
/**
|
|
|
|
* @internal
|
|
|
|
*/
|
2018-11-06 03:57:36 +01:00
|
|
|
class NamespaceAnalyzer extends SourceAnalyzer implements StatementsSource
|
2016-01-20 00:27:06 +01:00
|
|
|
{
|
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_
|
|
|
|
*/
|
2017-02-12 00:56:38 +01:00
|
|
|
private $namespace;
|
2016-10-15 06:12:57 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*/
|
2017-02-12 00:56:38 +01:00
|
|
|
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-07-22 19:29:46 +02:00
|
|
|
*/
|
2016-11-21 03:49:06 +01:00
|
|
|
protected static $public_namespace_constants = [];
|
2016-07-22 19:29:46 +02:00
|
|
|
|
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)
|
2016-01-20 00:27:06 +01:00
|
|
|
{
|
2017-01-02 21:31:18 +01:00
|
|
|
$this->source = $source;
|
2016-08-14 00:54:49 +02:00
|
|
|
$this->namespace = $namespace;
|
2016-10-15 06:12:57 +02:00
|
|
|
$this->namespace_name = $this->namespace->name ? implode('\\', $this->namespace->name->parts) : '';
|
2016-01-20 00:27:06 +01:00
|
|
|
}
|
|
|
|
|
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
|
|
|
*/
|
2017-07-25 22:11:02 +02:00
|
|
|
public function collectAnalyzableInformation()
|
2016-01-20 00:27:06 +01:00
|
|
|
{
|
|
|
|
$leftover_stmts = [];
|
|
|
|
|
2017-01-18 05:55:08 +01:00
|
|
|
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();
|
2018-01-21 19:38:51 +01:00
|
|
|
|
2017-01-17 00:33:04 +01:00
|
|
|
$namespace_context = new Context();
|
2018-01-21 19:38:51 +01:00
|
|
|
$namespace_context->collect_references = $codebase->collect_references;
|
2017-01-02 21:31:18 +01:00
|
|
|
|
2016-08-14 00:54:49 +02:00
|
|
|
foreach ($this->namespace->stmts as $stmt) {
|
|
|
|
if ($stmt instanceof PhpParser\Node\Stmt\ClassLike) {
|
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) {
|
2018-04-17 18:16:25 +02:00
|
|
|
self::$public_namespace_constants[$this->namespace_name][$const->name->name] = Type::getMixed();
|
2016-01-20 00:27:06 +01:00
|
|
|
}
|
2017-01-02 21:31:18 +01:00
|
|
|
|
2016-11-21 03:49:06 +01:00
|
|
|
$leftover_stmts[] = $stmt;
|
2016-11-02 07:29:00 +01:00
|
|
|
} else {
|
2016-01-20 00:27:06 +01:00
|
|
|
$leftover_stmts[] = $stmt;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-06-21 23:10:35 +02:00
|
|
|
$codebase->analyzer->addNodeAliases(
|
|
|
|
$this->getFilePath(),
|
|
|
|
$this->namespace,
|
|
|
|
array_merge(
|
|
|
|
[$this->namespace_name => $this->namespace_name],
|
|
|
|
$this->getAliasedClassesFlipped()
|
|
|
|
)
|
|
|
|
);
|
|
|
|
|
2016-01-20 00:27:06 +01:00
|
|
|
if ($leftover_stmts) {
|
2018-11-11 18:01:14 +01:00
|
|
|
$statements_analyzer = new StatementsAnalyzer($this);
|
2017-01-17 00:33:04 +01:00
|
|
|
$context = new Context();
|
2018-01-21 19:38:51 +01:00
|
|
|
$context->collect_references = $codebase->collect_references;
|
2018-03-18 15:38:08 +01:00
|
|
|
$context->is_global = true;
|
2019-03-11 14:54:41 +01:00
|
|
|
$context->defineGlobals();
|
2019-03-24 21:17:14 +01:00
|
|
|
$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);
|
2019-03-25 22:26:28 +01:00
|
|
|
|
|
|
|
$file_context = $this->source->context;
|
|
|
|
if ($file_context) {
|
2019-03-29 00:43:14 +01:00
|
|
|
$file_context->mergeExceptions($context);
|
2019-03-25 22:26:28 +01:00
|
|
|
}
|
2016-01-20 00:27:06 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
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
|
|
|
|
*/
|
2017-07-25 22:11:02 +02:00
|
|
|
public function collectAnalyzableClassLike(PhpParser\Node\Stmt\ClassLike $stmt)
|
2017-02-02 00:11:00 +01:00
|
|
|
{
|
2016-12-04 04:41:45 +01:00
|
|
|
if (!$stmt->name) {
|
|
|
|
throw new \UnexpectedValueException('Did not expect anonymous class here');
|
|
|
|
}
|
2016-12-14 18:28:38 +01:00
|
|
|
|
2018-04-17 18:16:25 +02: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(
|
2017-02-02 00:11:00 +01:00
|
|
|
$fq_class_name,
|
2018-11-06 03:57:36 +01:00
|
|
|
new ClassAnalyzer($stmt, $this, $fq_class_name)
|
2017-02-02 00:11:00 +01:00
|
|
|
);
|
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(
|
2017-02-02 00:11:00 +01:00
|
|
|
$fq_class_name,
|
2018-11-06 03:57:36 +01:00
|
|
|
new InterfaceAnalyzer($stmt, $this, $fq_class_name)
|
2017-02-02 00:11:00 +01:00
|
|
|
);
|
2016-11-21 03:49:06 +01:00
|
|
|
}
|
2016-01-20 00:27: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-01-20 00:27:06 +01:00
|
|
|
{
|
2016-11-21 03:49:06 +01:00
|
|
|
return $this->namespace_name;
|
2016-01-20 00:27:06 +01:00
|
|
|
}
|
|
|
|
|
2016-10-09 23:54:58 +02:00
|
|
|
/**
|
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-10-09 23:54:58 +02:00
|
|
|
*/
|
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-05-16 05:06:03 +02:00
|
|
|
|
2016-11-21 03:49:06 +01:00
|
|
|
if ($visibility === \ReflectionProperty::IS_PUBLIC) {
|
|
|
|
return self::$public_namespace_constants[$namespace_name];
|
|
|
|
}
|
2016-07-22 19:29:46 +02:00
|
|
|
|
2016-11-21 03:49:06 +01:00
|
|
|
throw new \InvalidArgumentException('Given $visibility not supported');
|
2016-07-22 19:29:46 +02:00
|
|
|
}
|
2017-07-29 21:05:06 +02:00
|
|
|
|
2018-11-06 03:57:36 +01:00
|
|
|
public function getFileAnalyzer() : FileAnalyzer
|
2017-07-29 21:05:06 +02:00
|
|
|
{
|
|
|
|
return $this->source;
|
|
|
|
}
|
2019-05-14 23:30:16 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $namespace Generally a namespace, but may also be a fully qualified class name (FQCN)_.
|
|
|
|
* @param string $className Generally a FQCN, but may be a FQCN
|
|
|
|
*
|
|
|
|
* Returns true if $className is the same as, or starts with $namespace, in a case-insensitive comparision.
|
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public static function isWithin(string $className, string $namespace): bool
|
|
|
|
{
|
|
|
|
$className = strtolower(trim($className, '\\') . '\\');
|
|
|
|
$namespace = strtolower(trim($namespace, '\\') . '\\');
|
|
|
|
|
|
|
|
return $className === $namespace || strpos($className, $namespace) === 0;
|
|
|
|
}
|
2019-05-14 23:50:21 +02:00
|
|
|
|
|
|
|
public static function nameSpaceRootsMatch(string $fqcnA, string $fqcnB): bool
|
|
|
|
{
|
|
|
|
return strtolower(self::getNameSpaceRoot($fqcnA)) === strtolower(self::getNameSpaceRoot($fqcnB));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $fullyQualifiedClassName, e.g. '\Psalm\Internal\Analyzer\NamespaceAnalyzer'
|
|
|
|
* @return string , e.g. 'Psalm'
|
|
|
|
*/
|
|
|
|
private static function getNameSpaceRoot(string $fullyQualifiedClassName): string
|
|
|
|
{
|
|
|
|
return preg_replace('/^([^\\\]+).*/', '$1', $fullyQualifiedClassName);
|
|
|
|
}
|
2016-01-20 00:27:06 +01:00
|
|
|
}
|