PHPSA\Analyzer\Pass\Statement\ReturnAndYieldInOneMethod

Complexity

Total Complexity

5

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	pass()	0	15	4
A	getRegister()	0	6	1

<?php

namespace PHPSA\Analyzer\Pass\Statement;

use PhpParser\Node\Stmt;
use PHPSA\Analyzer\Helper\DefaultMetadataPassTrait;
use PHPSA\Analyzer\Helper\ResolveExpressionTrait;
use PHPSA\Analyzer\Pass;
use PhpParser\Node\Expr;
use PHPSA\Context;

class ReturnAndYieldInOneMethod implements Pass\AnalyzerPassInterface
{
    const DESCRIPTION = 'Checks for using return and yield statements in a one method and discourages it.';

    use DefaultMetadataPassTrait;
    use ResolveExpressionTrait;

    /**
     * @param Stmt $stmt
     * @param Context $context
     * @return bool
     */
    public function pass(Stmt $stmt, Context $context)
    {
        $yieldExists = $this->findYieldExpression([$stmt])->current();
        if (!$yieldExists) {
            // YieldFrom is another expression
            $yieldExists = $this->findNode([$stmt], Expr\YieldFrom::class)->current();
        }

        if ($yieldExists && $this->findReturnStatement([$stmt])->current()) {
            $context->notice('return_and_yield_in_one_method', 'Do not use return and yield in a one method', $stmt);
            return true;
        }

        return false;
    }

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