XoopsPrivmessageHandler Class Reference

Inheritance diagram for XoopsPrivmessageHandler:

Public Member Functions
&	create ($isNew=true)
&	get ($id)
	insert (&$pm, $force=false)
	delete (&$pm)
&	getObjects ($criteria=null, $id_as_key=false)
&	getObjectsByFromUid ($uid, $start=0, $limit=20, $order='DESC')
	getCountByFromUid ($uid)
	getCountUnreadByFromUid ($uid)
	getCount ($criteria=null)
	setRead (&$pm)
Public Member Functions inherited from XoopsObjectHandler
	__construct (&$db)
&	create ()
	insert (&$object)

Additional Inherited Members
Data Fields inherited from XoopsObjectHandler
	$db

Detailed Description

Definition at line 61 of file privmessage.php.

Member Function Documentation

create()

& create

(

$isNew = true

)

Create a new XoopsPrivmessage object

Parameters

bool

$isNew

Flag as "new"?

Returns

object

Definition at line 69 of file privmessage.php.

delete()

delete

(

&

$pm

)

Delete from the database

Parameters

object

$pm

XoopsPrivmessage object

Returns

bool

Reimplemented from XoopsObjectHandler.

Definition at line 153 of file privmessage.php.

get()

& get

(

$id

)

Load a XoopsPrivmessage object

Parameters

int

$id

ID of the message

Returns

object

Reimplemented from XoopsObjectHandler.

Definition at line 83 of file privmessage.php.

getCount()

getCount

(

$criteria = null

)

Count message

Parameters

object

$criteria

= null CriteriaElement object

Returns

int

Definition at line 235 of file privmessage.php.

getCountByFromUid()

getCountByFromUid

(

$uid

)

Definition at line 218 of file privmessage.php.

getCountUnreadByFromUid()

getCountUnreadByFromUid

(

$uid

)

Definition at line 223 of file privmessage.php.

getObjects()

& 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 170 of file privmessage.php.

getObjectsByFromUid()

& getObjectsByFromUid	(		$uid,
			$start = 0,
			$limit = 20,
			$order = 'DESC' )

Return the collect of private message objects which appointed user received.

Parameters

int	$uid	user id
int	$start
int	$limit
string	$order

Returns

array of XoopsPrivmessage.

Definition at line 207 of file privmessage.php.

insert()

insert	(	&	$pm,
			$force = false )

Insert a message in the database

Parameters

object	$pm	XoopsPrivmessage object
bool	$force

Returns

bool

Definition at line 107 of file privmessage.php.

setRead()

setRead

(

&

$pm

)

Mark a message as read

Parameters

object

$pm

XoopsPrivmessage object

Returns

bool

Definition at line 253 of file privmessage.php.

---

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

• html/kernel/privmessage.php