XoopsPrivmessageHandler Class Reference

Inheritance diagram for XoopsPrivmessageHandler:

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

Additional Inherited Members
Public Attributes inherited from XoopsObjectHandler
	$db

Detailed Description

Definition at line 134 of file privmessage.php.

Member Function Documentation

& XoopsPrivmessageHandler::create

(

$isNew = true

)

Create a new XoopsPrivmessage object

Parameters

bool

$isNew

Flag as "new"?

Returns

object

Definition at line 141 of file privmessage.php.

XoopsPrivmessageHandler::delete

(

&

$pm

)

Delete from the database

Parameters

object

$pm

XoopsPrivmessage object

Returns

bool

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

Definition at line 220 of file privmessage.php.

References $result.

& XoopsPrivmessageHandler::get

(

$id

)

Load a XoopsPrivmessage object

Parameters

int

$id

ID of the message

Returns

object

Definition at line 155 of file privmessage.php.

References $result, and $sql.

XoopsPrivmessageHandler::getCount

(

$criteria = null

)

Count message

Parameters

object

$criteria

= null CriteriaElement object

Returns

int

Definition at line 278 of file privmessage.php.

References $criteria, $result, and $sql.

XoopsPrivmessageHandler::getObjects	(		$criteria = null,
			$id_as_key = false
	)

Load messages from the database

Parameters

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

Returns

array Array of XoopsPrivmessage objects

Definition at line 241 of file privmessage.php.

References $criteria, $limit, $result, $ret, $sql, and $start.

XoopsPrivmessageHandler::insert	(	&	$pm,
			$force = false
	)

Insert a message in the database

Parameters

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

Returns

bool

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

Definition at line 180 of file privmessage.php.

References $msg_id, $result, $sql, and $to_userid.

XoopsPrivmessageHandler::setRead

(

&

$pm

)

Mark a message as read

Parameters

object

$pm

XoopsPrivmessage object

Returns

bool

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

Definition at line 296 of file privmessage.php.

References $sql.

---

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

• L:/0xoops/xoops-2.5.6/htdocs/kernel/privmessage.php