PHPSA\Analyzer\Pass\Statement\MethodCannotReturn

Complexity

Total Complexity

8

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	5

Test Coverage

Coverage

30.43%

Importance

Changes	5
Bugs	0	Features	2

3 Methods

Rating	Name	Duplication	Size	Complexity
B	pass()	0	26	6
A	getConfiguration()	0	9	1
A	getRegister()	0	6	1

<?php
/**
 * @author Patsura Dmitry https://github.com/ovr <talk@dmtry.me>
 */

namespace PHPSA\Analyzer\Pass\Statement;

use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Return_;
use PHPSA\Analyzer\Helper\ResolveExpressionTrait;
use PHPSA\Analyzer\Pass\AnalyzerPassInterface;
use PHPSA\Analyzer\Pass\ConfigurablePassInterface;
use PHPSA\Context;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;

class MethodCannotReturn implements ConfigurablePassInterface, AnalyzerPassInterface
{
    use ResolveExpressionTrait;

    /**
     * @param ClassMethod $methodStmt
     * @param Context $context
     * @return bool
     */
    public function pass(ClassMethod $methodStmt, Context $context)
    {
        if (count($methodStmt->stmts) == 0) {
            return false;
        }

        $result = false;

        if ($methodStmt->name == '__construct' || $methodStmt->name == '__destruct') {
            foreach ($this->findReturnStatement($methodStmt->stmts) as $returnStmt) {
                if (!$returnStmt->expr) {
                    continue;
                }

                $context->notice(
                    'return.construct',
                    sprintf('Method %s cannot return a value.', $methodStmt->name),
                    $returnStmt
                );

                $result = true;
            }
        }

        return $result;
    }

    /**
     * @return TreeBuilder
     */
    public function getConfiguration()
    {
        $treeBuilder = new TreeBuilder();
        $treeBuilder->root('method_cannot_return')
            ->canBeDisabled()
        ;

        return $treeBuilder;
    }

    /**
     * @return array
     */
    public function getRegister()
    {
        return [
            \PhpParser\Node\Stmt\ClassMethod::class
        ];
    }
}