BestIt\Sniffs\DocPosProviderTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

<?php
trait DocPosProviderTrait
{
    /**
     * The position of the doc comment or null.
     *
     * @var int|bool
     */
    private $docCommentPos = false;

    /**
     * The used doc Helper.
     *
     * @var DocHelper|null
     */
    private ?DocHelper $docHelper = null;

This code did not parse for me. Apparently, there is an error somewhere around this line:

Syntax error, unexpected '?', expecting T_FUNCTION or T_CONST

    /**
     * Returns the position of the doc block if there is one.
     *
     * @return int|bool
     */
    protected function getDocCommentPos()
    {
        if ($this->docCommentPos === false) {
            $this->docCommentPos = $this->loadDocCommentPos();
        }

        return $this->docCommentPos;
    }

    /**
     * Returns the helper for the doc block.
     *
     * @return DocHelper
     */
    protected function getDocHelper(): DocHelper
    {
        if ($this->docHelper === null) {
            $this->docHelper = new DocHelper($this->getFile(), $this->getStackPos());
        }

        return $this->docHelper;
    }

    /**
     * Type-safe getter for the file.
     *
     * @return File
     */
    abstract protected function getFile(): File;

    /**
     * Type-safe getter for the stack position.
     *
     * @return int
     */
    abstract protected function getStackPos(): int;

    /**
     * Loads the position of the doc comment.
     *
     * @return int|null
     */
    protected function loadDocCommentPos(): ?int
    {
        $docHelper = $this->getDocHelper();

        return $docHelper->hasDocBlock() ? $docHelper->getBlockStartPosition() : null;
    }

    /**
     * Removes the cached data for the doc comment position.
     *
     * @return void
     */
    protected function resetDocCommentPos(): void
    {
        $this->docCommentPos = false;
        $this->docHelper = null;
    }

    /**
     * Removes the cached data.
     *
     * @return void
     */
    protected function tearDown(): void
    {
        $this->resetDocCommentPos();
    }
}