1. class
  2. Robo
  3. \
  4. Config
  5. \
  6. Config

Config

class Config extends ConfigOverlay implements GlobalOptionDefaultValuesInterface (View source)

Constants

PROGRESS_BAR_AUTO_DISPLAY_INTERVAL

DEFAULT_PROGRESS_DELAY

SIMULATE

INTERACTIVE

DECORATED

Properties

protected array $defaults

Methods

__construct(array $data = [])

Create a new configuration object, and initialize it with the provided nested array containing configuration data.

import($data)

{@inheritdoc}

replace($data)

{@inheritdoc}

combine($data)

{@inheritdoc}

array
getGlobalOptionDefaultValues()

Return an associative array containing all of the global configuration options and their default values.

array
trimPrefixFromGlobalOptions(array $globalOptions)

Remove the 'options.' prefix from the global options list.

bool
isSimulated() deprecated

No description

$this
setSimulated(bool $simulated = true) deprecated

No description

bool
isInteractive() deprecated

No description

$this
setInteractive(bool $interactive = true) deprecated

No description

bool
isDecorated() deprecated

No description

$this
setDecorated(bool $decorated = true) deprecated

No description

$this
setProgressBarAutoDisplayInterval(int $interval) deprecated

No description

Details

at line 27
__construct(array $data = [])

Create a new configuration object, and initialize it with the provided nested array containing configuration data.

Parameters

array $data

at line 38
import($data)

{@inheritdoc}

Parameters

$data

at line 46
replace($data)

{@inheritdoc}

Parameters

$data

at line 55
combine($data)

{@inheritdoc}

Parameters

$data

at line 67
array getGlobalOptionDefaultValues()

Return an associative array containing all of the global configuration options and their default values.

Return Value

array

at line 84
protected array trimPrefixFromGlobalOptions(array $globalOptions)

Remove the 'options.' prefix from the global options list.

Parameters

array $globalOptions

Return Value

array

at line 99
bool isSimulated() deprecated

deprecated Use $config->get(Config::SIMULATE)

No description

Return Value

bool

at line 111
$this setSimulated(bool $simulated = true) deprecated

deprecated Use $config->set(Config::SIMULATE, true)

No description

Parameters

bool $simulated

Return Value

$this

at line 121
bool isInteractive() deprecated

deprecated Use $config->get(Config::INTERACTIVE)

No description

Return Value

bool

at line 133
$this setInteractive(bool $interactive = true) deprecated

deprecated Use $config->set(Config::INTERACTIVE, true)

No description

Parameters

bool $interactive

Return Value

$this

at line 143
bool isDecorated() deprecated

deprecated Use $config->get(Config::DECORATED)

No description

Return Value

bool

at line 155
$this setDecorated(bool $decorated = true) deprecated

deprecated Use $config->set(Config::DECORATED, true)

No description

Parameters

bool $decorated

Return Value

$this

at line 167
$this setProgressBarAutoDisplayInterval(int $interval) deprecated

deprecated Use $config->set(Config::PROGRESS_BAR_AUTO_DISPLAY_INTERVAL, $interval)

No description

Parameters

int $interval

Return Value

$this