Class PEAR_Command_Auth

Description

PEAR commands for managing configuration data.

Located in /maintenance/libraries/pear/PEAR/Command/Auth.php (line 29)

PEAR
   |
   --PEAR_Command_Common
      |
      --PEAR_Command_Auth
Variable Summary
 mixed $commands
Method Summary
 PEAR_Command_Auth PEAR_Command_Auth (mixed &$ui, mixed &$config)
 bool doLogin (string $command, array $options, array $params)
 bool doLogout (string $command, array $options, array $params)
Variables
mixed $commands = array(
'login' => array(
'summary' => 'Connects and authenticates to remote server',
'shortcut' => 'li',
'function' => 'doLogin',
'options' => array(),'doc'=>'
Log in to the remote server. 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 33)

Inherited Variables

Inherited from PEAR_Command_Common

PEAR_Command_Common::$config
PEAR_Command_Common::$ui
PEAR_Command_Common::$_deps_rel_trans
PEAR_Command_Common::$_deps_type_trans
Methods
Constructor PEAR_Command_Auth (line 60)

PEAR_Command_Auth constructor.

  • access: public
PEAR_Command_Auth PEAR_Command_Auth (mixed &$ui, mixed &$config)
doLogin (line 83)

Execute the 'login' command.

  • return: TRUE on success, FALSE for unknown commands, or a PEAR error on failure
  • access: public
bool doLogin (string $command, array $options, array $params)
  • string $command: command name
  • array $options: option_name => value
  • array $params: list of additional parameters
doLogout (line 134)

Execute the 'logout' command.

  • return: TRUE on success, FALSE for unknown commands, or a PEAR error on failure
  • access: public
bool doLogout (string $command, array $options, array $params)
  • string $command: command name
  • array $options: option_name => value
  • array $params: list of additional parameters

Inherited Methods

Inherited From PEAR_Command_Common

 PEAR_Command_Common::PEAR_Command_Common()
 PEAR_Command_Common::getCommands()
 PEAR_Command_Common::getGetoptArgs()
 PEAR_Command_Common::getHelp()
 PEAR_Command_Common::getHelpArgs()
 PEAR_Command_Common::getOptions()
 PEAR_Command_Common::getShortcuts()
 PEAR_Command_Common::run()

Documentation generated on Fri, 10 Dec 2004 18:24:56 +0000 by phpDocumentor 1.3.0RC3