Class: PEAR_Command_Config

Source Location: /PEAR-1.9.4/PEAR/Command/Config.php

Class Overview

PEAR
   |
   --PEAR_Command_Common
      |
      --PEAR_Command_Config

PEAR commands for managing configuration data.

Author(s):

Greg Beaver <cellog at php.net>
Stig Bakken <ssb at php.net>

Version:

Release: 1.9.4

Copyright:

1997-2009 The Authors

Variables

$commands

Methods

Inherited Variables

Class: PEAR_Command_Common

PEAR_Command_Common::$config
PEAR_Command_Common::$ui
PEAR_Command_Common::$_registry

Inherited Methods

Class: PEAR_Command_Common

PEAR_Command_Common::PEAR_Command_Common(): PEAR_Command_Common constructor.
PEAR_Command_Common::getCommands(): Return a list of all the commands defined by this class.
PEAR_Command_Common::getGetoptArgs()
PEAR_Command_Common::getHelp(): Returns the help message for the given command
PEAR_Command_Common::getHelpArgs(): Returns the help for the accepted arguments of a command
PEAR_Command_Common::getOptions()
PEAR_Command_Common::getShortcuts(): Return a list of all the command shortcuts defined by this class.
PEAR_Command_Common::run()

Class: PEAR

PEAR::PEAR(): Constructor. Registers this object in $_PEAR_destructor_object_list for destructor emulation if a destructor object exists.
PEAR::delExpect(): This method deletes all occurences of the specified element from the expected error codes stack.
PEAR::expectError(): This method is used to tell which errors you expect to get.
PEAR::getStaticProperty(): If you have a class that's mostly/entirely static, and you need static
PEAR::isError(): Tell whether a value is a PEAR error.
PEAR::loadExtension(): OS independant PHP extension load. Remember to take care on the correct extension name for case sensitive OSes.
PEAR::popErrorHandling(): Pop the last error handler used
PEAR::popExpect(): This method pops one element off the expected error codes stack.
PEAR::pushErrorHandling(): Push a new error handler on top of the error handler options stack. With this you can easily override the actual error handler for some code and restore it later with popErrorHandling.
PEAR::raiseError(): This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. If the $mode and $options parameters are not specified, the object's defaults are used.
PEAR::registerShutdownFunc(): Use this function to register a shutdown method for static classes.
PEAR::setErrorHandling(): Sets how errors generated by this object should be handled.
PEAR::staticPopErrorHandling()
PEAR::staticPushErrorHandling()
PEAR::throwError(): Simpler form of raiseError with fewer options. In most cases message, code and userinfo are enough.
PEAR::_PEAR(): Destructor (the emulated type of...). Does nothing right now, but is included for forward compatibility, so subclass destructors should always call it.

Class Details

[line 36]
PEAR commands for managing configuration data.

Author: Greg Beaver <cellog@php.net>
Author: Stig Bakken <ssb@php.net>
Version: Release: 1.9.4
Copyright: 1997-2009 The Authors
Link: http://pear.php.net/package/PEAR
Since: Class available since Release 0.1
License: New BSD License

[ Top ]

Class Variables

$commands = array(
        'config-show' => array(
            'summary' => 'Show All Settings',
            'function' => 'doConfigShow',
            'shortcut' => 'csh',
            'options' => array(
                'channel' => array(
                    'shortopt' => 'c',
                    'doc' => 'show configuration variables for another channel',
                    'arg' => 'CHAN',
                    ),),'doc'=>'[layer]
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". To display
configurations for different channels, set the default_channel
configuration variable and run config-show again.
',),'config-get'=>array('summary'=>'Show One Setting','function'=>'doConfigGet','shortcut'=>'cg','options'=>array('channel'=>array('shortopt'=>'c','doc'=>'show configuration variables for another channel','arg'=>'CHAN',),),'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.  The configuration value will be retrieved for the channel
specified by the default_channel configuration variable.
',),'config-set'=>array('summary'=>'Change Setting','function'=>'doConfigSet','shortcut'=>'cs','options'=>array('channel'=>array('shortopt'=>'c','doc'=>'show configuration variables for another channel','arg'=>'CHAN',),),'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".  The
configuration value will be set for the current channel, which
is controlled by the default_channel configuration variable.
',),'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.
',),'config-create'=>array('summary'=>'Create a Default configuration file','function'=>'doConfigCreate','shortcut'=>'coc','options'=>array('windows'=>array('shortopt'=>'w','doc'=>'create a config file for a windows install',),),'doc'=>'<root path> <filename>
Create a default configuration file with all directory configuration
variables set to subdirectories of <root path>, and save it as <filename>.
This is useful especially for creating a configuration file for a remote
PEAR installation (using the --remoteconfig option of install, upgrade,
and uninstall).
',),)

[line 38]

Type:

mixed

[ Top ]

Method Detail

PEAR_Command_Config (Constructor) [line 136]

PEAR_Command_Config PEAR_Command_Config(

&$ui, 
&$config)

PEAR_Command_Config constructor.

Access: public

Parameters:

	`&$ui`	—
	`&$config`	—

[ Top ]

doConfigCreate [line 306]

void doConfigCreate(

$command, 
$options, 
$params)

Parameters:

	`$command`	—
	`$options`	—
	`$params`	—

[ Top ]

doConfigGet [line 188]

void doConfigGet(

$command, 
$options, 
$params)

Parameters:

	`$command`	—
	`$options`	—
	`$params`	—

[ Top ]

doConfigHelp [line 283]

void doConfigHelp(

$command, 
$options, 
$params)

Parameters:

	`$command`	—
	`$options`	—
	`$params`	—

[ Top ]

doConfigSet [line 219]

void doConfigSet(

$command, 
$options, 
$params)

Parameters:

	`$command`	—
	`$options`	—
	`$params`	—

[ Top ]

doConfigShow [line 141]

void doConfigShow(

$command, 
$options, 
$params)

Parameters:

	`$command`	—
	`$options`	—
	`$params`	—

[ Top ]