PHP Interface Horde_Kolab_Session, horde

Horde_Kolab_Server currently has no caching so we mainly cache some core user information in the Kolab session handler as reading this data is expensive and it is sufficient to read it once per session. The users account id needs to be provided from the outside. Any additional Kolab user data relevant for the user session should be accessed via the Horde_Kolab_Session class. Copyright 2008-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.
See link: http://pear.horde.org/index.php?package=Kolab_Session
Author: Gunnar Wrobel ([email protected])
Exibir arquivo Open project: horde/horde Interface Usage Examples

Public Methods

Method Description
connect ( string $user_id = null, array $credentials = null ) : null Try to connect the session handler.
export ( ) : array Export the session data as array.
getFreebusyServer ( ) : string Return the freebusy server.
getId ( ) : string Return the user id used for connecting the session.
getImapServer ( ) : string Return the imap server.
getMail ( ) : string Return the users mail address.
getName ( ) : string Return the users name.
getUid ( ) : string Return the users uid.
import ( array $session_data ) : null Import the session data from an array.
purge ( ) : null Clear the session data.

Method Details

connect() public method

Try to connect the session handler.
public connect ( string $user_id = null, array $credentials = null ) : null
$user_id string The user ID to connect with.
$credentials array An array of login credentials. For Kolab, this must contain a "password" entry.
return null

export() public method

Export the session data as array.
public export ( ) : array
return array The session data.

getFreebusyServer() public method

Return the freebusy server.
public getFreebusyServer ( ) : string
return string The freebusy host for the current user.

getId() public method

Return the user id used for connecting the session.
public getId ( ) : string
return string The user id.

getImapServer() public method

Return the imap server.
public getImapServer ( ) : string
return string The imap host for the current user.

getMail() public method

Return the users mail address.
public getMail ( ) : string
return string The users mail address.

getName() public method

Return the users name.
public getName ( ) : string
return string The users name.

getUid() public method

Return the users uid.
public getUid ( ) : string
return string The users uid.

import() public method

Import the session data from an array.
public import ( array $session_data ) : null
$session_data array
return null

purge() public method

Clear the session data.
public purge ( ) : null
return null