PhpdocSeparationFixer
extends AbstractFixer
in package
Tags
Table of Contents
- getDefinition() : mixed
- {@inheritdoc}
- getPriority() : mixed
- {@inheritdoc}
- isCandidate() : mixed
- {@inheritdoc}
- applyFix() : mixed
- {@inheritdoc}
- ensureAreSeparate() : mixed
- Force the given annotations to have one empty line between each other.
- ensureAreTogether() : mixed
- Force the given annotations to immediately follow each other.
- fixAnnotations() : string
- Make sure the annotations are correctly separated.
- fixDescription() : mixed
- Make sure the description is separated from the annotations.
Methods
getDefinition()
{@inheritdoc}
public
getDefinition() : mixed
Return values
mixed —getPriority()
{@inheritdoc}
public
getPriority() : mixed
Must run before PhpdocAlignFixer. Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, GeneralPhpdocAnnotationRemoveFixer, PhpdocIndentFixer, PhpdocNoAccessFixer, PhpdocNoEmptyReturnFixer, PhpdocNoPackageFixer, PhpdocOrderFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.
Return values
mixed —isCandidate()
{@inheritdoc}
public
isCandidate(Tokens $tokens) : mixed
Parameters
- $tokens : Tokens
Return values
mixed —applyFix()
{@inheritdoc}
protected
applyFix(SplFileInfo $file, Tokens $tokens) : mixed
Parameters
- $file : SplFileInfo
- $tokens : Tokens
Return values
mixed —ensureAreSeparate()
Force the given annotations to have one empty line between each other.
private
ensureAreSeparate(DocBlock $doc, Annotation $first, Annotation $second) : mixed
Parameters
- $doc : DocBlock
- $first : Annotation
- $second : Annotation
Return values
mixed —ensureAreTogether()
Force the given annotations to immediately follow each other.
private
ensureAreTogether(DocBlock $doc, Annotation $first, Annotation $second) : mixed
Parameters
- $doc : DocBlock
- $first : Annotation
- $second : Annotation
Return values
mixed —fixAnnotations()
Make sure the annotations are correctly separated.
private
fixAnnotations(DocBlock $doc) : string
Parameters
- $doc : DocBlock
Return values
string —fixDescription()
Make sure the description is separated from the annotations.
private
fixDescription(DocBlock $doc) : mixed
Parameters
- $doc : DocBlock