PHP Class Components_Config_Base, horde

Copyright 2009-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
See link: http://pear.horde.org/index.php?package=Components
Author: Gunnar Wrobel ([email protected])
Inheritance: implements Components_Config
Afficher le fichier Open project: horde/horde

Protected Properties

Свойство Type Description
$_arguments array Additional arguments.
$_options array Additional options.

Méthodes publiques

Méthode 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.

Method Details

getArguments() public méthode

Return the arguments parsed from the command line.
public getArguments ( ) : array
Résultat array An array of arguments.

getComponent() public méthode

Return the selected component.
public getComponent ( ) : Components_Component
Résultat Components_Component The selected component.

getOption() public méthode

Return the specified option.
public getOption ( string $option ) : mixed
$option string The name of the option.
Résultat mixed The option value or NULL if it is not defined.

getOptions() public méthode

Return all options.
public getOptions ( ) : Horde_Argv_Values
Résultat Horde_Argv_Values The option values.

getPath() public méthode

Get the path to the directory of the selected component (in case it was a source component).
public getPath ( ) : string
Résultat string The path to the component directory.

setComponent() public méthode

Set the path to the component directory.
public setComponent ( Components_Component $component ) : null
$component Components_Component The path to the component directory.
Résultat null

setOption() public méthode

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.
Résultat null

setPath() public méthode

Set the path to the directory of the selected source component.
public setPath ( string $path ) : null
$path string The path to the component directory.
Résultat null

shiftArgument() public méthode

Shift an element from the argument list.
public shiftArgument ( ) : mixed
Résultat mixed The shifted element.

unshiftArgument() public méthode

Unshift an element to the argument list.
public unshiftArgument ( string $element ) : null
$element string The element to unshift.
Résultat null

Property Details

$_arguments protected_oe property

Additional arguments.
protected array $_arguments
Résultat array

$_options protected_oe property

Additional options.
protected array $_options
Résultat array