org.puremvc.php.patterns.mediator

# Class: Mediator Source Location: /patterns/mediator/Mediator.php
### Class Overview
    Notifier
       |
       ..Mediator
A base IMediator implementation. #### Author(s): Implements interfaces: IMediator INotifier | ### Variables $facade $mediatorName $viewComponent | ### Constants NAME | ### Methods __construct getMediatorName getViewComponent handleNotification listNotificationInterests onRegister onRemove setViewComponent
### Child classes: ApplicationMediator The ApplicationMediator updates the display of the view when data is ready to be displayed. | ### Inherited Methods #### Class: Notifier Notifier::__construct() Notifier::sendNotification()
### Class Details [line 25] A base IMediator implementation. #### Tags:
see: | org.puremvc.core.view.View View
[ Top ] ### Class Variables #### $facade = [line 34] #### Tags:
access: | protected
Type: | mixed
Overrides: | Array
[ Top ] #### $mediatorName = [line 29] #### Tags:
access: | protected
Type: | mixed
[ Top ] #### $viewComponent = [line 32] #### Tags:
access: | protected
Type: | mixed
[ Top ] ### Class Methods ### constructor __construct [line 49]
`Mediator __construct( $mediatorName, [ $viewComponent = null])`
Constructor. #### Tags:
access: | public
Overridden in child classes as: ApplicationMediator::__construct() Constructor Overrides Notifier::__construct() (parent method not documented) #### Parameters:
| $mediatorName |
| $viewComponent |
[ Top ] ### method getMediatorName [line 61]
`void getMediatorName( )`
Get the name of the Mediator . Override in subclass! #### Tags:
access: | public
[ Top ] ### method getViewComponent [line 69]
`void getViewComponent( )`
Get the Mediator 's view component. #### Tags:
access: | public
[ Top ] ### method handleNotification [line 98]
`void handleNotification( $notification)`
Handle INotification s. Typically this will be handled in a switch statement, with one 'case' entry per INotification the Mediator is interested in. #### Tags:
access: | public
Overridden in child classes as: ApplicationMediator::handleNotification() Handles notifications sent by the PureMVC framework that this Mediator is interested in. #### Parameters:
INotification | $notification |
[ Top ] ### method listNotificationInterests [line 85]
`Array listNotificationInterests( )`
List the INotification names this Mediator is interested in being notified of. #### Tags:
return: | the list of INotification names
access: | public
Overridden in child classes as: ApplicationMediator::listNotificationInterests() Lists the notifications that this mediator is interested in. [ Top ] ### method onRegister [line 106]
`void onRegister( )`
Called when the View registers a Mediator. #### Tags:
access: | public
[ Top ] ### method onRemove [line 114]
`void onRemove( )`
Called when the View removes a Mediator. #### Tags:
access: | public
[ Top ] ### method setViewComponent [line 74]
`void setViewComponent( $component)`
#### Tags:
access: | public
#### Parameters:
| $component |
[ Top ] ### Class Constants #### NAME = 'Mediator' [line 44] The name of the Mediator . Typically, a Mediator will be written to serve one specific control or group controls and so, will not have a need to be dynamically named. [ Top ] Documentation generated on Tue, 30 Sep 2008 08:05:45 -0700 by phpDocumentor 1.4.0