TypeCastSniff.php

<?php

declare (strict_types=1);
namespace SlevomatCodingStandard\Sniffs\PHP;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use SlevomatCodingStandard\Helpers\FixerHelper;
use SlevomatCodingStandard\Helpers\TokenHelper;
use function array_key_exists;
use function preg_match;
use function sprintf;
use function strtolower;
use const T_BINARY_CAST;
use const T_BOOL_CAST;
use const T_DOUBLE_CAST;
use const T_INT_CAST;
use const T_STRING_CAST;
use const T_UNSET_CAST;
class TypeCastSniff implements Sniff {
    public const CODE_FORBIDDEN_CAST_USED = 'ForbiddenCastUsed';
    public const CODE_INVALID_CAST_USED = 'InvalidCastUsed';
    private const INVALID_CASTS = [
        'binary' => null,
        'boolean' => 'bool',
        'double' => 'float',
        'integer' => 'int',
        'real' => 'float',
        'unset' => null,
    ];
    
    /**
     * @return array<int, (int|string)>
     */
    public function register() : array {
        return [
            T_STRING_CAST,
            T_BOOL_CAST,
            T_DOUBLE_CAST,
            T_INT_CAST,
            T_UNSET_CAST,
            T_BINARY_CAST,
        ];
    }
    
    /**
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
     * @param int $pointer
     */
    public function process(File $phpcsFile, $pointer) : void {
        $tokens = $phpcsFile->getTokens();
        $cast = $tokens[$pointer]['content'];
        preg_match('~^\\(\\s*(\\S+)\\s*\\)\\z~i', $cast, $matches);
        if (!array_key_exists(1, $matches)) {
            return;
        }
        $castName = $matches[1];
        $castNameLower = strtolower($castName);
        if (!array_key_exists($castNameLower, self::INVALID_CASTS)) {
            return;
        }
        if ($castNameLower === 'unset') {
            $phpcsFile->addError(sprintf('Cast "%s" is forbidden, use "unset(...)" or assign "null" instead.', $cast), $pointer, self::CODE_FORBIDDEN_CAST_USED);
            return;
        }
        if ($castNameLower === 'binary') {
            $fix = $phpcsFile->addFixableError(sprintf('"Cast "%s" is forbidden and has no effect.', $cast), $pointer, self::CODE_FORBIDDEN_CAST_USED);
            if (!$fix) {
                return;
            }
            $end = TokenHelper::findNextEffective($phpcsFile, $pointer + 1);
            $phpcsFile->fixer
                ->beginChangeset();
            FixerHelper::removeBetweenIncluding($phpcsFile, $pointer, $end - 1);
            $phpcsFile->fixer
                ->endChangeset();
            return;
        }
        $fix = $phpcsFile->addFixableError(sprintf('Cast "%s" is forbidden, use "(%s)" instead.', $cast, self::INVALID_CASTS[$castNameLower]), $pointer, self::CODE_INVALID_CAST_USED);
        if (!$fix) {
            return;
        }
        $phpcsFile->fixer
            ->beginChangeset();
        $phpcsFile->fixer
            ->replaceToken($pointer, '(' . self::INVALID_CASTS[$castNameLower] . ')');
        $phpcsFile->fixer
            ->endChangeset();
    }

}