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

Source Location: /interfaces/IModel.php

Interface Overview




The interface definition for a PureMVC Model.









        






Methods
























Class Details



[line 33]

The interface definition for a PureMVC Model.

In PureMVC, 
  1. IModel
    2. 

 implementors provide  access to 
  1. IProxy
    2. 

 objects by named lookup.
An 
  1. IModel
    2. 

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

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

     instances





[ Top ]








Class Methods




  

	
	
method hasProxy [line 63]

	

    

    

		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 registerProxy [line 41]

	

    

    

		void registerProxy(
IProxy
$proxy, proxy
1)
    

    


	
		Register an 
  1. IProxy
    2. 

 instance with the 
  1. Model
    2. 

.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        proxy  
        1  
        an object reference to be held by the 
  1. Model
    2. 

.		
      

          

        proxyName  
        $proxy  
        the name to associate with this 
  1. IProxy
    2. 

 instance.		
      

        

    


        
[ Top ]

  

  

	
	
method removeProxy [line 56]

	

    

    

		void removeProxy(
proxyName
$proxyName)
    

    


	
		Remove an 
  1. IProxy
    2. 

 instance from the Model.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        proxyName  
        $proxyName  
        name of the 
  1. IProxy
    2. 

 instance to be removed.		
      

        

    


        
[ Top ]

  

  

	
	
method retrieveProxy [line 49]

	

    

    

		the retrieveProxy(
proxyName
$proxyName)
    

    


	
		Retrieve an 
  1. IProxy
    2. 

 instance from the Model.





Tags:





  

    return:  
  1. IProxy
    2. 

 instance previously registered with the given 
  1. proxyName
    2. 

.		
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        proxyName  
        $proxyName  
        
      

        

    


        
[ Top ]

  






        

		    

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