org.puremvc.php.core
[ class tree: org.puremvc.php.core ] [ index: org.puremvc.php.core ] [ 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:
Controller.php
Model.php
View.php

Classes:
Controller
Model
View

Class: Model

Source Location: /core/Model.php

Class Overview




A Singleton 
  1. IModel
    2. 

 implementation.




Author(s):


    
              





        

                

            Implements interfaces:
            

        

        




Variables







Methods
























Class Details



[line 43]

A Singleton 
  1. IModel
    2. 

 implementation.

In PureMVC, the 
  1. Model
    2. 

 class provides  access to model objects (Proxies) by named lookup.
The 
  1. Model
    2. 

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

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

     instances.

   Your application must register 
  1. IProxy
    2. 

 instances  with the 
  1. Model
    2. 

. Typically, you use an  
  1. ICommand
    2. 

 to create and register 
  1. IProxy
    2. 

  instances once the 
  1. Facade
    2. 

 has initialized the Core  actors.





Tags:





  

    see:  org.puremvc.php.interfaces.IProxy IProxy
  

  

    see:  org.puremvc.php.patterns.proxy.Proxy Proxy
  










[ Top ]







Class Variables



	
	

	
static $instance = 

	
[line 49]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$proxyMap = 

	
[line 46]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods



  

	
	
static method getInstance [line 88]

	

    

    

		static the getInstance(
)
    

    


	
		
  1. Model
    2. 

 Singleton Factory method.





Tags:





  

    return:  Singleton instance
  

  

    access:  public
  









	
        
[ Top ]

  


  

	
	
method hasProxy [line 140]

	

    

    

		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 initializeModel [line 79]

	

    

    

		void initializeModel(
)
    

    


	
		Initialize the Singleton 
  1. Model
    2. 

 instance.

Called automatically by the constructor, this  is your opportunity to initialize the Singleton  instance in your subclass without overriding the  constructor.





Tags:





  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method registerProxy [line 99]

	

    

    

		void registerProxy(

$proxy)
    

    


	
		Register an 
  1. IProxy
    2. 

 with the 
  1. Model
    2. 

.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        proxy  
        $proxy  
        an 
  1. IProxy
    2. 

 to be held by the 
  1. Model
    2. 

.		
      

        

    


        
[ Top ]

  

  

	
	
method removeProxy [line 121]

	

    

    

		void removeProxy(
proxyName
$proxyName)
    

    


	
		Remove an 
  1. IProxy
    2. 

 from the 
  1. Model
    2. 

.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        proxyName  
        $proxyName  
        name of the 
  1. IProxy
    2. 

 instance to be removed.		
      

        

    


        
[ Top ]

  

  

	
	
method retrieveProxy [line 111]

	

    

    

		the retrieveProxy(
proxyName
$proxyName)
    

    


	
		Retrieve an 
  1. IProxy
    2. 

 from the 
  1. Model
    2. 

.





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:45 -0700 by phpDocumentor 1.4.0