MS\PHPMD\Rule\Symfony2\ControllerMethodName

Complexity

Total Complexity

8

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

94.44%

Importance

Changes	4
Bugs	0	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
B	apply()	0	20	5
A	isController()	0	12	3

<?php

namespace MS\PHPMD\Rule\Symfony2;

use PDepend\Source\AST\ASTClass;
use PHPMD\AbstractNode;
use PHPMD\AbstractRule;
use PHPMD\Node\ClassNode;
use PHPMD\Node\MethodNode;
use PHPMD\Rule\ClassAware;

/**
 * Class ControllerMethodName
 *
 * When the class is concrete and ends with Controller, the method names have to end with Action.
 *
 * @package PHPMD\Rule\Symfony2
 */
class ControllerMethodName extends AbstractRule implements ClassAware
{
    /**
     * @param AbstractNode|ClassNode $node
     */
    public function apply(AbstractNode $node)
    {
        if (false === $this->isController($node)) {

$node of type object<PHPMD\AbstractNode> is not a sub-type of object<PHPMD\Node\ClassNode>. It seems like you assume a child class of the class PHPMD\AbstractNode to be always present.

            return;
        }

        $allowedMethodNames = explode($this->getStringProperty('delimiter'), $this->getStringProperty('allowedMethodNames'));

        /** @var MethodNode $method */
        foreach ($node->getMethods() as $method) {
            // Check if method is whitelisted
            if (true === in_array($method->getImage(), $allowedMethodNames)) {
              continue;
            }

            if ('Action' !== substr($method->getImage(), -6, 6)) {
                $this->addViolation($method);
            }
        }
    }

    /**
     * @param ClassNode|ASTClass $node
     *
     * @return bool
     */
    private function isController(ClassNode $node)
    {
        if (true === $node->isAbstract()) {
            return false;
        }

        if ('Controller' === substr($node->getImage(), -10, 10)) {
            return true;
        }

        return false;
    }
}