Docs For Class NotificationEvent_1

Method Summary

array	getDescription()	Return a localized description of the event.
GalleryEvent	getEvent()	Set the event that caused this notification to be created.
array	getEventSpecs()	Returns the Event Specification The event specification determines the selection criteria for the particular event. The only required entry is 'eventName'.
mixed	getItemId()	Get the item id contained in the event or return 0 if there is no item id.
array	getNotificationMessage()	Return a formatted and localized plain text message describing the event to be used in any notification message.
string	getPermission()	What permission of the item should be checked to see if a user is allowed to get that event. Setting to null will limit the notifications to administrators
boolean	isAppropriateForItem()	Determines if the event is appropriate for the supplied item. This could be null and might not be an object.
boolean	isGlobal()	Determines if this notification is global or applies to an item
void	setEvent()	Set the event that caused this notification to be created.
array	_translateText()	Provide a common routine to do translations of descriptions and messages

[ Top ]

Methods

getDescription [line 63]

array getDescription(
)

Return a localized description of the event.

API Tags:

Return:	GalleryStatus a status codet string Localized description of event
Abstract:

Redefined in descendants as:

[ Top ]

getEvent [line 52]

GalleryEvent getEvent(
)

Set the event that caused this notification to be created.

[ Top ]

getEventSpecs [line 126]

array getEventSpecs(
)

Returns the Event Specification The event specification determines the selection criteria for the particular event. The only required entry is 'eventName'.

API Tags:

Return:	('eventName' => eventName, 'entityType' => entityType, 'persistentFlag' => flags)
Abstract:

Redefined in descendants as:

[ Top ]

getItemId [line 83]

mixed getItemId(
)

Get the item id contained in the event or return 0 if there is no item id.

API Tags:

Return:

Either a single id or an array of item ids

Redefined in descendants as:

[ Top ]

getNotificationMessage [line 75]

array getNotificationMessage(
)

Return a formatted and localized plain text message describing the event to be used in any notification message.

API Tags:

Return:	GalleryStatus string A formatted and localized plain text message.
Abstract:

Redefined in descendants as:

[ Top ]

getPermission [line 94]

string getPermission(
)

What permission of the item should be checked to see if a user is allowed to get that event. Setting to null will limit the notifications to administrators

API Tags:

Return:	name of permission to check
Abstract:

Redefined in descendants as:

[ Top ]

isAppropriateForItem [line 113]

boolean isAppropriateForItem(
GalleryItem
$item 
)

Determines if the event is appropriate for the supplied item. This could be null and might not be an object.

Parameters:

GalleryItem

$item:

The item to be checked against.

API Tags:

Return:

true or false if the event applies to provided item

Redefined in descendants as:

[ Top ]

isGlobal [line 102]

boolean isGlobal(
)

Determines if this notification is global or applies to an item

API Tags:

Return:

true if the notification is not related to an item.

Redefined in descendants as:

[ Top ]

setEvent [line 44]

void setEvent(
GalleryEvent
$event 
)

Set the event that caused this notification to be created.

Parameters:

GalleryEvent

$event:

[ Top ]

_translateText [line 139]

array _translateText(
string
$moduleId, mixed
$translateParms 
)

Provide a common routine to do translations of descriptions and messages

Parameters:

string	$moduleId:	the module id
mixed	$translateParms:	parameters to the module translate method

API Tags:

Return:	GalleryStatus string A formatted and localized plain text message.
Access:	protected

[ Top ]

Class: NotificationEvent_1_0

Class NotificationEvent_1_0

	Notification Classes

[ class tree: Notification ] [ index: Notification ] [ all elements ]