PHP Интерфейс 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.
Автор: Gunnar Wrobel ([email protected])
Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
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.

Описание методов

connect() публичный Метод

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.
Результат null

export() публичный Метод

Export the session data as array.
public export ( ) : array
Результат array The session data.

getFreebusyServer() публичный Метод

Return the freebusy server.
public getFreebusyServer ( ) : string
Результат string The freebusy host for the current user.

getId() публичный Метод

Return the user id used for connecting the session.
public getId ( ) : string
Результат string The user id.

getImapServer() публичный Метод

Return the imap server.
public getImapServer ( ) : string
Результат string The imap host for the current user.

getMail() публичный Метод

Return the users mail address.
public getMail ( ) : string
Результат string The users mail address.

getName() публичный Метод

Return the users name.
public getName ( ) : string
Результат string The users name.

getUid() публичный Метод

Return the users uid.
public getUid ( ) : string
Результат string The users uid.

import() публичный Метод

Import the session data from an array.
public import ( array $session_data ) : null
$session_data array
Результат null

purge() публичный Метод

Clear the session data.
public purge ( ) : null
Результат null