/usr/share/php/PHP/PMD/Rule/Naming/ShortVariable.php is in phpmd 1.5.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 | <?php
/**
* This file is part of PHP_PMD.
*
* PHP Version 5
*
* Copyright (c) 2008-2012, Manuel Pichler <mapi@phpmd.org>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Manuel Pichler nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @category PHP
* @package PHP_PMD
* @subpackage Rule_Naming
* @author Manuel Pichler <mapi@phpmd.org>
* @copyright 2008-2012 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version SVN: $Id$
* @link http://phpmd.org
*/
require_once 'PHP/PMD/AbstractRule.php';
require_once 'PHP/PMD/Rule/IClassAware.php';
require_once 'PHP/PMD/Rule/IMethodAware.php';
require_once 'PHP/PMD/Rule/IFunctionAware.php';
/**
* This rule class will detect variables, parameters and properties with short
* names.
*
* @category PHP
* @package PHP_PMD
* @subpackage Rule_Naming
* @author Manuel Pichler <mapi@phpmd.org>
* @copyright 2008-2012 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 1.5.0
* @link http://phpmd.org
*/
class PHP_PMD_Rule_Naming_ShortVariable
extends PHP_PMD_AbstractRule
implements PHP_PMD_Rule_IClassAware,
PHP_PMD_Rule_IMethodAware,
PHP_PMD_Rule_IFunctionAware
{
/**
* Temporary map holding variables that were already processed in the
* current context.
*
* @var array(string=>boolean)
*/
private $processedVariables = array();
/**
* Extracts all variable and variable declarator nodes from the given node
* and checks the variable name length against the configured minimum
* length.
*
* @param PHP_PMD_AbstractNode $node The context source code node.
*
* @return void
*/
public function apply(PHP_PMD_AbstractNode $node)
{
$this->resetProcessed();
if ($node->getType() === 'class') {
$fields = $node->findChildrenOfType('FieldDeclaration');
foreach ($fields as $field) {
$declarators = $field->findChildrenOfType('VariableDeclarator');
foreach ($declarators as $declarator) {
$this->checkNodeImage($declarator);
}
}
} else {
$declarators = $node->findChildrenOfType('VariableDeclarator');
foreach ($declarators as $declarator) {
$this->checkNodeImage($declarator);
}
$variables = $node->findChildrenOfType('Variable');
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 PHP_PMD_AbstractNode $node The context source code node.
*
* @return void
*/
protected function checkNodeImage(PHP_PMD_AbstractNode $node)
{
if ($this->isNotProcessed($node)) {
$this->addProcessed($node);
$this->doCheckNodeImage($node);
}
}
/**
* Template method that performs the real node image check.
*
* @param PHP_PMD_AbstractNode $node The context source code node.
*
* @return void
*/
protected function doCheckNodeImage(PHP_PMD_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
*/
private 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 PHP_PMD_AbstractNode $node The context source code node.
*
* @return boolean
*/
private function isNameAllowedInContext(PHP_PMD_AbstractNode $node)
{
return $this->isChildOf($node, 'CatchStatement')
|| $this->isChildOf($node, 'ForInit')
|| $this->isChildOf($node, 'ForeachStatement')
|| $this->isChildOf($node, 'MemberPrimaryPrefix');
}
/**
* Checks if the given node is a direct or indirect child of a node with
* the given type.
*
* @param PHP_PMD_AbstractNode $node The context source code node.
* @param string $type Possible parent type.
*
* @return boolean
*/
private function isChildOf(PHP_PMD_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 PHP_PMD_AbstractNode $node The node to add.
*
* @return void
*/
protected function addProcessed(PHP_PMD_AbstractNode $node)
{
$this->processedVariables[$node->getImage()] = true;
}
/**
* Checks if the given node was already processed.
*
* @param PHP_PMD_AbstractNode $node The node to check.
*
* @return boolean
*/
protected function isNotProcessed(PHP_PMD_AbstractNode $node)
{
return !isset($this->processedVariables[$node->getImage()]);
}
}
|