Class: PEAR_Command_Remote

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

Class Overview

PEAR
   |
   --PEAR_Command_Common
      |
      --PEAR_Command_Remote

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

Author(s):

Stig Bakken <ssb at php.net>

Inherited Variables

Class: PEAR_Command_Common

PEAR_Command_Common::$config
PEAR_Command_Common::$ui

Inherited Methods

Class: PEAR_Command_Common

PEAR_Command_Common::PEAR_Command_Common(): PEAR_Command_Common constructor.
PEAR_Command_Common::getCommands(): Return a list of all the commands defined by this class.
PEAR_Command_Common::getGetoptArgs()
PEAR_Command_Common::getHelp(): Returns the help message for the given command
PEAR_Command_Common::getHelpArgs(): Returns the help for the accepted arguments of a command
PEAR_Command_Common::getOptions()
PEAR_Command_Common::getShortcuts(): Return a list of all the command shortcuts defined by this class.
PEAR_Command_Common::run()

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 27]
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

$commands = array(
        'remote-info' => array(
            'summary' => 'Information About Remote Packages',
            'function' => 'doRemoteInfo',
            'shortcut' => 'ri',
            'options' => array(),'doc'=>'<package>
Get details on a package from the server.',),'list-upgrades'=>array('summary'=>'List Available Upgrades','function'=>'doListUpgrades','shortcut'=>'lu','options'=>array(),'doc'=>'
List releases on the server of packages you have installed where
a newer version is available with the same release state (stable etc.).'),'remote-list'=>array('summary'=>'List Remote Packages','function'=>'doRemoteList','shortcut'=>'rl','options'=>array(),'doc'=>'
Lists the packages available on the configured server along with the
latest stable release of each package.',),'search'=>array('summary'=>'Search remote package database','function'=>'doSearch','shortcut'=>'sp','options'=>array(),'doc'=>'
Lists all packages which match the search parameters (first param
is package name, second package info)',),'list-all'=>array('summary'=>'List All Packages','function'=>'doListAll','shortcut'=>'la','options'=>array(),'doc'=>'
Lists the packages available on the configured server along with the
latest stable release of each package.',),'download'=>array('summary'=>'Download Package','function'=>'doDownload','shortcut'=>'d','options'=>array('nocompress'=>array('shortopt'=>'Z','doc'=>'download an uncompressed (.tar) file',),),'doc'=>'{package|package-version}
Download a package tarball.  The file will be named as suggested by the
server, for example if you download the DB package and the latest stable
version of DB is 1.2, the downloaded file will be DB-1.2.tgz.',),'clear-cache'=>array('summary'=>'Clear XML-RPC Cache','function'=>'doClearCache','shortcut'=>'cc','options'=>array(),'doc'=>'
Clear the XML-RPC cache.  See also the cache_ttl configuration
parameter.
',),)

[line 31]

Type:

mixed

[ Top ]

Method Detail

PEAR_Command_Remote (Constructor) [line 111]

PEAR_Command_Remote PEAR_Command_Remote(

&$ui, 
&$config)

PEAR_Command_Remote constructor.

Access: public

Parameters:

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

[ Top ]

doClearCache [line 398]

void doClearCache(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doDownload [line 301]

void doDownload(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doListAll [line 172]

void doListAll(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doListUpgrades [line 335]

void doListUpgrades(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doRemoteInfo [line 120]

void doRemoteInfo(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doRemoteList [line 143]

void doRemoteList(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doSearch [line 243]

void doSearch(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

downloadCallback [line 325]

void downloadCallback(

$msg, [
$params = null])

Parameters:

	`$msg`	—
	`$params`	—

[ Top ]