Documentation

PhpdocTagTypeFixer extends AbstractFixer
in package
implements ConfigurableFixerInterface uses ConfigurableFixerTrait

FinalYes
Tags
phpstan-type

_AutogeneratedInputConfiguration array{ tags?: array<string, 'annotation'|'inline'> }

phpstan-type

_AutogeneratedComputedConfiguration array{ tags: array<string, 'annotation'|'inline'> }

implements

ConfigurableFixerInterface<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration>

Table of Contents

Interfaces

ConfigurableFixerInterface

Constants

TAG_REGEX  = '/^(?: (?<tag> (?:@(?<tag_name>.+?)(?:\s.+)?) ) | {(?<inlined_tag> (?:@(?<inlined_tag_name>.+?)(?:\s.+)?) )} )$/x'

Methods

getDefinition()  : FixerDefinitionInterface
Returns the definition of the fixer.
getPriority()  : int
Returns the priority of the fixer.
isCandidate()  : bool
Check if the fixer is a candidate for given Tokens collection.
applyFix()  : void
createConfigurationDefinition()  : FixerConfigurationResolverInterface
cleanComment()  : string
tagIsSurroundedByText()  : bool

Constants

TAG_REGEX

private mixed TAG_REGEX = '/^(?: (?<tag> (?:@(?<tag_name>.+?)(?:\s.+)?) ) | {(?<inlined_tag> (?:@(?<inlined_tag_name>.+?)(?:\s.+)?) )} )$/x'

Methods

getPriority()

Returns the priority of the fixer.

public getPriority() : int

Must run before PhpdocAlignFixer. Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, PhpdocIndentFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.

Return values
int

isCandidate()

Check if the fixer is a candidate for given Tokens collection.

public isCandidate(Tokens $tokens) : bool

Fixer is a candidate when the collection contains tokens that may be fixed during fixer work. This could be considered as some kind of bloom filter. When this method returns true then to the Tokens collection may or may not need a fixing, but when this method returns false then the Tokens collection need no fixing for sure.

Parameters
$tokens : Tokens
Return values
bool

cleanComment()

private cleanComment(string $comment) : string
Parameters
$comment : string
Return values
string

tagIsSurroundedByText()

private tagIsSurroundedByText(array<int, string> $parts, int $index) : bool
Parameters
$parts : array<int, string>
$index : int
Return values
bool

        
On this page

Search results