PEAR_Command_Config Class Reference

Inheritance diagram for PEAR_Command_Config:

Collaboration diagram for PEAR_Command_Config:

Public Member Functions
	__construct (&$ui, &$config)
	_checkLayer ($layer=null)
	_showConfig (&$config)
	doConfigCreate ($command, $options, $params)
	doConfigGet ($command, $options, $params)
	doConfigHelp ($command, $options, $params)
	doConfigSet ($command, $options, $params)
	doConfigShow ($command, $options, $params)
Public Member Functions inherited from PEAR_Command_Common
	getCommands ()
	getGetoptArgs ($command, &$short_args, &$long_args)
	getHelp ($command)
	getHelpArgs ($command)
	getOptions ($command)
	getShortcuts ()
	run ($command, $options, $params)
Public Member Functions inherited from PEAR
	__call ($method, $arguments)
	__construct ($error_class=null)
	_checkDelExpect ($error_code)
	_PEAR ()
	delExpect ($error_code)
	expectError ($code=' *')
	PEAR ($error_class=null)
	popExpect ()

Data Fields
	$commands
Data Fields inherited from PEAR_Command_Common
	$_deps_rel_trans
	$_deps_type_trans
	$_registry
	$config
	$ui
Data Fields inherited from PEAR
	$_debug = false
	$_default_error_handler = ''
	$_default_error_mode = null
	$_default_error_options = null
	$_error_class = 'PEAR_Error'
	$_expected_errors = array()

