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

Breadcrumb

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

class AbstractMethodSignature

@internal

Hierarchy

  • class \SlevomatCodingStandard\Sniffs\Classes\AbstractMethodSignature implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of AbstractMethodSignature

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/AbstractMethodSignature.php, line 22

Namespace

SlevomatCodingStandard\Sniffs\Classes
View source
abstract class AbstractMethodSignature implements Sniff {
    
    /**
     * @return array<int, (int|string)>
     */
    public function register() : array {
        return [
            T_FUNCTION,
        ];
    }
    
    /**
     * @return array<int, int>
     */
    protected function getSignatureStartAndEndPointers(File $phpcsFile, int $methodPointer) : array {
        $signatureStartPointer = TokenHelper::findFirstTokenOnLine($phpcsFile, $methodPointer);
        
        /** @var int $pointerAfterSignatureEnd */
        $pointerAfterSignatureEnd = TokenHelper::findNext($phpcsFile, [
            T_OPEN_CURLY_BRACKET,
            T_SEMICOLON,
        ], $methodPointer + 1);
        if ($phpcsFile->getTokens()[$pointerAfterSignatureEnd]['code'] === T_SEMICOLON) {
            return [
                $signatureStartPointer,
                $pointerAfterSignatureEnd,
            ];
        }
        
        /** @var int $signatureEndPointer */
        $signatureEndPointer = TokenHelper::findPreviousEffective($phpcsFile, $pointerAfterSignatureEnd - 1);
        return [
            $signatureStartPointer,
            $signatureEndPointer,
        ];
    }
    protected function getSignature(File $phpcsFile, int $signatureStartPointer, int $signatureEndPointer) : string {
        $signature = TokenHelper::getContent($phpcsFile, $signatureStartPointer, $signatureEndPointer);
        $signature = preg_replace(sprintf('~%s[ \\t]*~', $phpcsFile->eolChar), ' ', $signature);
        assert(is_string($signature));
        $signature = str_replace([
            '( ',
            ' )',
        ], [
            '(',
            ')',
        ], $signature);
        $signature = rtrim($signature);
        return $signature;
    }
    protected function getSignatureWithoutTabs(File $phpcsFile, string $signature) : string {
        return IndentationHelper::convertTabsToSpaces($phpcsFile, $signature);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AbstractMethodSignature::getSignature protected function
AbstractMethodSignature::getSignatureStartAndEndPointers protected function *
AbstractMethodSignature::getSignatureWithoutTabs protected function
AbstractMethodSignature::register public function * Overrides Sniff::register
Sniff::process public function Called when one of the token types that this sniff is listening for
is found.
453
RSS feed
Powered by Drupal