Static Public Member Functions
static &	factory ($command, &$config)
static	getCommands ()
static	getDescription ($command)
static &	getFrontendObject ()
static	getGetoptArgs ($command, &$short_args, &$long_args)
static	getHelp ($command)
static &	getObject ($command)
static	getShortcuts ()
static	registerCommands ($merge=false, $dir=null)
static &	setFrontendClass ($uiclass)
static	setFrontendType ($uitype)

Detailed Description

Definition at line 100 of file Command.php.

Member Function Documentation

◆ factory()

& factory	(		$command,
		&	$config )

static

Get the right object for executing a command.

Parameters

string	$command	The name of the command
object	$config	Instance of PEAR_Config object

Returns: object the command object or a PEAR error

Definition at line 112 of file Command.php.

    {
        if (empty($GLOBALS['_PEAR_Command_commandlist'])) {
            PEAR_Command::registerCommands();
        }
        if (isset($GLOBALS['_PEAR_Command_shortcuts'][$command])) {
            $command = $GLOBALS['_PEAR_Command_shortcuts'][$command];
        }
        if (!isset($GLOBALS['_PEAR_Command_commandlist'][$command])) {
            $a = PEAR::raiseError("unknown command `$command'");
            return $a;
        }
        $class = $GLOBALS['_PEAR_Command_commandlist'][$command];
        if (!class_exists($class)) {
            require_once $GLOBALS['_PEAR_Command_objects'][$class];
        }
        if (!class_exists($class)) {
            $a = PEAR::raiseError("unknown command `$command'");
            return $a;
        }
        $ui =& PEAR_Command::getFrontendObject();
        $obj = new $class($ui, $config);
        return $obj;
    }

References $command, $config, $GLOBALS, $ui, getFrontendObject(), and registerCommands().

Referenced by PEAR_Command_Mirror\factory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCommands()

getCommands ( )

static

Get the list of currently supported commands, and what classes implement them.

Returns: array command => implementing class

Definition at line 299 of file Command.php.

    {
        if (empty($GLOBALS['_PEAR_Command_commandlist'])) {
            PEAR_Command::registerCommands();
        }
        return $GLOBALS['_PEAR_Command_commandlist'];
    }

References $GLOBALS, and registerCommands().

Referenced by getHelp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDescription()

getDescription ( $command )

static

Get description for a command.

Parameters

string $command Name of the command

Returns: string command description

Definition at line 360 of file Command.php.

    {
        if (!isset($GLOBALS['_PEAR_Command_commanddesc'][$command])) {
            return null;
        }
        return $GLOBALS['_PEAR_Command_commanddesc'][$command];
    }

References $command, and $GLOBALS.

Referenced by usage().

Here is the caller graph for this function:

◆ getFrontendObject()

& getFrontendObject ( )

static

Get instance of frontend object.

Returns: object|PEAR_Error

Definition at line 162 of file Command.php.

    {
        $a = &PEAR_Frontend::singleton();
        return $a;
    }

References PEAR_Frontend\singleton().

Referenced by factory(), and getObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGetoptArgs()

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

static

Compiles arguments for getopt.

Parameters

string	$command	command to get optstring for
string	$short_args	(reference) short getopt format
array	$long_args	(reference) long getopt format

Returns: void

Definition at line 335 of file Command.php.

    {
        if (empty($GLOBALS['_PEAR_Command_commandlist'])) {
            PEAR_Command::registerCommands();
        }
        if (isset($GLOBALS['_PEAR_Command_shortcuts'][$command])) {
            $command = $GLOBALS['_PEAR_Command_shortcuts'][$command];
        }
        if (!isset($GLOBALS['_PEAR_Command_commandlist'][$command])) {
            return null;
        }
        $obj = &PEAR_Command::getObject($command);
        return $obj->getGetoptArgs($command, $short_args, $long_args);
    }

References $command, $GLOBALS, getObject(), and registerCommands().

Here is the call graph for this function:

◆ getHelp()

getHelp ( $command )

static

Get help for command.

Parameters

string $command Name of the command to return help for

Definition at line 376 of file Command.php.

    {
        $cmds = PEAR_Command::getCommands();
        if (isset($GLOBALS['_PEAR_Command_shortcuts'][$command])) {
            $command = $GLOBALS['_PEAR_Command_shortcuts'][$command];
        }
        if (isset($cmds[$command])) {
            $obj = &PEAR_Command::getObject($command);
            return $obj->getHelp($command);
        }
        return false;
    }

References $command, $GLOBALS, getCommands(), and getObject().

Referenced by cmdHelp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObject()

& getObject ( $command )

static

Definition at line 139 of file Command.php.

    {
        $class = $GLOBALS['_PEAR_Command_commandlist'][$command];
        if (!class_exists($class)) {
            require_once $GLOBALS['_PEAR_Command_objects'][$class];
        }
        if (!class_exists($class)) {
            return PEAR::raiseError("unknown command `$command'");
        }
        $ui =& PEAR_Command::getFrontendObject();
        $config = &PEAR_Config::singleton();
        $obj = new $class($ui, $config);
        return $obj;
    }

