BestIt\Sniffs\DocPosProviderTrait

Complexity

Total Complexity

9

Size/Duplication

Total Lines	101
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getDocCommentPos()	0	8	2
A	getDocHelper()	0	8	2
A	getFile()	0	4	1
A	getStackPos()	0	4	1
A	loadDocCommentPos()	0	6	2
A	resetDocCommentPos()	0	5	1

<?php

declare(strict_types=1);

namespace BestIt\Sniffs;

use BestIt\CodeSniffer\File;
use BestIt\CodeSniffer\Helper\DocHelper;

/**
 * Trait DocPosProviderTrait.
 *
 * @author blange <bjoern.lange@bestit-online.de>
 * @package  BestIt\Sniffs
 */
trait DocPosProviderTrait
{
    /**
     * The position of the doc comment or null.
     *
     * @var int|null
     */
    private $docCommentPos = -1;

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

    /**
     * The used file.
     *
     * @var File|void
     */
    protected $file;

    /**
     * Position of the listened token.
     *
     * @var int|void
     */
    protected $stackPos;

    /**
     * Returns the position of the doc block if there is one.
     *
     * @return int|null
     */
    protected function getDocCommentPos(): ?int
    {
        if ($this->docCommentPos === -1) {
            $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()->getBaseFile(), $this->getStackPos());
        }

        return $this->docHelper;
    }

    /**
     * Type safe getter for the file.
     *
     * @return File
     */
    private function getFile(): File
    {
        return $this->file;
    }

    /**
     * Type safe getter for the stack position for this sniff.
     *
     * @return int
     */
    private function getStackPos(): int
    {
        return $this->stackPos;
    }

    /**
     * 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 = -1;
        $this->docHelper = null;
    }
}