Overview

Namespaces

  • None
  • Xmf
    • Database
    • Module
      • Helper
    • Template
  • Xoops
    • Auth
    • Core
      • Cache
      • Database
        • Logging
        • Schema
      • Exception
      • Handler
        • Scheme
      • Kernel
        • Dtype
        • Handlers
        • Model
      • Lists
      • Locale
        • Punic
      • Service
        • Contract
      • Session
      • Text
        • Sanitizer
          • Extensions
      • Theme
        • Plugins
    • Form
    • Html
    • Locale
    • Module
      • Helper
      • Plugin

Classes

  • Fingerprint
  • Handler
  • Manager
  • RememberMe
  • SessionUser

Interfaces

  • FingerprintInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class SessionUser

Manage the session representation of a the current User

Namespace: Xoops\Core\Session
Package: SessionUser
Category: Xoops\Core\Session
Copyright: 2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Richard Griffith richard@geekwright.com
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Session/SessionUser.php
Methods summary
public
# __construct( Xoops\Core\Session\Manager $session )

constructor

constructor

Parameters

$session
the session manager object
public
# establish( )

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

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

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

public
# recordUserLogin( integer $userId, boolean $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.

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

$userId
id of user to establish in the session
$rememberMe
add a persistent login cookie
public
# 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.

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.

public
# addUserToSession( integer $userId )

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

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

Parameters

$userId
id of user to establish in the session
public
# setNeedsConfirmed( )

set authorization status to needs confirmed

set authorization status to needs confirmed

public
# setConfirmed( )

set authorization status to is confirmed

set authorization status to is confirmed

public boolean
# checkConfirmed( )

verify the authorization status is confirmed

verify the authorization status is confirmed

Returns

boolean
true if confirmed, otherwise false
Properties summary
protected Xoops\Core\Session\Manager $session
#
protected Xoops $xoops
# null
API documentation generated by ApiGen