Documentation

SingleImportPerStatementFixer extends AbstractFixer
in package
implements ConfigurableFixerInterface, WhitespacesAwareFixerInterface uses ConfigurableFixerTrait

FinalYes

Fixer for rules defined in PSR2 ¶3.

Tags
author

Dariusz Rumiński dariusz.ruminski@gmail.com

implements

ConfigurableFixerInterface<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration>

phpstan-type

_AutogeneratedInputConfiguration array{ group_to_single_imports?: bool }

phpstan-type

_AutogeneratedComputedConfiguration array{ group_to_single_imports: bool }

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
fixGroupUse()  : void
fixMultipleUse()  : void
getGroupDeclaration()  : array{: string, : ?int, : int, : string}
getGroupStatements()  : array<int, string>

Methods

getPriority()

Returns the priority of the fixer.

public getPriority() : int

Must run before MultilineWhitespaceBeforeSemicolonsFixer, NoLeadingImportSlashFixer, NoSinglelineWhitespaceBeforeSemicolonsFixer, NoUnusedImportsFixer, SpaceAfterSemicolonFixer.

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

getGroupDeclaration()

private getGroupDeclaration(Tokens $tokens, int $index) : array{: string, : ?int, : int, : string}
Parameters
$tokens : Tokens
$index : int
Return values
array{: string, : ?int, : int, : string}

getGroupStatements()

private getGroupStatements(Tokens $tokens, string $groupPrefix, int $groupOpenIndex, int $groupCloseIndex, string $comment) : array<int, string>
Parameters
$tokens : Tokens
$groupPrefix : string
$groupOpenIndex : int
$groupCloseIndex : int
$comment : string
Return values
array<int, string>

        
On this page

Search results