2016-01-08 00:28:27 +01:00
|
|
|
<?php
|
|
|
|
|
2016-01-08 00:36:55 +01:00
|
|
|
namespace CodeInspector;
|
2016-01-08 00:28:27 +01:00
|
|
|
|
2016-04-17 22:20:36 +02:00
|
|
|
use CodeInspector\Exception\InvalidClassException;
|
|
|
|
use CodeInspector\Exception\UndefinedClassException;
|
2016-06-03 01:21:35 +02:00
|
|
|
use CodeInspector\Exception\UndefinedTraitException;
|
2016-06-06 02:25:16 +02:00
|
|
|
use CodeInspector\ExceptionHandler;
|
2016-02-04 15:22:46 +01:00
|
|
|
use PhpParser;
|
|
|
|
use PhpParser\Error;
|
|
|
|
use PhpParser\ParserFactory;
|
2016-04-17 17:22:18 +02:00
|
|
|
use ReflectionClass;
|
|
|
|
use ReflectionException;
|
|
|
|
use ReflectionMethod;
|
2016-01-08 00:28:27 +01:00
|
|
|
|
2016-01-20 00:27:06 +01:00
|
|
|
class ClassChecker implements StatementsSource
|
2016-01-08 00:28:27 +01:00
|
|
|
{
|
|
|
|
protected $_file_name;
|
|
|
|
protected $_class;
|
|
|
|
protected $_namespace;
|
|
|
|
protected $_aliased_classes;
|
2016-01-20 00:27:06 +01:00
|
|
|
protected $_absolute_class;
|
2016-01-30 00:48:09 +01:00
|
|
|
protected $_class_properties = [];
|
|
|
|
protected $_has_custom_get = false;
|
2016-05-16 05:06:03 +02:00
|
|
|
protected $_source;
|
|
|
|
|
|
|
|
protected static $_method_checkers = [];
|
2016-01-20 00:27:06 +01:00
|
|
|
|
2016-04-17 17:22:18 +02:00
|
|
|
/** @var string|null */
|
|
|
|
protected $_parent_class;
|
|
|
|
|
2016-05-16 05:06:03 +02:00
|
|
|
protected static $_this_class = null;
|
|
|
|
|
2016-01-08 00:28:27 +01:00
|
|
|
protected static $_existing_classes = [];
|
2016-04-12 01:13:50 +02:00
|
|
|
protected static $_implementing_classes = [];
|
2016-01-08 00:28:27 +01:00
|
|
|
|
2016-04-17 17:22:18 +02:00
|
|
|
protected static $_class_methods = [];
|
2016-05-16 05:06:03 +02:00
|
|
|
protected static $_class_checkers = [];
|
2016-04-17 17:22:18 +02:00
|
|
|
|
2016-01-20 00:27:06 +01:00
|
|
|
public function __construct(PhpParser\Node\Stmt\Class_ $class, StatementsSource $source, $absolute_class)
|
2016-01-08 00:28:27 +01:00
|
|
|
{
|
|
|
|
$this->_class = $class;
|
2016-01-20 00:27:06 +01:00
|
|
|
$this->_namespace = $source->getNamespace();
|
|
|
|
$this->_aliased_classes = $source->getAliasedClasses();
|
|
|
|
$this->_file_name = $source->getFileName();
|
|
|
|
$this->_absolute_class = $absolute_class;
|
2016-01-08 00:28:27 +01:00
|
|
|
|
2016-04-17 17:22:18 +02:00
|
|
|
$this->_parent_class = $this->_class->extends ? ClassChecker::getAbsoluteClassFromName($this->_class->extends, $this->_namespace, $this->_aliased_classes) : null;
|
|
|
|
|
2016-01-20 00:27:06 +01:00
|
|
|
self::$_existing_classes[$absolute_class] = 1;
|
2016-05-16 05:06:03 +02:00
|
|
|
|
|
|
|
if (self::$_this_class) {
|
|
|
|
self::$_class_checkers[$absolute_class] = $this;
|
|
|
|
}
|
2016-01-08 00:28:27 +01:00
|
|
|
}
|
|
|
|
|
2016-05-16 05:06:03 +02:00
|
|
|
public function check($check_statements = true, $method_id = null)
|
2016-01-08 00:28:27 +01:00
|
|
|
{
|
2016-04-17 17:22:18 +02:00
|
|
|
if ($this->_parent_class) {
|
|
|
|
self::checkAbsoluteClass($this->_parent_class, $this->_class, $this->_file_name);
|
|
|
|
|
2016-05-16 05:06:03 +02:00
|
|
|
$this->_registerInheritedMethods($this->_parent_class);
|
2016-01-08 00:28:27 +01:00
|
|
|
}
|
|
|
|
|
2016-01-26 20:13:04 +01:00
|
|
|
$leftover_stmts = [];
|
|
|
|
|
2016-03-23 18:05:25 +01:00
|
|
|
$method_checkers = [];
|
|
|
|
|
2016-04-18 19:31:59 +02:00
|
|
|
self::$_class_methods[$this->_absolute_class] = [];
|
|
|
|
|
2016-01-08 00:28:27 +01:00
|
|
|
foreach ($this->_class->stmts as $stmt) {
|
|
|
|
if ($stmt instanceof PhpParser\Node\Stmt\ClassMethod) {
|
2016-05-16 05:06:03 +02:00
|
|
|
$method_id = $this->_absolute_class . '::' . $stmt->name;
|
|
|
|
|
|
|
|
if (!isset(self::$_method_checkers[$method_id])) {
|
|
|
|
$method_checker = new ClassMethodChecker($stmt, $this);
|
|
|
|
$method_checkers[$stmt->name] = $method_checker;
|
|
|
|
|
|
|
|
if (self::$_this_class && !$check_statements) {
|
|
|
|
self::$_method_checkers[$method_id] = $method_checker;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
$method_checker = self::$_method_checkers[$method_id];
|
|
|
|
}
|
|
|
|
|
2016-04-18 19:31:59 +02:00
|
|
|
self::$_class_methods[$this->_absolute_class][] = $stmt->name;
|
2016-05-16 05:06:03 +02:00
|
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\TraitUse) {
|
|
|
|
$method_map = [];
|
|
|
|
foreach ($stmt->adaptations as $adaptation) {
|
|
|
|
if ($adaptation instanceof PhpParser\Node\Stmt\TraitUseAdaptation\Alias) {
|
|
|
|
$method_map[$adaptation->method] = $adaptation->newName;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
foreach ($stmt->traits as $trait) {
|
|
|
|
$trait_name = self::getAbsoluteClassFromName($trait, $this->_namespace, $this->_aliased_classes);
|
|
|
|
if (!trait_exists($trait_name)) {
|
2016-06-06 02:25:16 +02:00
|
|
|
if (ExceptionHandler::accepts(
|
|
|
|
new UndefinedTraitException('Trait ' . $trait_name . ' does not exist', $this->_file_name, $trait->getLine())
|
|
|
|
)) {
|
|
|
|
return false;
|
|
|
|
}
|
2016-05-16 05:06:03 +02:00
|
|
|
}
|
|
|
|
$this->_registerInheritedMethods($trait_name, $method_map);
|
|
|
|
}
|
2016-01-26 20:13:04 +01:00
|
|
|
|
|
|
|
} else {
|
2016-01-30 00:48:09 +01:00
|
|
|
if ($stmt instanceof PhpParser\Node\Stmt\Property) {
|
|
|
|
foreach ($stmt->props as $property) {
|
|
|
|
$this->_class_properties[] = $property->name;
|
|
|
|
}
|
|
|
|
}
|
2016-01-26 20:13:04 +01:00
|
|
|
$leftover_stmts[] = $stmt;
|
2016-01-08 00:28:27 +01:00
|
|
|
}
|
|
|
|
}
|
2016-01-26 20:13:04 +01:00
|
|
|
|
2016-04-20 12:55:26 +02:00
|
|
|
if (method_exists($this->_absolute_class, '__get')) {
|
|
|
|
$this->_has_custom_get = true;
|
|
|
|
}
|
|
|
|
|
2016-01-26 20:13:04 +01:00
|
|
|
if ($leftover_stmts) {
|
|
|
|
$scope_vars = [];
|
|
|
|
$possibly_in_scope_vars = [];
|
|
|
|
|
|
|
|
(new StatementsChecker($this))->check($leftover_stmts, $scope_vars, $possibly_in_scope_vars);
|
|
|
|
}
|
2016-03-23 18:05:25 +01:00
|
|
|
|
2016-05-16 05:06:03 +02:00
|
|
|
if ($check_statements) {
|
|
|
|
// do the method checks after all class methods have been initialised
|
|
|
|
foreach ($method_checkers as $method_checker) {
|
|
|
|
$method_checker->check();
|
|
|
|
//$method_checker->checkReturnTypes();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Used in deep method evaluation, we get method checkers on the current or parent
|
|
|
|
* classes
|
|
|
|
*
|
|
|
|
* @param string $method_id
|
|
|
|
* @return ClassMethodChecker
|
|
|
|
*/
|
|
|
|
public static function getMethodChecker($method_id)
|
|
|
|
{
|
|
|
|
if (isset(self::$_method_checkers[$method_id])) {
|
|
|
|
return self::$_method_checkers[$method_id];
|
|
|
|
}
|
|
|
|
|
2016-05-22 18:14:48 +02:00
|
|
|
$parent_method_id = ClassMethodChecker::getDeclaringMethod($method_id);
|
2016-05-16 05:06:03 +02:00
|
|
|
$parent_class = explode('::', $parent_method_id)[0];
|
|
|
|
|
|
|
|
$class_checker = FileChecker::getClassCheckerFromClass($parent_class);
|
|
|
|
|
|
|
|
// this is now set
|
|
|
|
return self::$_method_checkers[$parent_method_id];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns a class checker for the given class, if one has already been registered
|
|
|
|
* @param string $class_name
|
|
|
|
* @return ClassChecker|null
|
|
|
|
*/
|
|
|
|
public static function getClassCheckerFromClass($class_name)
|
|
|
|
{
|
|
|
|
if (isset(self::$_class_checkers[$class_name])) {
|
|
|
|
return self::$_class_checkers[$class_name];
|
2016-03-23 18:05:25 +01:00
|
|
|
}
|
2016-05-16 05:06:03 +02:00
|
|
|
|
|
|
|
return null;
|
2016-01-08 00:28:27 +01:00
|
|
|
}
|
|
|
|
|
2016-04-27 00:42:48 +02:00
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
*/
|
2016-01-08 00:28:27 +01:00
|
|
|
public static function checkClassName(PhpParser\Node\Name $class_name, $namespace, array $aliased_classes, $file_name)
|
|
|
|
{
|
|
|
|
if ($class_name->parts[0] === 'static') {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
$absolute_class = self::getAbsoluteClassFromName($class_name, $namespace, $aliased_classes);
|
|
|
|
|
2016-02-18 21:05:13 +01:00
|
|
|
self::checkAbsoluteClass($absolute_class, $class_name, $file_name);
|
|
|
|
}
|
|
|
|
|
2016-04-27 00:42:48 +02:00
|
|
|
/**
|
|
|
|
* @return void
|
|
|
|
*/
|
2016-02-18 21:05:13 +01:00
|
|
|
public static function checkAbsoluteClass($absolute_class, PhpParser\NodeAbstract $stmt, $file_name)
|
|
|
|
{
|
2016-04-12 17:59:27 +02:00
|
|
|
if (empty($absolute_class)) {
|
|
|
|
throw new \InvalidArgumentException('$class cannot be empty');
|
|
|
|
}
|
|
|
|
|
2016-03-17 19:06:01 +01:00
|
|
|
$absolute_class = preg_replace('/^\\\/', '', $absolute_class);
|
|
|
|
|
|
|
|
if (isset(self::$_existing_classes[$absolute_class])) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!class_exists($absolute_class, true) && !interface_exists($absolute_class, true)) {
|
2016-06-06 02:25:16 +02:00
|
|
|
if (ExceptionHandler::accepts(
|
|
|
|
new UndefinedClassException('Class ' . $absolute_class . ' does not exist', $file_name, $stmt->getLine())
|
|
|
|
)) {
|
|
|
|
return false;
|
|
|
|
}
|
2016-01-08 00:28:27 +01:00
|
|
|
}
|
|
|
|
|
2016-04-16 17:28:19 +02:00
|
|
|
if (class_exists($absolute_class, true) && strpos($absolute_class, '\\') === false) {
|
2016-04-17 17:22:18 +02:00
|
|
|
$reflection_class = new ReflectionClass($absolute_class);
|
2016-03-17 19:06:01 +01:00
|
|
|
|
|
|
|
if ($reflection_class->getName() !== $absolute_class) {
|
2016-06-06 02:25:16 +02:00
|
|
|
if (ExceptionHandler::accepts(
|
|
|
|
new InvalidClassException('Class ' . $absolute_class . ' has wrong casing', $file_name, $stmt->getLine())
|
|
|
|
)) {
|
|
|
|
return false;
|
|
|
|
}
|
2016-03-17 19:06:01 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-01-08 00:28:27 +01:00
|
|
|
self::$_existing_classes[$absolute_class] = 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
public static function getAbsoluteClassFromName(PhpParser\Node\Name $class_name, $namespace, array $aliased_classes)
|
|
|
|
{
|
|
|
|
if ($class_name instanceof PhpParser\Node\Name\FullyQualified) {
|
2016-02-18 21:05:13 +01:00
|
|
|
return implode('\\', $class_name->parts);
|
2016-01-08 00:28:27 +01:00
|
|
|
}
|
|
|
|
|
2016-01-20 00:27:06 +01:00
|
|
|
return self::getAbsoluteClassFromString(implode('\\', $class_name->parts), $namespace, $aliased_classes);
|
2016-01-08 00:28:27 +01:00
|
|
|
}
|
|
|
|
|
2016-01-20 00:27:06 +01:00
|
|
|
public static function getAbsoluteClassFromString($class, $namespace, array $imported_namespaces)
|
|
|
|
{
|
2016-04-12 17:59:27 +02:00
|
|
|
if (empty($class)) {
|
|
|
|
throw new \InvalidArgumentException('$class cannot be empty');
|
|
|
|
}
|
|
|
|
|
2016-01-08 00:28:27 +01:00
|
|
|
if ($class[0] === '\\') {
|
2016-02-18 21:05:13 +01:00
|
|
|
return substr($class, 1);
|
2016-01-08 00:28:27 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
if (strpos($class, '\\') !== false) {
|
|
|
|
$class_parts = explode('\\', $class);
|
|
|
|
$first_namespace = array_shift($class_parts);
|
|
|
|
|
|
|
|
if (isset($imported_namespaces[$first_namespace])) {
|
2016-02-18 21:05:13 +01:00
|
|
|
return $imported_namespaces[$first_namespace] . '\\' . implode('\\', $class_parts);
|
2016-01-08 00:28:27 +01:00
|
|
|
}
|
2016-01-20 00:27:06 +01:00
|
|
|
} elseif (isset($imported_namespaces[$class])) {
|
2016-02-18 21:05:13 +01:00
|
|
|
return $imported_namespaces[$class];
|
2016-01-08 00:28:27 +01:00
|
|
|
}
|
|
|
|
|
2016-02-27 01:11:11 +01:00
|
|
|
return ($namespace ? $namespace . '\\' : '') . $class;
|
2016-01-08 00:28:27 +01:00
|
|
|
}
|
2016-01-20 00:27:06 +01:00
|
|
|
|
|
|
|
public function getNamespace()
|
|
|
|
{
|
|
|
|
return $this->_namespace;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getAliasedClasses()
|
|
|
|
{
|
|
|
|
return $this->_aliased_classes;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getAbsoluteClass()
|
|
|
|
{
|
|
|
|
return $this->_absolute_class;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getClassName()
|
|
|
|
{
|
|
|
|
return $this->_class->name;
|
|
|
|
}
|
|
|
|
|
2016-04-17 17:22:18 +02:00
|
|
|
public function getParentClass()
|
2016-01-20 00:27:06 +01:00
|
|
|
{
|
2016-04-17 17:22:18 +02:00
|
|
|
return $this->_parent_class;
|
2016-01-20 00:27:06 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
public function getFileName()
|
|
|
|
{
|
|
|
|
return $this->_file_name;
|
|
|
|
}
|
|
|
|
|
2016-01-30 00:48:09 +01:00
|
|
|
public function getClassChecker()
|
|
|
|
{
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
2016-04-27 00:42:48 +02:00
|
|
|
/**
|
|
|
|
* @return bool
|
|
|
|
*/
|
2016-01-20 00:27:06 +01:00
|
|
|
public function isStatic()
|
|
|
|
{
|
|
|
|
return false;
|
|
|
|
}
|
2016-01-30 00:48:09 +01:00
|
|
|
|
|
|
|
public function hasCustomGet()
|
|
|
|
{
|
|
|
|
return $this->_has_custom_get;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getPropertyNames()
|
|
|
|
{
|
|
|
|
return $this->_class_properties;
|
|
|
|
}
|
2016-04-12 01:13:50 +02:00
|
|
|
|
2016-05-16 05:06:03 +02:00
|
|
|
public function getSource()
|
|
|
|
{
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
2016-04-27 00:42:48 +02:00
|
|
|
/**
|
|
|
|
* @return bool
|
|
|
|
*/
|
2016-04-12 01:13:50 +02:00
|
|
|
public function classImplements($absolute_class, $interface)
|
|
|
|
{
|
|
|
|
if (isset($_implementing_classes[$absolute_class][$interface])) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (isset($_implementing_classes[$absolute_class])) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
$class_implementations = class_implements($absolute_class);
|
|
|
|
|
|
|
|
if (!isset($class_implementations[$interface])) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
$_implementing_classes[$absolute_class] = $class_implementations;
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
2016-04-17 17:22:18 +02:00
|
|
|
|
2016-05-16 05:06:03 +02:00
|
|
|
protected function _registerInheritedMethods($parent_class, array $method_map = null)
|
2016-04-17 17:22:18 +02:00
|
|
|
{
|
2016-05-16 05:06:03 +02:00
|
|
|
if (!isset(self::$_class_methods[$parent_class])) {
|
2016-04-17 17:22:18 +02:00
|
|
|
$class_methods = [];
|
|
|
|
|
2016-05-16 05:06:03 +02:00
|
|
|
$reflection_class = new ReflectionClass($parent_class);
|
2016-04-17 17:22:18 +02:00
|
|
|
|
|
|
|
$reflection_methods = $reflection_class->getMethods(ReflectionMethod::IS_PUBLIC | ReflectionMethod::IS_PROTECTED);
|
|
|
|
|
|
|
|
foreach ($reflection_methods as $reflection_method) {
|
2016-06-03 01:21:35 +02:00
|
|
|
if (!$reflection_method->isAbstract() && $reflection_method->getDeclaringClass()->getName() === $parent_class) {
|
2016-05-17 00:10:59 +02:00
|
|
|
$method_name = $reflection_method->getName();
|
|
|
|
$class_methods[] = $method_name;
|
|
|
|
}
|
2016-04-17 17:22:18 +02:00
|
|
|
}
|
2016-04-17 18:27:47 +02:00
|
|
|
|
2016-05-16 05:06:03 +02:00
|
|
|
self::$_class_methods[$parent_class] = $class_methods;
|
2016-04-17 17:22:18 +02:00
|
|
|
}
|
|
|
|
else {
|
2016-05-16 05:06:03 +02:00
|
|
|
$class_methods = self::$_class_methods[$parent_class];
|
2016-04-17 17:22:18 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
foreach ($class_methods as $method_name) {
|
2016-05-22 18:14:48 +02:00
|
|
|
$parent_method_id = $parent_class . '::' . $method_name;
|
|
|
|
$implemented_method_id = $this->_absolute_class . '::' . (isset($method_map[$method_name]) ? $method_map[$method_name] : $method_name);
|
|
|
|
|
|
|
|
ClassMethodChecker::registerInheritedMethod($parent_method_id, $implemented_method_id);
|
2016-04-17 17:22:18 +02:00
|
|
|
}
|
|
|
|
}
|
2016-05-16 05:06:03 +02:00
|
|
|
|
|
|
|
public static function setThisClass($this_class)
|
|
|
|
{
|
|
|
|
self::$_this_class = $this_class;
|
2016-05-16 22:12:02 +02:00
|
|
|
|
|
|
|
self::$_class_checkers = [];
|
2016-05-16 05:06:03 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
public static function getThisClass()
|
|
|
|
{
|
|
|
|
return self::$_this_class;
|
|
|
|
}
|
2016-01-08 00:28:27 +01:00
|
|
|
}
|