Config class
PhpCsFixer\Config
Implements:
PhpCsFixer\ConfigInterface, PhpCsFixer\ParallelAwareConfigInterface, PhpCsFixer\UnsupportedPhpVersionAllowedConfigInterface, PhpCsFixer\CustomRulesetsAwareConfigInterface, PhpCsFixer\Config\RuleCustomisationPolicyAwareConfigInterface
Defined in D:/WEBISTERS/projects/app/vendor/friendsofphp/php-cs-fixer/src/Config.php
Constants #
Properties #
- $cacheFile
- -
- $customFixers
- -
- $customRuleSets
- -
- $finder
- -
- $format
- -
- $hideProgress
- -
- $indent
- -
- $isRiskyAllowed
- -
- $lineEnding
- -
- $name
- -
- $parallelConfig
- -
- $phpExecutable
- -
- $rules
- -
- $usingCache
- -
- $isUnsupportedPhpVersionAllowed
- -
- $ruleCustomisationPolicy
- -
$cacheFile
private string $cacheFile = '.php-cs-fixer.cache'
$customFixers
private array $customFixers = array (
)
$customRuleSets
private array $customRuleSets = array (
)
$finder
private ?iterable $finder = NULL
$format
private string $format
$hideProgress
private bool $hideProgress = false
$indent
private string $indent = ' '
$isRiskyAllowed
private bool $isRiskyAllowed = false
$lineEnding
private string $lineEnding = '
'
$name
private string $name
$parallelConfig
private \PhpCsFixer\Runner\Parallel\ParallelConfig $parallelConfig
$phpExecutable
private ?string $phpExecutable = NULL
$rules
private array $rules
$usingCache
private bool $usingCache = true
$isUnsupportedPhpVersionAllowed
private bool $isUnsupportedPhpVersionAllowed = false
$ruleCustomisationPolicy
private ?\PhpCsFixer\Config\RuleCustomisationPolicyInterface $ruleCustomisationPolicy = NULL
Methods #
- __construct()
- -
- getCacheFile()
- -
- getCustomFixers()
- -
- getCustomRuleSets()
- -
- getFinder()
- -
- getFormat()
- -
- getHideProgress()
- -
- getIndent()
- -
- getLineEnding()
- -
- getName()
- -
- getParallelConfig()
- -
- getPhpExecutable()
- -
- getRiskyAllowed()
- -
- getRuleCustomisationPolicy()
- -
- getRules()
- -
- getUnsupportedPhpVersionAllowed()
- -
- getUsingCache()
- -
- registerCustomFixers()
- -
- registerCustomRuleSets()
- -
- setCacheFile()
- -
- setFinder()
- -
- setFormat()
- -
- setHideProgress()
- -
- setIndent()
- -
- setLineEnding()
- -
- setParallelConfig()
- -
- setPhpExecutable()
- -
- setRiskyAllowed()
- -
- setRuleCustomisationPolicy()
- -
- setRules()
- -
- setUnsupportedPhpVersionAllowed()
- -
- setUsingCache()
- -
- addCustomFixer()
- -
__construct()
public function __construct(string $name = 'default')
Parameters
- string $name
getCacheFile()
public function getCacheFile(): string
Returns
string
getCustomFixers()
public function getCustomFixers(): array
Returns
array
getCustomRuleSets()
public function getCustomRuleSets(): array
Returns
array
getFinder()
public function getFinder(): iterable
Returns
iterable
getFormat()
public function getFormat(): string
Returns
string
getHideProgress()
public function getHideProgress(): bool
Returns
bool
getIndent()
public function getIndent(): string
Returns
string
getLineEnding()
public function getLineEnding(): string
Returns
string
getName()
public function getName(): string
Returns
string
getParallelConfig()
public function getParallelConfig(): \PhpCsFixer\Runner\Parallel\ParallelConfig
Returns
\PhpCsFixer\Runner\Parallel\ParallelConfig
getPhpExecutable()
public function getPhpExecutable(): ?string
Returns
?string
getRiskyAllowed()
public function getRiskyAllowed(): bool
Returns
bool
getRuleCustomisationPolicy()
public function getRuleCustomisationPolicy(): ?\PhpCsFixer\Config\RuleCustomisationPolicyInterface
Returns
?\PhpCsFixer\Config\RuleCustomisationPolicyInterface
getRules()
public function getRules(): array
Returns
array
getUnsupportedPhpVersionAllowed()
public function getUnsupportedPhpVersionAllowed(): bool
Returns
bool
getUsingCache()
public function getUsingCache(): bool
Returns
bool
registerCustomFixers()
public function registerCustomFixers(iterable $fixers): \PhpCsFixer\ConfigInterface
Parameters
- iterable $fixers
Returns
\PhpCsFixer\ConfigInterface
registerCustomRuleSets()
public function registerCustomRuleSets(array $ruleSets): \PhpCsFixer\ConfigInterface
Parameters
- array $ruleSets
Returns
\PhpCsFixer\ConfigInterface
setCacheFile()
public function setCacheFile(string $cacheFile): \PhpCsFixer\ConfigInterface
Parameters
- string $cacheFile
Returns
\PhpCsFixer\ConfigInterface
setFinder()
public function setFinder(iterable $finder): \PhpCsFixer\ConfigInterface
Parameters
- iterable $finder
Returns
\PhpCsFixer\ConfigInterface
setFormat()
public function setFormat(string $format): \PhpCsFixer\ConfigInterface
Parameters
- string $format
Returns
\PhpCsFixer\ConfigInterface
setHideProgress()
public function setHideProgress(bool $hideProgress): \PhpCsFixer\ConfigInterface
Parameters
- bool $hideProgress
Returns
\PhpCsFixer\ConfigInterface
setIndent()
public function setIndent(string $indent): \PhpCsFixer\ConfigInterface
Parameters
- string $indent
Returns
\PhpCsFixer\ConfigInterface
setLineEnding()
public function setLineEnding(string $lineEnding): \PhpCsFixer\ConfigInterface
Parameters
- string $lineEnding
Returns
\PhpCsFixer\ConfigInterface
setParallelConfig()
public function setParallelConfig(\PhpCsFixer\Runner\Parallel\ParallelConfig $config): \PhpCsFixer\ConfigInterface
Parameters
- \PhpCsFixer\Runner\Parallel\ParallelConfig $config
Returns
\PhpCsFixer\ConfigInterface
setPhpExecutable()
public function setPhpExecutable(?string $phpExecutable): \PhpCsFixer\ConfigInterface
Parameters
- ?string $phpExecutable
Returns
\PhpCsFixer\ConfigInterface
setRiskyAllowed()
public function setRiskyAllowed(bool $isRiskyAllowed): \PhpCsFixer\ConfigInterface
Parameters
- bool $isRiskyAllowed
Returns
\PhpCsFixer\ConfigInterface
setRuleCustomisationPolicy()
public function setRuleCustomisationPolicy(?\PhpCsFixer\Config\RuleCustomisationPolicyInterface $ruleCustomisationPolicy): \PhpCsFixer\ConfigInterface
Parameters
- ?\PhpCsFixer\Config\RuleCustomisationPolicyInterface $ruleCustomisationPolicy
Returns
\PhpCsFixer\ConfigInterface
setRules()
public function setRules(array $rules): \PhpCsFixer\ConfigInterface
Parameters
- array $rules
Returns
\PhpCsFixer\ConfigInterface
setUnsupportedPhpVersionAllowed()
public function setUnsupportedPhpVersionAllowed(bool $isUnsupportedPhpVersionAllowed): \PhpCsFixer\ConfigInterface
Parameters
- bool $isUnsupportedPhpVersionAllowed
Returns
\PhpCsFixer\ConfigInterface
setUsingCache()
public function setUsingCache(bool $usingCache): \PhpCsFixer\ConfigInterface
Parameters
- bool $usingCache
Returns
\PhpCsFixer\ConfigInterface
addCustomFixer()
private function addCustomFixer(\PhpCsFixer\Fixer\FixerInterface $fixer): void
Parameters
- \PhpCsFixer\Fixer\FixerInterface $fixer
Returns
void