Class Net_IMSP_Auth

Description

The Net_IMSP_Auth class abstract class for IMSP authentication.

Required Parameters:

   'username'  Username to logon to IMSP server as.
   'password'  Password for current user.
   'server'    The hostname of the IMSP server.
   'port'      The port of the IMSP server.

$Horde: framework/Net_IMSP/IMSP/Auth.php,v 1.8.10.15 2009/01/06 15:23:27 jan Exp $

Copyright 2003-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Net_IMSP/IMSP/Auth.php (line 24)


	
			
Direct descendents
Class Description
 class Net_IMSP_Auth_cram_md5 The Net_IMSP_Auth_cram_md5 class for IMSP authentication.
 class Net_IMSP_Auth_imtest The Net_IMSP_Auth_imtest class for IMSP authentication.
 class Net_IMSP_Auth_plaintext The Net_IMSP_Auth_plaintext class for IMSP authentication.
Variable Summary
Method Summary
 mixed &authenticate (array $params, [boolean $login = true])
 mixed factory (string $driver)
 string getDriverType ()
 void logout ()
 object Reference &singleton (string $driver)
Variables
Net_IMSP $_imsp (line 30)

Class variable to hold the resulting Net_IMSP object

Methods
authenticate (line 44)

Attempts to login to IMSP server.

  • return: Returns a Net_IMSP object connected to the IMSP server if login is true and successful. Returns boolean true if successful and login is false. Returns PEAR_Error on failure.
mixed &authenticate (array $params, [boolean $login = true])
  • array $params: Parameters for Net_IMSP
  • boolean $login: Should we remain logged in after auth?
factory (line 104)

Attempts to return a concrete Net_IMSP_Auth instance based on $driver Must be called as &Net_IMSP_Auth::factory()

  • return: The created Net_IMSP_Auth subclass or PEAR_Error.
mixed factory (string $driver)
  • string $driver: Type of Net_IMSP_Auth subclass to return.
getDriverType (line 82)

Returns the type of this driver.

  • return: Type of IMSP_Auth driver instance
  • abstract:
string getDriverType ()

Redefined in descendants as:
logout (line 91)

Force a logout from the underlying IMSP stream.

void logout ()

Redefined in descendants as:
singleton (line 135)

Attempts to return a concrete Net_IMSP_Auth instance based on $driver.

Will only create a new object if one with the same parameters already does not exist. Must be called like: $var = &Net_IMSP_Auth::singleton('driver_type');

  • return: to IMSP_Auth subclass.
object Reference &singleton (string $driver)
  • string $driver: Type of IMSP_Auth subclass to return.

Documentation generated on Sun, 30 Jan 2011 05:15:19 +0000 by phpDocumentor 1.4.3