SavinMikhail\CommentsDensity\MissingDocblock\Visitors\MissingDocBlockVisitor

Complexity

Total Complexity

4

Size/Duplication

Total Lines	31
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	enterNode()	0	20	3

<?php

declare(strict_types=1);

namespace SavinMikhail\CommentsDensity\MissingDocblock\Visitors;

use PhpParser\Node;
use PhpParser\NodeVisitorAbstract;
use SavinMikhail\CommentsDensity\DTO\Output\CommentDTO;

The type SavinMikhail\CommentsDensity\DTO\Output\CommentDTO was not found. Maybe you did not declare it correctly or list all dependencies?

use SavinMikhail\CommentsDensity\MissingDocblock\MissingDocBlockAnalyzer;
use SavinMikhail\CommentsDensity\MissingDocblock\Visitors\Checkers\NodeNeedsDocblockChecker;

final class MissingDocBlockVisitor extends NodeVisitorAbstract
{
    /** @var CommentDTO[]  */
    public array $missingDocBlocks = [];

    public function __construct(
        private readonly string $filename,
        private readonly NodeNeedsDocblockChecker $nodeChecker,
    ) {
    }

    public function enterNode(Node $node): null
    {
        if (! $this->nodeChecker->requiresDocBlock($node)) {
            return null;
        }
        $docComment = $node->getDocComment();
        if ($docComment !== null) {
            return null;
        }

        $this->missingDocBlocks[] =
            new CommentDTO(
                MissingDocBlockAnalyzer::NAME, //todo: use methods from MissingDocBlockAnalyzer
                MissingDocBlockAnalyzer::COLOR,
                $this->filename,
                $node->getLine(),

The function PhpParser\Node::getLine() has been deprecated: Use getStartLine() instead

                $this->nodeChecker->determineMissingContent(),
            );

        return null;
    }
}