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

Breadcrumb

  1. Drupal Core 11.1.x
  2. NamespaceSpacingSniff.php

function NamespaceSpacingSniff::checkLinesBeforeNamespace

1 call to NamespaceSpacingSniff::checkLinesBeforeNamespace()
NamespaceSpacingSniff::process in vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/NamespaceSpacingSniff.php
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint *

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/NamespaceSpacingSniff.php, line 56

Class

NamespaceSpacingSniff

Namespace

SlevomatCodingStandard\Sniffs\Namespaces

Code

private function checkLinesBeforeNamespace(File $phpcsFile, int $namespacePointer) : void {
    $tokens = $phpcsFile->getTokens();
    
    /** @var int $pointerBeforeNamespace */
    $pointerBeforeNamespace = TokenHelper::findPreviousNonWhitespace($phpcsFile, $namespacePointer - 1);
    $whitespaceBeforeNamespace = '';
    $isInlineCommentBefore = (bool) preg_match('~^(?://|#)(.*)~', $tokens[$pointerBeforeNamespace]['content']);
    if ($tokens[$pointerBeforeNamespace]['code'] === T_OPEN_TAG) {
        $whitespaceBeforeNamespace .= substr($tokens[$pointerBeforeNamespace]['content'], strlen('<?php'));
    }
    elseif ($isInlineCommentBefore) {
        $whitespaceBeforeNamespace .= $phpcsFile->eolChar;
    }
    if ($pointerBeforeNamespace + 1 !== $namespacePointer) {
        $whitespaceBeforeNamespace .= TokenHelper::getContent($phpcsFile, $pointerBeforeNamespace + 1, $namespacePointer - 1);
    }
    $actualLinesCountBeforeNamespace = substr_count($whitespaceBeforeNamespace, $phpcsFile->eolChar) - 1;
    if ($actualLinesCountBeforeNamespace === $this->linesCountBeforeNamespace) {
        return;
    }
    $fix = $phpcsFile->addFixableError(sprintf('Expected %d line%s before namespace statement, found %d.', $this->linesCountBeforeNamespace, $this->linesCountBeforeNamespace === 1 ? '' : 's', $actualLinesCountBeforeNamespace), $namespacePointer, self::CODE_INCORRECT_LINES_COUNT_BEFORE_NAMESPACE);
    if (!$fix) {
        return;
    }
    $phpcsFile->fixer
        ->beginChangeset();
    if ($tokens[$pointerBeforeNamespace]['code'] === T_OPEN_TAG) {
        $phpcsFile->fixer
            ->replaceToken($pointerBeforeNamespace, '<?php');
    }
    elseif ($isInlineCommentBefore) {
        $phpcsFile->fixer
            ->replaceToken($pointerBeforeNamespace, rtrim($tokens[$pointerBeforeNamespace]['content'], $phpcsFile->eolChar));
    }
    FixerHelper::removeBetween($phpcsFile, $pointerBeforeNamespace, $namespacePointer);
    for ($i = 0; $i <= $this->linesCountBeforeNamespace; $i++) {
        $phpcsFile->fixer
            ->addNewline($pointerBeforeNamespace);
    }
    $phpcsFile->fixer
        ->endChangeset();
}

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal