PHPSA\Analyzer\Pass\Statement\ConstantNaming

Complexity

Total Complexity

5

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	5

Test Coverage

Coverage

73.68%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getConfiguration()	0	9	1
A	getRegister()	0	6	1
A	pass()	0	17	3

<?php

namespace PHPSA\Analyzer\Pass\Statement;

use PhpParser\Node\Stmt\ClassConst;
use PHPSA\Analyzer\Pass\AnalyzerPassInterface;
use PHPSA\Analyzer\Pass\ConfigurablePassInterface;
use PHPSA\Context;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;

class ConstantNaming implements ConfigurablePassInterface, AnalyzerPassInterface
{
    /**
     * @param ClassConst $stmt
     * @param Context $context
     * @return bool
     */
    public function pass(ClassConst $stmt, Context $context)
    {
        $result = false;
        foreach ($stmt->consts as $const) {
            if ($const->name !== strtoupper($const->name)) {
                $context->notice(
                    'constant.naming',
                    'Constant names should be all uppercase.',
                    $stmt
                );

                $result = true;
            }
        }
        
        return $result;
    }

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

        return $treeBuilder;
    }

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