Documentation

PhpdocOrderFixer extends AbstractFixer
in package

Tags
author

Graham Campbell graham@alt-three.com

Table of Contents

getDefinition()  : mixed
{@inheritdoc}
getPriority()  : mixed
{@inheritdoc}
isCandidate()  : mixed
{@inheritdoc}
applyFix()  : mixed
{@inheritdoc}
moveParamAnnotations()  : string
Move all param annotations in before throws and return annotations.
moveReturnAnnotations()  : string
Move all return annotations after param and throws annotations.

Methods

getDefinition()

{@inheritdoc}

public getDefinition() : mixed
Return values
mixed

getPriority()

{@inheritdoc}

public getPriority() : mixed

Must run before PhpdocAlignFixer, PhpdocSeparationFixer, PhpdocTrimFixer. Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, PhpdocAddMissingParamAnnotationFixer, PhpdocIndentFixer, PhpdocNoEmptyReturnFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.

Return values
mixed

applyFix()

{@inheritdoc}

protected applyFix(SplFileInfo $file, Tokens $tokens) : mixed
Parameters
$file : SplFileInfo
$tokens : Tokens
Return values
mixed

moveParamAnnotations()

Move all param annotations in before throws and return annotations.

private moveParamAnnotations(string $content) : string
Parameters
$content : string
Return values
string

moveReturnAnnotations()

Move all return annotations after param and throws annotations.

private moveReturnAnnotations(string $content) : string
Parameters
$content : string
Return values
string

Search results