API Documentation
\

\Horde_Kolab_Session_Valid

Interface for session validators.

Copyright 2009-2017 Horde LLC (http://www.horde.org/)

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

Summary

Methods
Constants
validate()
getSession()
getAuth()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

validate()

validate(string  $user = null) : boolean

Reset the current session information in case it does not match the authentication information anymore.

Parameters

string $user

The user the session information is being requested for. This is usually empty, indicating the current user.

Returns

boolean —

True if the session is still valid.

getSession()

getSession() : \Horde_Kolab_Session

Return the session this validator checks.

Returns

\Horde_Kolab_Session —

The session checked by this validator.

getAuth()

getAuth() : mixed

Return the auth driver of this validator.

Returns

mixed —

The user ID or false if no user is logged in.