Documentation

FixerDefinition
in package
implements FixerDefinitionInterface

Tags
author

Dariusz RumiƄski dariusz.ruminski@gmail.com

Interfaces, Classes and Traits

FixerDefinitionInterface

Table of Contents

$codeSamples  : mixed
$configurationDescription  : mixed
$defaultConfiguration  : mixed
$description  : mixed
$riskyDescription  : mixed
$summary  : mixed
__construct()  : mixed
getCodeSamples()  : array<string|int, CodeSampleInterface>
Array of samples, where single sample is [code, configuration].
getConfigurationDescription()  : null|string
getDefaultConfiguration()  : null|array<string|int, mixed>
getDescription()  : null|string
getRiskyDescription()  : null|string
getSummary()  : string

Properties

Methods

__construct()

public __construct(string $summary, array<string|int, CodeSampleInterface$codeSamples[, null|string $description = null ][, null|string $configurationDescription = null ][, null|array<string|int, mixed> $defaultConfiguration = null ][, null|string $riskyDescription = null ]) : mixed
Parameters
$summary : string
$codeSamples : array<string|int, CodeSampleInterface>

array of samples, where single sample is [code, configuration]

$description : null|string = null
$configurationDescription : null|string = null

null for non-configurable fixer

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

null for non-configurable fixer

$riskyDescription : null|string = null

null for non-risky fixer

Return values
mixed

getConfigurationDescription()

public getConfigurationDescription() : null|string
Return values
null|string

null for non-configurable fixer

getDefaultConfiguration()

public getDefaultConfiguration() : null|array<string|int, mixed>
Return values
null|array<string|int, mixed>

null for non-configurable fixer

getDescription()

public getDescription() : null|string
Return values
null|string

getRiskyDescription()

public getRiskyDescription() : null|string
Return values
null|string

null for non-risky fixer

Search results