API Documentation
\

\Horde_Kolab_Session_Valid_Base

A class to check if the given session is valid.

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
Properties
Constants
__construct()
validate()
getSession()
getAuth()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$_session
$_auth
N/A

Properties

$_session

$_session : \Horde_Kolab_Session

The session handler this instance provides with anonymous access.

Type

\Horde_Kolab_Session

$_auth

$_auth : mixed

Provides authentication information for this object.

Type

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

Methods

__construct()

__construct(\Horde_Kolab_Session  $session, mixed  $auth)

Constructor.

Parameters

\Horde_Kolab_Session $session

The session that should be validated.
mixed $auth

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

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.