Codor\Sniffs\Classes\ExtendsSniff

Complexity

Total Complexity

5

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	3	1
A	process()	0	5	2
A	handleToken()	0	7	2

<?php declare(strict_types = 1);

namespace Codor\Sniffs\Classes;

use PHP_CodeSniffer\Sniffs\Sniff as PHP_CodeSniffer_Sniff;
use PHP_CodeSniffer\Files\File as PHP_CodeSniffer_File;

class ExtendsSniff implements PHP_CodeSniffer_Sniff
{
    /**
     * The file where the token was found.
     * @var PHP_CodeSniffer_File
     */
    private $phpcsFile;

    /**
     * Returns the token types that this sniff is interested in.
     * @return array
     */
    public function register(): array
    {
        return [T_CLASS];
    }

    /**
     * Processes the tokens that this sniff is interested in.
     *
     * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
     * @param int                  $stackPtr  The position in the stack where
     *                                        the token was found.
     * @return void
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
    {
        $this->phpcsFile = $phpcsFile;
        foreach ($phpcsFile->getTokens() as $token) {
            $this->handleToken($token);
        }
    }

    /**
     * Handle the incoming token.
     * @param  array $token Token data.
     * @return void
     */
    protected function handleToken($token)
    {
        if ($token['type'] !== 'T_EXTENDS') {
            return;
        }
        $warning = "Class extends another class - consider composition over inheritance.";
        $this->phpcsFile->addWarning($warning, $token['line'], __CLASS__);
    }
}