Interface Horde_Kolab_Session

The interface describing Horde_Kolab_Session handlers.

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.

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

Direct known implementers

Horde_Kolab_Session_Abstract, Horde_Kolab_Session_Decorator_Base

Indirect known implementers

Horde_Kolab_Session_Base, Horde_Kolab_Session_Decorator_Anonymous, Horde_Kolab_Session_Decorator_Logged, Horde_Kolab_Session_Decorator_Stored, Horde_Kolab_Session_Imap

Package: Kolab\Session
Category: Kolab
License: LGPL 2.1
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://pear.horde.org/index.php?package=Kolab_Session
Located at Horde/Kolab/Session.php

Methods summary
`public null`	# `connect( string $user_id = null, array $credentials = null )` Try to connect the session handler. Try to connect the session handler. Parameters `$user_id` The user ID to connect with. `$credentials` <p>An array of login credentials. For Kolab, this must contain a "password" entry.</p> Returns `null` Throws `Horde_Kolab_Session_Exception` If the connection failed.
`public string`	# `getId( )` Return the user id used for connecting the session. Return the user id used for connecting the session. Returns `string` The user id.
`public string`	# `getMail( )` Return the users mail address. Return the users mail address. Returns `string` The users mail address.
`public string`	# `getUid( )` Return the users uid. Return the users uid. Returns `string` The users uid.
`public string`	# `getName( )` Return the users name. Return the users name. Returns `string` The users name.
`public string`	# `getImapServer( )` Return the imap server. Return the imap server. Returns `string` The imap host for the current user.
`public string`	# `getFreebusyServer( )` Return the freebusy server. Return the freebusy server. Returns `string` The freebusy host for the current user.
`public null`	# `import( array $session_data )` Import the session data from an array. Import the session data from an array. Parameters `$session_data` session data. Returns `null`
`public array`	# `export( )` Export the session data as array. Export the session data as array. Returns `array` The session data.
`public null`	# `purge( )` Clear the session data. Clear the session data. Returns `null`

Packages

Classes

Interfaces

Interface Horde_Kolab_Session

Direct known implementers

Indirect known implementers

Parameters

Returns

Throws

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns