PHPSA\Analyzer\Pass\Statement\DoNotUseGoto

Complexity

Total Complexity

5

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

73.91%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	pass()	0	19	3
A	getConfiguration()	0	8	1
A	getRegister()	0	7	1

<?php

namespace PHPSA\Analyzer\Pass\Statement;

use PhpParser\Node\Stmt;
use PhpParser\Node;
use PhpParser\Node\Stmt\Goto_;
use PhpParser\Node\Stmt\Label;
use PHPSA\Analyzer\Pass;
use PHPSA\Context;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;

class DoNotUseGoto implements Pass\ConfigurablePassInterface, Pass\AnalyzerPassInterface
{
    /**
     * @param $stmt
     * @param Context $context
     * @return bool
     */
    public function pass($stmt, Context $context)
    {
        if ($stmt instanceof Label) {
            $context->notice(
                'do_not_use_goto',
                'Do not use labels',
                $stmt
            );
            return true;
        } elseif ($stmt instanceof Goto_) {
            $context->notice(
                'do_not_use_goto',
                'Do not use goto statements',
                $stmt
            );
            return true;
        }
        return false;
    }

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

        return $treeBuilder;
    }

    /**
     * @return array
     */
    public function getRegister()
    {
        return [
            Goto_::class,
            Label::class,
        ];
    }
}