BaseInbox Class Reference
[Object Managers]

Inheritance diagram for BaseInbox:

List of all members.

---

Detailed Description

Get a users inbox messages.

Built-in privacy for only selecting the current users messages. Also bulk delete, and read/unread css.

Definition at line 9 of file base-inbox.inc.php.

Public Member Functions
	__construct ($class= 'Message')
	constructor
	initSearchPage ()
	prep page: assert login, etc
	getSearchParamXml ()
	add extra param to search page: read status
	drawRows ($rs)
	draw our rows
	getPagesXml ()
	get extra pages
	initDeletePage ()
	prep our delete page
	drawDeletePage ()
	give a message back about the delete status
Protected Member Functions
	getSearchSelect ($params)
	add read status to select
	getSearchFrom ($params)
	join us on the inbox table
	getSearchWhere ($params)
	get where SQL: user privacy, read status, etc
	getSortFieldsArray ()
	add read status as sort option
	loadObjects ($data)
	load up our object data

---

Member Function Documentation

BaseInbox::__construct (  $  class = 'Message'  )

constructor See also: ObjectManager::__construct() Definition at line 16 of file base-inbox.inc.php.

BaseInbox::drawDeletePage (   )

give a message back about the delete status Definition at line 201 of file base-inbox.inc.php.

BaseInbox::drawRows (  $  rs  )

draw our rows add header row, checkboxes, delete form, etc. Parameters: $rs  array of BaseMessage objects to draw Definition at line 136 of file base-inbox.inc.php. References BaseModule::getUrl().

BaseInbox::getPagesXml (   )

get extra pages delete - bulk delete inbox messages Reimplemented from ObjectManager. Definition at line 161 of file base-inbox.inc.php.

BaseInbox::getSearchFrom (  $  params  )  [protected]

join us on the inbox table See also: ObjectManager::getSearchFrom() Reimplemented from ObjectManager. Definition at line 70 of file base-inbox.inc.php.

BaseInbox::getSearchParamXml (   )

add extra param to search page: read status See also: ObjectManager::getSearchParamXml() Reimplemented from ObjectManager. Definition at line 38 of file base-inbox.inc.php.

BaseInbox::getSearchSelect (  $  params  )  [protected]

add read status to select See also: ObjectManager::getSearchSelect() Reimplemented from ObjectManager. Definition at line 56 of file base-inbox.inc.php.

BaseInbox::getSearchWhere (  $  params  )  [protected]

get where SQL: user privacy, read status, etc See also: ObjectManager::getSearchWhere() Reimplemented from ObjectManager. Definition at line 84 of file base-inbox.inc.php.

BaseInbox::getSortFieldsArray (   )  [protected]

add read status as sort option See also: ObjectManager::getSortFieldsArray() Reimplemented from ObjectManager. Definition at line 105 of file base-inbox.inc.php.

BaseInbox::initDeletePage (   )

prep our delete page Definition at line 173 of file base-inbox.inc.php. References BaseModule::assertLogin(), dbExecute(), and Util::redirect().

BaseInbox::initSearchPage (   )

prep page: assert login, etc Reimplemented from ObjectManager. Definition at line 24 of file base-inbox.inc.php. References BaseModule::assertLogin().

BaseInbox::loadObjects (  $  data  )  [protected]

load up our object data Parameters: $data  the search data array from mysql Returns: an array of BaseMessage objects Reimplemented from ObjectManager. Definition at line 119 of file base-inbox.inc.php.

---

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

• lib/modules/base-inbox.inc.php

---