org.puremvc.php.interfaces

# Class: IFacade Source Location: /interfaces/IFacade.php
### Interface Overview
The interface definition for a PureMVC Facade. #### Author(s): | ### Methods hasMediator hasProxy notifyObservers registerCommand registerMediator registerProxy removeMediator removeProxy retrieveMediator retrieveProxy sendNotification
### Class Details [line 33] The interface definition for a PureMVC Facade. The Facade Pattern suggests providing a single class to act as a central point of communication for a subsystem. In PureMVC, the Facade acts as an interface between the core MVC actors (Model, View, Controller) and the rest of your application. #### Tags:
see: | org.puremvc.php.interfaces.INotification INotification
see: | org.puremvc.php.interfaces.ICommand ICommand
see: | org.puremvc.php.interfaces.IController IController
see: | org.puremvc.php.interfaces.IView IView
see: | org.puremvc.php.interfaces.IModel IModel
[ Top ] ### Class Methods ### method hasMediator [line 99]
`void hasMediator( mediatorName $mediatorName)`
Check to see if a Mediator is registered with the View. #### Tags:
access: | public
#### Parameters:
mediatorName | $mediatorName | name of the IMediator instance to check for.
[ Top ] ### method hasProxy [line 55]
`void hasProxy( proxyName $proxyName)`
Check to see if a Proxy is registered with the Model. #### Tags:
access: | public
#### Parameters:
proxyName | $proxyName | name of the IProxy instance to check for.
[ Top ] ### method notifyObservers [line 77]
`void notifyObservers( INotification $note)`
Notify Observer s of an INotification . #### Tags:
access: | public
#### Parameters:
note | $note | the INotification to have the View notify observers of.
[ Top ] ### method registerCommand [line 70]
`void registerCommand( noteName $noteName, commandClassRef $commandClassRef)`
Register an ICommand with the Controller . #### Tags:
access: | public
#### Parameters:
noteName | $noteName | the name of the INotification to associate the ICommand with.
commandClassRef | $commandClassRef | a reference to the Class of the ICommand .
[ Top ] ### method registerMediator [line 84]
`void registerMediator( IMediator $mediator)`
Register an IMediator instance with the View . #### Tags:
access: | public
#### Parameters:
mediator | $mediator | a reference to the IMediator instance
[ Top ] ### method registerProxy [line 40]
`void registerProxy( IProxy $proxy)`
Register an IProxy with the Model by name. #### Tags:
access: | public
#### Parameters:
proxy | $proxy | the IProxy to be registered with the Model .
[ Top ] ### method removeMediator [line 106]
`void removeMediator( mediatorName $mediatorName)`
Remove a IMediator instance from the View . #### Tags:
access: | public
#### Parameters:
mediatorName | $mediatorName | name of the IMediator instance to be removed.
[ Top ] ### method removeProxy [line 62]
`void removeProxy( proxyName $proxyName)`
Remove an IProxy instance from the Model by name. #### Tags:
access: | public
#### Parameters:
proxyName | $proxyName | the IProxy to remove from the Model .
[ Top ] ### method retrieveMediator [line 92]
`the retrieveMediator( mediatorName $mediatorName)`
Retrieve an IMediator instance from the View . #### Tags:
return: | IMediator previously registered with the given mediatorName .
access: | public
#### Parameters:
mediatorName | $mediatorName | the name of the IMediator instance to retrievve
[ Top ] ### method retrieveProxy [line 48]
`the retrieveProxy( proxyName $proxyName)`
Retrieve a IProxy from the Model by name. #### Tags:
return: | IProxy previously regisetered by proxyName with the Model .
access: | public
#### Parameters:
proxyName | $proxyName | the name of the IProxy instance to be retrieved.
[ Top ] ### method sendNotification [line 119]
`void sendNotification( notificationName $notificationName, [body $body = null], [type $type = null])`
Send a INotification . 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