BaseAlert Class Reference
[Base Objects]

Inheritance diagram for BaseAlert:

List of all members.

---

Detailed Description

Used with the BaseUser class to give an easy, quick way to alert the user to a variety of things.

You add alerts, which consist of a message and a link. They can then view the alert and it takes the to them appropriate page. They are automatically deleted after viewed.

Definition at line 10 of file base-alert.inc.php.

Public Member Functions
	__construct ($data=null, $table= 'alerts')
	canView ()
	can i view the alert?
	canDelete ()
	can i delete the alert?
	drawDeletePage ()
	draw our delete page, no confirmation
	initViewPage ()
	prep the view page.
	getName ($link=false)
	gets and/or links our alert text
	drawLine ()
	draws our alert line
	drawRow ()
	draws our alert as a row...
	getRssItem ()
	gets our alert as an rss item
	getPublicData ()
	gets our alert for data export
	getCreateFieldsArray ()
	get an array of fields in the table that stores the alerts
	getCreateIndexesArray ()
	get an array of indexes on fields in the alert table
Protected Member Functions
	getEditPageXml ()
	get the edit page xml

---

Member Function Documentation

BaseAlert::__construct (  $  data = null, $  table = 'alerts' )

See also: BaseObject::__construct Reimplemented from BaseObject. Definition at line 15 of file base-alert.inc.php.

BaseAlert::canDelete (   )

can i delete the alert? Returns: boolean if we can/cant delete it. Reimplemented from BaseObject. Definition at line 37 of file base-alert.inc.php. References canView().

BaseAlert::canView (   )

can i view the alert? Returns: boolean if we can/cant view it. Reimplemented from BaseObject. Definition at line 25 of file base-alert.inc.php. Referenced by canDelete().

BaseAlert::drawDeletePage (   )

draw our delete page, no confirmation Definition at line 55 of file base-alert.inc.php.

BaseAlert::drawLine (   )

draws our alert line Reimplemented from BaseObject. Definition at line 97 of file base-alert.inc.php. References getName(). Referenced by drawRow().

BaseAlert::drawRow (   )

draws our alert as a row... calls drawLine() Reimplemented from BaseObject. Definition at line 105 of file base-alert.inc.php. References drawLine().

BaseAlert::getCreateFieldsArray (   )

get an array of fields in the table that stores the alerts Returns: an array of field definitions with keys that are the same as the field name. Reimplemented from BaseObject. Definition at line 146 of file base-alert.inc.php.

BaseAlert::getCreateIndexesArray (   )

get an array of indexes on fields in the alert table Returns: a keyed array with keys as the field/index name and values as the index creation sql. Reimplemented from BaseObject. Definition at line 164 of file base-alert.inc.php.

BaseAlert::getEditPageXml (   )  [protected]

get the edit page xml in this special case, we return nothing since there is no edit page. Reimplemented from BaseObject. Definition at line 47 of file base-alert.inc.php.

BaseAlert::getName (  $  link = false  )

gets and/or links our alert text See also: BaseObject::getName Definition at line 89 of file base-alert.inc.php. Referenced by drawLine(), getPublicData(), and getRssItem().

BaseAlert::getPublicData (   )

gets our alert for data export See also: BaseObject::getPublicData() Reimplemented from BaseObject. Definition at line 130 of file base-alert.inc.php. References getName().

BaseAlert::getRssItem (   )

gets our alert as an rss item See also: BaseObject::getRssItem() Reimplemented from BaseObject. Definition at line 115 of file base-alert.inc.php. References getName().

BaseAlert::initViewPage (   )

prep the view page. actually with this one, it handles all the work, since we're redirecting them afterwards. it loads the alert, gets the url, deletes, then redirects. Definition at line 69 of file base-alert.inc.php. References BaseModule::assertLogin(), and Util::redirect().

---

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

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

---