PmMessageHandler Class Reference

Inheritance diagram for PmMessageHandler:

Collaboration diagram for PmMessageHandler:

Public Member Functions
	__construct (XoopsDatabase $db)
	setRead (PmMessage $pm, $val=1)
	setFromdelete (PmMessage $pm, $val=1)
	setTodelete (PmMessage $pm, $val=1)
	setFromsave (PmMessage $pm, $val=1)
	setTosave (PmMessage $pm, $val=1)
	getSavecount (XoopsUser $user=null)
	sendEmail (PmMessage $pm, XoopsUser $user)
	getPruneForm ()
Public Member Functions inherited from XoopsPersistableObjectHandler
	__construct (XoopsDatabase $db=null, $table='', $className='', $keyName='', $identifierName='')
	XoopsPersistableObjectHandler (XoopsDatabase $db=null, $table='', $className='', $keyName='', $identifierName='')
	setHandler ($handler=null, $args=null, $path=null)
	loadHandler ($name, $args=null)
	__call ($name, $args)
	create ($isNew=true)
	get ($id=null, $fields=null)
	insert (XoopsObject $object, $force=true)
	delete (XoopsObject $object, $force=false)
	deleteAll (CriteriaElement $criteria=null, $force=true, $asObject=false)
	updateAll ($fieldname, $fieldvalue, CriteriaElement $criteria=null, $force=false)
&	getObjects (CriteriaElement $criteria=null, $id_as_key=false, $as_object=true)
&	getAll (CriteriaElement $criteria=null, $fields=null, $asObject=true, $id_as_key=true)
	getList (CriteriaElement $criteria=null, $limit=0, $start=0)
&	getIds (CriteriaElement $criteria=null)
&	getByLimit ($limit=0, $start=0, CriteriaElement $criteria=null, $fields=null, $asObject=true)
	getCount (CriteriaElement $criteria=null)
	getCounts (CriteriaElement $criteria=null)
&	getByLink (CriteriaElement $criteria=null, $fields=null, $asObject=true, $field_link=null, $field_object=null)
	getCountByLink (CriteriaElement $criteria=null)
	getCountsByLink (CriteriaElement $criteria=null)
	updateByLink ($data, CriteriaElement $criteria=null)
	deleteByLink (CriteriaElement $criteria=null)
	cleanOrphan ($table_link='', $field_link='', $field_object='')
	synchronization ()
	convertResultSet ($result, $id_as_key=false, $as_object=true)
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 XoopsPersistableObjectHandler
	$handler
	$handlers = array('read' => null, 'stats' => null, 'joint' => null, 'write' => null, 'sync' => null)
	$table
	$keyName
	$className
	$identifierName
	$field_link
	$field_object
Data Fields inherited from XoopsObjectHandler
	$db

Detailed Description

Class PmMessageHandler

Constructor & Destructor Documentation

__construct()

__construct

(

XoopsDatabase

$db

)

Parameters

null | XoopsDatabase

$db

Reimplemented from XoopsObjectHandler.

Member Function Documentation

getPruneForm()

getPruneForm

(

)

Get XoopsForm for setting prune criteria

Returns

XoopsForm

getSavecount()

getSavecount

(

XoopsUser

$user = null

)

get user's message count in savebox

Parameters

XoopsUser

$user

Returns

int

Here is the call graph for this function:

sendEmail()

sendEmail	(	PmMessage	$pm,
		XoopsUser	$user
	)

Send a message to user's email

Parameters

PmMessage	$pm	message object
XoopsUser	$user	user object

Returns

bool

Here is the call graph for this function:

setFromdelete()

setFromdelete	(	PmMessage	$pm,
			$val = 1
	)

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

Parameters

PmMessage	$pm	PmMessage object
int	$val

Returns

bool

Here is the call graph for this function:

setFromsave()

setFromsave	(	PmMessage	$pm,
			$val = 1
	)

Mark a message as from_save = 1

Parameters

PmMessage	$pm	PmMessage object
int	$val

Returns

bool

Here is the call graph for this function:

setRead()

setRead	(	PmMessage	$pm,
			$val = 1
	)

Mark a message as read

Parameters

PmMessage	$pm	PmMessage object
int	$val

Returns

bool

Here is the call graph for this function:

setTodelete()

setTodelete	(	PmMessage	$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

PmMessage	$pm	PmMessage object
int	$val

Returns

bool

Here is the call graph for this function:

setTosave()

setTosave	(	PmMessage	$pm,
			$val = 1
	)

Mark a message as to_save = 1

Parameters

PmMessage	$pm	PmMessage object
int	$val

Returns

bool

Here is the call graph for this function:

---

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

• C:/xoops2511b2/htdocs/modules/pm/class/message.php