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: IMediator

Source Location: /interfaces/IMediator.php

Interface Overview




The interface definition for a PureMVC Mediator.




Author(s):


    
        





    

        






Methods
























Class Details



[line 19]

The interface definition for a PureMVC Mediator.





Tags:





  

    see:  org.puremvc.interfaces.INotification INotification
  










[ Top ]








Class Methods




  

	
	
method getMediatorName [line 27]

	

    

    

		the getMediatorName(
)
    

    


	
		Get the 
  1. IMediator
    2. 

 instance name





Tags:





  

    return:  
  1. IMediator
    2. 

 instance name		
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getViewComponent [line 34]

	

    

    

		Object getViewComponent(
)
    

    


	
		Get the 
  1. IMediator
    2. 

's view component.





Tags:





  

    return:  the view component
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method handleNotification [line 55]

	

    

    

		void handleNotification(
INotification
$notification)
    

    


	
		Handle an 
  1. INotification
    2. 

.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        notification  
        $notification  
        the 
  1. INotification
    2. 

 to be handled		
      

        

    


        
[ Top ]

  

  

	
	
method listNotificationInterests [line 48]

	

    

    

		an listNotificationInterests(
)
    

    


	
		List 
  1. INotification
    2. 

 interests.





Tags:





  

    return:  
  1. Array
    2. 

 of the 
  1. INotification
    2. 

 names this 
  1. IMediator
    2. 

 has an interest in.		
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method onRegister [line 60]

	

    

    

		void onRegister(
)
    

    


	
		Called when the View registers a Mediator.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method onRemove [line 65]

	

    

    

		void onRemove(
)
    

    


	
		Called when the View removes a Mediator.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setViewComponent [line 41]

	

    

    

		void setViewComponent(
Object
$viewComponent)
    

    


	
		Set the 
  1. IMediator
    2. 

's view component.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        Object  
        $viewComponent  
        the view component
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Tue, 30 Sep 2008 08:05:44 -0700 by phpDocumentor 1.4.0