Issues in CamelCaseParameterName.php - All Issues - Inspection of "Merge pull request #865 from lukasbestle/feature/s..." - phpmd/phpmd - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 902a34...c826a7 )

by Kyle

created 2021-04-16 22:41 UTC

Rule/Controversial/CamelCaseParameterName.php (1 issue)

Labels

Severity

Minor 1

Francis Besset 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * This file is part of PHP Mess Detector.
 *
 * Copyright (c) Manuel Pichler <[email protected]>.
 * 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 <[email protected]>
 * @copyright Manuel Pichler. All rights reserved.
 * @license https://opensource.org/licenses/bsd-license.php BSD License
 * @link http://phpmd.org/
 */

namespace PHPMD\Rule\Controversial;

use PHPMD\AbstractNode;
use PHPMD\AbstractRule;
use PHPMD\Rule\FunctionAware;
use PHPMD\Rule\MethodAware;

/**
 * This rule class detects parameters not named in camelCase.
 *
 * @author Francis Besset <[email protected]>
 * @since 1.1.0
 */
class CamelCaseParameterName extends AbstractRule implements MethodAware, FunctionAware
{
    /**
     * This method checks if a parameter is not named in camelCase
     * and emits a rule violation.
     *
     * @param \PHPMD\AbstractNode $node
     * @return void
     */
    public function apply(AbstractNode $node)
    {
        foreach ($node->getParameters() as $parameter) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            if (!$this->isValid($parameter->getName())) {
                $this->addViolation(
                    $node,
                    array(
                        $parameter->getName(),
                    )
                );
            }
        }
    }

    protected function isValid($parameterName)
    {
        if ($this->getBooleanProperty('allow-underscore')) {
            return preg_match('/^\$[_]?[a-z][a-zA-Z0-9]*$/', $parameterName);
        }

        return preg_match('/^\$[a-z][a-zA-Z0-9]*$/', $parameterName);
    }
}


1			<?php
2			/**
3			* This file is part of PHP Mess Detector.
4			*
5			* Copyright (c) Manuel Pichler <[email protected]>.
6			* All rights reserved.
7			*
8			* Licensed under BSD License
9			* For full copyright and license information, please see the LICENSE file.
10			* Redistributions of files must retain the above copyright notice.
11			*
12			* @author Manuel Pichler <[email protected]>
13			* @copyright Manuel Pichler. All rights reserved.
14			* @license https://opensource.org/licenses/bsd-license.php BSD License
15			* @link http://phpmd.org/
16			*/
17
18			namespace PHPMD\Rule\Controversial;
19
20			use PHPMD\AbstractNode;
21			use PHPMD\AbstractRule;
22			use PHPMD\Rule\FunctionAware;
23			use PHPMD\Rule\MethodAware;
24
25			/**
26			* This rule class detects parameters not named in camelCase.
27			*
28			* @author Francis Besset <[email protected]>
29			* @since 1.1.0
30			*/
31			class CamelCaseParameterName extends AbstractRule implements MethodAware, FunctionAware
32			{
33			/**
34			* This method checks if a parameter is not named in camelCase
35			* and emits a rule violation.
36			*
37			* @param \PHPMD\AbstractNode $node
38			* @return void
39			*/
40			public function apply(AbstractNode $node)
41			{
42			foreach ($node->getParameters() as $parameter) {
			0 ignored issues – show Documentation Bug introduced 2015-11-24 14:03 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `getParameters` does not exist on `object<PHPMD\AbstractNode>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
43			if (!$this->isValid($parameter->getName())) {
44			$this->addViolation(
45			$node,
46			array(
47			$parameter->getName(),
48			)
49			);
50			}
51			}
52			}
53
54			protected function isValid($parameterName)
55			{
56			if ($this->getBooleanProperty('allow-underscore')) {
57			return preg_match('/^\$[_]?[a-z][a-zA-Z0-9]*$/', $parameterName);
58			}
59
60			return preg_match('/^\$[a-z][a-zA-Z0-9]*$/', $parameterName);
61			}
62			}
63

phpmd / phpmd

Push — master ( 902a34...c826a7 )

Rule/Controversial/CamelCaseParameterName.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like