/usr/share/php/PHP/PMD/Rule/Naming/BooleanGetMethodName.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 | <?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/IMethodAware.php';
/**
* This rule tests that a method which returns a boolean value does not start
* with <b>get</b> or <b>_get</b> for a getter.
*
* @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_BooleanGetMethodName
extends PHP_PMD_AbstractRule
implements PHP_PMD_Rule_IMethodAware
{
/**
* 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)
{
if ($this->isBooleanGetMethod($node)) {
$this->addViolation($node, array($node->getImage()));
}
}
/**
* Tests if the given method matches all criterias to be an invalid
* boolean get method.
*
* @param PHP_PMD_Node_Method $node The context method node.
*
* @return boolean
*/
private function isBooleanGetMethod(PHP_PMD_Node_Method $node)
{
return $this->isGetterMethodName($node)
&& $this->isReturnTypeBoolean($node)
&& $this->isParameterizedOrIgnored($node);
}
/**
* Tests if the given method starts with <b>get</b> or <b>_get</b>.
*
* @param PHP_PMD_Node_Method $node The context method node.
*
* @return boolean
*/
private function isGetterMethodName(PHP_PMD_Node_Method $node)
{
return (preg_match('(^_?get)i', $node->getImage()) > 0);
}
/**
* Tests if the given method is declared with return type boolean.
*
* @param PHP_PMD_Node_Method $node The context method node.
*
* @return boolean
*/
private function isReturnTypeBoolean(PHP_PMD_Node_Method $node)
{
$comment = $node->getDocComment();
return (preg_match('(\*\s*@return\s+bool(ean)?\s)i', $comment) > 0);
}
/**
* Tests if the property <b>$checkParameterizedMethods</b> is set to <b>true</b>
* or has no parameters.
*
* @param PHP_PMD_Node_Method $node The context method node.
*
* @return boolean
*/
private function isParameterizedOrIgnored(PHP_PMD_Node_Method $node)
{
if ($this->getBooleanProperty('checkParameterizedMethods')) {
return $node->getParameterCount() === 0;
}
return true;
}
}
|