PHP Класс Peridot\Configuration

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$colorsEnableExplicit boolean
$colorsEnabled boolean
$configurationFile string
$dsl string
$grep string
$path string
$reporter string
$stopOnFailure boolean

Открытые методы

Метод Описание
__construct ( )
areColorsEnabled ( ) : boolean Check if output colors are disabled
areColorsEnabledExplicit ( ) : boolean Check if output colors are explicitly enabled.
disableColors ( ) Disable output colors
enableColorsExplicit ( ) Force output colors even without TTY support.
getConfigurationFile ( ) : string Return the path to the Peridot configuration file. Returns a relative path if it exists, otherwise return the provided value
getDsl ( ) : string Get the path to a DSL file containing test functions to use
getGrep ( ) : string Returns the pattern used to load tests
getPath ( ) : string Return the path being searched for tests
getReporter ( ) : string Return the name of the reporter configured for use
setConfigurationFile ( string $configurationFile ) Set the path to a Peridot configuration file
setDsl ( string $dsl ) Set the path to a DSL file for defining the test language used
setGrep ( string $grep ) Set the pattern used to load tests
setPath ( string $path ) Set the path to load tests from
setReporter ( string $reporter ) Set the name of the reporter to use
shouldStopOnFailure ( ) : boolean Check if the suite runner should stop on failure
stopOnFailure ( ) Stop the suite runner when a failure occurs

Защищенные методы

Метод Описание
write ( $varName, $value ) Write a configuration value and persist it to the current environment.

Описание методов

__construct() публичный Метод

public __construct ( )

areColorsEnabled() публичный Метод

Check if output colors are disabled
public areColorsEnabled ( ) : boolean
Результат boolean

areColorsEnabledExplicit() публичный Метод

Check if output colors are explicitly enabled.
public areColorsEnabledExplicit ( ) : boolean
Результат boolean

disableColors() публичный Метод

Disable output colors
public disableColors ( )

enableColorsExplicit() публичный Метод

Force output colors even without TTY support.
public enableColorsExplicit ( )

getConfigurationFile() публичный Метод

Return the path to the Peridot configuration file. Returns a relative path if it exists, otherwise return the provided value
public getConfigurationFile ( ) : string
Результат string

getDsl() публичный Метод

Get the path to a DSL file containing test functions to use
public getDsl ( ) : string
Результат string

getGrep() публичный Метод

Returns the pattern used to load tests
public getGrep ( ) : string
Результат string

getPath() публичный Метод

Return the path being searched for tests
public getPath ( ) : string
Результат string

getReporter() публичный Метод

Return the name of the reporter configured for use
public getReporter ( ) : string
Результат string

setConfigurationFile() публичный Метод

Set the path to a Peridot configuration file
public setConfigurationFile ( string $configurationFile )
$configurationFile string

setDsl() публичный Метод

Set the path to a DSL file for defining the test language used
public setDsl ( string $dsl )
$dsl string

setGrep() публичный Метод

Set the pattern used to load tests
public setGrep ( string $grep )
$grep string

setPath() публичный Метод

Set the path to load tests from
public setPath ( string $path )
$path string

setReporter() публичный Метод

Set the name of the reporter to use
public setReporter ( string $reporter )
$reporter string

shouldStopOnFailure() публичный Метод

Check if the suite runner should stop on failure
public shouldStopOnFailure ( ) : boolean
Результат boolean

stopOnFailure() публичный Метод

Stop the suite runner when a failure occurs
public stopOnFailure ( )

write() защищенный Метод

Write a configuration value and persist it to the current environment.
protected write ( $varName, $value )
$varName
$value

Описание свойств

$colorsEnableExplicit защищенное свойство

protected bool $colorsEnableExplicit
Результат boolean

$colorsEnabled защищенное свойство

protected bool $colorsEnabled
Результат boolean

$configurationFile защищенное свойство

protected string $configurationFile
Результат string

$dsl защищенное свойство

protected string $dsl
Результат string

$grep защищенное свойство

protected string $grep
Результат string

$path защищенное свойство

protected string $path
Результат string

$reporter защищенное свойство

protected string $reporter
Результат string

$stopOnFailure защищенное свойство

protected bool $stopOnFailure
Результат boolean