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 Handler

Handler for database session storage

Xoops\Core\Session\Handler implements SessionHandlerInterface
Namespace: Xoops\Core\Session
Package: Handler
Category: Xoops\Core\Session
Copyright: 2000-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://jp.xoops.org/
Author: Taiwen Jiang phppp@users.sourceforge.net
Author: Richard Griffith richard@geekwright.com
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Session/Handler.php
Methods summary
public
# __construct( )

Constructor

Constructor

public boolean
# open( string $save_path, string $name )

Open a session

Open a session

Parameters

$save_path
not used
$name
not used

Returns

boolean

Implementation of

SessionHandlerInterface::open()
public boolean
# close( )

Close a session

Close a session

Returns

boolean

Implementation of

SessionHandlerInterface::close()
public string
# read( string $session_id )

Read a session from the database

Read a session from the database

Parameters

$session_id
Id of the session

Returns

string
Session data

Implementation of

SessionHandlerInterface::read()
public boolean
# write( string $session_id, string $session_data )

Write a session to the database

Write a session to the database

Parameters

$session_id
id of session
$session_data
data to store

Returns

boolean

Implementation of

SessionHandlerInterface::write()
public boolean
# destroy( string $session_id )

Destroy a session

Destroy a session

Parameters

$session_id
Id of session

Returns

boolean

Implementation of

SessionHandlerInterface::destroy()
public boolean
# gc( string $maxlifetime )

Garbage Collector

Garbage Collector

Parameters

$maxlifetime
Time in seconds until a session expires

Returns

boolean

Implementation of

SessionHandlerInterface::gc()
API documentation generated by ApiGen