org-puremvc-php-multicore
[ class tree: org-puremvc-php-multicore ] [ index: org-puremvc-php-multicore ] [ all elements ]
Packages:
org-puremvc-php-multicore


Interfaces:
ICommand
IController
IFacade
IMediator
IModel
INotification
INotifier
IObserver
IProxy
IView
Classes:
Controller
Facade
MacroCommand
Mediator
Model
Notification
Notifier
Observer
Proxy
SimpleCommand
View
Files:
Controller.php
Facade.php
ICommand.php
IController.php
IFacade.php
IMediator.php
IModel.php
INotification.php
INotifier.php
IObserver.php
IProxy.php
IView.php
MacroCommand.php
Mediator.php
Model.php
Notification.php
Notifier.php
Observer.php
Proxy.php
SimpleCommand.php
View.php

Class: IFacade

Source Location: /org/puremvc/php/multicore/interfaces/IFacade.php

Interface Overview

INotifier
   |
   --IFacade

The interface definition for a PureMVC Facade.


Author(s):

Methods

Inherited Methods

Class: INotifier

INotifier::initializeNotifier()
Initialize this INotifier instance.
INotifier::sendNotification()
Send a INotification.

Class Details

[line 51]
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:  INotification
see:  ICommand
see:  IController
see:  IView
see:  IModel


[ Top ]

Class Methods

method hasCommand [line 122]

bool hasCommand( string $notificationName)

Has Command

Check if a Command is registered for a given Notification




Tags:

return:  Whether a Command is currently registered for the given notificationName.
access:  public


Parameters:

string   $notificationName   Name of the INotification to check for.

[ Top ]

method hasMediator [line 161]

bool hasMediator( string $mediatorName)

Has Mediator

Check if a IMediator is registered or not.




Tags:

return:  Boolean: Whether a IMediator is registered with the given mediatorName.
access:  public


Parameters:

string   $mediatorName   The name of the IMediator to check for.

[ Top ]

method hasProxy [line 92]

bool hasProxy( string $proxyName)

Has Proxy

Check if a Proxy is registered for the given proxyName.




Tags:

return:  Boolean: Whether a Proxy is currently registered with the given proxyName.
access:  public


Parameters:

string   $proxyName   Name of the Proxy to check for.

[ Top ]

method notifyObservers [line 177]

void notifyObservers( INotification $notification)

Notify Observers.

This method is left public mostly for backward compatibility, and to allow you to send custom notification classes using the facade.

Usually you should just call sendNotification and pass the parameters, never having to construct the notification yourself.




Tags:

access:  public


Parameters:

INotification   $notification   The INotification to have the View notify Observers of.

[ Top ]

method registerCommand [line 103]

void registerCommand( string $noteName, object|string $commandClassRef)

Register Command

Register an ICommand with the Controller.




Tags:

access:  public


Parameters:

string   $noteName   Name of the INotification
object|string   $commandClassRef   ICommand object to register. Can be an object OR a class name.

[ Top ]

method registerMediator [line 131]

void registerMediator( IMediator $mediator)

Register Mediator

Register an IMediator instance with the View.




Tags:

access:  public


Parameters:

IMediator   $mediator   Reference to the IMediator instance.

[ Top ]

method registerProxy [line 62]

void registerProxy( IProxy $proxy)

Register Proxy

Register an IProxy with the Model.




Tags:

access:  public


Parameters:

IProxy   $proxy   The IProxy to be registered with the Model.

[ Top ]

method removeCommand [line 112]

void removeCommand( string $notificationName)

Remove Command

Remove a previously registered ICommand to INotification mapping.




Tags:

access:  public


Parameters:

string   $notificationName   Name of the INotification to remove the ICommand mapping for.

[ Top ]

method removeMediator [line 151]

IMediator removeMediator( string $mediatorName)

Remove Mediator

Remove a previously registered IMediator instance from the View.




Tags:

return:  The IMediator instance previously registered with the given mediatorName.
access:  public


Parameters:

string   $mediatorName   Name of the IMediator instance to be removed.

[ Top ]

method removeProxy [line 82]

IProxy removeProxy( string $proxyName)

Remove Proxy

Remove a previously registered IProxy instance from the Model by name.




Tags:

return:  The IProxy that was removed from the Model.
access:  public


Parameters:

string   $proxyName   Name of the IProxy to remove from the Model.

[ Top ]

method retrieveMediator [line 141]

IMediator retrieveMediator( string $mediatorName)

Retreive Mediator

Retrieve a previously registered IMediator instance from the View.




Tags:

return:  The IMediator previously registered with the given mediatorName.
access:  public


Parameters:

string   $mediatorName   Name of the IMediator instance to retrieve.

[ Top ]

method retrieveProxy [line 72]

IProxy retrieveProxy( string $proxyName)

Retreive Proxy

Retrieve a previously registered IProxy from the Model by name.




Tags:

return:  The IProxy previously regisetered by proxyName with the Model.
access:  public


Parameters:

string   $proxyName   Name of the IProxy instance to be retrieved.

[ Top ]

Documentation generated on Mon, 03 Aug 2009 04:57:55 +0000 by phpDocumentor 1.4.2