| Current Path : /home/rtorresani/www/vendor/phpmd/phpmd/src/main/php/PHPMD/Rule/CleanCode/ |
| Current File : //home/rtorresani/www/vendor/phpmd/phpmd/src/main/php/PHPMD/Rule/CleanCode/MissingImport.php |
<?php
/**
* This file is part of PHP Mess Detector.
*
* Copyright (c) Manuel Pichler <mapi@phpmd.org>.
* All rights reserved.
*
* Licensed under BSD License
* For full copyright and license information, please see the LICENSE file.
* Redistributions of files must retain the above copyright notice.
*
* @author Manuel Pichler <mapi@phpmd.org>
* @copyright Manuel Pichler. All rights reserved.
* @license https://opensource.org/licenses/bsd-license.php BSD License
* @link http://phpmd.org/
*/
namespace PHPMD\Rule\CleanCode;
use PHPMD\AbstractNode;
use PHPMD\AbstractRule;
use PHPMD\Node\ASTNode;
use PHPMD\Rule\FunctionAware;
use PHPMD\Rule\MethodAware;
/**
* Checks that all classes are imported
*
* This rule can be used to prevent use of fully qualified class names.
*/
class MissingImport extends AbstractRule implements MethodAware, FunctionAware
{
/**
* @var array Self reference class names.
*/
protected $selfReferences = array('self', 'static');
/**
* Checks for missing class imports and warns about it
*
* @param AbstractNode $node The node to check upon.
* @return void
*/
public function apply(AbstractNode $node)
{
$ignoreGlobal = $this->getBooleanProperty('ignore-global');
foreach ($node->findChildrenOfType('AllocationExpression') as $allocationNode) {
if (!$allocationNode) {
continue;
}
$classNode = $allocationNode->getChild(0);
if ($this->isSelfReference($classNode)) {
continue;
}
if ($ignoreGlobal && $this->isGlobalNamespace($classNode)) {
continue;
}
$classNameLength = $classNode->getEndColumn() - $classNode->getStartColumn() + 1;
$className = $classNode->getImage();
$fqcnLength = strlen($className);
if ($classNameLength === $fqcnLength && substr($className, 0, 1) !== '$') {
$this->addViolation($classNode, array($classNode->getBeginLine(), $classNode->getStartColumn()));
}
}
}
/**
* Check whether a given class node is a self reference
*
* @param ASTNode $classNode A class node to check.
* @return bool Whether the given class node is a self reference.
*/
protected function isSelfReference(ASTNode $classNode)
{
return in_array($classNode->getImage(), $this->selfReferences, true);
}
/**
* Check whether a given class node is in the global namespace
*
* @param ASTNode $classNode A class node to check.
* @return bool Whether the given class node is in the global namespace.
*/
protected function isGlobalNamespace(ASTNode $classNode)
{
return !strpos($classNode->getImage(), '\\', 1);
}
}