Class: ItemAddedNotification

Source Location: /modules/notification/classes/GalleryCoreEventNotifications.class

Class ItemAddedNotification

Class Overview

Located in /modules/notification/classes/GalleryCoreEventNotifications.class [line 686]

NotificationEvent_1_0
   |
   --ItemAddedNotification

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From NotificationEvent_1_0

NotificationEvent_1_0::$_event

Inherited From NotificationEvent_1_0

NotificationEvent_1_0::getDescription()

Return a localized description of the event.

NotificationEvent_1_0::getEvent()

Set the event that caused this notification to be created.

NotificationEvent_1_0::getEventSpecs()

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

NotificationEvent_1_0::getItemId()

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

NotificationEvent_1_0::getNotificationMessage()

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

NotificationEvent_1_0::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

NotificationEvent_1_0::isAppropriateForItem()

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

NotificationEvent_1_0::isGlobal()

Determines if this notification is global or applies to an item

NotificationEvent_1_0::setEvent()

Set the event that caused this notification to be created.

NotificationEvent_1_0::_translateText()

Provide a common routine to do translations of descriptions and messages

[ Top ]

Method Summary

void	getDescription()
void	getEventSpecs()
void	getItemId()
void	getNotificationMessage()
void	getPermission()
void	isAppropriateForItem()

[ Top ]

Properties

Methods

getDescription [line 690]

void getDescription(
)

API Tags:

See:

NotificationEvent_1_0::getDescription.

Redefinition of:

NotificationEvent_1_0::getDescription(): Return a localized description of the event.

[ Top ]

getEventSpecs [line 698]

void getEventSpecs(
)

API Tags:

See:

NotificationEvent_1_0::getEventSpecs

Redefinition of:

NotificationEvent_1_0::getEventSpecs(): Returns the Event Specification The event specification determines the selection criteria for the particular event. The only required entry is 'eventName'.

[ Top ]

getItemId [line 759]

void getItemId(
)

API Tags:

See:

NotificationEvent_1_0::getItemId

Redefinition of:

NotificationEvent_1_0::getItemId(): Get the item id contained in the event or return 0 if there is no item id.

[ Top ]

getNotificationMessage [line 705]

void getNotificationMessage(
)

API Tags:

See:

NotificationEvent_1_0::getNotificationMessage.

Redefinition of:

NotificationEvent_1_0::getNotificationMessage(): Return a formatted and localized plain text message describing the event to be used in any notification message.

[ Top ]

getPermission [line 752]

void getPermission(
)

API Tags:

See:

NotificationEvent_1_0::getPermission

Redefinition of:

NotificationEvent_1_0::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

[ Top ]

isAppropriateForItem [line 767]

void isAppropriateForItem(

$item 
)

Parameters:

$item:

API Tags:

See:

NotificationEvent_1_0::isAppropriateForItem

Redefinition of:

NotificationEvent_1_0::isAppropriateForItem(): Determines if the event is appropriate for the supplied item. This could be null and might not be an object.

[ Top ]

Documentation generated on Sat, 21 Nov 2009 04:44:23 -0800 by phpDocumentor 1.3.0RC6

	Notification Classes

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