Documentation

OrderedAttributesFixer extends AbstractFixer
in package
implements ConfigurableFixerInterface uses ConfigurableFixerTrait

FinalYes
Tags
author

HypeMC hypemc@gmail.com

phpstan-import-type

_AttributeItems from AttributeAnalysis

implements

ConfigurableFixerInterface<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration>

phpstan-type

_AutogeneratedInputConfiguration array{ order?: list, sort_algorithm?: 'alpha'|'custom' }

phpstan-type

_AutogeneratedComputedConfiguration array{ order: array<string, int>, sort_algorithm: 'alpha'|'custom' }

Table of Contents

Interfaces

ConfigurableFixerInterface

Constants

ORDER_ALPHA  = 'alpha'
ORDER_CUSTOM  = 'custom'
SUPPORTED_SORT_ALGORITHMS  = [self::ORDER_ALPHA, self::ORDER_CUSTOM]

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
collectNamespaceAnalysis()  : NamespaceUseAnalysis>}
determineAttributeFullyQualifiedName()  : string
getAttributeName()  : string
sortAttributes()  : string
sortElements()  : array<int, array{name: string, start: int, end: int}>
sortTokens()  : void

Constants

SUPPORTED_SORT_ALGORITHMS

private mixed SUPPORTED_SORT_ALGORITHMS = [self::ORDER_ALPHA, self::ORDER_CUSTOM]

Methods

getPriority()

Returns the priority of the fixer.

public getPriority() : int

Must run after FullyQualifiedStrictTypesFixer.

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

collectNamespaceAnalysis()

private collectNamespaceAnalysis(Tokens $tokens, int $startIndex) : NamespaceUseAnalysis>}
Parameters
$tokens : Tokens
$startIndex : int
Return values
NamespaceUseAnalysis>}

determineAttributeFullyQualifiedName()

private determineAttributeFullyQualifiedName(Tokens $tokens, string $name, int $index) : string
Parameters
$tokens : Tokens
$name : string
$index : int
Return values
string

getAttributeName()

private getAttributeName(Tokens $tokens, string $name, int $index) : string
Parameters
$tokens : Tokens
$name : string
$index : int
Return values
string

sortAttributes()

private sortAttributes(Tokens $tokens, int $index, _AttributeItems $attributes) : string
Parameters
$tokens : Tokens
$index : int
$attributes : _AttributeItems
Return values
string

sortElements()

private sortElements(array<int, array{name: string, start: int, end: int}> $elements) : array<int, array{name: string, start: int, end: int}>
Parameters
$elements : array<int, array{name: string, start: int, end: int}>
Return values
array<int, array{name: string, start: int, end: int}>

sortTokens()

private sortTokens(Tokens $tokens, int $startIndex, int $endIndex, array<int, array{name: string, start: int, end: int}> $elements[, Token|null $delimiter = null ]) : void
Parameters
$tokens : Tokens
$startIndex : int
$endIndex : int
$elements : array<int, array{name: string, start: int, end: int}>
$delimiter : Token|null = null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results