Class PEAR_Command_Config

Description

PEAR commands for managing configuration data.

Located in /maintenance/libraries/pear/PEAR/Command/Config.php (line 30)

PEAR
   |
   --PEAR_Command_Common
      |
      --PEAR_Command_Config
Variable Summary
 mixed $commands
Method Summary
 PEAR_Command_Config PEAR_Command_Config (mixed &$ui, mixed &$config)
 void doConfigGet (mixed $command, mixed $options, mixed $params)
 void doConfigHelp (mixed $command, mixed $options, mixed $params)
 void doConfigSet (mixed $command, mixed $options, mixed $params)
 void doConfigShow (mixed $command, mixed $options, mixed $params)
 mixed _checkLayer ([string $layer = null])
Variables
mixed $commands = array(
'config-show' => array(
'summary' => 'Show All Settings',
'function' => 'doConfigShow',
'shortcut' => 'csh',
'options' => array(),'doc'=>'
Displays all configuration values. An optional argument
may be used to tell which configuration layer to display. Valid
configuration layers are "user", "system" and "default".
',),'config-get'=>array('summary'=>'Show One Setting','function'=>'doConfigGet','shortcut'=>'cg','options'=>array(),'doc'=>'<parameter> [layer]
Displays the value of one configuration parameter. The
first argument is the name of the parameter, an optional second argument
may be used to tell which configuration layer to look in. Valid configuration
layers are "user", "system" and "default". If no layer is specified, a value
will be picked from the first layer that defines the parameter, in the order
just specified.
',),'config-set'=>array('summary'=>'Change Setting','function'=>'doConfigSet','shortcut'=>'cs','options'=>array(),'doc'=>'<parameter> <value> [layer]
Sets the value of one configuration parameter. The first argument is
the name of the parameter, the second argument is the new value. Some
parameters are subject to validation, and the command will fail with
an error message if the new value does not make sense. An optional
third argument may be used to specify in which layer to set the
configuration parameter. The default layer is "user".
',),'config-help'=>array('summary'=>'Show Information About Setting','function'=>'doConfigHelp','shortcut'=>'ch','options'=>array(),'doc'=>'[parameter]
Displays help for a configuration parameter. Without arguments it
displays help for all configuration parameters.
',),)
(line 34)

Inherited Variables

Inherited from PEAR_Command_Common

PEAR_Command_Common::$config
PEAR_Command_Common::$ui
PEAR_Command_Common::$_deps_rel_trans
PEAR_Command_Common::$_deps_type_trans
Methods
Constructor PEAR_Command_Config (line 73)

PEAR_Command_Config constructor.

  • access: public
PEAR_Command_Config PEAR_Command_Config (mixed &$ui, mixed &$config)
doConfigGet (line 111)
void doConfigGet (mixed $command, mixed $options, mixed $params)
doConfigHelp (line 161)
void doConfigHelp (mixed $command, mixed $options, mixed $params)
doConfigSet (line 132)
void doConfigSet (mixed $command, mixed $options, mixed $params)
doConfigShow (line 82)
void doConfigShow (mixed $command, mixed $options, mixed $params)
_checkLayer (line 190)

Checks if a layer is defined or not

  • return: False on no error or the error message
mixed _checkLayer ([string $layer = null])
  • string $layer: The layer to search for

Inherited Methods

Inherited From PEAR_Command_Common

 PEAR_Command_Common::PEAR_Command_Common()
 PEAR_Command_Common::getCommands()
 PEAR_Command_Common::getGetoptArgs()
 PEAR_Command_Common::getHelp()
 PEAR_Command_Common::getHelpArgs()
 PEAR_Command_Common::getOptions()
 PEAR_Command_Common::getShortcuts()
 PEAR_Command_Common::run()

Documentation generated on Fri, 11 Feb 2005 18:12:56 +0000 by phpDocumentor 1.3.0RC3