BestIt\Sniffs\Functions\ForbiddenFunctionsSniff

Complexity

Total Complexity

5

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

<?php
{
    use SuppressingTrait;

    /**
     * You SHOULD not use eval.
     */
    public const CODE_DISCOURAGED_WITHOUT_ALTERNATIVE = 'Discouraged';

    /**
     * You SHOULD not use alias but the original function names.
     */
    public const CODE_DISCOURAGED_WITH_ALTERNATIVE = 'DiscouragedWithAlternative';

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

    /**
     * The used file.
     *
     * @var File|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 ?int $stackPos = 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
     */
    protected function getFile(): File
    {
        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 $file 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 $file, $stackPtr): void
    {
        $this->file = $file;
        $this->stackPos = $stackPtr;

        if (
            !$this->isSniffSuppressed(static::CODE_DISCOURAGED_WITHOUT_ALTERNATIVE) &&
            !$this->isSniffSuppressed(static::CODE_DISCOURAGED_WITH_ALTERNATIVE)
        ) {
            parent::process($file, $stackPtr);
        }
    }
}