API Documentation
\

\Horde_Kolab_Session_Valid_Decorator_Logged

A logger for Horde_Kolab_Session_Valid 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
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
$_valid
$_logger
N/A

Properties

$_valid

$_valid : \Horde_Kolab_Session_Valid_Interface

The valid handler.

Type

\Horde_Kolab_Session_Valid_Interface

$_logger

$_logger : mixed

The logger.

Type

mixed

Methods

__construct()

__construct(\Horde_Kolab_Session_Valid_Interface  $valid, mixed  $logger)

Constructor.

The provided logger class needs to implement the methods debug() and err().

Parameters

\Horde_Kolab_Session_Valid_Interface $valid

The validator.
mixed $logger

The logger instance.

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.