Class: PEAR_Command_Remote

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

Class Overview

PEAR
   |
   --PEAR_Command_Common
      |
      --PEAR_Command_Remote

PEAR commands for remote server querying

Author(s):

Greg Beaver <cellog at php.net>
Stig Bakken <ssb at php.net>

Version:

Release: 1.10.12

Copyright:

1997-2009 The Authors

Variables

$commands

Methods

Inherited Variables

Class: PEAR_Command_Common

PEAR_Command_Common::$config
PEAR_Command_Common::$ui
PEAR_Command_Common::$_registry

Class: PEAR

PEAR::$bivalentMethods

Inherited Methods

Class: PEAR_Command_Common

PEAR_Command_Common::__construct(): 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::__construct(): Constructor. Registers this object in $_PEAR_destructor_object_list for destructor emulation if a destructor object exists.
PEAR::PEAR(): Only here for backwards compatibility.
PEAR::delExpect(): This method deletes all occurrences 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::getSourceDateEpoch(): Get SOURCE_DATE_EPOCH environment variable See https://reproducible-builds.org/specs/source-date-epoch/
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 independent PHP extension load. Remember to take care on the correct extension name for case sensitive OSes.
PEAR::popExpect(): This method pops one element off the expected error codes stack.
PEAR::registerShutdownFunc(): Use this function to register a shutdown method for static classes.
PEAR::staticPopErrorHandling()
PEAR::staticPushErrorHandling()
PEAR::_PEAR(): Destructor (the emulated type of...). Does nothing right now, but is included for forward compatibility, so subclass destructors should always call it.
PEAR::_popErrorHandling(): Pop the last error handler used
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::_setErrorHandling(): Sets how errors generated by this object should be handled.
PEAR::_throwError(): Simpler form of raiseError with fewer options. In most cases message, code and userinfo are enough.
PEAR::__call()
PEAR::__callStatic()

Class Details

[line 37]
PEAR commands for remote server querying

Author: Greg Beaver <cellog@php.net>
Author: Stig Bakken <ssb@php.net>
Version: Release: 1.10.12
Copyright: 1997-2009 The Authors
Link: http://pear.php.net/package/PEAR
Since: Class available since Release 0.1
License: New BSD License

[ 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('channelinfo'=>array('shortopt'=>'i','doc'=>'output fully channel-aware data, even on failure',),),'doc'=>'[preferred_state]
List releases on the server of packages you have installed where
a newer version is available with the same release state (stable etc.)
or the state passed as the second parameter.'),'remote-list'=>array('summary'=>'List Remote Packages','function'=>'doRemoteList','shortcut'=>'rl','options'=>array('channel'=>array('shortopt'=>'c','doc'=>'specify a channel other than the default channel','arg'=>'CHAN',)),'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('channel'=>array('shortopt'=>'c','doc'=>'specify a channel other than the default channel','arg'=>'CHAN',),'allchannels'=>array('shortopt'=>'a','doc'=>'search packages from all known channels',),'channelinfo'=>array('shortopt'=>'i','doc'=>'output fully channel-aware data, even on failure',),),'doc'=>'[packagename] [packageinfo]
Lists all packages which match the search parameters.  The first
parameter is a fragment of a packagename.  The default channel
will be used unless explicitly overridden.  The second parameter
will be used to match any portion of the summary/description',),'list-all'=>array('summary'=>'List All Packages','function'=>'doListAll','shortcut'=>'la','options'=>array('channel'=>array('shortopt'=>'c','doc'=>'specify a channel other than the default channel','arg'=>'CHAN',),'channelinfo'=>array('shortopt'=>'i','doc'=>'output fully channel-aware data, even on failure',),),'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>...
Download package tarballs.  The files 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.6.5, the downloaded file will be DB-1.6.5.tgz.',),'clear-cache'=>array('summary'=>'Clear Web Services Cache','function'=>'doClearCache','shortcut'=>'cc','options'=>array(),'doc'=>'
Clear the REST cache. See also the cache_ttl configuration
parameter.
',),)

[line 39]

Type:

mixed

[ Top ]

Method Detail

__construct (Constructor) [line 157]

PEAR_Command_Remote __construct(

&$ui, 
&$config)

PEAR_Command_Remote constructor.

Access: public

Overrides PEAR_Command_Common::__construct() (PEAR_Command_Common constructor.)

Parameters:

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

[ Top ]

doClearCache [line 762]

void doClearCache(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doDownload [line 585]

void doDownload(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doListAll [line 298]

void doListAll(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doListUpgrades [line 637]

void doListUpgrades(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doRemoteInfo [line 185]

void doRemoteInfo(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doRemoteList [line 236]

void doRemoteList(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doSearch [line 440]

void doSearch(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

downloadCallback [line 630]

void downloadCallback(

$msg, [
$params = null])

Parameters:

	`$msg`	—
	`$params`	—

[ Top ]

getDownloader [line 576]

void &getDownloader(

$options)

Parameters:

$options —

[ Top ]