References $command, $config, $GLOBALS, $ui, and getFrontendObject().

Referenced by getGetoptArgs(), and getHelp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getShortcuts()

getShortcuts ( )

static

Get the list of command shortcuts.

Returns: array shortcut => command

Definition at line 315 of file Command.php.

    {
        if (empty($GLOBALS['_PEAR_Command_shortcuts'])) {
            PEAR_Command::registerCommands();
        }
        return $GLOBALS['_PEAR_Command_shortcuts'];
    }

References $GLOBALS, and registerCommands().

Referenced by cmdHelp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerCommands()

registerCommands	(		$merge = false,
			$dir = null )

static

Scan through the Command directory looking for classes and see what commands they implement.

Parameters

bool	(optional) if FALSE (default), the new list of commands should replace the current one. If TRUE, new entries will be merged with old.
string	(optional) where (what directory) to look for classes, defaults to the Command subdirectory of the directory from where this file (FILE) is included.

Returns: bool TRUE on success, a PEAR error on failure

Definition at line 218 of file Command.php.

    {
        $parser = new PEAR_XMLParser;
        if ($dir === null) {
            $dir = dirname(__FILE__) . '/Command';
        }
        if (!is_dir($dir)) {
            return PEAR::raiseError("registerCommands: opendir($dir) '$dir' does not exist or is not a directory");
        }
        $dp = @opendir($dir);
        if (empty($dp)) {
            return PEAR::raiseError("registerCommands: opendir($dir) failed");
        }
        if (!$merge) {
            $GLOBALS['_PEAR_Command_commandlist'] = array();
        }
 
        while ($file = readdir($dp)) {
            if ($file[0] == '.' || substr($file, -4) != '.xml') {
                continue;
            }
 
            $f = substr($file, 0, -4);
            $class = "PEAR_Command_" . $f;
            // List of commands
            if (empty($GLOBALS['_PEAR_Command_objects'][$class])) {
                $GLOBALS['_PEAR_Command_objects'][$class] = "$dir/" . $f . '.php';
            }
 
            $parser->parse(file_get_contents("$dir/$file"));
            $implements = $parser->getData();
            foreach ($implements as $command => $desc) {
                if ($command == 'attribs') {
                    continue;
                }
 
                if (isset($GLOBALS['_PEAR_Command_commandlist'][$command])) {
                    return PEAR::raiseError('Command "' . $command . '" already registered in ' .
                        'class "' . $GLOBALS['_PEAR_Command_commandlist'][$command] . '"');
                }
 
                $GLOBALS['_PEAR_Command_commandlist'][$command] = $class;
                $GLOBALS['_PEAR_Command_commanddesc'][$command] = $desc['summary'];
                if (isset($desc['shortcut'])) {
                    $shortcut = $desc['shortcut'];
                    if (isset($GLOBALS['_PEAR_Command_shortcuts'][$shortcut])) {
                        return PEAR::raiseError('Command shortcut "' . $shortcut . '" already ' .
                            'registered to command "' . $command . '" in class "' .
                            $GLOBALS['_PEAR_Command_commandlist'][$command] . '"');
                    }
                    $GLOBALS['_PEAR_Command_shortcuts'][$shortcut] = $command;
                }
 
                if (isset($desc['options']) && $desc['options']) {
                    foreach ($desc['options'] as $oname => $option) {
                        if (isset($option['shortopt']) && strlen($option['shortopt']) > 1) {
                            return PEAR::raiseError('Option "' . $oname . '" short option "' .
                                $option['shortopt'] . '" must be ' .
                                'only 1 character in Command "' . $command . '" in class "' .
                                $class . '"');
                        }
                    }
                }
            }
        }
 
        ksort($GLOBALS['_PEAR_Command_shortcuts']);
        ksort($GLOBALS['_PEAR_Command_commandlist']);
        @closedir($dp);
        return true;
    }

References $command, and $GLOBALS.

Referenced by factory(), getCommands(), getGetoptArgs(), and getShortcuts().

Here is the caller graph for this function:

◆ setFrontendClass()

& setFrontendClass ( $uiclass )

static

Load current frontend class.

Parameters

string $uiclass Name of class implementing the frontend

Returns: object the frontend object, or a PEAR error

Definition at line 178 of file Command.php.

    {
        $a = &PEAR_Frontend::setFrontendClass($uiclass);
        return $a;
    }

References PEAR_Frontend\setFrontendClass().

Referenced by setFrontendType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFrontendType()

setFrontendType ( $uitype )

static

Set current frontend.

Parameters

string $uitype Name of the frontend type (for example "CLI")

Returns: object the frontend object, or a PEAR error

Definition at line 194 of file Command.php.

    {
        $uiclass = 'PEAR_Frontend_' . $uitype;
        return PEAR_Command::setFrontendClass($uiclass);
    }

References setFrontendClass().

Here is the call graph for this function:

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

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

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ factory()

◆ getCommands()

◆ getDescription()

◆ getFrontendObject()

◆ getGetoptArgs()

◆ getHelp()

◆ getObject()

◆ getShortcuts()

◆ registerCommands()

◆ setFrontendClass()

◆ setFrontendType()