org.puremvc.php.interfaces
[ class tree: org.puremvc.php.interfaces ] [ index: org.puremvc.php.interfaces ] [ all elements ]

Class: INotifier

Source Location: /interfaces/INotifier.php

Interface Overview


The interface definition for a PureMVC Notifier.


Author(s):

Methods



Class Details

[line 37]
The interface definition for a PureMVC Notifier.

and
all have a need to send
  1. Notifications
.

The

interface provides a common method called
that relieves implementation code of the necessity to actually construct
  1. Notifications
.

The

class, which all of the above mentioned classes extend, also provides an initialized reference to the
Singleton, which is required for the convienience method for sending
  1. Notifications
, but also eases implementation as these classes have frequent
interactions and usually require access to the facade anyway.




Tags:

see:  org.puremvc.php.interfaces.INotification INotification
see:  org.puremvc.php.interfaces.IFacade IFacade


[ Top ]


Class Methods


method sendNotification [line 50]

void sendNotification( notificationName $notificationName, [body $body = null], [type $type = null])

Send a
.

Convenience method to prevent having to construct new notification instances in our implementation code.




Tags:

access:  public


Parameters:

notificationName   $notificationName   the name of the notification to send
body   $body   the body of the notification (optional)
type   $type   the type of the notification (optional)

[ Top ]


Documentation generated on Tue, 30 Sep 2008 08:05:44 -0700 by phpDocumentor 1.4.0