Overview

Namespaces

  • Composer
    • Autoload
  • Geekwright
    • RegDom
  • League
    • OAuth2
      • Client
        • Provider
  • None
  • Xmf
    • Database
    • Jwt
    • Key
    • Module
      • Helper

Classes

  • AbstractHelper
  • Cache
  • GenericHelper
  • Permission
  • Session
  • Overview
  • Namespace
  • Class
  • Tree

Class Session

Manage session variables for a module. Session variable will be prefixed with the module name to separate it from variables set by other modules or system functions. All data is serialized, so any arbitrary data (i.e. array) can be stored.

Xmf\Module\Helper\AbstractHelper
Extended by Xmf\Module\Helper\Session
Namespace: Xmf\Module\Helper
Package: Xmf
Category: Xmf\Module\Helper\Session
Copyright: 2011-2016 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: trabis lusopoemas@gmail.com
Author: Richard Griffith richard@geekwright.com
Link: http://xoops.org
Located at lass/libraries/vendor/xoops/xmf/src/Xmf/Module/Helper/Session.php
Methods summary
public
# init( )

Initialize parent::__construct calls this after verifying module object.

Initialize parent::__construct calls this after verifying module object.

protected string
# prefix( string $name )

Add our module prefix to a name

Add our module prefix to a name

Parameters

$name
name to prefix

Returns

string
module prefixed name
public
# set( string $name, mixed $value )

Sets a named session variable respecting our module prefix

Sets a named session variable respecting our module prefix

Parameters

$name
name of variable
$value
value of variable
public mixed
# get( string $name, mixed $default = false )

Fetch a named session variable respecting our module prefix

Fetch a named session variable respecting our module prefix

Parameters

$name
name of variable
$default
default value to return if config $name is not set

Returns

mixed
$value value of session variable or false if not set
public
# del( string $name )

Deletes a named session variable respecting our module prefix

Deletes a named session variable respecting our module prefix

Parameters

$name
name of variable
public
# destroy( )

Delete all session variable starting with our module prefix

Delete all session variable starting with our module prefix

Methods inherited from Xmf\Module\Helper\AbstractHelper
__construct(), addLog(), setDebug()
Properties summary
protected string $prefix
#
Properties inherited from Xmf\Module\Helper\AbstractHelper
$debug, $module
API documentation generated by ApiGen