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

  • Admin
  • Cache
  • Helper
  • 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\Session
Namespace: Xmf\Module
Package: Xmf
Category: Xmf\Module\Helper\Session
Copyright: 2011-2013 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
Version: Release: 1.0
Since: 1.0
Link: http://xoops.org
Located at oops_lib/Xmf/Module/Session.php
Methods summary
public
# init( )

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

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

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 )

Fetch a named session variable respecting our module prefix

Fetch a named session variable respecting our module prefix

Parameters

$name
name of variable

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 inherited from Xmf\Module\Helper\AbstractHelper
$debug, $module
API documentation generated by ApiGen