*/ public array $includedMethodPatterns = []; /** @var list|null */ public ?array $includedMethodNormalizedPatterns = null; /** @var list */ public array $excludedMethodPatterns = []; /** @var list|null */ public ?array $excludedMethodNormalizedPatterns = null; /** * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint * @param int $methodPointer */ public function process(File $phpcsFile, $methodPointer): void { $this->maxLineLength = SniffSettingsHelper::normalizeInteger($this->maxLineLength); if (!FunctionHelper::isMethod($phpcsFile, $methodPointer)) { return; } $tokens = $phpcsFile->getTokens(); [$signatureStartPointer, $signatureEndPointer] = $this->getSignatureStartAndEndPointers($phpcsFile, $methodPointer); if ($tokens[$signatureStartPointer]['line'] === $tokens[$signatureEndPointer]['line']) { return; } $signature = $this->getSignature($phpcsFile, $signatureStartPointer, $signatureEndPointer); $methodName = FunctionHelper::getName($phpcsFile, $methodPointer); if ( count($this->includedMethodPatterns) !== 0 && !$this->isMethodNameInPatterns($methodName, $this->getIncludedMethodNormalizedPatterns()) ) { return; } if ( count($this->excludedMethodPatterns) !== 0 && $this->isMethodNameInPatterns($methodName, $this->getExcludedMethodNormalizedPatterns()) ) { return; } if ($this->maxLineLength !== 0 && strlen($signature) > $this->maxLineLength) { return; } $error = sprintf('Signature of method "%s" should be placed on a single line.', $methodName); $fix = $phpcsFile->addFixableError($error, $methodPointer, self::CODE_REQUIRED_SINGLE_LINE_SIGNATURE); if (!$fix) { return; } $phpcsFile->fixer->beginChangeset(); FixerHelper::change($phpcsFile, $signatureStartPointer, $signatureEndPointer, $signature); $phpcsFile->fixer->endChangeset(); } /** * @param list $normalizedPatterns */ private function isMethodNameInPatterns(string $methodName, array $normalizedPatterns): bool { foreach ($normalizedPatterns as $pattern) { if (!SniffSettingsHelper::isValidRegularExpression($pattern)) { throw new Exception(sprintf('%s is not valid PCRE pattern.', $pattern)); } if (preg_match($pattern, $methodName) !== 0) { return true; } } return false; } /** * @return list */ private function getIncludedMethodNormalizedPatterns(): array { $this->includedMethodNormalizedPatterns ??= SniffSettingsHelper::normalizeArray($this->includedMethodPatterns); return $this->includedMethodNormalizedPatterns; } /** * @return list */ private function getExcludedMethodNormalizedPatterns(): array { $this->excludedMethodNormalizedPatterns ??= SniffSettingsHelper::normalizeArray($this->excludedMethodPatterns); return $this->excludedMethodNormalizedPatterns; } }