Description

OXSessionD - Abstraction of the OpenExchange session daemon access

The code of this class is heavily derivated from the OXtensions::OXSession perl module at the openexchange wiki.

Located in /OXSession.php (line 33)

Variable Summary

string $sid

Method Summary

object OXSessionD (string $host, string $port)

bool checkUser (string $uid)

array getSession (string $sessionID)

bool getSessions ()

string login (string $login, string $passwd, string $remoteip, string $hostname, [string $lang = 'DE'])

bool logoff (mixed $sid)

bool ping (string $sid)

bool report (mixed $uid)

Variables

string $sid (line 68)

The session id

access: public

Methods

Constructor OXSessionD (line 82)

Constructor

The constructor opens a connection to the OpenExchange session daemon and returns an OXsession object.

access: public

object OXSessionD (string $host, string $port)

string $host
string $port

checkUser (line 120)

Class method to check if the user exists

access: public

bool checkUser (string $uid)

string $uid

getSession (line 215)

Loads the data of a certain session.

Returns an array with authentication information of the session assigned to the given session id. The following keys will be set: uid - user id passwd - cleartext password lang - language localip - local ip host - host

access: public

array getSession (string $sessionID)

string $sessionID

getSessions (line 97)

Class method which returns a list of sessions

This method returns an array with session data arrays.

access: public

bool getSessions ()

login (line 175)

Performs an authentication request and starts a session

This method performs an authentication request. If successful an openexchange session will be established. A php session with the same session id with the openexchange session will be initiated too.

The parameters are:

uid - user id passwd - password (cleartext) lang - language remoteip - ip address of the clients host hostname - name of the virtual host sid - session id

access: public

string login (string $login, string $passwd, string $remoteip, string $hostname, [string $lang = 'DE'])

string $login
string $passwd
string $remoteip
string $hostname
string $lang: (default DE)

logoff (line 259)

Removes the current session (logoff)

This method sets some http headers. Thus you MUST NOT call this method after you print (echo) something to STDOUT.

access: public

bool logoff (mixed $sid)

ping (line 237)

Reset the timeout of the OX session with the given session id

access: public

bool ping (string $sid)

string $sid

report (line 138)

Class method forces the session daemon to log session data

access: public

bool report (mixed $uid)

OXSessionD

Class OXSessionD