Class: PEAR_Command_Common

Source Location: /PEAR-1.3.5/PEAR/Command/Common.php

Class Overview

PEAR
   |
   --PEAR_Command_Common

Base class for other PEAR classes. Provides rudimentary emulation of destructors.

Author(s):

Stig Bakken <ssb at php.net>

Child classes:

PEAR_Command_Package: Base class for other PEAR classes. Provides rudimentary emulation of destructors.

PEAR_Command_Build: PEAR commands for building extensions.

PEAR_Command_Remote: Base class for other PEAR classes. Provides rudimentary emulation of destructors.

PEAR_Command_Config: PEAR commands for managing configuration data.

PEAR_Command_Registry: Base class for other PEAR classes. Provides rudimentary emulation of destructors.

PEAR_Command_Auth: PEAR commands for managing configuration data.

PEAR_Command_Install: PEAR commands for installation or deinstallation/upgrading of packages.

PEAR_Command_Mirror: PEAR commands for providing file mirrors

Inherited Variables

Inherited Methods

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 23]
Base class for other PEAR classes. Provides rudimentary emulation of destructors.

If you want a destructor in your class, inherit PEAR and make a destructor method called _yourclassname (same name as the constructor, but with a "_" prefix). Also, in your constructor you have to call the PEAR constructor: $this->PEAR();. The destructor method will be called without parameters. Note that at in some SAPI implementations (such as Apache), any output during the request shutdown (in which destructors are called) seems to be discarded. If you need to get any debug information from your destructor, use error_log(), syslog() or something similar.

IMPORTANT! To use the emulated destructors you need to create the objects by reference: $obj =& new PEAR_child;

Author: Stig Bakken <ssb@php.net>

[ Top ]

Class Variables

$config =

[line 33]

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

Type:

object

[ Top ]

$ui =

[line 39]

User Interface object, for all interaction with the user.

Type:

object

[ Top ]

Method Detail

PEAR_Command_Common (Constructor) [line 71]

PEAR_Command_Common PEAR_Command_Common(

&$ui, 
&$config)

PEAR_Command_Common constructor.

Access: public

Parameters:

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

[ Top ]

getCommands [line 87]

array getCommands(
)

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

Return: list of commands
Access: public

[ Top ]

getGetoptArgs [line 126]

void getGetoptArgs(

$command, 
&$short_args, 
&$long_args)

Parameters:

	`$command`	—
	`&$short_args`	—
	`&$long_args`	—

[ Top ]

getHelp [line 164]

mixed getHelp(
string
$command)

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

Parameters:

string $command — The command

[ Top ]

getHelpArgs [line 190]

string getHelpArgs(
string
$command)

Returns the help for the accepted arguments of a command

Return: The help string

Parameters:

string $command —

[ Top ]

getOptions [line 118]

void getOptions(

$command)

Parameters:

$command —

[ Top ]

getShortcuts [line 104]

array getShortcuts(
)

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

Return: shortcut => command
Access: public

[ Top ]

run [line 227]

void run(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]