Your IP : 216.73.216.43
<?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\Naming;
use PHPMD\AbstractNode;
use PHPMD\AbstractRule;
use PHPMD\Rule\ClassAware;
use PHPMD\Rule\FunctionAware;
use PHPMD\Rule\MethodAware;
use PHPMD\Rule\TraitAware;
/**
* This rule class will detect variables, parameters and properties with short
* names.
*/
class ShortVariable extends AbstractRule implements ClassAware, MethodAware, FunctionAware, TraitAware
{
/**
* Temporary map holding variables that were already processed in the
* current context.
*
* @var array(string=>boolean)
*/
protected $processedVariables = array();
/**
* Extracts all variable and variable declarator nodes from the given node
*
* Checks the variable name length against the configured minimum
* length.
*
* @param \PHPMD\AbstractNode $node
* @return void
*/
public function apply(AbstractNode $node)
{
$this->resetProcessed();
if ($node->getType() === 'class') {
$this->applyClass($node);
return;
}
$this->applyNonClass($node);
}
/**
* Extracts all variable and variable declarator nodes from the given class node
*
* Checks the variable name length against the configured minimum
* length.
*
* @param AbstractNode $node
* @return void
*/
protected function applyClass(AbstractNode $node)
{
$fields = $node->findChildrenOfType('FieldDeclaration');
foreach ($fields as $field) {
$declarators = $field->findChildrenOfType('VariableDeclarator');
foreach ($declarators as $declarator) {
$this->checkNodeImage($declarator);
}
}
$this->resetProcessed();
}
/**
* Extracts all variable and variable declarator nodes from the given non-class node
*
* Checks the variable name length against the configured minimum
* length.
*
* @param AbstractNode $node
* @return void
*/
protected function applyNonClass(AbstractNode $node)
{
$declarators = $node->findChildrenOfType('VariableDeclarator');
foreach ($declarators as $declarator) {
$this->checkNodeImage($declarator);
}
$variables = $node->findChildrenOfTypeVariable();
foreach ($variables as $variable) {
$this->checkNodeImage($variable);
}
$this->resetProcessed();
}
/**
* Checks if the variable name of the given node is greater/equal to the
* configured threshold or if the given node is an allowed context.
*
* @param \PHPMD\AbstractNode $node
* @return void
*/
protected function checkNodeImage(AbstractNode $node)
{
if ($this->isNotProcessed($node)) {
$this->addProcessed($node);
$this->checkMinimumLength($node);
}
}
/**
* Template method that performs the real node image check.
*
* @param \PHPMD\AbstractNode $node
* @return void
*/
protected function checkMinimumLength(AbstractNode $node)
{
$threshold = $this->getIntProperty('minimum');
if ($threshold <= strlen($node->getImage()) - 1) {
return;
}
if ($this->isNameAllowedInContext($node)) {
return;
}
$exceptions = $this->getExceptionsList();
if (in_array(substr($node->getImage(), 1), $exceptions)) {
return;
}
$this->addViolation($node, array($node->getImage(), $threshold));
}
/**
* Gets array of exceptions from property
*
* @return array
*/
protected function getExceptionsList()
{
try {
$exceptions = $this->getStringProperty('exceptions');
} catch (\OutOfBoundsException $e) {
$exceptions = '';
}
return explode(',', $exceptions);
}
/**
* Checks if a short name is acceptable in the current context. For the
* moment these contexts are the init section of a for-loop and short
* variable names in catch-statements.
*
* @param \PHPMD\AbstractNode $node
* @return boolean
*/
protected function isNameAllowedInContext(AbstractNode $node)
{
$parent = $node->getParent();
if ($parent && $parent->isInstanceOf('ForeachStatement')) {
return $this->isInitializedInLoop($node);
}
return $this->isChildOf($node, 'CatchStatement')
|| $this->isChildOf($node, 'ForInit')
|| $this->isChildOf($node, 'MemberPrimaryPrefix');
}
/**
* Checks if a short name is initialized within a foreach loop statement
*
* @param \PHPMD\AbstractNode $node
* @return boolean
*/
protected function isInitializedInLoop(AbstractNode $node)
{
if (!$this->getBooleanProperty('allow-short-variables-in-loop', true)) {
return false;
}
$exceptionVariables = array();
$parentForeaches = $this->getParentsOfType($node, 'ForeachStatement');
foreach ($parentForeaches as $foreach) {
foreach ($foreach->getChildren() as $foreachChild) {
$exceptionVariables[] = $foreachChild->getImage();
}
}
$exceptionVariables = array_filter(array_unique($exceptionVariables));
return in_array($node->getImage(), $exceptionVariables, true);
}
/**
* Returns an array of parent nodes of the specified type
*
* @param \PHPMD\AbstractNode $node
* @return array
*/
protected function getParentsOfType(AbstractNode $node, $type)
{
$parents = array();
$parent = $node->getParent();
while (is_object($parent)) {
if ($parent->isInstanceOf($type)) {
$parents[] = $parent;
}
$parent = $parent->getParent();
}
return $parents;
}
/**
* Checks if the given node is a direct or indirect child of a node with
* the given type.
*
* @param \PHPMD\AbstractNode $node
* @param string $type
* @return boolean
*/
protected function isChildOf(AbstractNode $node, $type)
{
$parent = $node->getParent();
while (is_object($parent)) {
if ($parent->isInstanceOf($type)) {
return true;
}
$parent = $parent->getParent();
}
return false;
}
/**
* Resets the already processed nodes.
*
* @return void
*/
protected function resetProcessed()
{
$this->processedVariables = array();
}
/**
* Flags the given node as already processed.
*
* @param \PHPMD\AbstractNode $node
* @return void
*/
protected function addProcessed(AbstractNode $node)
{
$this->processedVariables[$node->getImage()] = true;
}
/**
* Checks if the given node was already processed.
*
* @param \PHPMD\AbstractNode $node
* @return boolean
*/
protected function isNotProcessed(AbstractNode $node)
{
return !isset($this->processedVariables[$node->getImage()]);
}
}