PEAR_Command_Common Class Reference

Inheritance diagram for PEAR_Command_Common:

Collaboration diagram for PEAR_Command_Common:

Public Member Functions
	__construct (&$ui, &$config)
	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
	$_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 Common.php.

Constructor & Destructor Documentation

__construct()

__construct	(	&	$ui,
		&	$config )

PEAR_Command_Common constructor.

@access public

Reimplemented in PEAR_Command_Auth, PEAR_Command_Build, PEAR_Command_Channels, PEAR_Command_Config, PEAR_Command_Install, PEAR_Command_Mirror, PEAR_Command_Package, PEAR_Command_Pickle, PEAR_Command_Registry, PEAR_Command_Remote, and PEAR_Command_Test.

Definition at line 83 of file Common.php.

    {
        parent::__construct();
        $this->config = &$config;
        $this->ui = &$ui;
    }

References $config, and $ui.

Member Function Documentation

getCommands()

getCommands

(

)

Return a list of all the commands defined by this class.

Returns

array list of commands @access public

Definition at line 95 of file Common.php.

    {
        $ret = array();
        foreach (array_keys($this->commands) as $command) {
            $ret[$command] = $this->commands[$command]['summary'];
        }
 
        return $ret;
    }

References $command.

getGetoptArgs()

getGetoptArgs	(		$command,
		&	$short_args,
		&	$long_args )

Definition at line 137 of file Common.php.

    {
        $short_args = '';
        $long_args = array();
        if (empty($this->commands[$command]) || empty($this->commands[$command]['options'])) {
            return;
        }
 
        reset($this->commands[$command]['options']);
        foreach ($this->commands[$command]['options'] as $option => $info) {
            $larg = $sarg = '';
            if (isset($info['arg'])) {
                if ($info['arg'][0] == '(') {
                    $larg = '==';
                    $sarg = '::';
                    $arg = substr($info['arg'], 1, -1);
                } else {
                    $larg = '=';
                    $sarg = ':';
                    $arg = $info['arg'];
                }
            }
 
            if (isset($info['shortopt'])) {
                $short_args .= $info['shortopt'] . $sarg;
            }
 
            $long_args[] = $option . $larg;
        }
    }

References $command.

getHelp()

getHelp

(

$command

)

Returns the help message for the given command

Parameters

string

$command

The command

Returns

mixed A fail string if the command does not have help or a two elements array containing [0]=>help string, [1]=> help string for the accepted cmd args

Definition at line 176 of file Common.php.

    {
        $config = &PEAR_Config::singleton();
        if (!isset($this->commands[$command])) {
            return "No such command \"$command\"";
        }
 
        $help = null;
        if (isset($this->commands[$command]['doc'])) {
            $help = $this->commands[$command]['doc'];
        }
 
        if (empty($help)) {
            // XXX (cox) Fallback to summary if there is no doc (show both?)
            if (!isset($this->commands[$command]['summary'])) {
                return "No help for command \"$command\"";
            }
            $help = $this->commands[$command]['summary'];
        }
 
        if (preg_match_all('/{config\s+([^\}]+)}/', $help, $matches)) {
            foreach($matches[0] as $k => $v) {
                $help = preg_replace("/$v/", $config->get($matches[1][$k]), $help);
            }
        }
 
        return array($help, $this->getHelpArgs($command));
    }

References $command, $config, and getHelpArgs().

Referenced by PEAR_Command_Package\doCvsDiff(), PEAR_Command_Package\doCvsTag(), and PEAR_Command_Package\doSvnTag().

Here is the call graph for this function:

Here is the caller graph for this function:

getHelpArgs()

getHelpArgs

(

$command

)

Returns the help for the accepted arguments of a command

Parameters

string

$command

Returns

string The help string

Definition at line 211 of file Common.php.

    {
        if (isset($this->commands[$command]['options']) &&
            count($this->commands[$command]['options']))
        {
            $help = "Options:\n";
            foreach ($this->commands[$command]['options'] as $k => $v) {
                if (isset($v['arg'])) {
                    if ($v['arg'][0] == '(') {
                        $arg = substr($v['arg'], 1, -1);
                        $sapp = " [$arg]";
                        $lapp = "[=$arg]";
                    } else {
                        $sapp = " $v[arg]";
                        $lapp = "=$v[arg]";
                    }
                } else {
                    $sapp = $lapp = "";
                }
 
                if (isset($v['shortopt'])) {
                    $s = $v['shortopt'];
                    $help .= "  -$s$sapp, --$k$lapp\n";
                } else {
                    $help .= "  --$k$lapp\n";
                }
 
                $p = "        ";
                $doc = rtrim(str_replace("\n", "\n$p", $v['doc']));
                $help .= "        $doc\n";
            }
 
            return $help;
        }
 
        return null;
    }

