• Home
  • Horde_Imsp_Auth_Base

PHP Class Horde_Imsp_Auth_Base, horde

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.
Copyright 2003-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Author: Michael Rubinsky ([email protected])
Show file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_imsp Horde_Imsp_Client_Base Class variable to hold the resulting Horde_Imsp object
$_params

Public Methods

Method Description
__construct ( array $params = [] ) Constructor
authenticate ( Horde_Imsp_Client_Base $client, boolean $login = true ) : boolean Attempts to login to IMSP server.
getDriverType ( ) : string Returns the type of this driver.
logout ( ) Force a logout from the underlying IMSP stream.

Protected Methods

Method Description
_authenticate ( ) : boolean Private authentication function. Provides actual authentication code.

Method Details

__construct() public method

Constructor
public __construct ( array $params = [] )
$params array

_authenticate() abstract protected method

Private authentication function. Provides actual authentication code.
abstract protected _authenticate ( ) : boolean
return boolean

authenticate() public method

Attempts to login to IMSP server.
public authenticate ( Horde_Imsp_Client_Base $client, boolean $login = true ) : boolean
$client Horde_Imsp_Client_Base The Imsp client connection.
$login boolean Remain logged in after auth?
return boolean

getDriverType() abstract public method

Returns the type of this driver.
abstract public getDriverType ( ) : string
return string Type of IMSP_Auth driver instance

logout() abstract public method

Force a logout from the underlying IMSP stream.
abstract public logout ( )

Property Details

$_imsp protected property

Class variable to hold the resulting Horde_Imsp object
protected Horde_Imsp_Client_Base $_imsp
return Horde_Imsp_Client_Base

$_params protected property

protected $_params