Documentation

HeaderCommentFixer extends AbstractFixer
in package
implements ConfigurableFixerInterface, WhitespacesAwareFixerInterface uses ConfigurableFixerTrait

FinalYes
Tags
author

Antonio J. García Lagar aj@garcialagar.es

implements

ConfigurableFixerInterface<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration>

phpstan-type

_AutogeneratedInputConfiguration array{ comment_type?: 'PHPDoc'|'comment', header: string, location?: 'after_declare_strict'|'after_open', separate?: 'both'|'bottom'|'none'|'top' }

phpstan-type

_AutogeneratedComputedConfiguration array{ comment_type: 'PHPDoc'|'comment', header: string, location: 'after_declare_strict'|'after_open', separate: 'both'|'bottom'|'none'|'top' }

Table of Contents

Interfaces

ConfigurableFixerInterface
WhitespacesAwareFixerInterface

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
findHeaderCommentCurrentIndex()  : int|null
findHeaderCommentInsertionIndex()  : int
Find the index where the header comment must be inserted.
fixWhiteSpaceAroundHeader()  : void
getHeaderAsComment()  : string
Enclose the given text in a comment block.
getLineBreakCount()  : int
insertHeader()  : void
removeHeader()  : void

Methods

getPriority()

Returns the priority of the fixer.

public getPriority() : int

Must run before BlankLinesBeforeNamespaceFixer, SingleBlankLineBeforeNamespaceFixer, SingleLineCommentStyleFixer. Must run after DeclareStrictTypesFixer, NoBlankLinesAfterPhpdocFixer.

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

findHeaderCommentCurrentIndex()

private findHeaderCommentCurrentIndex(Tokens $tokens, int $headerNewIndex) : int|null
Parameters
$tokens : Tokens
$headerNewIndex : int
Return values
int|null

findHeaderCommentInsertionIndex()

Find the index where the header comment must be inserted.

private findHeaderCommentInsertionIndex(Tokens $tokens, string $location) : int
Parameters
$tokens : Tokens
$location : string
Return values
int

fixWhiteSpaceAroundHeader()

private fixWhiteSpaceAroundHeader(Tokens $tokens, int $headerIndex) : void
Parameters
$tokens : Tokens
$headerIndex : int

getHeaderAsComment()

Enclose the given text in a comment block.

private getHeaderAsComment() : string
Return values
string

getLineBreakCount()

private getLineBreakCount(Tokens $tokens, int $index, int $direction) : int
Parameters
$tokens : Tokens
$index : int
$direction : int
Return values
int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results