XOOPS  2.6.0
Xoops\Core\Session\SessionUser Class Reference

Public Member Functions

 __construct (Manager $session)
 
 addUserToSession ($userId)
 
 checkConfirmed ()
 
 establish ()
 
 recordUserLogin ($userId, $rememberMe=false)
 
 recordUserLogout ()
 
 setConfirmed ()
 
 setNeedsConfirmed ()
 

Protected Attributes

 $session
 
 $xoops = null
 

Detailed Description

Definition at line 27 of file SessionUser.php.

Constructor & Destructor Documentation

Xoops\Core\Session\SessionUser::__construct ( Manager  $session)

constructor

Parameters
Manager$sessionthe session manager object

Definition at line 44 of file SessionUser.php.

References Xoops\Core\Session\SessionUser\$session, Xoops\getInstance(), and Xoops\session().

Here is the call graph for this function:

Member Function Documentation

Xoops\Core\Session\SessionUser::addUserToSession (   $userId)

Check the we have a remember me cookie, and apply if valid

Parameters
integer$userIdid of user to establish in the session
Returns
void

Definition at line 119 of file SessionUser.php.

References Xoops\Core\Session\SessionUser\$session, Xoops\$user, and Xoops\Core\Session\SessionUser\setNeedsConfirmed().

Referenced by Xoops\Core\Session\SessionUser\establish(), and Xoops\Core\Session\SessionUser\recordUserLogin().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Core\Session\SessionUser::checkConfirmed ( )

verify the authorization status is confirmed

Returns
boolean true if confirmed, otherwise false

Definition at line 166 of file SessionUser.php.

References Xoops\session().

Here is the call graph for this function:

Xoops\Core\Session\SessionUser::establish ( )

Check any user data in the current session and clear if invalid.

If no user data, check if "remember me" data should be applied

Returns
void

Definition at line 58 of file SessionUser.php.

References Xoops\Core\Session\SessionUser\$session, Xoops\Core\Session\SessionUser\addUserToSession(), and Xoops\Core\Session\SessionUser\setNeedsConfirmed().

Here is the call graph for this function:

Xoops\Core\Session\SessionUser::recordUserLogin (   $userId,
  $rememberMe = false 
)

Record a login event in the session. This is to be called by the login process, i.e. the user has entered the name and password, and that combination was found valid.

Parameters
integer$userIdid of user to establish in the session
boolean$rememberMeadd a persistent login cookie
Returns
void

Definition at line 88 of file SessionUser.php.

References Xoops\Core\Session\SessionUser\addUserToSession(), and Xoops\Core\Session\SessionUser\setConfirmed().

Here is the call graph for this function:

Xoops\Core\Session\SessionUser::recordUserLogout ( )

Record a login event in the session. This is to be called by the login process, i.e. the user has entered the name and password, and that combination was found valid.

Returns
void

Definition at line 105 of file SessionUser.php.

References Xoops\session().

Here is the call graph for this function:

Xoops\Core\Session\SessionUser::setConfirmed ( )

set authorization status to is confirmed

Returns
void

Definition at line 156 of file SessionUser.php.

References Xoops\session().

Referenced by Xoops\Core\Session\SessionUser\recordUserLogin().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Core\Session\SessionUser::setNeedsConfirmed ( )

set authorization status to needs confirmed

Returns
void

Definition at line 146 of file SessionUser.php.

References Xoops\session().

Referenced by Xoops\Core\Session\SessionUser\addUserToSession(), and Xoops\Core\Session\SessionUser\establish().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Xoops\Core\Session\SessionUser::$session
protected
Xoops\Core\Session\SessionUser::$xoops = null
protected

Definition at line 38 of file SessionUser.php.


The documentation for this class was generated from the following file: