PmMessageHandler Class Reference

Inheritance diagram for PmMessageHandler:

Public Member Functions
	__construct (&$db)
	getPruneForm ()
	getSavecount ($user=null)
	PmMessageHandler (&$db)
	sendEmail ($pm, $user)
	setFromdelete ($pm, $val=1)
	setFromsave ($pm, $val=1)
	setRead ($pm, $val=1)
	setTodelete ($pm, $val=1)
	setTosave ($pm, $val=1)
Public Member Functions inherited from XoopsPersistableObjectHandler
	__construct ($db=null, $table= '', $className= '', $keyName= '', $identifierName= '')
	__call ($name, $args)
	cleanOrphan ($table_link= '', $field_link= '', $field_object= '')
	convertResultSet ($result, $id_as_key=false, $as_object=true)
&	create ($isNew=true)
	delete (&$object, $force=false)
	deleteAll ($criteria=null, $force=true, $asObject=false)
	deleteByLink ($criteria=null)
&	get ($id=null, $fields=null)
&	getAll ($criteria=null, $fields=null, $asObject=true, $id_as_key=true)
&	getByLimit ($limit=0, $start=0, $criteria=null, $fields=null, $asObject=true)
&	getByLink ($criteria=null, $fields=null, $asObject=true, $field_link=null, $field_object=null)
	getCount ($criteria=null)
	getCountByLink ($criteria=null)
	getCounts ($criteria=null)
	getCountsByLink ($criteria=null)
&	getIds ($criteria=null)
	getList ($criteria=null, $limit=0, $start=0)
&	getObjects ($criteria=null, $id_as_key=false, $as_object=true)
	insert (&$object, $force=true)
	loadHandler ($name, $args=null)
	setHandler ($handler=null, $args=null, $path=null)
	synchronization ()
	updateAll ($fieldname, $fieldvalue, $criteria=null, $force=false)
	updateByLink ($data, $criteria=null)
	XoopsPersistableObjectHandler ($db=null, $table= '', $className= '', $keyName= '', $identifierName= '')
Public Member Functions inherited from XoopsObjectHandler
&	create ()
	delete (&$object)
&	get ($int_id)
	insert (&$object)
	XoopsObjectHandler (&$db)

Additional Inherited Members
Public Attributes inherited from XoopsPersistableObjectHandler
	$className
	$handler
	$handlers = array('read' => null , 'stats' => null , 'joint' => null , 'write' => null , 'sync' => null)
	$identifierName
	$keyName
	$table

Detailed Description

Definition at line 54 of file message.php.

Constructor & Destructor Documentation

PmMessageHandler::__construct

(

&

$db

)

Definition at line 57 of file message.php.

References XoopsObjectHandler\$db.

Referenced by PmMessageHandler().

Here is the caller graph for this function:

Member Function Documentation

PmMessageHandler::getPruneForm

(

)

Get XoopsForm for setting prune criteria

Returns

object

Definition at line 191 of file message.php.

References $form, _PM_AM_INCLUDESAVE, _PM_AM_NOTIFYUSERS, _PM_AM_ONLYREADMESSAGES, _PM_AM_PRUNE, _PM_AM_PRUNEAFTER, _PM_AM_PRUNEBEFORE, and _SUBMIT.

PmMessageHandler::getSavecount

(

$user = null

)

get user's message count in savebox

Parameters

object

$user

Returns

int

Definition at line 131 of file message.php.

References $criteria, $GLOBALS, $user, and XoopsPersistableObjectHandler\getCount().

Here is the call graph for this function:

PmMessageHandler::PmMessageHandler

(

&

$db

)

Definition at line 62 of file message.php.

References XoopsObjectHandler\$db, and __construct().

Here is the call graph for this function:

PmMessageHandler::sendEmail	(		$pm,
			$user
	)

Send a message to user's email

Parameters

object	$pm	XoopsPrivmessage object
object	$user

Returns

bool

Definition at line 153 of file message.php.

References $GLOBALS, $msg, $user, $xoopsConfig, _PM_EMAIL_DESC, _PM_EMAIL_FROM, _PM_EMAIL_MESSAGE, _PM_EMAIL_SUBJECT, _PM_EMAIL_TO, formatTimestamp(), XoopsObject\getVar(), and xoops_getMailer().

Here is the call graph for this function:

PmMessageHandler::setFromdelete	(		$pm,
			$val = 1
	)

Mark a message as from_delete = 1 or removes it if the recipient has also deleted it

Parameters

object

$pm

PmMessage object

Returns

bool

Definition at line 83 of file message.php.

References XoopsPersistableObjectHandler\updateAll().

Here is the call graph for this function:

PmMessageHandler::setFromsave	(		$pm,
			$val = 1
	)

Mark a message as from_save = 1

Parameters

object

$pm

PmMessage object

Returns

bool

Definition at line 111 of file message.php.

References XoopsPersistableObjectHandler\updateAll().

Here is the call graph for this function:

PmMessageHandler::setRead	(		$pm,
			$val = 1
	)

Mark a message as read

Parameters

object

$pm

PmMessage object

Returns

bool

Definition at line 73 of file message.php.

References XoopsPersistableObjectHandler\updateAll().

Here is the call graph for this function:

PmMessageHandler::setTodelete	(		$pm,
			$val = 1
	)

Mark a message as to_delete = 1 or removes it if the sender has also deleted it or sent by anonymous

Parameters

object

$pm

PmMessage object

Returns

bool

Definition at line 97 of file message.php.

References XoopsPersistableObjectHandler\updateAll().

Here is the call graph for this function:

PmMessageHandler::setTosave	(		$pm,
			$val = 1
	)

Mark a message as to_save = 1

Parameters

object

$pm

PmMessage object

Returns

bool

Definition at line 121 of file message.php.

References XoopsPersistableObjectHandler\updateAll().

Here is the call graph for this function:

---

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

• L:/0xoops/xoops-2.5.6/htdocs/modules/pm/class/message.php