ChWsbAlerts Class Reference

Public Member Functions
	__construct ($sUnit, $sAction, $iObjectId, $iSender=0, $aExtras=array())
	alert ()

Static Public Member Functions
static	cache ()

Public Attributes
	$sUnit
	$sAction
	$iObject
	$iSender
	$aExtras
	$_aAlerts
	$_aHandlers

Detailed Description

This work, "Cheetah - https://www.cheetahwsb.com", is a derivative of "Dolphin Pro V7.4.2" by BoonEx Pty Limited - https://www.boonex.com/, used under CC-BY. "Cheetah" is licensed under CC-BY by Dean J. Bassett Jr. CC-BY License - http://creativecommons.org/licenses/by/3.0/ Alert/Handler engine.

Is needed to fire some alert(event) in one place and caught it with a handler somewhere else.

Related classes: ChWsbAlertsResponse - abstract class for all response classes. ChWsbAlertsResponseUser - response class to process standard profile related alerts.

Example of usage:

1. Fire an alert

ch_import('ChWsbAlerts'); $oZ = new ChWsbAlerts('unit_name', 'action', 'object_id', 'sender_id', 'extra_params'); $oZ->alert();

1. Add handler and caught alert(s)

   See also

   ChWsbAlertsResponseUser a. Create Response class extending ChWsbAlertsResponse class. It should process all necessary alerts which are passed to it. b. Register your handler in the database by adding it in sys_alerts_handlers table. c. Associate necessary alerts with the handler by adding them in the sys_alerts table.

   Memberships/ACL: Doesn't depend on user's membership.

Alerts: no alerts available

Definition at line 38 of file ChWsbAlerts.php.

Constructor & Destructor Documentation

__construct()

ChWsbAlerts::__construct	(		$sUnit,
			$sAction,
			$iObjectId,
			$iSender = 0,
			$aExtras = array()
	)

Constructor

Parameters

string	$sType	- system type
string	$sAction	- system action
int	$iObjectId	- object id
int	$iSenderId	- sender (action's author) id

Definition at line 56 of file ChWsbAlerts.php.

Member Function Documentation

alert()

ChWsbAlerts::alert

(

)

Notifies the necessary handlers about the alert.

Definition at line 79 of file ChWsbAlerts.php.

cache()

static ChWsbAlerts::cache ( )

static

Cache alerts and handlers.

Returns

an array with all alerts and handlers.

Definition at line 106 of file ChWsbAlerts.php.

Member Data Documentation

$_aAlerts

ChWsbAlerts::$_aAlerts

Definition at line 46 of file ChWsbAlerts.php.

$_aHandlers

ChWsbAlerts::$_aHandlers

Definition at line 47 of file ChWsbAlerts.php.

$aExtras

ChWsbAlerts::$aExtras

Definition at line 44 of file ChWsbAlerts.php.

$iObject

ChWsbAlerts::$iObject

Definition at line 42 of file ChWsbAlerts.php.

$iSender

ChWsbAlerts::$iSender

Definition at line 43 of file ChWsbAlerts.php.

$sAction

ChWsbAlerts::$sAction

Definition at line 41 of file ChWsbAlerts.php.

$sUnit

ChWsbAlerts::$sUnit

Definition at line 40 of file ChWsbAlerts.php.

---

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

• inc/classes/ChWsbAlerts.php