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

Source Location: /interfaces/IView.php

Interface Overview




The interface definition for a PureMVC View.




Author(s):


    
                    





            

        






Methods
























Class Details



[line 35]

The interface definition for a PureMVC View.

In PureMVC, 
  1. IView
    2. 

 implementors assume these responsibilities:
In PureMVC, the 
  1. View
    2. 

 class assumes these responsibilities:  
  • Maintain a cache of 
    1. IMediator
      2. 

     instances.
  • Provide methods for registering, retrieving, and removing 
    1. IMediators
      2. 

    .
  • Managing the observer lists for each 
    1. INotification
      2. 

     in the application.
  • Providing a method for attaching 
    1. IObservers
      2. 

     to an 
    1. INotification
      2. 

    's observer list.
  • Providing a method for broadcasting an 
    1. INotification
      2. 

    .
  • Notifying the 
    1. IObservers
      2. 

     of a given 
    1. INotification
      2. 

     when it broadcast.





Tags:





  

    see:  org.puremvc.php.interfaces.INotification INotification
  

  

    see:  org.puremvc.php.interfaces.IObserver IObserver
  

  

    see:  org.puremvc.php.interfaces.IMediator IMediator
  










[ Top ]








Class Methods




  

	
	
method hasMediator [line 97]

	

    

    

		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 notifyObservers [line 56]

	

    

    

		void notifyObservers(
INotification
$note)
    

    


	
		Notify the 
  1. IObservers
    2. 

 for a particular 
  1. INotification
    2. 

.

All previously attached 
  1. IObservers
    2. 

 for this 
  1. INotification
    2. 

's  list are notified and are passed a reference to the 
  1. INotification
    2. 

 in  the order in which they were registered.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        notification  
        $note  
        the 
  1. INotification
    2. 

 to notify 
  1. IObservers
    2. 

 of.		
      

        

    


        
[ Top ]

  

  

	
	
method registerMediator [line 75]

	

    

    

		void registerMediator(
IMediator
$mediator, mediator
1)
    

    


	
		Register an 
  1. IMediator
    2. 

 instance with the 
  1. View
    2. 

.

Registers the 
  1. IMediator
    2. 

 so that it can be retrieved by name,  and further interrogates the 
  1. IMediator
    2. 

 for its  
  1. INotification
    2. 

 interests.
If the 
  1. IMediator
    2. 

 returns any 
  1. INotification
    2. 

  names to be notified about, an 
  1. Observer
    2. 

 is created encapsulating  the 
  1. IMediator
    2. 

 instance's 
  1. handleNotification
    2. 

 method  and registering it as an 
  1. Observer
    2. 

 for all 
  1. INotifications
    2. 

 the  
  1. IMediator
    2. 

 is interested in.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        mediator  
        1  
        a reference to the 
  1. IMediator
    2. 

 instance		
      

          

        mediatorName  
        $mediator  
        the name to associate with this 
  1. IMediator
    2. 

 instance		
      

        

    


        
[ Top ]

  

  

	
	
method registerObserver [line 44]

	

    

    

		void registerObserver(
notificationName
$noteName, IObserver
$observer)
    

    


	
		Register an 
  1. IObserver
    2. 

 to be notified  of 
  1. INotifications
    2. 

 with a given name.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        notificationName  
        $noteName  
        the name of the 
  1. INotifications
    2. 

 to notify this 
  1. IObserver
    2. 

 of		
      

          

        observer  
        $observer  
        the 
  1. IObserver
    2. 

 to register		
      

        

    


        
[ Top ]

  

  

	
	
method removeMediator [line 90]

	

    

    

		void removeMediator(
mediatorName
$mediatorName)
    

    


	
		Remove an 
  1. IMediator
    2. 

 from the 
  1. View
    2. 

.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        mediatorName  
        $mediatorName  
        name of the 
  1. IMediator
    2. 

 instance to be removed.		
      

        

    


        
[ Top ]

  

  

	
	
method retrieveMediator [line 83]

	

    

    

		the retrieveMediator(
mediatorName
$mediatorName)
    

    


	
		Retrieve an 
  1. IMediator
    2. 

 from the 
  1. View
    2. 

.





Tags:





  

    return:  
  1. IMediator
    2. 

 instance previously registered with the given 
  1. mediatorName
    2. 

.		
  

  

    access:  public
  









	
        
Parameters:

    

    

          

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

 instance to retrieve.		
      

        

    


        
[ Top ]

  






        

		    

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