org.puremvc.php.interfaces
[ class tree: org.puremvc.php.interfaces ] [ index: org.puremvc.php.interfaces ] [ all elements ]
Packages:
org.puremvc.php.core
org.puremvc.php.demos
org.puremvc.php.demos.basic.controller.commands
org.puremvc.php.demos.basic.model.proxy
org.puremvc.php.demos.basic.model.vo
org.puremvc.php.demos.basic.view
org.puremvc.php.interfaces
org.puremvc.php.patterns.command
org.puremvc.php.patterns.facade
org.puremvc.php.patterns.mediator
org.puremvc.php.patterns.observer
org.puremvc.php.patterns.proxy


Files:
ICommand.php
IController.php
IFacade.php
IMediator.php
IModel.php
INotification.php
INotifier.php
IObserver.php
IProxy.php
IView.php

Interfaces:
ICommand
IController
IFacade
IMediator
IModel
INotification
INotifier
IObserver
IProxy
IView

Class: IFacade

Source Location: /interfaces/IFacade.php

Interface Overview




The interface definition for a PureMVC Facade.




Author(s):


    
                                





                    

        






Methods
























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 
  1. IMediator
    2. 

 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 
  1. IProxy
    2. 

 instance to check for.		
      

        

    


        
[ Top ]

  

  

	
	
method notifyObservers [line 77]

	

    

    

		void notifyObservers(
INotification
$note)
    

    


	
		Notify 
  1. Observer
    2. 

s of an 
  1. INotification
    2. 

.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        note  
        $note  
        the 
  1. INotification
    2. 

 to have the 
  1. View
    2. 

 notify observers of.		
      

        

    


        
[ Top ]

  

  

	
	
method registerCommand [line 70]

	

    

    

		void registerCommand(
noteName
$noteName, commandClassRef
$commandClassRef)
    

    


	
		Register an 
  1. ICommand
    2. 

 with the 
  1. Controller
    2. 

.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        noteName  
        $noteName  
        the name of the 
  1. INotification
    2. 

 to associate the 
  1. ICommand
    2. 

 with.		
      

          

        commandClassRef  
        $commandClassRef  
        a reference to the 
  1. Class
    2. 

 of the 
  1. ICommand
    2. 

.		
      

        

    


        
[ Top ]

  

  

	
	
method registerMediator [line 84]

	

    

    

		void registerMediator(
IMediator
$mediator)
    

    


	
		Register an 
  1. IMediator
    2. 

 instance with the 
  1. View
    2. 

.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        mediator  
        $mediator  
        a reference to the 
  1. IMediator
    2. 

 instance		
      

        

    


        
[ Top ]

  

  

	
	
method registerProxy [line 40]

	

    

    

		void registerProxy(
IProxy
$proxy)
    

    


	
		Register an 
  1. IProxy
    2. 

 with the 
  1. Model
    2. 

 by name.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        proxy  
        $proxy  
        the 
  1. IProxy
    2. 

 to be registered with the 
  1. Model
    2. 

.		
      

        

    


        
[ Top ]

  

  

	
	
method removeMediator [line 106]

	

    

    

		void removeMediator(
mediatorName
$mediatorName)
    

    


	
		Remove a 
  1. IMediator
    2. 

 instance from the 
  1. View
    2. 

.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        mediatorName  
        $mediatorName  
        name of the 
  1. IMediator
    2. 

 instance to be removed.		
      

        

    


        
[ Top ]

  

  

	
	
method removeProxy [line 62]

	

    

    

		void removeProxy(
proxyName
$proxyName)
    

    


	
		Remove an 
  1. IProxy
    2. 

 instance from the 
  1. Model
    2. 

 by name.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        proxyName  
        $proxyName  
        the 
  1. IProxy
    2. 

 to remove from the 
  1. Model
    2. 

.		
      

        

    


        
[ Top ]

  

  

	
	
method retrieveMediator [line 92]

	

    

    

		the retrieveMediator(
mediatorName
$mediatorName)
    

    


	
		Retrieve an 
  1. IMediator
    2. 

 instance from the 
  1. View
    2. 

.





Tags:





  

    return:  
  1. IMediator
    2. 

 previously registered with the given 
  1. mediatorName
    2. 

.		
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        mediatorName  
        $mediatorName  
        the name of the 
  1. IMediator
    2. 

 instance to retrievve		
      

        

    


        
[ Top ]

  

  

	
	
method retrieveProxy [line 48]

	

    

    

		the retrieveProxy(
proxyName
$proxyName)
    

    


	
		Retrieve a 
  1. IProxy
    2. 

 from the 
  1. Model
    2. 

 by name.





Tags:





  

    return:  
  1. IProxy
    2. 

 previously regisetered by 
  1. proxyName
    2. 

 with the 
  1. Model
    2. 

.		
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        proxyName  
        $proxyName  
        the name of the 
  1. IProxy
    2. 

 instance to be retrieved.		
      

        

    


        
[ Top ]

  

  

	
	
method sendNotification [line 119]

	

    

    

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

    


	
		Send a 
  1. INotification
    2. 

.

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