Class: PEAR_Command_Auth

Source Location: /PEAR-1.7.1/PEAR/Command/Auth.php

Class Overview

PEAR
   |
   --PEAR_Command_Common
      |
      --PEAR_Command_Auth

PEAR commands for login/logout

Author(s):

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

Version:

Release: 1.7.1

Copyright:

1997-2008 The PHP Group

Variables

$commands

Methods

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 43]
PEAR commands for login/logout

Author: Greg Beaver <cellog@php.net>
Author: Stig Bakken <ssb@php.net>
Version: Release: 1.7.1
Copyright: 1997-2008 The PHP Group
Link: http://pear.php.net/package/PEAR
Since: Class available since Release 0.1
License: PHP License 3.0

[ Top ]

Class Variables

$commands = array(
        'login' => array(
            'summary' => 'Connects and authenticates to remote server',
            'shortcut' => 'li',
            '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.',),'logout'=>array('summary'=>'Logs out from the remote server','shortcut'=>'lo','function'=>'doLogout','options'=>array(),'doc'=>'
Logs out from the remote server.  This command does not actually
connect to the remote server, it only deletes the stored username and
password from your user configuration.',))

[line 47]

Type:

mixed

[ Top ]

Method Detail

PEAR_Command_Auth (Constructor) [line 84]

PEAR_Command_Auth PEAR_Command_Auth(

&$ui, 
&$config)

PEAR_Command_Auth constructor.

Access: public

Parameters:

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

[ Top ]

doLogin [line 107]

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

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 ]