Overview

Packages

  • Auth
    • Ads
    • Ldap
    • Xoops
  • Autotasks
  • Config
    • Category
    • Item
    • Option
  • Core
    • Filesystem
    • Filters
    • Logger
    • Mail
    • Message
    • Password
    • Security
    • StopSpammer
    • Template
    • Textsanitizer
    • VersionChecker
  • Data
    • Avatar
    • Comment
  • Database
    • Connection
    • Criteria
    • Legacy
    • MySQL
    • PDO
    • Updater
  • Feeds
    • RSS
  • File
  • Form
    • Base
    • Elements
  • ICMS
    • IPF
      • View
  • Image
    • Category
  • Ipf
    • Category
    • Controller
    • Export
    • form
    • Keyhighlighter
    • Member
    • Object
    • Permission
    • richfile
    • Tree
    • urllink
    • View
  • kernel
    • Set
  • Member
    • Group
    • GroupMembership
    • GroupPermission
    • User
  • Messaging
  • Module
  • None
  • Notification
  • Page
  • Plugins
    • Editor
  • Preload
    • Libraries
  • Privmessage
  • Session
  • SmartObject
  • View
    • Block
    • Breadcrumb
    • PageNav
    • PrinterFriendly
    • Template
    • Templates
    • Theme
    • Tree

Classes

  • icms_core_Debug
  • icms_core_Object
  • icms_core_ObjectHandler
  • icms_core_OnlineHandler
  • icms_file_ZipFileHandler
  • icms_image_set_Handler
  • Overview
  • Package
  • Class

Class icms_core_OnlineHandler

A handler for "Who is Online?" information

Package: Core
Category: ICMS
Copyright: copyright (c) 2000-2003 XOOPS.org
License: GNU General Public License (GPL)
Author: Kazumi Ono onokazu@xoops.org
Since: XOOPS
Located at core/OnlineHandler.php
Methods summary
public
# __construct( object & $db )

Constructor

Constructor

Parameters

$db
$db XoopsHandlerFactory
public boolean
# write( integer $uid, string $uname, string $time, string $module, string $ip )

Inserts online information into the database

Inserts online information into the database

Parameters

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

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
# 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
public array
# getAll( object $criteria = null )

Get an array of online information

Get an array of online information

Parameters

$criteria
icms_db_criteria_Element

Returns

array
Array of associative arrays of online information
public
# getCount( object $criteria = null )

Count the number of online users

Count the number of online users

Parameters

$criteria
icms_db_criteria_Element
API documentation generated by ApiGen