XoopsPrivmessageHandler Class Reference

Inheritance diagram for XoopsPrivmessageHandler:

Collaboration diagram for XoopsPrivmessageHandler:

Public Member Functions
	create ($isNew=true)
	get ($id)
	insert (XoopsObject $pm, $force=false)
	delete (XoopsObject $pm)
	getObjects (CriteriaElement $criteria=null, $id_as_key=false)
	getCount (CriteriaElement $criteria=null)
	setRead (XoopsPrivmessage $pm)
Public Member Functions inherited from XoopsObjectHandler
	__construct (XoopsDatabase $db)
	XoopsObjectHandler ($db)
	create ()
	get ($id)
	insert (XoopsObject $object)
	delete (XoopsObject $object)

Additional Inherited Members
Data Fields inherited from XoopsObjectHandler
	$db

Member Function Documentation

create()

create

(

$isNew = true

)

Create a new XoopsPrivmessage object

Parameters

bool

$isNew

Flag as "new"?

Returns

XoopsPrivmessage

delete()

delete

(

XoopsObject

$pm

)

Delete from the database

Parameters

XoopsPrivmessage

$pm

XoopsPrivmessage object

Returns

bool

Reimplemented from XoopsObjectHandler.

get()

get

(

$id

)

Load a XoopsPrivmessage object

Parameters

int

$id

ID of the message

Returns

XoopsPrivmessage

Reimplemented from XoopsObjectHandler.

getCount()

getCount

(

CriteriaElement

$criteria = null

)

Count message

Parameters

CriteriaElement | CriteriaCompo

$criteria

= null CriteriaElement object

Returns

int

getObjects()

getObjects	(	CriteriaElement	$criteria = null,
			$id_as_key = false
	)

Load messages from the database

Parameters

CriteriaElement | CriteriaCompo	$criteria	CriteriaElement object
bool	$id_as_key	use ID as key into the array?

Returns

array Array of XoopsPrivmessage objects

insert()

insert	(	XoopsObject	$pm,
			$force = false
	)

Insert a message in the database

Parameters

XoopsPrivmessage	$pm	XoopsPrivmessage object
bool	$force	flag to force the query execution skip request method check, which might be required in some situations
XoopsObject | XoopsPrivmessage	$pm	a XoopsMembership object

Returns

bool true on success, otherwise false

setRead()

setRead

(

XoopsPrivmessage

$pm

)

Mark a message as read

Parameters

XoopsPrivmessage

$pm

XoopsPrivmessage object

Returns

bool

@TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5

---

The documentation for this class was generated from the following file:

• C:/xoops2511b2/htdocs/kernel/privmessage.php