MS\PHPMD\Rule\CleanCode\ReturnStatement

Complexity

Total Complexity

6

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	apply()	0	17	4
A	getAllowedClasses()	0	10	2

<?php

namespace MS\PHPMD\Rule\CleanCode;

use PDepend\Source\AST\ASTReturnStatement;
use PHPMD\AbstractNode;
use PHPMD\AbstractRule;
use PHPMD\Node\MethodNode;
use PHPMD\Rule\MethodAware;

/**
 * To easy understand a return statement line, it should only have simple allocations.
 * Don't write your logical code in the return line.
 */
class ReturnStatement extends AbstractRule implements MethodAware
{
    /**
     * @param AbstractNode|MethodNode $node
     */
    public function apply(AbstractNode $node)
    {
        $allowedChildren = $this->getStringProperty('allowedChildren');
        $allowedClasses = $this->getAllowedClasses($allowedChildren);
        $returnStatements = $node->findChildrenOfType('ReturnStatement');

        /** @var AbstractNode|ASTReturnStatement $returnStatement */
        foreach ($returnStatements as $returnStatement) {
            foreach ($returnStatement->getChildren() as $child) {
                $reflectChild = new \ReflectionClass($child);

                if (false === in_array($reflectChild->getShortName(), $allowedClasses)) {
                    $this->addViolation($returnStatement, [$allowedChildren]);
                }
            }
        }
    }

    /**
     * @param string $allowedChildren
     *
     * @return array
     */
    private function getAllowedClasses($allowedChildren)
    {
        $allowedClasses = explode($this->getStringProperty('delimiter'), $allowedChildren);

        foreach ($allowedClasses as &$allowedClass) {
            $allowedClass = 'AST'.$allowedClass;
        }

        return $allowedClasses;
    }
}