Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x

UseDoesNotStartWithBackslashSniff.php

Namespace

SlevomatCodingStandard\Sniffs\Namespaces

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseDoesNotStartWithBackslashSniff.php

View source
<?php

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

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use SlevomatCodingStandard\Helpers\NamespaceHelper;
use SlevomatCodingStandard\Helpers\TokenHelper;
use SlevomatCodingStandard\Helpers\UseStatementHelper;
use function in_array;
use function ltrim;
use const T_USE;
class UseDoesNotStartWithBackslashSniff implements Sniff {
    public const CODE_STARTS_WITH_BACKSLASH = 'UseStartsWithBackslash';
    
    /**
     * @return array<int, (int|string)>
     */
    public function register() : array {
        return [
            T_USE,
        ];
    }
    
    /**
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
     * @param int $usePointer
     */
    public function process(File $phpcsFile, $usePointer) : void {
        if (!UseStatementHelper::isImportUse($phpcsFile, $usePointer)) {
            return;
        }
        $tokens = $phpcsFile->getTokens();
        
        /** @var int $nextTokenPointer */
        $nextTokenPointer = TokenHelper::findNextEffective($phpcsFile, $usePointer + 1);
        if (in_array($tokens[$nextTokenPointer]['code'], TokenHelper::getOnlyNameTokenCodes(), true) && ($tokens[$nextTokenPointer]['content'] === 'function' || $tokens[$nextTokenPointer]['content'] === 'const')) {
            
            /** @var int $nextTokenPointer */
            $nextTokenPointer = TokenHelper::findNextEffective($phpcsFile, $nextTokenPointer + 1);
        }
        if (!NamespaceHelper::isFullyQualifiedPointer($phpcsFile, $nextTokenPointer)) {
            return;
        }
        $fix = $phpcsFile->addFixableError('Use statement cannot start with a backslash.', $nextTokenPointer, self::CODE_STARTS_WITH_BACKSLASH);
        if (!$fix) {
            return;
        }
        $phpcsFile->fixer
            ->beginChangeset();
        $phpcsFile->fixer
            ->replaceToken($nextTokenPointer, ltrim($tokens[$nextTokenPointer]['content'], '\\'));
        $phpcsFile->fixer
            ->endChangeset();
    }

}

Classes

Title Deprecated Summary
UseDoesNotStartWithBackslashSniff
RSS feed
Powered by Drupal