Class: CommentAddNotification

Source Location: /modules/comment/classes/CommentAddNotification.class

Class CommentAddNotification

Class Overview

The CommentAddNotification is used when new comments are added

Located in /modules/comment/classes/CommentAddNotification.class [line 36]

NotificationEvent_1_0
   |
   --CommentAddNotification

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

string	getComment()	Get the comment text
void	getDescription()
void	getEventSpecs()
void	getItemId()
string	getItemUrl()	Get the url of the item the comment was made against
void	getNotificationMessage()
void	getPermission()
void	isAppropriateForItem()

[ Top ]

Properties

Methods

getComment [line 99]

string getComment(
)

Get the comment text

API Tags:

Return:

Comment text

[ Top ]

getDescription [line 40]

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 90]

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 68]

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 ]

getItemUrl [line 110]

string getItemUrl(
GalleryEvent
0 
)

Get the url of the item the comment was made against

Parameters:

GalleryEvent

A Comment Added Event

API Tags:

Return:

The url of the item

[ Top ]

getNotificationMessage [line 48]

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 76]

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 83]

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:32:30 -0800 by phpDocumentor 1.3.0RC6

	Comment Classes

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