Documentation

BracesPositionFixer extends AbstractFixer
in package
implements ConfigurableFixerInterface, WhitespacesAwareFixerInterface uses ConfigurableFixerTrait, Indentation

FinalYes
Tags
implements

ConfigurableFixerInterface<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration>

phpstan-type

_AutogeneratedInputConfiguration array{ allow_single_line_anonymous_functions?: bool, allow_single_line_empty_anonymous_classes?: bool, anonymous_classes_opening_brace?: 'next_line_unless_newline_at_signature_end'|'same_line', anonymous_functions_opening_brace?: 'next_line_unless_newline_at_signature_end'|'same_line', classes_opening_brace?: 'next_line_unless_newline_at_signature_end'|'same_line', control_structures_opening_brace?: 'next_line_unless_newline_at_signature_end'|'same_line', functions_opening_brace?: 'next_line_unless_newline_at_signature_end'|'same_line' }

phpstan-type

_AutogeneratedComputedConfiguration array{ allow_single_line_anonymous_functions: bool, allow_single_line_empty_anonymous_classes: bool, anonymous_classes_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line', anonymous_functions_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line', classes_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line', control_structures_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line', functions_opening_brace: 'next_line_unless_newline_at_signature_end'|'same_line' }

Table of Contents

Interfaces

ConfigurableFixerInterface
WhitespacesAwareFixerInterface

Methods

createConfigurationDefinition()  : FixerConfigurationResolverInterface
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
findParenthesisEnd()  : int
hasCommentOnSameLine()  : bool
isFollowedByNewLine()  : bool

Methods

getPriority()

Returns the priority of the fixer.

public getPriority() : int

Must run before SingleLineEmptyBodyFixer, StatementIndentationFixer. Must run after ControlStructureBracesFixer, NoMultipleStatementsPerLineFixer.

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

findParenthesisEnd()

private findParenthesisEnd(Tokens $tokens, int $structureTokenIndex) : int
Parameters
$tokens : Tokens
$structureTokenIndex : int
Return values
int

hasCommentOnSameLine()

private hasCommentOnSameLine(Tokens $tokens, int $index) : bool
Parameters
$tokens : Tokens
$index : int
Return values
bool

isFollowedByNewLine()

private isFollowedByNewLine(Tokens $tokens, int $index) : bool
Parameters
$tokens : Tokens
$index : int
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results