Documentation

PhpdocOrderFixer extends AbstractFixer
in package
implements ConfigurableFixerInterface uses ConfigurableFixerTrait

FinalYes
Tags
author

Graham Campbell hello@gjcampbell.co.uk

author

Jakub Kwaśniewski jakub@zero-85.pl

implements

ConfigurableFixerInterface<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration>

phpstan-type

_AutogeneratedInputConfiguration array{ order?: list }

phpstan-type

_AutogeneratedComputedConfiguration array{ order: list }

Table of Contents

Interfaces

ConfigurableFixerInterface

Constants

ORDER_DEFAULT  = ['param', 'throws', 'return']

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
moveAnnotationsAfter()  : string
Move all given annotations after given set of annotations.
moveAnnotationsBefore()  : string
Move all given annotations in before given set of annotations.

Constants

ORDER_DEFAULT

private mixed ORDER_DEFAULT = ['param', 'throws', 'return']
Tags
const

string[]

TODO:

4.0 - change default to ['param', 'return', 'throws']

Methods

getPriority()

Returns the priority of the fixer.

public getPriority() : int

Must run before PhpdocAlignFixer, PhpdocSeparationFixer, PhpdocTrimFixer. Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, PhpdocAddMissingParamAnnotationFixer, PhpdocIndentFixer, PhpdocNoEmptyReturnFixer, 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

moveAnnotationsAfter()

Move all given annotations after given set of annotations.

private moveAnnotationsAfter(string $move, array<int, string> $after, string $content) : string
Parameters
$move : string

Tag of annotations that should be moved

$after : array<int, string>

Tags of annotations that should moved annotations be placed after

$content : string
Return values
string

moveAnnotationsBefore()

Move all given annotations in before given set of annotations.

private moveAnnotationsBefore(string $move, array<int, string> $before, string $content) : string
Parameters
$move : string

Tag of annotations that should be moved

$before : array<int, string>

Tags of annotations that should moved annotations be placed before

$content : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results