static method getInstance [line 141]
static IFacade getInstance(
string
$key)
|
|
Facade Multiton Factory method
This IFacade implementation is a Multiton, so you MUST not call the constructor directly, but instead call this static Factory method, passing the unique key for this instance
Tags:
Parameters:
static method hasCore [line 451]
static bool hasCore(
string
$key)
|
|
Check if a Core is registered or not
Tags:
Parameters:
static method removeCore [line 465]
static void removeCore(
string
$key)
|
|
Remove a Core.
Remove the Model, View, Controller and Facade instances for the given key.
Tags:
Parameters:
constructor __construct [line 103]
Instance constructor
This IFacade implementation is a Multiton, so you should not call the constructor directly, but instead call the static Factory method, passing the unique key for this instance
Tags:
Parameters:
method hasCommand [line 332]
bool hasCommand(
string
$notificationName)
|
|
Has Command
Check if a Command is registered for a given Notification
Tags:
Implementation of:
- IFacade::hasCommand()
- Has Command
Parameters:
method hasMediator [line 386]
bool hasMediator(
string
$mediatorName)
|
|
Has Mediator
Check if a IMediator is registered or not.
Tags:
Implementation of:
- IFacade::hasMediator()
- Has Mediator
Parameters:
method hasProxy [line 288]
bool hasProxy(
string
$proxyName)
|
|
Has Proxy
Check if a Proxy is registered for the given proxyName.
Tags:
Implementation of:
- IFacade::hasProxy()
- Has Proxy
Parameters:
method initializeController [line 167]
void initializeController(
)
|
|
Initialize the
Controller.
Called by the initializeFacade() method.
Override this method in your subclass of Facade if one or both of the following are true:
- You wish to initialize a different Controller.
- You have Commands to register with the Controller at startup.
If you don't want to initialize a different
Controller, call
parent::initializeController() at the beginning of your method, then register Commands.
Tags:
method initializeFacade [line 123]
Initialize the
Facade instance.
Called automatically by the constructor. Override in your subclass to do any subclass specific initializations. Be sure to call parent::initializeFacade(), though.
Tags:
method initializeModel [line 199]
Initialize the
Model.
Called by the initializeFacade() method.
Override this method in your subclass of Facade if one or both of the following are true:
- You wish to initialize a different Model.
- You have Proxys to register with the Model that do not
retrieve a reference to the Facade at construction time.
If you don't want to initialize a different
Model, call
parent::initializeModel() at the beginning of your method, then register
Proxys.
Note:
This method is rarely overridden; in practice you are more likely to use a Command to create and register Proxys with the Model, since Proxys with mutable data will likely need to send Notifications and thus will likely want to fetch a reference to the Facade during their construction.
Tags:
method initializeNotifier [line 440]
void initializeNotifier(
string
$key)
|
|
Set the Multiton key for this facade instance.
Not called directly, but instead from the constructor when getInstance is invoked. It is necessary to be public in order to implement INotifier.
Tags:
Implementation of:
- INotifier::initializeNotifier()
- Initialize this INotifier instance.
Parameters:
method initializeView [line 231]
Initialize the
View.
Called by the initializeFacade() method.
Override this method in your subclass of Facade if one or both of the following are true:
- You wish to initialize a different IView implementation.
- You have Observers to register with the View
If you don't want to initialize a different
, call
at the beginning of your method, then register
instances.
Note:
This method is rarely overridden; in practice you are more likely to use a Command to create and register Mediators with the View, since IMediator instances will need to send INotifications and thus will likely want to fetch a reference to the Facade during their construction.
Tags:
method notifyObservers [line 421]
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:
Implementation of:
- IFacade::notifyObservers()
- Notify Observers.
Parameters:
method registerCommand [line 302]
void registerCommand(
$notificationName, object|string
$commandClassRef, string
$noteName)
|
|
Register Command
Register an ICommand with the Controller.
Tags:
Implementation of:
- IFacade::registerCommand()
- Register Command
Parameters:
method registerMediator [line 344]
Register Mediator
Register an IMediator instance with the View.
Tags:
Implementation of:
- IFacade::registerMediator()
- Register Mediator
Parameters:
method registerProxy [line 246]
void registerProxy(
IProxy
$proxy)
|
|
Register Proxy
Register an IProxy with the Model.
Tags:
Implementation of:
- IFacade::registerProxy()
- Register Proxy
Parameters:
method removeCommand [line 316]
void removeCommand(
string
$notificationName)
|
|
Remove Command
Remove a previously registered ICommand to INotification mapping.
Tags:
Implementation of:
- IFacade::removeCommand()
- Remove Command
Parameters:
method removeMediator [line 373]
IMediator removeMediator(
string
$mediatorName)
|
|
Remove Mediator
Remove a previously registered IMediator instance from the View.
Tags:
Implementation of:
- IFacade::removeMediator()
- Remove Mediator
Parameters:
method removeProxy [line 275]
IProxy removeProxy(
string
$proxyName)
|
|
Remove Proxy
Remove a previously registered IProxy instance from the Model by name.
Tags:
Implementation of:
- IFacade::removeProxy()
- Remove Proxy
Parameters:
method retrieveMediator [line 360]
IMediator retrieveMediator(
string
$mediatorName)
|
|
Retreive Mediator
Retrieve a previously registered IMediator instance from the View.
Tags:
Implementation of:
- IFacade::retrieveMediator()
- Retreive Mediator
Parameters:
method retrieveProxy [line 262]
IProxy retrieveProxy(
string
$proxyName)
|
|
Retreive Proxy
Retrieve a previously registered IProxy from the Model by name.
Tags:
Implementation of:
- IFacade::retrieveProxy()
- Retreive Proxy
Parameters:
method sendNotification [line 402]
void sendNotification(
string
$notificationName, [mixed
$body = null], [string
$type = null])
|
|
Create and send an
INotification.
Keeps us from having to construct new notification instances in our implementation code.
Tags:
Implementation of:
- INotifier::sendNotification()
- Send a INotification.
Parameters: