BestIt\Sniffs\Functions\ForbiddenFunctionsSniff

Complexity

Total Complexity

5

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getFile()	0	4	1
A	getStackPos()	0	4	1
A	process()	0	10	3

<?php

declare(strict_types=1);

namespace BestIt\Sniffs\Functions;

use BestIt\CodeSniffer\File as FileDecorator;
use BestIt\Sniffs\SuppressingTrait;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\ForbiddenFunctionsSniff as BaseSniff;

/**
 * You SHOULD not use eval, die, sizeof, delete ...
 *
 * @author blange <bjoern.lange@bestit-online.de>
 * @package BestIt\Sniffs\Functions
 */
class ForbiddenFunctionsSniff extends BaseSniff
{
    use SuppressingTrait;

    /**
     * If true, an error will be thrown; otherwise a warning.
     *
     * @var boolean
     */
    public $error = false;

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

    /**
     * A list of forbidden functions with their alternatives.
     *
     * The value is NULL if no alternative exists. IE, the function should just not be used.
     *
     * @var array<string, string|null>
     */
    public $forbiddenFunctions = [
        'eval' => null,
        'die' => 'exit',
        'sizeof' => 'count',
        'delete' => 'unset',
    ];

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

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

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

    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint
     *
     * @param File $phpcsFile The file being scanned.
     * @param int $stackPtr The position of the current token in the stack passed in $tokens.
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr): void
    {
        $this->file = new FileDecorator($phpcsFile);
        $this->stackPos = $stackPtr;

        if (!$this->isSniffSuppressed('Discouraged') &&
            !$this->isSniffSuppressed('DiscouragedWithAlternative')) {
            parent::process($phpcsFile, $stackPtr);
        }
    }
}