FixerDefinition
in package
implements
FixerDefinitionInterface
FinalYes
Tags
Table of Contents
Interfaces
Properties
- $codeSamples : array<int, CodeSampleInterface>
- $description : string|null
- Description of Fixer and benefit of using it.
- $riskyDescription : string|null
- Description why Fixer is risky.
- $summary : string
Methods
- __construct() : mixed
- getCodeSamples() : array<int, CodeSampleInterface>
- Array of samples, where single sample is [code, configuration].
- getDescription() : string|null
- getRiskyDescription() : null|string
- getSummary() : string
Properties
$codeSamples
private
array<int, CodeSampleInterface>
$codeSamples
$description
Description of Fixer and benefit of using it.
private
string|null
$description
$riskyDescription
Description why Fixer is risky.
private
string|null
$riskyDescription
$summary
private
string
$summary
Methods
__construct()
public
__construct(string $summary, array<int, CodeSampleInterface> $codeSamples[, string|null $description = null ][, null|string $riskyDescription = null ]) : mixed
Parameters
- $summary : string
- $codeSamples : array<int, CodeSampleInterface>
-
array of samples, where single sample is [code, configuration]
- $description : string|null = null
- $riskyDescription : null|string = null
-
null for non-risky fixer
getCodeSamples()
Array of samples, where single sample is [code, configuration].
public
getCodeSamples() : array<int, CodeSampleInterface>
Return values
array<int, CodeSampleInterface>getDescription()
public
getDescription() : string|null
Return values
string|nullgetRiskyDescription()
public
getRiskyDescription() : null|string
Return values
null|string —null for non-risky fixer
getSummary()
public
getSummary() : string