1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-13 17:57:37 +01:00
psalm/src/Psalm/Checker/NamespaceChecker.php

185 lines
5.4 KiB
PHP
Raw Normal View History

<?php
namespace Psalm\Checker;
2016-10-15 06:12:57 +02:00
use PhpParser\Node\Stmt\Namespace_;
2016-02-04 15:22:46 +01:00
use PhpParser;
2016-11-02 07:29:00 +01:00
use Psalm\Context;
2017-02-01 01:21:33 +01:00
use Psalm\Exception\RedefinedPredefinedClassException;
use Psalm\IssueBuffer;
use Psalm\Issue\DuplicateClass;
2016-11-02 07:29:00 +01:00
use Psalm\StatementsSource;
2016-11-21 03:49:06 +01:00
use Psalm\Type;
2016-11-21 03:49:06 +01:00
class NamespaceChecker extends SourceChecker implements StatementsSource
{
2017-01-07 20:35:07 +01:00
use CanAlias;
/**
* @var FileChecker
*/
protected $source;
2016-10-15 06:12:57 +02:00
/**
* @var Namespace_
*/
protected $namespace;
2016-10-15 06:12:57 +02:00
/**
* @var string
*/
protected $namespace_name;
2016-10-15 06:12:57 +02:00
/**
* @var array<int, ClassChecker>
*/
2017-01-12 06:54:41 +01:00
public $class_checkers = [];
/**
* @var array<int, ClassChecker>
*/
public $interface_checkers = [];
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
2017-01-07 20:35:07 +01:00
* @param FileChecker $source
2016-11-02 07:29:00 +01:00
*/
2017-01-07 20:35:07 +01:00
public function __construct(Namespace_ $namespace, FileChecker $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
*/
public function visit()
{
$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
$namespace_context = new Context();
$namespace_context->count_references = $this->getFileChecker()->project_checker->count_references;
foreach ($this->namespace->stmts as $stmt) {
if ($stmt instanceof PhpParser\Node\Stmt\ClassLike) {
$this->visitClassLike($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] = 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_checker = new StatementsChecker($this);
$context = new Context();
$context->count_references = $this->getFileChecker()->project_checker->count_references;
$statements_checker->analyze($leftover_stmts, $context);
}
}
2016-11-21 04:02:26 +01:00
/**
* @param PhpParser\Node\Stmt\ClassLike $stmt
* @return void
*/
public function visitClassLike(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
2017-02-01 01:21:33 +01:00
$config = \Psalm\Config::getInstance();
$predefined_classlikes = $config->getPredefinedClassLikes();
2017-02-01 01:21:33 +01:00
2017-01-07 20:35:07 +01:00
$fq_class_name = ClassLikeChecker::getFQCLNFromString($stmt->name, $this);
2017-02-01 01:21:33 +01:00
if (isset($predefined_classlikes[strtolower($fq_class_name)])) {
if (IssueBuffer::accepts(
new DuplicateClass(
'Class ' . $fq_class_name . ' has already been defined internally',
new \Psalm\CodeLocation($this, $stmt, true)
)
)) {
// fall through
}
return;
}
2016-11-21 03:49:06 +01:00
if ($stmt instanceof PhpParser\Node\Stmt\Class_) {
$this->source->addNamespacedClassChecker(
$fq_class_name,
new ClassChecker($stmt, $this, $fq_class_name)
);
2016-11-21 03:49:06 +01:00
} elseif ($stmt instanceof PhpParser\Node\Stmt\Interface_) {
$this->source->addNamespacedInterfaceChecker(
$fq_class_name,
new InterfaceChecker($stmt, $this, $fq_class_name)
);
2016-11-21 03:49:06 +01:00
} elseif ($stmt instanceof PhpParser\Node\Stmt\Trait_) {
// register the trait checker
new TraitChecker($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
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
* @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
// remove for PHP 7.1 support
$visibility = \ReflectionProperty::IS_PUBLIC;
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');
}
}