Additional Inherited Members
Static Public Member Functions inherited from PEAR
static	__callStatic ($method, $arguments)
static	getSourceDateEpoch ()
static &	getStaticProperty ($class, $var)
static	isError ($data, $code=null)
static	loadExtension ($ext)
static	registerShutdownFunc ($func, $args=array())
static	staticPopErrorHandling ()
static	staticPushErrorHandling ($mode, $options=null)
Static Protected Member Functions inherited from PEAR
static	_popErrorHandling ($object)
static	_pushErrorHandling ($object, $mode, $options=null)
static	_raiseError ($object, $message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
static	_setErrorHandling ( $object, $mode=null, $options=null)
static	_throwError ($object, $message=null, $code=null, $userinfo=null)
Static Protected Attributes inherited from PEAR
static	$bivalentMethods

Detailed Description

Definition at line 35 of file Config.php.

Constructor & Destructor Documentation

__construct()

__construct	(	&	$ui,
		&	$config )

PEAR_Command_Config constructor.

@access public

Reimplemented from PEAR_Command_Common.

Definition at line 135 of file Config.php.

    {
        parent::__construct($ui, $config);
    }

References PEAR_Command_Common\$config, and PEAR_Command_Common\$ui.

Member Function Documentation

_checkLayer()

_checkLayer

(

$layer = null

)

Checks if a layer is defined or not

Parameters

string

$layer

The layer to search for

Returns

mixed False on no error or the error message

Definition at line 403 of file Config.php.

    {
        if (!empty($layer) && $layer != 'default') {
            $layers = $this->config->getLayers();
            if (!in_array($layer, $layers)) {
                return " only the layers: \"" . implode('" or "', $layers) . "\" are supported";
            }
        }
 
        return false;
    }

Referenced by doConfigGet(), doConfigSet(), and doConfigShow().

Here is the caller graph for this function:

_showConfig()

_showConfig

(

&

$config

)

Definition at line 364 of file Config.php.

    {
        $params = array('user');
        $keys = $config->getKeys();
        sort($keys);
        $channel = 'pear.php.net';
        $data = array('caption' => 'Configuration (channel ' . $channel . '):');
        foreach ($keys as $key) {
            $type = $config->getType($key);
            $value = $config->get($key, 'user', $channel);
            if ($type == 'password' && $value) {
                $value = '********';
            }
 
            if ($value === false) {
                $value = 'false';
            } elseif ($value === true) {
                $value = 'true';
            }
            $data['data'][$config->getGroup($key)][] =
                array($config->getPrompt($key) , $key, $value);
        }
 
        foreach ($config->getLayers() as $layer) {
            $data['data']['Config Files'][] =
                array(ucfirst($layer) . ' Configuration File', 'Filename' ,
                    $config->getConfFile($layer));
        }
 
        $this->ui->outputData($data, 'config-show');
        return true;
    }

References PEAR_Command_Common\$config.

Referenced by doConfigCreate().

Here is the caller graph for this function:

doConfigCreate()

doConfigCreate	(		$command,
			$options,
			$params )

Definition at line 305 of file Config.php.

    {
        if (count($params) != 2) {
            return PEAR::raiseError('config-create: must have 2 parameters, root path and ' .
                'filename to save as');
        }
 
        $root = $params[0];
        // Clean up the DIRECTORY_SEPARATOR mess
        $ds2 = DIRECTORY_SEPARATOR . DIRECTORY_SEPARATOR;
        $root = preg_replace(array('!\\\\+!', '!/+!', "!$ds2+!"),
                             array('/', '/', '/'),
                            $root);
        if ($root[0] != '/') {
            if (!isset($options['windows'])) {
                return PEAR::raiseError('Root directory must be an absolute path beginning ' .
                    'with "/", was: "' . $root . '"');
            }
 
            if (!preg_match('/^[A-Za-z]:/', $root)) {
                return PEAR::raiseError('Root directory must be an absolute path beginning ' .
                    'with "\\" or "C:\\", was: "' . $root . '"');
            }
        }
 
        $windows = isset($options['windows']);
        if ($windows) {
            $root = str_replace('/', '\\', $root);
        }
 
        if (!file_exists($params[1]) && !@touch($params[1])) {
            return PEAR::raiseError('Could not create "' . $params[1] . '"');
        }
 
        $params[1] = realpath($params[1]);
        $config = new PEAR_Config($params[1], '#no#system#config#', false, false);
        if ($root[strlen($root) - 1] == '/') {
            $root = substr($root, 0, strlen($root) - 1);
        }
 
        $config->noRegistry();
        $config->set('php_dir', $windows ? "$root\\pear\\php" : "$root/pear/php", 'user');
        $config->set('data_dir', $windows ? "$root\\pear\\data" : "$root/pear/data");
        $config->set('www_dir', $windows ? "$root\\pear\\www" : "$root/pear/www");
        $config->set('cfg_dir', $windows ? "$root\\pear\\cfg" : "$root/pear/cfg");
        $config->set('ext_dir', $windows ? "$root\\pear\\ext" : "$root/pear/ext");
        $config->set('doc_dir', $windows ? "$root\\pear\\docs" : "$root/pear/docs");
        $config->set('test_dir', $windows ? "$root\\pear\\tests" : "$root/pear/tests");
        $config->set('cache_dir', $windows ? "$root\\pear\\cache" : "$root/pear/cache");
        $config->set('download_dir', $windows ? "$root\\pear\\download" : "$root/pear/download");
        $config->set('temp_dir', $windows ? "$root\\pear\\temp" : "$root/pear/temp");
        $config->set('bin_dir', $windows ? "$root\\pear" : "$root/pear");
        $config->set('man_dir', $windows ? "$root\\pear\\man" : "$root/pear/man");
        $config->writeConfigFile();
        $this->_showConfig($config);
        $this->ui->outputData('Successfully created default configuration file "' . $params[1] . '"',
            $command);
    }

References $command, PEAR_Command_Common\$config, $options, and _showConfig().

Here is the call graph for this function:

doConfigGet()

doConfigGet	(		$command,
			$options,
			$params )

Definition at line 187 of file Config.php.

    {
        $args_cnt = is_array($params) ? count($params) : 0;
        switch ($args_cnt) {
            case 1:
                $config_key = $params[0];
                $layer = null;
                break;
            case 2:
                $config_key = $params[0];
                $layer = $params[1];
                if ($error = $this->_checkLayer($layer)) {
                    return $this->raiseError("config-get:$error");
                }
                break;
            case 0:
            default:
                return $this->raiseError("config-get expects 1 or 2 parameters");
        }
 
        $reg = &$this->config->getRegistry();
        $channel = isset($options['channel']) ? $options['channel'] : $this->config->get('default_channel');
        if (!$reg->channelExists($channel)) {
            return $this->raiseError('Channel "' . $channel . '" does not exist');
        }
 
        $channel = $reg->channelName($channel);
        $this->ui->outputData($this->config->get($config_key, $layer, $channel), $command);
        return true;
    }

References $command, $options, and _checkLayer().

Here is the call graph for this function:

doConfigHelp()

doConfigHelp	(		$command,
			$options,
			$params )

Definition at line 282 of file Config.php.

    {
        if (empty($params)) {
            $params = $this->config->getKeys();
        }
 
        $data['caption']  = "Config help" . ((count($params) == 1) ? " for $params[0]" : '');
        $data['headline'] = array('Name', 'Type', 'Description');
        $data['border']   = true;
        foreach ($params as $name) {
            $type = $this->config->getType($name);
            $docs = $this->config->getDocs($name);
            if ($type == 'set') {
                $docs = rtrim($docs) . "\nValid set: " .
                    implode(' ', $this->config->getSetValues($name));
            }
 
            $data['data'][] = array($name, $type, $docs);
        }
 
        $this->ui->outputData($data, $command);
    }

References $command, and $options.

doConfigSet()

doConfigSet	(		$command,
			$options,
			$params )

Definition at line 218 of file Config.php.

    {
        // $param[0] -> a parameter to set
        // $param[1] -> the value for the parameter
        // $param[2] -> the layer
        $failmsg = '';
        if (count($params) < 2 || count($params) > 3) {
            $failmsg .= "config-set expects 2 or 3 parameters";
            return PEAR::raiseError($failmsg);
        }
 
        if (isset($params[2]) && ($error = $this->_checkLayer($params[2]))) {
            $failmsg .= $error;
            return PEAR::raiseError("config-set:$failmsg");
        }
 
        $channel = isset($options['channel']) ? $options['channel'] : $this->config->get('default_channel');
        $reg = &$this->config->getRegistry();
        if (!$reg->channelExists($channel)) {
            return $this->raiseError('Channel "' . $channel . '" does not exist');
        }
 
        $channel = $reg->channelName($channel);
        if ($params[0] == 'default_channel' && !$reg->channelExists($params[1])) {
            return $this->raiseError('Channel "' . $params[1] . '" does not exist');
        }
 
        if ($params[0] == 'preferred_mirror'
            && (
                !$reg->mirrorExists($channel, $params[1]) &&
                (!$reg->channelExists($params[1]) || $channel != $params[1])
            )
        ) {
            $msg  = 'Channel Mirror "' . $params[1] . '" does not exist';
            $msg .= ' in your registry for channel "' . $channel . '".';
            $msg .= "\n" . 'Attempt to run "pear channel-update ' . $channel .'"';
            $msg .= ' if you believe this mirror should exist as you may';
            $msg .= ' have outdated channel information.';
            return $this->raiseError($msg);
        }
 
        if (count($params) == 2) {
            array_push($params, 'user');
            $layer = 'user';
        } else {
            $layer = $params[2];
        }
 
        array_push($params, $channel);
        if (!call_user_func_array(array(&$this->config, 'set'), $params)) {
            array_pop($params);
            $failmsg = "config-set (" . implode(", ", $params) . ") failed, channel $channel";
        } else {
            $this->config->store($layer);
        }
 
        if ($failmsg) {
            return $this->raiseError($failmsg);
        }
 
        $this->ui->outputData('config-set succeeded', $command);
        return true;
    }

References $command, $options, and _checkLayer().

Here is the call graph for this function:

doConfigShow()

doConfigShow	(		$command,
			$options,
			$params )

Definition at line 140 of file Config.php.

    {
        $layer = null;
        if (is_array($params)) {
            $layer = isset($params[0]) ? $params[0] : null;
        }
 
        // $params[0] -> the layer
        if ($error = $this->_checkLayer($layer)) {
            return $this->raiseError("config-show:$error");
        }
 
        $keys = $this->config->getKeys();
        sort($keys);
        $channel = isset($options['channel']) ? $options['channel'] :
            $this->config->get('default_channel');
        $reg = &$this->config->getRegistry();
        if (!$reg->channelExists($channel)) {
            return $this->raiseError('Channel "' . $channel . '" does not exist');
        }
 
        $channel = $reg->channelName($channel);
        $data = array('caption' => 'Configuration (channel ' . $channel . '):');
        foreach ($keys as $key) {
            $type = $this->config->getType($key);
            $value = $this->config->get($key, $layer, $channel);
            if ($type == 'password' && $value) {
                $value = '********';
            }
 
            if ($value === false) {
                $value = 'false';
            } elseif ($value === true) {
                $value = 'true';
            }
 
            $data['data'][$this->config->getGroup($key)][] = array($this->config->getPrompt($key) , $key, $value);
        }
 
        foreach ($this->config->getLayers() as $layer) {
            $data['data']['Config Files'][] = array(ucfirst($layer) . ' Configuration File', 'Filename' , $this->config->getConfFile($layer));
        }
 
        $this->ui->outputData($data, $command);
        return true;
    }

References $command, $options, and _checkLayer().

Here is the call graph for this function:

Field Documentation

$commands

$commands

Definition at line 37 of file Config.php.

---

The documentation for this class was generated from the following file:

• E:/Bearsampp-development/sandbox/core/libs/php/pear/pear/PEAR/Command/Config.php