ConfigurationHelper

Extends \Symfony\Component\Console\Helper\Helper

package

Default

Methods

Initializes this helper and registers the application configuration on it.

__construct(\phpDocumentor\Configuration $configuration) 

Arguments

Returns a value by traversing the configuration tree as if it was a file path.

getConfigValueFromPath(string $path) : string|integer|boolean

Arguments

$path

string

Path to the config value separated by '/'.

Response

string|integer|boolean

Returns the canonical name of this helper.

getName() : string
api
codeCoverageIgnore

it is not interesting to test a name.

Response

string

The canonical name

Returns the value of an option from the command-line parameters, configuration or given default.

getOption(\Symfony\Component\Console\Input\InputInterface $input, string $name, string|null $configPath = null, mixed|null $default = null, boolean $commaSeparated = false) : string|array

Arguments

$input

\Symfony\Component\Console\Input\InputInterface

Input interface to query for information

$name

string

Name of the option to retrieve from argv

$configPath

string|null

Path to the config element(s) containing the value to be used when no option is provided.

$default

mixed|null

Default value used if there is no configuration option or path set

$commaSeparated

boolean

Could the value be a comma separated string requiring splitting

Response

string|array

Split comma separated values.

splitCommaSeparatedValues(mixed $value) : mixed

Arguments

$value

mixed

Response

mixed

Is value empty?

valueIsEmpty(mixed $value) : boolean

Arguments

$value

mixed

Response

boolean

Properties

configuration

configuration : \phpDocumentor\Configuration