PHP Interface Components_Config, 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])
Mostrar archivo Open project: horde/horde Interface Usage Examples

Public Methods

Method Description
getArguments ( ) : array Return the arguments provided by the configuration handlers.
getComponent ( ) : Components_Component Return the selected component.
getOptions ( ) : array Return the options provided by the configuration handlers.
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 selected component.
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 method

Return the arguments provided by the configuration handlers.
public getArguments ( ) : array
return array An array of arguments.

getComponent() public method

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

getOptions() public method

Return the options provided by the configuration handlers.
public getOptions ( ) : array
return array An array of options.

getPath() public method

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.

setComponent() public method

Set the selected component.
public setComponent ( Components_Component $component ) : null
$component Components_Component The selected component.
return null

setOption() public method

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

setPath() public method

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

shiftArgument() public method

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

unshiftArgument() public method

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