Documentation

OrderedInterfacesFixer extends AbstractFixer
in package
implements ConfigurableFixerInterface uses ConfigurableFixerTrait

FinalYes
Tags
author

Dave van der Brugge dmvdbrugge@gmail.com

implements

ConfigurableFixerInterface<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration>

phpstan-type

_AutogeneratedInputConfiguration array{ case_sensitive?: bool, direction?: 'ascend'|'descend', order?: 'alpha'|'length' }

phpstan-type

_AutogeneratedComputedConfiguration array{ case_sensitive: bool, direction: 'ascend'|'descend', order: 'alpha'|'length' }

Table of Contents

Interfaces

ConfigurableFixerInterface

Constants

SUPPORTED_DIRECTION_OPTIONS  = [self::DIRECTION_ASCEND, self::DIRECTION_DESCEND]
Array of supported directions in configuration.
SUPPORTED_ORDER_OPTIONS  = [self::ORDER_ALPHA, self::ORDER_LENGTH]
Array of supported orders in configuration.

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
getInterfaces()  : array<int, array<int, Token>>

Constants

SUPPORTED_DIRECTION_OPTIONS

Array of supported directions in configuration.

private array<int, string> SUPPORTED_DIRECTION_OPTIONS = [self::DIRECTION_ASCEND, self::DIRECTION_DESCEND]

SUPPORTED_ORDER_OPTIONS

Array of supported orders in configuration.

private array<int, string> SUPPORTED_ORDER_OPTIONS = [self::ORDER_ALPHA, self::ORDER_LENGTH]

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

getInterfaces()

private getInterfaces(Tokens $tokens, int $implementsStart, int $implementsEnd) : array<int, array<int, Token>>
Parameters
$tokens : Tokens
$implementsStart : int
$implementsEnd : int
Return values
array<int, array<int, Token>> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results