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

Class: LoginNotification

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

Class LoginNotification

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   getNotificationMessage()  
object GalleryUser   getUser()   Return the User entity which just logged on.
void   isGlobal()  

[ Top ]
Methods
getDescription  [line 265]

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

  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 ]
getNotificationMessage  [line 288]

  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 ]
getUser  [line 300]

  object GalleryUser getUser( )

Return the User entity which just logged on.



[ Top ]
isGlobal  [line 281]

  void isGlobal( )


API Tags:
See:  NotificationEvent_1_0::isGlobal


Redefinition of:
NotificationEvent_1_0::isGlobal()
Determines if this notification is global or applies to an item

[ Top ]

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