API Documentation
\

\Horde_Imsp_Auth_Base

Abstract IMSP authentication class.

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-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
__construct()
authenticate()
getDriverType()
logout()
No public properties found
No constants found
_authenticate()
$_params
$_imsp
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params :

Type

$_imsp

$_imsp : \Horde_Imsp_Client_Base

Class variable to hold the resulting Horde_Imsp object

Type

\Horde_Imsp_Client_Base

Methods

__construct()

__construct(array  $params = array())

Constructor

Parameters

array $params

authenticate()

authenticate(\Horde_Imsp_Client_Base  $client, boolean  $login = true) : boolean

Attempts to login to IMSP server.

Parameters

\Horde_Imsp_Client_Base $client

The Imsp client connection.
boolean $login

Remain logged in after auth?

Returns

boolean

getDriverType()

getDriverType() : string

Returns the type of this driver.

Returns

string —

Type of IMSP_Auth driver instance

logout()

logout()

Force a logout from the underlying IMSP stream.

_authenticate()

_authenticate() : boolean

Private authentication function. Provides actual authentication code.

Returns

boolean