Class: PEAR_Command_Channels

Source Location: /PEAR-1.9.4/PEAR/Command/Channels.php

Class Overview

PEAR
   |
   --PEAR_Command_Common
      |
      --PEAR_Command_Channels

PEAR commands for managing channels.

Author(s):

Greg Beaver <cellog at php.net>

Version:

Release: 1.9.4

Copyright:

1997-2009 The Authors

Variables

$commands

Methods

Child classes:

PEAR_Command_Auth: PEAR commands for login/logout

Inherited Variables

Class: PEAR_Command_Common

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

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 39]
PEAR commands for managing channels.

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

[ Top ]

Class Variables

$commands = array(
        'list-channels' => array(
            'summary' => 'List Available Channels',
            'function' => 'doList',
            'shortcut' => 'lc',
            'options' => array(),'doc'=>'
List all available channels for installation.
',),'update-channels'=>array('summary'=>'Update the Channel List','function'=>'doUpdateAll','shortcut'=>'uc','options'=>array(),'doc'=>'
List all installed packages in all channels.
'),'channel-delete'=>array('summary'=>'Remove a Channel From the List','function'=>'doDelete','shortcut'=>'cde','options'=>array(),'doc'=>'<channel name>
Delete a channel from the registry.  You may not
remove any channel that has installed packages.
'),'channel-add'=>array('summary'=>'Add a Channel','function'=>'doAdd','shortcut'=>'ca','options'=>array(),'doc'=>'<channel.xml>
Add a private channel to the channel list.  Note that all
public channels should be synced using "update-channels".
Parameter may be either a local file or remote URL to a
channel.xml.
'),'channel-update'=>array('summary'=>'Update an Existing Channel','function'=>'doUpdate','shortcut'=>'cu','options'=>array('force'=>array('shortopt'=>'f','doc'=>'will force download of new channel.xml if an existing channel name is used',),'channel'=>array('shortopt'=>'c','arg'=>'CHANNEL','doc'=>'will force download of new channel.xml if an existing channel name is used',),),'doc'=>'[<channel.xml>|<channel name>]
Update a channel in the channel list directly.  Note that all
public channels can be synced using "update-channels".
Parameter may be a local or remote channel.xml, or the name of
an existing channel.
'),'channel-info'=>array('summary'=>'Retrieve Information on a Channel','function'=>'doInfo','shortcut'=>'ci','options'=>array(),'doc'=>'<package>
List the files in an installed package.
'),'channel-alias'=>array('summary'=>'Specify an alias to a channel name','function'=>'doAlias','shortcut'=>'cha','options'=>array(),'doc'=>'<channel> <alias>
Specify a specific alias to use for a channel name.
The alias may not be an existing channel name or
alias.
'),'channel-discover'=>array('summary'=>'Initialize a Channel from its server','function'=>'doDiscover','shortcut'=>'di','options'=>array(),'doc'=>'[<channel.xml>|<channel name>]
Initialize a channel from its server and create a local channel.xml.
If <channel name> is in the format "<username>:<password>@<channel>" then
<username> and <password> will be set as the login username/password for
<channel>. Use caution when passing the username/password in this way, as
it may allow other users on your computer to briefly view your username/
password via the system\'s process list.
'),'channel-login'=>array('summary'=>'Connects and authenticates to remote channel server','shortcut'=>'cli','function'=>'doLogin','options'=>array(),'doc'=>'<channel name>
Log in to a remote channel server.  If <channel name> is not supplied,
the default channel is used. To use remote functions in the installer
that require any kind of privileges, you need to log in first.  The
username and password you enter here will be stored in your per-user
PEAR configuration (~/.pearrc on Unix-like systems).  After logging
in, your username and password will be sent along in subsequent
operations on the remote server.',),'channel-logout'=>array('summary'=>'Logs out from the remote channel server','shortcut'=>'clo','function'=>'doLogout','options'=>array(),'doc'=>'<channel name>
Logs out from a remote channel server.  If <channel name> is not supplied,
the default channel is used. This command does not actually connect to the
remote server, it only deletes the stored username and password from your user
configuration.',),)

[line 41]

Type:

mixed

[ Top ]

Method Detail

PEAR_Command_Channels (Constructor) [line 170]

PEAR_Command_Channels PEAR_Command_Channels(

&$ui, 
&$config)

PEAR_Command_Registry constructor.

Access: public

Parameters:

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

[ Top ]

doAdd [line 409]

void doAdd(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doAlias [line 671]

void doAlias(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doDelete [line 364]

void doDelete(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doDiscover [line 726]

null|PEAR_Error doDiscover(
string
$command, array
$options, array
$params)

The channel-discover command

Parameters:

string	`$command`	—	command name
array	`$options`	—	option_name => value
array	`$params`	—	list of additional parameters. $params[0] should contain a string with either: <channel name> or <username>:<password>@<channel name>

[ Top ]

doInfo [line 227]

void doInfo(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doList [line 180]

void doList(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doLogin [line 798]

bool doLogin(
string
$command, array
$options, array
$params)

Execute the 'login' command.

Return: TRUE on success or a PEAR error on failure
Access: public

Parameters:

string	`$command`	—	command name
array	`$options`	—	option_name => value
array	`$params`	—	list of additional parameters

[ Top ]

doLogout [line 864]

bool doLogout(
string
$command, array
$options, array
$params)

Execute the 'logout' command.

Return: TRUE on success or a PEAR error on failure
Access: public

Parameters:

string	`$command`	—	command name
array	`$options`	—	option_name => value
array	`$params`	—	list of additional parameters

[ Top ]

doUpdate [line 507]

void doUpdate(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doUpdateAll [line 204]

void doUpdateAll(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

getDownloader [line 662]

void &getDownloader(
)

[ Top ]