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_data_privmessage_Handler
  • icms_data_privmessage_Object
  • Overview
  • Package
  • Class

Class icms_data_privmessage_Handler

Private message handler class.

This class is responsible for providing data access mechanisms to the data source of private message class objects.

icms_core_ObjectHandler
Extended by icms_data_privmessage_Handler
Package: Privmessage
Category: ICMS
Copyright: copyright (c) 2000-2007 XOOPS.org
License: GNU General Public License (GPL)
Author: Kazumi Ono onokazu@xoops.org
Located at data/privmessage/Handler.php
Methods summary
public object &
# create( boolean $isNew = true )

Create a new icms_data_privmessage_Object object

Create a new icms_data_privmessage_Object object

Parameters

$isNew
Flag as "new"?

Returns

object
icms_data_privmessage_Object
public object &
# get( integer $id )

Load a icms_data_privmessage_Object object

Load a icms_data_privmessage_Object object

Parameters

$id
ID of the message

Returns

object
icms_data_privmessage_Object
public boolean
# insert( object & $pm, boolean $force = false )

Insert a message in the database

Insert a message in the database

Parameters

$pm
icms_data_privmessage_Object object
$force
flag to force the query execution skip request method check, which might be required in some situations

Returns

boolean
public boolean
# delete( object & $pm )

Delete from the database

Delete from the database

Parameters

$pm
icms_data_privmessage_Object object

Returns

boolean
public array
# getObjects( object $criteria = null, boolean $id_as_key = false )

Load messages from the database

Load messages from the database

Parameters

$criteria
icms_db_criteria_Element object
$id_as_key
use ID as key into the array?

Returns

array
Array of icms_data_privmessage_Object objects
public integer
# getCount( object $criteria = null )

Count message

Count message

Parameters

$criteria
= null icms_db_criteria_Element object

Returns

integer
public boolean
# setRead( object & $pm )

Mark a message as read

Mark a message as read

Parameters

$pm
icms_data_privmessage_Object object

Returns

boolean
Methods inherited from icms_core_ObjectHandler
__construct()
Properties inherited from icms_core_ObjectHandler
$db
API documentation generated by ApiGen