References $command.

Referenced by getHelp().

Here is the caller graph for this function:

getOptions()

getOptions

(

$command

)

Definition at line 122 of file Common.php.

    {
        $shortcuts = $this->getShortcuts();
        if (isset($shortcuts[$command])) {
            $command = $shortcuts[$command];
        }
 
        if (isset($this->commands[$command]) &&
              isset($this->commands[$command]['options'])) {
            return $this->commands[$command]['options'];
        }
 
        return null;
    }

References $command, and getShortcuts().

Here is the call graph for this function:

getShortcuts()

getShortcuts

(

)

Return a list of all the command shortcuts defined by this class.

Returns

array shortcut => command @access public

Definition at line 110 of file Common.php.

    {
        $ret = array();
        foreach (array_keys($this->commands) as $command) {
            if (isset($this->commands[$command]['shortcut'])) {
                $ret[$this->commands[$command]['shortcut']] = $command;
            }
        }
 
        return $ret;
    }

References $command.

Referenced by getOptions().

Here is the caller graph for this function:

run()

run	(		$command,
			$options,
			$params )

Definition at line 249 of file Common.php.

    {
        if (empty($this->commands[$command]['function'])) {
            // look for shortcuts
            foreach (array_keys($this->commands) as $cmd) {
                if (isset($this->commands[$cmd]['shortcut']) && $this->commands[$cmd]['shortcut'] == $command) {
                    if (empty($this->commands[$cmd]['function'])) {
                        return $this->raiseError("unknown command `$command'");
                    } else {
                        $func = $this->commands[$cmd]['function'];
                    }
                    $command = $cmd;
 
                    //$command = $this->commands[$cmd]['function'];
                    break;
                }
            }
        } else {
            $func = $this->commands[$command]['function'];
        }
 
        return $this->$func($command, $options, $params);
    }

References $command, and $options.

Field Documentation

$_deps_rel_trans

$_deps_rel_trans

Initial value:

= array(
        'lt' => '<',
        'le' => '<=',
        'eq' => '=',
        'ne' => '!=',
        'gt' => '>',
        'ge' => '>=',
        'has' => '=='
        )

Definition at line 56 of file Common.php.

$_deps_type_trans

$_deps_type_trans

Initial value:

= array(
        'pkg' => 'package',
        'ext' => 'extension',
        'php' => 'PHP',
        'prog' => 'external program',
        'ldlib' => 'external library for linking',
        'rtlib' => 'external runtime library',
        'os' => 'operating system',
        'websrv' => 'web server',
        'sapi' => 'SAPI backend'
        )

Definition at line 66 of file Common.php.

$_registry

$_registry

Definition at line 48 of file Common.php.

$config

$config

Definition at line 43 of file Common.php.

Referenced by PEAR_Command_Auth\__construct(), PEAR_Command_Build\__construct(), PEAR_Command_Channels\__construct(), __construct(), PEAR_Command_Config\__construct(), PEAR_Command_Install\__construct(), PEAR_Command_Mirror\__construct(), PEAR_Command_Package\__construct(), PEAR_Command_Pickle\__construct(), PEAR_Command_Registry\__construct(), PEAR_Command_Remote\__construct(), PEAR_Command_Test\__construct(), PEAR_Command_Config\_showConfig(), PEAR_Command_Config\doConfigCreate(), PEAR_Command_Package\getCommandPackaging(), PEAR_Command_Install\getDownloader(), getHelp(), PEAR_Command_Package\getPackageFile(), and PEAR_Command_Pickle\getPackageFile().

$ui

$ui

Definition at line 54 of file Common.php.

Referenced by PEAR_Command_Auth\__construct(), PEAR_Command_Build\__construct(), PEAR_Command_Channels\__construct(), __construct(), PEAR_Command_Config\__construct(), PEAR_Command_Install\__construct(), PEAR_Command_Mirror\__construct(), PEAR_Command_Package\__construct(), PEAR_Command_Pickle\__construct(), PEAR_Command_Registry\__construct(), PEAR_Command_Remote\__construct(), PEAR_Command_Test\__construct(), PEAR_Command_Test\doRunTests(), PEAR_Command_Package\getCommandPackaging(), PEAR_Command_Install\getDownloader(), PEAR_Command_Install\getInstaller(), PEAR_Command_Package\getInstaller(), PEAR_Command_Package\getPackageFile(), and PEAR_Command_Pickle\getPackageFile().

---

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

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