Documentation

ConfigurableFixerInterface extends FixerInterface
in

Tags
author

Dariusz RumiƄski dariusz.ruminski@gmail.com

author

SpacePossum

todo

Will incorporate ConfigurationDefinitionFixerInterface in 3.0

Table of Contents

configure()  : mixed
Set configuration.
fix()  : mixed
Fixes a file.
getName()  : string
Returns the name of the fixer.
getPriority()  : int
Returns the priority of the fixer.
isCandidate()  : bool
Check if the fixer is a candidate for given Tokens collection.
isRisky()  : bool
Check if fixer is risky or not.
supports()  : bool
Returns true if the file is supported by this fixer.

Methods

configure()

Set configuration.

public configure([null|array<string|int, mixed> $configuration = null ]) : mixed

New configuration must override current one, not patch it. Using null makes fixer to use default configuration (or reset configuration from previously configured back to default one).

Some fixers may have no configuration, then - simply pass null. Other ones may have configuration that will change behavior of fixer, eg php_unit_strict fixer allows to configure which methods should be fixed. Finally, some fixers need configuration to work, eg header_comment.

Parameters
$configuration : null|array<string|int, mixed> = null

configuration depends on Fixer

Tags
throws
InvalidFixerConfigurationException
Return values
mixed

fix()

Fixes a file.

public fix(SplFileInfo $file, Tokens $tokens) : mixed
Parameters
$file : SplFileInfo

A \SplFileInfo instance

$tokens : Tokens

Tokens collection

Return values
mixed

getName()

Returns the name of the fixer.

public getName() : string

The name must be all lowercase and without any spaces.

Return values
string

The name of the fixer

getPriority()

Returns the priority of the fixer.

public getPriority() : int

The default priority is 0 and higher priorities are executed first.

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

isRisky()

Check if fixer is risky or not.

public isRisky() : bool

Risky fixer could change code behavior!

Return values
bool

supports()

Returns true if the file is supported by this fixer.

public supports(SplFileInfo $file) : bool
Parameters
$file : SplFileInfo
Return values
bool

true if the file is supported by this fixer, false otherwise

Search results