BestIt\Sniffs\SuppressingTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

<?php
trait SuppressingTrait
{
    /**
     * The used suppresshelper.
     *
     * @var SuppressHelper|null
     */
    private ?SuppressHelper $suppressHelper = 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

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

    /**
     * Get the sniff name.
     *
     * @param string|null $sniffName If there is an optional sniff name.
     *
     * @return string Returns the special sniff name in the code sniffer context.
     */
    private function getSniffName(?string $sniffName = null): string
    {
        $sniffClassName = preg_replace(
            '/Sniff$/',
            '',
            str_replace(['\\', '.Sniffs'], ['.', ''], static::class)
        );

        if ($sniffName) {
            $sniffClassName .= '.' . $sniffName;
        }

        return $sniffClassName;
    }

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

    /**
     * Returns the used suppress helper.
     *
     * @return SuppressHelper The suppress helper.
     */
    private function getSuppressHelper(): SuppressHelper
    {
        if (!$this->suppressHelper) {
            $this->suppressHelper = new SuppressHelper();
        }

        return $this->suppressHelper;
    }

    /**
     * Returns true if this sniff or a rule of this sniff is suppressed with the slevomat suppress annotation.
     *
     * @param null|string $rule The optional rule.
     * @param int|null $stackPos Do you want ot overload the position for the which position the sniff is suppressed.
     *
     * @return bool Returns true if the sniff is suppressed.
     */
    protected function isSniffSuppressed(?string $rule = null, ?int $stackPos = null): bool
    {
        return $this->getSuppressHelper()->isSniffSuppressed(
            $this->getFile(),
            $stackPos ?? $this->getStackPos(),
            $this->getSniffName($rule)
        );
    }
}