Config
in package
implements
ConfigInterface
Tags
Interfaces, Classes and Traits
Table of Contents
- $cacheFile : mixed
- $customFixers : mixed
- $finder : mixed
- $format : mixed
- $hideProgress : mixed
- $indent : mixed
- $isRiskyAllowed : mixed
- $lineEnding : mixed
- $name : mixed
- $phpExecutable : mixed
- $rules : mixed
- $usingCache : mixed
- __construct() : mixed
- create() : static
- getCacheFile() : null|string
- Returns the path to the cache file.
- getCustomFixers() : array<string|int, FixerInterface>
- Returns the custom fixers to use.
- getFinder() : Finder
- Returns files to scan.
- getFormat() : string
- getHideProgress() : bool
- Returns true if progress should be hidden.
- getIndent() : string
- getLineEnding() : string
- getName() : string
- Returns the name of the configuration.
- getPhpExecutable() : null|string
- Get configured PHP executable, if any.
- getRiskyAllowed() : bool
- Check if it is allowed to run risky fixers.
- getRules() : array<string|int, mixed>
- Get rules.
- getUsingCache() : bool
- Returns true if caching should be enabled.
- registerCustomFixers() : self
- Adds a suite of custom fixers.
- setCacheFile() : self
- Sets the path to the cache file.
- setFinder() : self
- setFormat() : self
- setHideProgress() : self
- setIndent() : self
- setLineEnding() : self
- setPhpExecutable() : self
- Set PHP executable.
- setRiskyAllowed() : self
- Set if it is allowed to run risky fixers.
- setRules() : self
- Set rules.
- setUsingCache() : self
- addCustomFixer() : mixed
Properties
$cacheFile
private
mixed
$cacheFile
= '.php_cs.cache'
$customFixers
private
mixed
$customFixers
= []
$finder
private
mixed
$finder
$format
private
mixed
$format
= 'txt'
$hideProgress
private
mixed
$hideProgress
= false
$indent
private
mixed
$indent
= ' '
$isRiskyAllowed
private
mixed
$isRiskyAllowed
= false
$lineEnding
private
mixed
$lineEnding
= "
"
$name
private
mixed
$name
$phpExecutable
private
mixed
$phpExecutable
$rules
private
mixed
$rules
= ['@PSR2' => true]
$usingCache
private
mixed
$usingCache
= true
Methods
__construct()
public
__construct([mixed $name = 'default' ]) : mixed
Parameters
- $name : mixed = 'default'
Return values
mixed —create()
public
static create() : static
Tags
Return values
static —getCacheFile()
Returns the path to the cache file.
public
getCacheFile() : null|string
Return values
null|string —Returns null if not using cache
getCustomFixers()
Returns the custom fixers to use.
public
getCustomFixers() : array<string|int, FixerInterface>
Return values
array<string|int, FixerInterface> —getFinder()
Returns files to scan.
public
getFinder() : Finder
Return values
Finder —getFormat()
public
getFormat() : string
Return values
string —getHideProgress()
Returns true if progress should be hidden.
public
getHideProgress() : bool
Return values
bool —getIndent()
public
getIndent() : string
Return values
string —getLineEnding()
public
getLineEnding() : string
Return values
string —getName()
Returns the name of the configuration.
public
getName() : string
Return values
string —The name of the configuration
getPhpExecutable()
Get configured PHP executable, if any.
public
getPhpExecutable() : null|string
Return values
null|string —getRiskyAllowed()
Check if it is allowed to run risky fixers.
public
getRiskyAllowed() : bool
Return values
bool —getRules()
Get rules.
public
getRules() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUsingCache()
Returns true if caching should be enabled.
public
getUsingCache() : bool
Return values
bool —registerCustomFixers()
Adds a suite of custom fixers.
public
registerCustomFixers(mixed $fixers) : self
Parameters
- $fixers : mixed
Return values
self —setCacheFile()
Sets the path to the cache file.
public
setCacheFile(mixed $cacheFile) : self
Parameters
- $cacheFile : mixed
Return values
self —setFinder()
public
setFinder(mixed $finder) : self
Parameters
- $finder : mixed
Return values
self —setFormat()
public
setFormat(mixed $format) : self
Parameters
- $format : mixed
Return values
self —setHideProgress()
public
setHideProgress(mixed $hideProgress) : self
Parameters
- $hideProgress : mixed
Return values
self —setIndent()
public
setIndent(mixed $indent) : self
Parameters
- $indent : mixed
Return values
self —setLineEnding()
public
setLineEnding(mixed $lineEnding) : self
Parameters
- $lineEnding : mixed
Return values
self —setPhpExecutable()
Set PHP executable.
public
setPhpExecutable(mixed $phpExecutable) : self
Parameters
- $phpExecutable : mixed
Return values
self —setRiskyAllowed()
Set if it is allowed to run risky fixers.
public
setRiskyAllowed(mixed $isRiskyAllowed) : self
Parameters
- $isRiskyAllowed : mixed
Return values
self —setRules()
Set rules.
public
setRules(array<string|int, mixed> $rules) : self
Parameters
- $rules : array<string|int, mixed>
Return values
self —setUsingCache()
public
setUsingCache(mixed $usingCache) : self
Parameters
- $usingCache : mixed
Return values
self —addCustomFixer()
private
addCustomFixer(FixerInterface $fixer) : mixed
Parameters
- $fixer : FixerInterface