PhpdocSeparationFixer
extends AbstractFixer
in package
implements
ConfigurableFixerInterface
Tags
Table of Contents
Interfaces
Properties
- $groups : array<int, array<int, string>>
Methods
- configure() : void
- Set configuration.
- 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
- ensureAreSeparate() : void
- Force the given annotations to have one empty line between each other.
- ensureAreTogether() : void
- Force the given annotations to immediately follow each other.
- fixAnnotations() : void
- Make sure the annotations are correctly separated.
- fixDescription() : void
- Make sure the description is separated from the annotations.
- isInGroup() : bool
- shouldBeTogether() : bool|null
- tagName() : string|null
Properties
$groups
private
array<int, array<int, string>>
$groups
Methods
configure()
Set configuration.
public
configure(array<string|int, mixed> $configuration) : void
New configuration must override current one, not patch it. Using empty array makes fixer to use default configuration (or reset configuration from previously configured back to default one).
Some fixers may have no configuration, then - simply don't implement this interface.
Other ones may have configuration that will change behavior of fixer,
eg php_unit_strict fixer allows to configure which methods should be fixed.
Finally, some fixers need configuration to work, eg header_comment.
Parameters
- $configuration : array<string|int, mixed>
-
configuration depends on Fixer
getDefinition()
Returns the definition of the fixer.
public
getDefinition() : FixerDefinitionInterface
Return values
FixerDefinitionInterfacegetPriority()
Returns the priority of the fixer.
public
getPriority() : int
Must run before PhpdocAlignFixer. Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, GeneralPhpdocAnnotationRemoveFixer, PhpUnitAttributesFixer, PhpUnitInternalClassFixer, PhpUnitSizeClassFixer, PhpUnitTestClassRequiresCoversFixer, PhpdocIndentFixer, PhpdocNoAccessFixer, PhpdocNoEmptyReturnFixer, PhpdocNoPackageFixer, PhpdocOrderFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.
Return values
intisCandidate()
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
boolapplyFix()
protected
applyFix(SplFileInfo $file, Tokens $tokens) : void
Parameters
- $file : SplFileInfo
- $tokens : Tokens
createConfigurationDefinition()
protected
createConfigurationDefinition() : FixerConfigurationResolverInterface
Return values
FixerConfigurationResolverInterfaceensureAreSeparate()
Force the given annotations to have one empty line between each other.
private
ensureAreSeparate(DocBlock $doc, Annotation $first, Annotation $second) : void
Parameters
- $doc : DocBlock
- $first : Annotation
- $second : Annotation
ensureAreTogether()
Force the given annotations to immediately follow each other.
private
ensureAreTogether(DocBlock $doc, Annotation $first, Annotation $second) : void
Parameters
- $doc : DocBlock
- $first : Annotation
- $second : Annotation
fixAnnotations()
Make sure the annotations are correctly separated.
private
fixAnnotations(DocBlock $doc) : void
Parameters
- $doc : DocBlock
fixDescription()
Make sure the description is separated from the annotations.
private
fixDescription(DocBlock $doc) : void
Parameters
- $doc : DocBlock
isInGroup()
private
isInGroup(string $tag, array<int, string> $group) : bool
Parameters
- $tag : string
- $group : array<int, string>
Return values
boolshouldBeTogether()
private
shouldBeTogether(Annotation $first, Annotation $second, array<int, array<int, string>> $groups) : bool|null
Parameters
- $first : Annotation
- $second : Annotation
- $groups : array<int, array<int, string>>
Return values
bool|nulltagName()
private
tagName(Annotation $annotation) : string|null
Parameters
- $annotation : Annotation