Class PEAR_Command_Common

Description

Located in /maintenance/libraries/pear/PEAR/Command/Common.php (line 23)

PEAR
   |
   --PEAR_Command_Common
Direct descendents
Class Description
 class PEAR_Command_Mirror PEAR commands for providing file mirrors
 class PEAR_Command_Package
 class PEAR_Command_Remote
 class PEAR_Command_Build PEAR commands for building extensions.
 class PEAR_Command_Auth PEAR commands for managing configuration data.
 class PEAR_Command_Config PEAR commands for managing configuration data.
 class PEAR_Command_Install PEAR commands for installation or deinstallation/upgrading of packages.
 class PEAR_Command_Registry
Variable Summary
 object $config
 object $ui
Method Summary
 PEAR_Command_Common PEAR_Command_Common (mixed &$ui, mixed &$config)
 array getCommands ()
 void getGetoptArgs (mixed $command, mixed &$short_args, mixed &$long_args)
 mixed getHelp (string $command)
 string getHelpArgs (string $command)
 void getOptions (mixed $command)
 array getShortcuts ()
 void run (mixed $command, mixed $options, mixed $params)
Variables
object $config (line 33)

PEAR_Config object used to pass user system and configuration on when executing commands

object $ui (line 39)

User Interface object, for all interaction with the user.

mixed $_deps_rel_trans = array(
'lt' => '<',
'le' => '<=',
'eq' => '=',
'ne' => '!=',
'gt' => '>',
'ge' => '>=',
'has' => '=='
)
(line 41)
mixed $_deps_type_trans = array(
'pkg' => 'package',
'extension' => 'extension',
'php' => 'PHP',
'prog' => 'external program',
'ldlib' => 'external library for linking',
'rtlib' => 'external runtime library',
'os' => 'operating system',
'websrv' => 'web server',
'sapi' => 'SAPI backend'
)
(line 51)
Methods
Constructor PEAR_Command_Common (line 71)

PEAR_Command_Common constructor.

  • access: public
PEAR_Command_Common PEAR_Command_Common (mixed &$ui, mixed &$config)
getCommands (line 87)

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

  • return: list of commands
  • access: public
array getCommands ()
getGetoptArgs (line 126)
void getGetoptArgs (mixed $command, mixed &$short_args, mixed &$long_args)
getHelp (line 164)

Returns the help message for the given command

  • return: 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
mixed getHelp (string $command)
  • string $command: The command
getHelpArgs (line 190)

Returns the help for the accepted arguments of a command

  • return: The help string
string getHelpArgs (string $command)
  • string $command
getOptions (line 118)
void getOptions (mixed $command)
getShortcuts (line 104)

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

  • return: shortcut => command
  • access: public
array getShortcuts ()
run (line 227)
void run (mixed $command, mixed $options, mixed $params)

Documentation generated on Fri, 10 Dec 2004 18:25:07 +0000 by phpDocumentor 1.3.0RC3