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

  • XoopsBlock
  • XoopsBlockHandler
  • XoopsBlockModuleLink
  • XoopsBlockModuleLinkHandler
  • XoopsConfigHandler
  • XoopsConfigItem
  • XoopsConfigItemHandler
  • XoopsConfigOption
  • XoopsConfigOptionHandler
  • XoopsGroup
  • XoopsGroupHandler
  • XoopsGroupPerm
  • XoopsGroupPermHandler
  • XoopsMemberHandler
  • XoopsMembership
  • XoopsMembershipHandler
  • XoopsModule
  • XoopsModuleHandler
  • XoopsOnline
  • XoopsOnlineHandler
  • XoopsPrivateMessage
  • XoopsPrivateMessageHandler
  • XoopsTplFile
  • XoopsTplFileHandler
  • XoopsTplSet
  • XoopsTplSetHandler
  • XoopsUser
  • XoopsUserHandler
  • Overview
  • Namespace
  • Class
  • Tree

Class XoopsOnlineHandler

A handler for "Who is Online?" information

Xoops\Core\Kernel\XoopsObjectHandler
Extended by Xoops\Core\Kernel\XoopsPersistableObjectHandler
Extended by Xoops\Core\Kernel\Handlers\XoopsOnlineHandler

Direct known subclasses

XoopsOnlineHandler
Namespace: Xoops\Core\Kernel\Handlers
Package: Xoops\Core\Kernel
Category: Xoops\Core\Kernel\Handlers\XoopsOnlineHandler
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 onokazu@xoops.org
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Kernel/Handlers/XoopsOnlineHandler.php
Methods summary
public
# __construct( Xoops\Core\Database\Connection $db = null )

Constructor

Constructor

Parameters

$db
database

Overrides

Xoops\Core\Kernel\XoopsPersistableObjectHandler::__construct()
public boolean
# write( integer $uid, string $uname, string $time, string $module, string $ip )

Write online information to the database

Write online information to the database

Parameters

$uid
UID of the active user
$uname
Username
$time
time
$module
Current module
$ip
User's IP address

Returns

boolean
TRUE on success
public boolean
# destroy( integer $uid )

Delete online information for a user

Delete online information for a user

Parameters

$uid
UID

Returns

boolean
TRUE on success
public boolean
# gc( integer $expire )

Garbage Collection

Garbage Collection

Delete all online information that has not been updated for a certain time

Parameters

$expire
Expiration time in seconds

Returns

boolean
Methods inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
__call(), cleanOrphan(), create(), delete(), deleteAll(), deleteByLink(), get(), getAll(), getByLink(), getCount(), getCountByLink(), getCounts(), getCountsByLink(), getIds(), getList(), getObjects(), insert(), loadHandler(), setHandler(), synchronization(), updateAll(), updateByLink()
Properties inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
$className, $field_link, $field_object, $handler, $identifierName, $keyName, $keyName_link, $table, $table_link
Properties inherited from Xoops\Core\Kernel\XoopsObjectHandler
$db2
API documentation generated by ApiGen