PHP Class Components_Config_Base, horde

Author: Gunnar Wrobel ([email protected])

Inheritance: implements Components_Config

Protected Properties

Property	Type	Description
$_arguments	array	Additional arguments.
$_options	array	Additional options.

Method	Description
getArguments ( ) : array	Return the arguments parsed from the command line.
getComponent ( ) : Components_Component	Return the selected component.
getOption ( string $option ) : mixed	Return the specified option.
getOptions ( ) : Horde_Argv_Values	Return all options.
getPath ( ) : string	Get the path to the directory of the selected component (in case it was a source component).
setComponent ( Components_Component $component ) : null	Set the path to the component directory.
setOption ( string $key, string $value ) : null	Set an additional option value.
setPath ( string $path ) : null	Set the path to the directory of the selected source component.
shiftArgument ( ) : mixed	Shift an element from the argument list.
unshiftArgument ( string $element ) : null	Unshift an element to the argument list.

Return the arguments parsed from the command line.

public getArguments ( ) : array
return	array	An array of arguments.

Return the selected component.

public getComponent ( ) : Components_Component
return	Components_Component	The selected component.

Return the specified option.

public getOption ( string $option ) : mixed
$option	string	The name of the option.
return	mixed	The option value or NULL if it is not defined.

Return all options.

public getOptions ( ) : Horde_Argv_Values
return	Horde_Argv_Values	The option values.

Get the path to the directory of the selected component (in case it was a source component).

public getPath ( ) : string
return	string	The path to the component directory.

Set the path to the component directory.

public setComponent ( Components_Component $component ) : null
$component	Components_Component	The path to the component directory.
return	null

Set an additional option value.

public setOption ( string $key, string $value ) : null
$key	string	The option to set.
$value	string	The value of the option.
return	null

Set the path to the directory of the selected source component.

public setPath ( string $path ) : null
$path	string	The path to the component directory.
return	null

Shift an element from the argument list.

public shiftArgument ( ) : mixed
return	mixed	The shifted element.

Unshift an element to the argument list.

public unshiftArgument ( string $element ) : null
$element	string	The element to unshift.
return	null

Additional arguments.

protected array $_arguments
return	array

Additional options.

protected array $_options
return	array