PHPSA\Analyzer\Pass\Statement\MissingDocblock

Complexity

Total Complexity

3

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	pass()	0	14	2
A	getRegister()	0	12	1

<?php

namespace PHPSA\Analyzer\Pass\Statement;

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

class MissingDocblock implements AnalyzerPassInterface
{
    /**
     * @param Stmt $stmt
     * @param Context $context
     * @return bool
     */
    public function pass(Stmt $stmt, Context $context)
    {
        if ($stmt->getDocComment() === null) {
            $context->notice(
                'missing_docblock',
                'Missing Docblock',
                $stmt
            );

            return true;
        }
        
        return false;
    }

    /**
     * @return array
     */
    public function getRegister()
    {
        return [
            Stmt\Class_::class,
            Stmt\ClassMethod::class,
            Stmt\Property::class,
            Stmt\Function_::class,
            Stmt\Trait_::class,
            Stmt\Interface_::class,
            Stmt\ClassConst::class,
        ];
    }
}