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

Source Location: /core/Controller.php

Class Overview




A Singleton 
  1. IController
    2. 

 implementation.




Author(s):


    
                                





                    

                

            Implements interfaces:
            

        

        




Variables







Methods
























Class Details



[line 54]

A Singleton 
  1. IController
    2. 

 implementation.

In PureMVC, the 
  1. Controller
    2. 

 class follows the  'Command and Controller' strategy, and assumes these  responsibilities:  
Your application must register 
  1. ICommands
    2. 

 with the  Controller.
The simplest way is to subclass </code>Facade</code>,  and use its 
  1. initializeController
    2. 

 method to add your  registrations.





Tags:





  

    see:  org.puremvc.php.patterns.command.MacroCommand MacroCommand
  

  

    see:  org.puremvc.php.patterns.command.SimpleCommand SimpleCommand
  

  

    see:  org.puremvc.php.patterns.observer.Notification Notification
  

  

    see:  org.puremvc.php.patterns.observer.Observer Observer
  

  

    see:  org.puremvc.core.View View
  










[ Top ]







Class Variables



	
	

	
static $instance = 

	
[line 64]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$commandMap = 

	
[line 61]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$view = 

	
[line 58]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods



  

	
	
static method getInstance [line 114]

	

    

    

		static the getInstance(
)
    

    


	
		
  1. Controller
    2. 

 Singleton Factory method.





Tags:





  

    return:  Singleton instance of 
  1. Controller
    2. 


  

  

    access:  public
  









	
        
[ Top ]

  


  

	
	
method executeCommand [line 126]

	

    

    

		void executeCommand(

$note)
    

    


	
		If an 
  1. ICommand
    2. 

 has previously been registered  to handle a the given 
  1. INotification
    2. 

, then it is executed.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        note  
        $note  
        an 
  1. INotification
    2. 


      

        

    


        
[ Top ]

  

  

	
	
method hasCommand [line 155]

	

    

    

		whether hasCommand(
string
$notificationName)
    

    


	
		Check if a Command is registered for a given Notification





Tags:





  

    return:  a Command is currently registered for the given 
  1. notificationName
    2. 

.		
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $notificationName  
        
      

        

    


        
[ Top ]

  

  

	
	
method initializeController [line 104]

	

    

    

		void initializeController(
)
    

    


	
		Initialize the Singleton 
  1. Controller
    2. 

 instance.

Called automatically by the constructor.
Note that if you are using a subclass of 
  1. View
    2. 

  in your application, you should also subclass 
  1. Controller
    2. 

  and override the 
  1. initializeController
    2. 

 method in the  following way:
<listing>		// ensure that the Controller is talking to my IView implementation		override public function initializeController(  ) : void		{			view = MyView.getInstance();		} </listing>





Tags:





  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method registerCommand [line 144]

	

    

    

		void registerCommand(
notificationName
$notificationName, commandClassRef
$commandClassRef)
    

    


	
		Register a particular 
  1. ICommand
    2. 

 class as the handler for a particular 
  1. INotification
    2. 

.

If an 
  1. ICommand
    2. 

 has already been registered to  handle 
  1. INotification
    2. 

s with this name, it is no longer  used, the new 
  1. ICommand
    2. 

 is used instead.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

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


      

          

        commandClassRef  
        $commandClassRef  
        the 
  1. Class
    2. 

 of the 
  1. ICommand
    2. 


      

        

    


        
[ Top ]

  

  

	
	
method removeCommand [line 165]

	

    

    

		void removeCommand(
notificationName
$notificationName)
    

    


	
		Remove a previously registered 
  1. ICommand
    2. 

 to 
  1. INotification
    2. 

 mapping.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

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

 to remove the 
  1. ICommand
    2. 

 mapping for		
      

        

    


        
[ Top ]

  






        

		    

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