Murtukov\PHPCodeGenerator\DocBlockTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	buildDocBlock()	0	9	2
A	getDocBlock()	0	3	1
A	setDocBlock()	0	5	1
A	createDocBlock()	0	3	1
A	removeDocBlock()	0	5	1

<?php

declare(strict_types=1);

namespace Murtukov\PHPCodeGenerator;

trait DocBlockTrait
{
    protected ?Comment $docBlock = null;

    public function getDocBlock(): Comment
    {
        return $this->docBlock;

The expression return $this->docBlock could return the type null which is incompatible with the type-hinted return Murtukov\PHPCodeGenerator\Comment. Consider adding an additional type-check to rule them out.

    }

    public function setDocBlock(string $text): self
    {
        $this->docBlock = Comment::docBlock($text);

        return $this;
    }

    public function createDocBlock(string $text = ''): Comment
    {
        return $this->docBlock = Comment::docBlock($text);
    }

    public function removeDocBlock(): self
    {
        $this->docBlock = null;

        return $this;
    }

    protected function buildDocBlock()
    {
        $code = '';

        if (null !== $this->docBlock) {
            $code = "$this->docBlock\n";
        }

        return $code;
    }
}