PHP Class Horde_Kolab_Session_Valid_Base, horde

Copyright 2009-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.
Inheritance: implements Horde_Kolab_Session_Valid
Show file Open project: horde/horde Class Usage Examples

Public Methods

Method Description
__construct ( Horde_Kolab_Session $session, mixed $auth ) Constructor.
getAuth ( ) : mixed Return the auth driver of this validator.
getSession ( ) : Horde_Kolab_Session Return the session this validator checks.
validate ( string $user = null ) : boolean Reset the current session information in case it does not match the authentication information anymore.

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Kolab_Session $session, mixed $auth )
$session Horde_Kolab_Session The session that should be validated.
$auth mixed The user ID or false if no user is logged in.

getAuth() public method

Return the auth driver of this validator.
public getAuth ( ) : mixed
return mixed The user ID or false if no user is logged in.

getSession() public method

Return the session this validator checks.
public getSession ( ) : Horde_Kolab_Session
return Horde_Kolab_Session The session checked by this validator.

validate() public method

Reset the current session information in case it does not match the authentication information anymore.
public validate ( string $user = null ) : boolean
$user string The user the session information is being requested for. This is usually empty, indicating the current user.
return boolean True if the session is still valid.