	Notification Classes

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

Notification

Packages:

Gallery
AlbumSelect
ArchiveUpload
Captcha
Cart
ColorPack
Comment
CustomField
Dcraw
Debug
Digibug
DynamicAlbum
Ecard
Exif
Ffmpeg
FlashVideo
Fotokasten
GalleryCore
Gd
Getid3
Hidden
HttpAuth
Icons
ImageBlock
ImageFrame
ImageMagick
Install
ItemAdd
Jpegtran
KeyAlbum
LinkItem
Members
Migrate
Mime
MP3Audio
MultiLang
Multiroot
NetPbm
NewItems
NokiaUpload
Notification
Panorama
Password
Permalinks
PhotoAccess
Picasa
PublishXp
Quotas
RandomHighlight
Rating
Rearrange
Registration
Remote
Replica
Reupload
Rewrite
Rss
Search
Shutterfly
Sitemap
SizeLimit
Slideshow
SlideshowApplet
SnapGalaxy
SquareThumb
Themes
Thumbnail
ThumbPage
Tools
Upgrade
UploadApplet
UserAlbum
Watermark
WebCam
WebDav
ZipCart

Files:

module.inc

Classes
GalleryCoreEventNotifications.class
NotificationEvent_1_0.class
NotificationHandler_1_0.class
NotificationHelper.class
NotificationMethodEmail.class
NotificationRouter.class

PHPUnit
NotificationEventHandlingTest.class
NotificationHelperTest.class
NotificationItemAdminControllerTest.class
NotificationSiteAdminControllerTest.class
NotificationUserAdminControllerTest.class

UserInterface
NotificationItemAdmin.inc
NotificationItemsAddedOption.inc
NotificationSiteAdmin.inc
NotificationUserAdmin.inc

Classes:

Classes
ActivatePluginNotification
AlbumStructureChangeNotification
DeactivatePluginNotification
DeleteNotification
ErrorNotification
FailedLoginNotification
ItemAddedNotification
ItemOrderNotification
LoginNotification
LogoutNotification
NotificationEvent_1_0
NotificationHandler_1_0
NotificationHelper
NotificationMethodEmail
NotificationRouter
RemovePermissionNotification
SaveNotification
UninstallPluginNotification

NotificationModule

PHPUnit
NotificationEventHandlingPlatform
NotificationEventHandlingTest
NotificationEventTest
NotificationEventTest2
NotificationHelperTest
NotificationHelperTestEvent
NotificationHelperTestEvent2
NotificationHelperTestEventHandler
NotificationHelperTestGlobalEvent
NotificationHelperTestNotificationHandler
NotificationHelperTestNotificationHandlerNew
NotificationItemAdminControllerTest
NotificationItemEventTest
NotificationMethodTest
NotificationMethodTestNew
NotificationRouterTest1
NotificationRouterTest2
NotificationRouterTestHandler1
NotificationSiteAdminControllerTest
NotificationUserAdminControllerTest
NotificationUserTestEvent

UserInterface
NotificationItemAdminController
NotificationItemAdminView
NotificationItemsAddedOption
NotificationSiteAdminController
NotificationSiteAdminView
NotificationUserAdminController
NotificationUserAdminView

Class: NotificationHandler_1_0

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

Class NotificationHandler_1_0

Class Overview

This is an interface for alternative notification methods for the notification module.

Located in /modules/notification/classes/NotificationHandler_1_0.class [line 36]

Author(s):

API Tags:

Abstract:

[ Top ]

Direct descendents

Child Class	Description
NotificationRouterTestHandler1
NotificationHelperTestNotificationHandler
NotificationHelperTestNotificationHandlerNew
NotificationMethodTest
NotificationMethodEmail	This NotificationMethod sends notification by email

[ Top ]

Method Summary

array	getDescription()	Return a localized description of the handler.
GalleryStatus	handleNotification()	Handle the event.
array	_translateText()	Provide a common routine to do translations of descriptions

[ Top ]

Methods

getDescription [line 43]

array getDescription(
)

Return a localized description of the handler.

API Tags:

Return:	GalleryStatus string Localized description of the handler.
Abstract:

Redefined in descendants as:

[ Top ]

handleNotification [line 54]

GalleryStatus handleNotification(
array
$subscribers, NotificationEvent_1_0
$notification 
)

Handle the event.

Parameters:

array	$subscribers:	Array of userIds to send the notification to
NotificationEvent_1_0	$notification:	The event notification descriptor

API Tags:

Abstract:

Redefined in descendants as:

[ Top ]

_translateText [line 66]

array _translateText(
string
$moduleId, mixed
$translateParms 
)

Provide a common routine to do translations of descriptions

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 ]

Documentation generated on Fri, 08 Oct 2010 05:42:23 -0700 by phpDocumentor 1.3.0RC6