class RequireAttributeAfterDocCommentSniff
Hierarchy
- class \SlevomatCodingStandard\Sniffs\Attributes\RequireAttributeAfterDocCommentSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of RequireAttributeAfterDocCommentSniff
File
-
vendor/
slevomat/ coding-standard/ SlevomatCodingStandard/ Sniffs/ Attributes/ RequireAttributeAfterDocCommentSniff.php, line 15
Namespace
SlevomatCodingStandard\Sniffs\AttributesView source
class RequireAttributeAfterDocCommentSniff implements Sniff {
public const CODE_ATTRIBUTE_BEFORE_DOC_COMMENT = 'AttributeBeforeDocComment';
/**
* @return array<int, (int|string)>
*/
public function register() : array {
return [
T_ATTRIBUTE,
];
}
/**
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
* @param int $attributeOpenerPointer
*/
public function process(File $phpcsFile, $attributeOpenerPointer) : void {
if (!AttributeHelper::isValidAttribute($phpcsFile, $attributeOpenerPointer)) {
return;
}
$tokens = $phpcsFile->getTokens();
$docCommentOpenerPointer = TokenHelper::findNextExcluding($phpcsFile, T_WHITESPACE, $tokens[$attributeOpenerPointer]['attribute_closer'] + 1);
if ($tokens[$docCommentOpenerPointer]['code'] !== T_DOC_COMMENT_OPEN_TAG) {
return;
}
$docCommentStartPointer = TokenHelper::findFirstTokenOnLine($phpcsFile, $docCommentOpenerPointer);
$docCommentEndPointer = TokenHelper::findLastTokenOnLine($phpcsFile, $tokens[$docCommentOpenerPointer]['comment_closer']);
$docComment = TokenHelper::getContent($phpcsFile, $docCommentStartPointer, $docCommentEndPointer);
$firstAttributeOpenerPointer = $attributeOpenerPointer;
do {
$nonWhitespacePointerBefore = TokenHelper::findPreviousNonWhitespace($phpcsFile, $firstAttributeOpenerPointer - 1);
if ($tokens[$nonWhitespacePointerBefore]['code'] !== T_ATTRIBUTE_END) {
break;
}
$firstAttributeOpenerPointer = $tokens[$nonWhitespacePointerBefore]['attribute_opener'];
} while (true);
$attributeStartPointer = TokenHelper::findFirstTokenOnLine($phpcsFile, $firstAttributeOpenerPointer);
$fix = $phpcsFile->addFixableError('Attribute should be placed after documentation comment.', $attributeOpenerPointer, self::CODE_ATTRIBUTE_BEFORE_DOC_COMMENT);
if (!$fix) {
return;
}
$phpcsFile->fixer
->beginChangeset();
$phpcsFile->fixer
->addContentBefore($attributeStartPointer, $docComment);
FixerHelper::removeBetweenIncluding($phpcsFile, $docCommentStartPointer, $docCommentEndPointer);
$phpcsFile->fixer
->endChangeset();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
RequireAttributeAfterDocCommentSniff::CODE_ATTRIBUTE_BEFORE_DOC_COMMENT | public | constant | ||
RequireAttributeAfterDocCommentSniff::process | public | function | * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint * |
Overrides Sniff::process |
RequireAttributeAfterDocCommentSniff::register | public | function | * | Overrides Sniff::register |