BestIt\CodeSniffer\AbstractSniff

Complexity

Total Complexity

7

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

80%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	4	1
A	process()	0	10	1
A	getBaseFile()	0	4	1
A	getFile()	0	4	1
A	getTokens()	0	4	1
A	getListenerPointer()	0	4	1
A	getListenerToken()	0	4	1
	getRegisteredTokens()	0	1	?
	processToken()	0	1	?

<?php

declare(strict_types=1);

namespace BestIt\CodeSniffer;

use PHP_CodeSniffer_File;
use PHP_CodeSniffer_Sniff;

/**
 * Class AbstractSniff
 *
 * @package BestIt\Sniffs
 * @author Nick Lubisch <nick.lubisch@bestit-online.de>
 */
abstract class AbstractSniff implements PHP_CodeSniffer_Sniff
{
    /**
     * The CodeSniffer file.
     *
     * @var PHP_CodeSniffer_File
     */
    private $baseFile;

    /**
     * A deferred class of PHP_CodeSniffer_File
     *
     * @var File
     */
    private $file;

    /**
     * Stack of all tokens found in the file
     *
     * @var array
     */
    private $tokens;

    /**
     * Pointer of the listened token.
     *
     * @var int
     */
    private $listenerPtr;

    /**
     * Token data of listened token
     *
     * @var array
     */
    private $listenerToken;

    /**
     * Registers the tokens that this sniff wants to listen for.
     *
     * @return int[] Returns an array of tokens
     */
    public function register(): array
    {
        return $this->getRegisteredTokens();
    }

    /**
     * Called when one of the token types that this sniff is listening for is found.
     *
     * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where the token was found.
     * @param int $stackPtr The position in the PHP_CodeSniffer file's token stack where the token was found.
     *
     * @return void
     */
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr): void
    {
        $this->baseFile = $phpcsFile;
        $this->file = new File($phpcsFile);
        $this->tokens = $phpcsFile->getTokens();
        $this->listenerPtr = $stackPtr;
        $this->listenerToken = $this->tokens[$stackPtr];

        $this->processToken();
    }

    /**
     * Getter for CodeSniffer file
     *
     * @return PHP_CodeSniffer_File The CodeSniffer file
     */
    public function getBaseFile(): PHP_CodeSniffer_File
    {
        return $this->baseFile;
    }

    /**
     * Getter for deferred PHP_CodeSniffer class.
     *
     * @return File The deferred CodeSniffer file
     */
    public function getFile(): File
    {
        return $this->file;
    }

    /**
     * Getter for token stack.
     *
     * @return array Array of token data indexed by pointer
     */
    public function getTokens(): array
    {
        return $this->tokens;
    }

    /**
     * Getter for listener pointer.
     *
     * @return int Returns pointer of the listened token
     */
    public function getListenerPointer(): int
    {
        return $this->listenerPtr;
    }

    /**
     * Getter for listener token data.
     *
     * @return array Returns token data of the listened token
     */
    public function getListenerToken(): array
    {
        return $this->listenerToken;
    }

    /**
     * Returns an array of registered tokens.
     *
     * @return int[] Returns array of tokens to listen for
     */
    abstract public function getRegisteredTokens(): array;

    /**
     * Processes a found registered token.
     *
     * @return void
     */
    abstract public function processToken(): void;
}