\phpDocumentor\Command\HelperConfigurationHelper

Summary

Methods
Properties
Constants
__construct()
getName()
getOption()
getConfigValueFromPath()
No public properties found
No constants found
splitCommaSeparatedValues()
valueIsEmpty()
No protected properties found
N/A
No private methods found
$configuration
N/A

Properties

Methods

__construct()

__construct(\phpDocumentor\Configuration  $configuration) 

Initializes this helper and registers the application configuration on it.

Parameters

\phpDocumentor\Configuration $configuration

getName()

getName() : string

Returns the canonical name of this helper.

Returns

string —

The canonical name

getOption()

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

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

Parameters

\Symfony\Component\Console\Input\InputInterface $input

Input interface to query for information

string $name

Name of the option to retrieve from argv

string|null $configPath

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

mixed|null $default

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

boolean $commaSeparated

Could the value be a comma separated string requiring splitting

Returns

string|array

getConfigValueFromPath()

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

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

Parameters

string $path

Path to the config value separated by '/'.

Returns

string|integer|boolean

splitCommaSeparatedValues()

splitCommaSeparatedValues(mixed  $value) : mixed

Split comma separated values.

Parameters

mixed $value

Returns

mixed

valueIsEmpty()

valueIsEmpty(mixed  $value) : boolean

Is value empty?

Parameters

mixed $value

Returns

boolean