Class Horde_Kolab_Session

Description

The Horde_Kolab_Session class holds additional user details for the current session.

The core user credentials (login, pass) are kept within the Auth module and can be retrieved using

respectively
  1. Auth::getCredential('password')
. Any additional Kolab user data relevant for the user session should be accessed via the Horde_Kolab_Session class.

$Horde: framework/Kolab_Server/lib/Horde/Kolab/Session.php,v 1.1.2.11 2009/02/07 14:09:56 wrobel Exp $

Copyright 2008-2009 The Horde Project (http://www.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.

Located in /Kolab_Server/lib/Horde/Kolab/Session.php (line 43)


	
			
Variable Summary
 boolean|PEAR_Error $auth
 array|PEAR_Error $freebusy_server
 string $user_id
 string $user_mail
 string $user_name
 string $user_uid
 array|PEAR_Error $_imap_params
Method Summary
 static Horde_Kolab_Session &singleton ([string $user = null], [array $credentials = null], [ $destruct = false])
 Horde_Kolab_Session Horde_Kolab_Session ([string $user = null], [array $credentials = null])
 Horde_Kolab_IMAP|PEAR_Error &getImap ()
 array|PEAR_Error &getImapParams ()
 Horde_Kolab_Server|PEAR_Error &getServer ([string $user = null], [array $credentials = null])
 NULL shutdown ()
 array __sleep ()
Variables
boolean|PEAR_Error $auth (line 78)

True if the Kolab_Server login was successfull.

array|PEAR_Error $freebusy_server (line 99)

The free/busy server for the current user.

string $user_id (line 50)

User ID.

string $user_mail (line 64)

Primary user mail address.

string $user_name = '' (line 71)

Full name.

string $user_uid (line 57)

User UID.

Horde_Kolab_IMAP $_imap (line 92)

Our IMAP connection.

array|PEAR_Error $_imap_params (line 85)

The connection parameters for the IMAP server.

Methods
static singleton (line 342)

Attempts to return a reference to a concrete Horde_Kolab_Session instance.

It will only create a new instance if no Horde_Kolab_Session instance currently exists or if a user ID has been specified that does not match the user ID/user mail of the current session.

This method must be invoked as:

  • return: The concrete Session reference.
static Horde_Kolab_Session &singleton ([string $user = null], [array $credentials = null], [ $destruct = false])
  • string $user: The session will be setup for the user with this ID.
  • array $credentials: An array of login credentials. For Kolab, this must contain a "password" entry.
  • $destruct
Constructor Horde_Kolab_Session (line 109)

Constructor.

Horde_Kolab_Session Horde_Kolab_Session ([string $user = null], [array $credentials = null])
  • string $user: The session will be setup for the user with this ID.
  • array $credentials: An array of login credentials. For Kolab, this must contain a "password" entry.
getImap (line 295)

Create an IMAP connection.

  • return: The IMAP connection.
Horde_Kolab_IMAP|PEAR_Error &getImap ()
getImapParams (line 285)

Get the IMAP connection parameters.

  • return: The IMAP connection parameters.
array|PEAR_Error &getImapParams ()
getServer (line 260)

Get the Kolab Server connection.

  • return: The Kolab Server connection.
Horde_Kolab_Server|PEAR_Error &getServer ([string $user = null], [array $credentials = null])
  • string $user: The session will be setup for the user with this ID.
  • array $credentials: An array of login credentials. For Kolab, this must contain a "password" entry.
shutdown (line 377)

Stores the object in the session cache.

NULL shutdown ()
__sleep (line 242)

Returns the properties that need to be serialized.

  • return: List of serializable properties.
array __sleep ()

Documentation generated on Sun, 30 Jan 2011 05:21:16 +0000 by phpDocumentor 1.4.3