Horde 3.1.3 : Vue détaillée de Auth.php

(pas de description)

Poids:	162 lignes (5 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Définit 1 class

Net_IMSP_Auth:: (6 méthodes):
  authenticate()
  _authenticate()
  getDriverType()
  logout()
  factory()
  singleton()

Classe: Net_IMSP_Auth - X-Ref

The Net_IMSP_Auth class abstract class for IMSP authentication.

Required Parameters:<pre>
'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.</pre>

$Horde: framework/Net_IMSP/IMSP/Auth.php,v 1.8.10.11 2006/01/01 21:28:27 jan Exp $

Copyright 2003-2006 Michael Rubinsky <mrubinsk@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.

authenticate($params, $login = true) X-Ref

Attempts to login to IMSP server.

param: array $params         Parameters for Net_IMSP
param: boolean $login        Should we remain logged in after auth?
return: mixed                Returns a Net_IMSP object connected to

_authenticate($params) X-Ref

Private authentication function. Provides actual authentication
code.

param: array $params Parameters for Net_IMSP_Auth driver.
return: mixed Returns Net_IMSP object connected to server

getDriverType() X-Ref

Returns the type of this driver.

return: string Type of IMSP_Auth driver instance

logout() X-Ref

Force a logout from the underlying IMSP stream.

factory($driver) X-Ref

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

param: string $driver Type of Net_IMSP_Auth subclass to return.
return: mixed The created Net_IMSP_Auth subclass or PEAR_Error.

singleton($driver) X-Ref

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');

param: string $driver Type of IMSP_Auth subclass to return.
return: object Reference to IMSP_Auth subclass.

Code source de Horde 3.1.3

/lib/Net/IMSP/ -> Auth.php (sommaire)

Définit 1 class