class MethodSpacingSniff
Hierarchy
- class \SlevomatCodingStandard\Sniffs\Classes\MethodSpacingSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of MethodSpacingSniff
File
-
vendor/
slevomat/ coding-standard/ SlevomatCodingStandard/ Sniffs/ Classes/ MethodSpacingSniff.php, line 20
Namespace
SlevomatCodingStandard\Sniffs\ClassesView source
class MethodSpacingSniff implements Sniff {
public const CODE_INCORRECT_LINES_COUNT_BETWEEN_METHODS = 'IncorrectLinesCountBetweenMethods';
/** @var int */
public $minLinesCount = 1;
/** @var int */
public $maxLinesCount = 1;
/**
* @return array<int, (int|string)>
*/
public function register() : array {
return [
T_FUNCTION,
];
}
/**
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
* @param int $methodPointer
*/
public function process(File $phpcsFile, $methodPointer) : void {
$this->minLinesCount = SniffSettingsHelper::normalizeInteger($this->minLinesCount);
$this->maxLinesCount = SniffSettingsHelper::normalizeInteger($this->maxLinesCount);
if (!FunctionHelper::isMethod($phpcsFile, $methodPointer)) {
return;
}
$tokens = $phpcsFile->getTokens();
$methodEndPointer = array_key_exists('scope_closer', $tokens[$methodPointer]) ? $tokens[$methodPointer]['scope_closer'] : TokenHelper::findNext($phpcsFile, T_SEMICOLON, $methodPointer + 1);
$classPointer = ClassHelper::getClassPointer($phpcsFile, $methodPointer);
$nextMethodPointer = TokenHelper::findNext($phpcsFile, T_FUNCTION, $methodEndPointer + 1, $tokens[$classPointer]['scope_closer']);
if ($nextMethodPointer === null) {
return;
}
$nextMethodDocCommentStartPointer = DocCommentHelper::findDocCommentOpenPointer($phpcsFile, $nextMethodPointer);
if ($nextMethodDocCommentStartPointer !== null && $tokens[$tokens[$nextMethodDocCommentStartPointer]['comment_closer']]['line'] + 1 !== $tokens[$nextMethodPointer]['line']) {
$nextMethodDocCommentStartPointer = null;
}
$nextMethodFirstLinePointer = $tokens[$nextMethodPointer]['line'] === $tokens[$methodEndPointer]['line'] ? TokenHelper::findNextEffective($phpcsFile, $methodEndPointer + 1) : TokenHelper::findFirstTokenOnLine($phpcsFile, $nextMethodDocCommentStartPointer ?? $nextMethodPointer);
if (TokenHelper::findNextNonWhitespace($phpcsFile, $methodEndPointer + 1, $nextMethodFirstLinePointer) !== null) {
return;
}
$linesBetween = $tokens[$nextMethodFirstLinePointer]['line'] !== $tokens[$methodEndPointer]['line'] ? $tokens[$nextMethodFirstLinePointer]['line'] - $tokens[$methodEndPointer]['line'] - 1 : null;
if ($linesBetween !== null && $linesBetween >= $this->minLinesCount && $linesBetween <= $this->maxLinesCount) {
return;
}
if ($this->minLinesCount === $this->maxLinesCount) {
$errorMessage = $this->minLinesCount === 1 ? 'Expected 1 blank line after method, found %3$d.' : 'Expected %2$d blank lines after method, found %3$d.';
}
else {
$errorMessage = 'Expected %1$d to %2$d blank lines after method, found %3$d.';
}
$fix = $phpcsFile->addFixableError(sprintf($errorMessage, $this->minLinesCount, $this->maxLinesCount, $linesBetween ?? 0), $methodPointer, self::CODE_INCORRECT_LINES_COUNT_BETWEEN_METHODS);
if (!$fix) {
return;
}
$phpcsFile->fixer
->beginChangeset();
if ($linesBetween === null) {
$phpcsFile->fixer
->addContent($methodEndPointer, $phpcsFile->eolChar . str_repeat($phpcsFile->eolChar, $this->minLinesCount) . IndentationHelper::getIndentation($phpcsFile, TokenHelper::findFirstNonWhitespaceOnLine($phpcsFile, $methodPointer)));
FixerHelper::removeBetween($phpcsFile, $methodEndPointer, $nextMethodFirstLinePointer);
}
elseif ($linesBetween > $this->maxLinesCount) {
$phpcsFile->fixer
->addContent($methodEndPointer, str_repeat($phpcsFile->eolChar, $this->maxLinesCount + 1));
$firstPointerOnNextMethodLine = TokenHelper::findFirstTokenOnLine($phpcsFile, $nextMethodFirstLinePointer);
FixerHelper::removeBetween($phpcsFile, $methodEndPointer, $firstPointerOnNextMethodLine);
}
else {
$phpcsFile->fixer
->addContent($methodEndPointer, str_repeat($phpcsFile->eolChar, $this->minLinesCount - $linesBetween));
}
$phpcsFile->fixer
->endChangeset();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
MethodSpacingSniff::$maxLinesCount | public | property | @var int | |
MethodSpacingSniff::$minLinesCount | public | property | @var int | |
MethodSpacingSniff::CODE_INCORRECT_LINES_COUNT_BETWEEN_METHODS | public | constant | ||
MethodSpacingSniff::process | public | function | * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint * |
Overrides Sniff::process |
MethodSpacingSniff::register | public | function | * | Overrides Sniff::register |