PHP Class PhpCsFixer\Console\ConfigurationResolver

Author: Fabien Potencier ([email protected])
Author: Katsuhiro Ogawa ([email protected])
Author: Dariusz Rumiński ([email protected])
Mostra file Open project: friendsofphp/php-cs-fixer Class Usage Examples

Public Methods

Method Description
__construct ( PhpCsFixer\ConfigInterface $config, array $options, string $cwd ) ConfigurationResolver constructor.
getCacheFile ( ) : string | null
getCacheManager ( ) : PhpCsFixer\Cache\CacheManagerInterface
getConfig ( ) : PhpCsFixer\ConfigInterface Returns config instance.
getConfigFile ( ) : null | string Returns config file path.
getDiffer ( ) : PhpCsFixer\Differ\DifferInterface
getFinder ( )
getFixers ( ) : PhpCsFixer\Fixer\FixerInterface[] Returns fixers.
getLinter ( ) : PhpCsFixer\Linter\LinterInterface
getPath ( ) : string[] Returns path.
getProgress ( ) : boolean Returns progress flag.
getReporter ( ) : PhpCsFixer\Report\ReporterInterface
getRiskyAllowed ( ) : boolean
getRules ( ) : array Returns rules.
getUsingCache ( ) : boolean
isDryRun ( ) : boolean Returns dry-run flag.

Private Methods

Method Description
computeConfigFiles ( ) : string[] Compute file candidates for config file.
getFormat ( ) : string
getRuleSet ( )
isStdIn ( ) : boolean
iterableToTraversable ( iterable $iterable ) : Traversable
parseRules ( ) : array Compute rules.
resolveFinder ( ) Apply path on config instance.
setOption ( string $name, mixed $value ) Set option that will be resolved.

Method Details

__construct() public method

ConfigurationResolver constructor.
public __construct ( PhpCsFixer\ConfigInterface $config, array $options, string $cwd )
$config PhpCsFixer\ConfigInterface
$options array
$cwd string

getCacheFile() public method

public getCacheFile ( ) : string | null
return string | null

getCacheManager() public method

public getCacheManager ( ) : PhpCsFixer\Cache\CacheManagerInterface
return PhpCsFixer\Cache\CacheManagerInterface

getConfig() public method

Returns config instance.
public getConfig ( ) : PhpCsFixer\ConfigInterface
return PhpCsFixer\ConfigInterface

getConfigFile() public method

Returns config file path.
public getConfigFile ( ) : null | string
return null | string

getDiffer() public method

public getDiffer ( ) : PhpCsFixer\Differ\DifferInterface
return PhpCsFixer\Differ\DifferInterface

getFinder() public method

public getFinder ( )

getFixers() public method

Returns fixers.
public getFixers ( ) : PhpCsFixer\Fixer\FixerInterface[]
return PhpCsFixer\Fixer\FixerInterface[] An array of FixerInterface

getLinter() public method

public getLinter ( ) : PhpCsFixer\Linter\LinterInterface
return PhpCsFixer\Linter\LinterInterface

getPath() public method

Returns path.
public getPath ( ) : string[]
return string[]

getProgress() public method

Returns progress flag.
public getProgress ( ) : boolean
return boolean

getReporter() public method

public getReporter ( ) : PhpCsFixer\Report\ReporterInterface
return PhpCsFixer\Report\ReporterInterface

getRiskyAllowed() public method

public getRiskyAllowed ( ) : boolean
return boolean

getRules() public method

Returns rules.
public getRules ( ) : array
return array

getUsingCache() public method

public getUsingCache ( ) : boolean
return boolean

isDryRun() public method

Returns dry-run flag.
public isDryRun ( ) : boolean
return boolean