Completed
Push — master ( d82f0a...49e44e )
by Дмитрий
03:44
created

MethodCannotReturn::getConfiguration()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 9
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 5
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 9
ccs 0
cts 5
cp 0
crap 2
rs 9.6666
1
<?php
2
/**
3
 * @author Patsura Dmitry https://github.com/ovr <[email protected]>
4
 */
5
6
namespace PHPSA\Analyzer\Pass\Statement;
7
8
use PhpParser\Node\Stmt\ClassMethod;
9
use PhpParser\Node\Stmt\Return_;
10
use PHPSA\Analyzer\Helper\ResolveExpressionTrait;
11
use PHPSA\Analyzer\Pass\AnalyzerPassInterface;
12
use PHPSA\Analyzer\Pass\ConfigurablePassInterface;
13
use PHPSA\Context;
14
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
15
16
class MethodCannotReturn implements ConfigurablePassInterface, AnalyzerPassInterface
17
{
18
    use ResolveExpressionTrait;
19
20
    /**
21
     * @param ClassMethod $methodStmt
22
     * @param Context $context
23
     * @return bool
24
     */
25 6
    public function pass(ClassMethod $methodStmt, Context $context)
26
    {
27 6
        if (count($methodStmt->stmts) == 0) {
28
            return false;
29
        }
30
31 6
        $result = false;
32
33 6
        if ($methodStmt->name == '__construct' || $methodStmt->name == '__destruct') {
34
            foreach ($this->findReturnStatement($methodStmt->stmts) as $returnStmt) {
35
                if (!$returnStmt->expr) {
36
                    continue;
37
                }
38
39
                $context->notice(
40
                    'return.construct',
41
                    sprintf('Method %s cannot return a value.', $methodStmt->name),
42
                    $returnStmt
43
                );
44
45
                $result = true;
46
            }
47
        }
48
49 6
        return $result;
50
    }
51
52
    /**
53
     * @return TreeBuilder
54
     */
55
    public function getConfiguration()
56
    {
57
        $treeBuilder = new TreeBuilder();
58
        $treeBuilder->root('method_cannot_return')
59
            ->canBeDisabled()
60
        ;
61
62
        return $treeBuilder;
63
    }
64
65
    /**
66
     * @return array
67
     */
68 1
    public function getRegister()
69
    {
70
        return [
71
            \PhpParser\Node\Stmt\ClassMethod::class
72 1
        ];
73
    }
74
}
75