class RequireSingleLineMethodSignatureSniff
Hierarchy
- class \SlevomatCodingStandard\Sniffs\Classes\AbstractMethodSignature implements \PHP_CodeSniffer\Sniffs\Sniff
- class \SlevomatCodingStandard\Sniffs\Classes\RequireSingleLineMethodSignatureSniff extends \SlevomatCodingStandard\Sniffs\Classes\AbstractMethodSignature
Expanded class hierarchy of RequireSingleLineMethodSignatureSniff
File
-
vendor/
slevomat/ coding-standard/ SlevomatCodingStandard/ Sniffs/ Classes/ RequireSingleLineMethodSignatureSniff.php, line 15
Namespace
SlevomatCodingStandard\Sniffs\ClassesView source
class RequireSingleLineMethodSignatureSniff extends AbstractMethodSignature {
public const CODE_REQUIRED_SINGLE_LINE_SIGNATURE = 'RequiredSingleLineSignature';
/** @var int */
public $maxLineLength = 120;
/** @var list<string> */
public $includedMethodPatterns = [];
/** @var list<string>|null */
public $includedMethodNormalizedPatterns;
/** @var list<string> */
public $excludedMethodPatterns = [];
/** @var list<string>|null */
public $excludedMethodNormalizedPatterns;
/**
* @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);
$signatureWithoutTabIndentation = $this->getSignatureWithoutTabs($phpcsFile, $signature);
$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($signatureWithoutTabIndentation) > $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<string> $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<string>
*/
private function getIncludedMethodNormalizedPatterns() : array {
if ($this->includedMethodNormalizedPatterns === null) {
$this->includedMethodNormalizedPatterns = SniffSettingsHelper::normalizeArray($this->includedMethodPatterns);
}
return $this->includedMethodNormalizedPatterns;
}
/**
* @return list<string>
*/
private function getExcludedMethodNormalizedPatterns() : array {
if ($this->excludedMethodNormalizedPatterns === null) {
$this->excludedMethodNormalizedPatterns = SniffSettingsHelper::normalizeArray($this->excludedMethodPatterns);
}
return $this->excludedMethodNormalizedPatterns;
}
}