ConfigurableFixerInterface
extends
FixerInterface
in
Tags
Table of Contents
Methods
- configure() : void
- Set configuration.
- fix() : void
- Fixes a file.
- getConfigurationDefinition() : FixerConfigurationResolverInterface
- Defines the available configuration options of the fixer.
- getDefinition() : FixerDefinitionInterface
- Returns the definition of the fixer.
- 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(TFixerInputConfig $configuration) : void
New configuration must override current one, not patch it. Using empty array makes fixer to use default configuration (or reset configuration from previously configured back to default one).
Some fixers may have no configuration, then - simply don't implement this interface.
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 : TFixerInputConfig
-
configuration depends on Fixer
Tags
fix()
Fixes a file.
public
fix(SplFileInfo $file, Tokens $tokens) : void
Parameters
- $file : SplFileInfo
-
A \SplFileInfo instance
- $tokens : Tokens
-
Tokens collection
getConfigurationDefinition()
Defines the available configuration options of the fixer.
public
getConfigurationDefinition() : FixerConfigurationResolverInterface
Return values
FixerConfigurationResolverInterfacegetDefinition()
Returns the definition of the fixer.
public
getDefinition() : FixerDefinitionInterface
Return values
FixerDefinitionInterfacegetName()
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
intisCandidate()
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
boolisRisky()
Check if fixer is risky or not.
public
isRisky() : bool
Risky fixer could change code behavior!
Return values
boolsupports()
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