Class XoopsPrivmessageHandler

XOOPS private message handler class.

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

XoopsObjectHandler

XoopsPrivmessageHandler

Package: kernel
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Located at ernel/privmessage.php

Methods summary
`public XoopsPrivmessage`	# `create( boolean $isNew = true )` Create a new `XoopsPrivmessage` object Create a new `XoopsPrivmessage` object Parameters `$isNew` Flag as "new"? Returns `XoopsPrivmessage` Overrides `XoopsObjectHandler::create()`
`public XoopsPrivmessage`	# `get( integer $id )` Load a `XoopsPrivmessage` object Load a `XoopsPrivmessage` object Parameters `$id` ID of the message Returns `XoopsPrivmessage` Overrides `XoopsObjectHandler::get()`
`public boolean`	# `insert( XoopsObject $pm, boolean $force = false, XoopsObject\|XoopsPrivmessage $pm,… )` Insert a message in the database Insert a message in the database Parameters `$pm` `XoopsPrivmessage` object `$force` flag to force the query execution skip request method check, which might be required in some situations `$pm`,… a XoopsMembership object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::insert()`
`public boolean`	# `delete( XoopsObject $pm )` Delete from the database Delete from the database Parameters `$pm` `XoopsPrivmessage` object Returns boolean Overrides `XoopsObjectHandler::delete()`
`public array`	# `getObjects( CriteriaElement $criteria = null, boolean $id_as_key = false )` Load messages from the database Load messages from the database Parameters `$criteria` `CriteriaElement` object `$id_as_key` use ID as key into the array? Returns array Array of `XoopsPrivmessage` objects
`public integer`	# `getCount( CriteriaElement $criteria = null )` Count message Count message Parameters `$criteria` = null `CriteriaElement` object Returns integer
`public boolean`	# `setRead( XoopsPrivmessage $pm )` Mark a message as read Mark a message as read Parameters `$pm` `XoopsPrivmessage` object Returns boolean

Methods inherited from XoopsObjectHandler
`XoopsObjectHandler(), __construct()`

Properties inherited from XoopsObjectHandler
`$db`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsPrivmessageHandler

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns