PHP 인터페이스 PhpCsFixer\ConfigInterface

저자: Fabien Potencier ([email protected])
파일 보기 프로젝트 열기: friendsofphp/php-cs-fixer 0 사용 예제들

공개 메소드들

메소드 설명
getCacheFile ( ) : string | null Returns the path to the cache file.
getCustomFixers ( ) : PhpCsFixer\Fixer\FixerInterface[] Returns the custom fixers to use.
getFinder ( ) : iterable | Traversable | string[] Returns files to scan.
getFormat ( ) : string
getHideProgress ( ) : boolean Returns true if progress should be hidden.
getIndent ( ) : string
getLineEnding ( ) : string
getName ( ) : string Returns the name of the configuration.
getPhpExecutable ( ) : string | null Get configured PHP executable, if any.
getRiskyAllowed ( ) : boolean Check if it is allowed to run risky fixers.
getRules ( ) : array Get rules.
getUsingCache ( ) : boolean Returns true if caching should be enabled.
registerCustomFixers ( iterable | Traversable | PhpCsFixer\Fixer\FixerInterface[] $fixers ) Adds a suite of custom fixers.
setCacheFile ( string $cacheFile ) : self Sets the path to the cache file.
setFinder ( iterable | Traversable | string[] $finder ) : self
setFormat ( string $format ) : self
setHideProgress ( boolean $hideProgress ) : self
setIndent ( string $indent ) : self
setLineEnding ( string $lineEnding ) : self
setPhpExecutable ( string | null $phpExecutable ) : self Set PHP executable.
setRiskyAllowed ( boolean $isRiskyAllowed ) : self Set if it is allowed to run risky fixers.
setRules ( array $rules ) : self Set rules.
setUsingCache ( boolean $usingCache ) : self

메소드 상세

getCacheFile() 공개 메소드

Returns the path to the cache file.
public getCacheFile ( ) : string | null
리턴 string | null Returns null if not using cache

getCustomFixers() 공개 메소드

Returns the custom fixers to use.
public getCustomFixers ( ) : PhpCsFixer\Fixer\FixerInterface[]
리턴 PhpCsFixer\Fixer\FixerInterface[]

getFinder() 공개 메소드

Returns files to scan.
public getFinder ( ) : iterable | Traversable | string[]
리턴 iterable | Traversable | string[]

getFormat() 공개 메소드

public getFormat ( ) : string
리턴 string

getHideProgress() 공개 메소드

Returns true if progress should be hidden.
public getHideProgress ( ) : boolean
리턴 boolean

getIndent() 공개 메소드

public getIndent ( ) : string
리턴 string

getLineEnding() 공개 메소드

public getLineEnding ( ) : string
리턴 string

getName() 공개 메소드

The name must be all lowercase and without any spaces.
public getName ( ) : string
리턴 string The name of the configuration

getPhpExecutable() 공개 메소드

Get configured PHP executable, if any.
public getPhpExecutable ( ) : string | null
리턴 string | null

getRiskyAllowed() 공개 메소드

Check if it is allowed to run risky fixers.
public getRiskyAllowed ( ) : boolean
리턴 boolean

getRules() 공개 메소드

Keys of array are names of fixers/sets, values are true/false.
public getRules ( ) : array
리턴 array

getUsingCache() 공개 메소드

Returns true if caching should be enabled.
public getUsingCache ( ) : boolean
리턴 boolean

registerCustomFixers() 공개 메소드

Name of custom fixer should follow VendorName/rule_name convention.
public registerCustomFixers ( iterable | Traversable | PhpCsFixer\Fixer\FixerInterface[] $fixers )
$fixers iterable | Traversable | PhpCsFixer\Fixer\FixerInterface[]

setCacheFile() 공개 메소드

Sets the path to the cache file.
public setCacheFile ( string $cacheFile ) : self
$cacheFile string
리턴 self

setFinder() 공개 메소드

public setFinder ( iterable | Traversable | string[] $finder ) : self
$finder iterable | Traversable | string[]
리턴 self

setFormat() 공개 메소드

public setFormat ( string $format ) : self
$format string
리턴 self

setHideProgress() 공개 메소드

public setHideProgress ( boolean $hideProgress ) : self
$hideProgress boolean
리턴 self

setIndent() 공개 메소드

public setIndent ( string $indent ) : self
$indent string
리턴 self

setLineEnding() 공개 메소드

public setLineEnding ( string $lineEnding ) : self
$lineEnding string
리턴 self

setPhpExecutable() 공개 메소드

Set PHP executable.
public setPhpExecutable ( string | null $phpExecutable ) : self
$phpExecutable string | null
리턴 self

setRiskyAllowed() 공개 메소드

Set if it is allowed to run risky fixers.
public setRiskyAllowed ( boolean $isRiskyAllowed ) : self
$isRiskyAllowed boolean
리턴 self

setRules() 공개 메소드

Keys of array are names of fixers or sets. Value for set must be bool (turn it on or off). Value for fixer may be bool (turn it on or off) or array of configuration (turn it on and contains configuration for FixerInterface::configure method).
public setRules ( array $rules ) : self
$rules array
리턴 self

setUsingCache() 공개 메소드

public setUsingCache ( boolean $usingCache ) : self
$usingCache boolean
리턴 self