mvc.controller
[ class tree: mvc.controller ] [ index: mvc.controller ] [ all elements ]
Packages:
default
common.cache
common.container
common.controller.flow
common.datasource
common.datastructure
common.helper.dsn
common.logger
common.logger.appender
common.logger.layout
common.reader
common.storage
common.validator
Mojavi
mvc.controller
package.loader


Files:
ActionController.class.php

Classes:
ActionController
DynamicResponseActionController

Class: ActionController

Source Location: /mvc/controller/action/ActionController.class.php

Class Overview




Base 'Action' controller class




Author(s):


    
                      
  • Tyler Tompkins (ttompkins@mojavi.org)
    • 
      





            






Variables







Methods















Child classes:






DynamicResponseActionController

	

















Class Details



[line 19]

Base 'Action' controller class





Tags:





  

    abstract:  
  

  

    since:  4.0.0  $Id: ActionController.class.php 973 2006-01-25 20:43:58Z illusina $
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










[ Top ]







Class Variables



	
	

	
$controller =  null

	
[line 30]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$messenger =  null

	
[line 29]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$module =  null

	
[line 31]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$request =  null

	
[line 26]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$response =  null

	
[line 28]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$sl =  null

	
[line 25]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$user =  null

	
[line 27]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor __construct [line 43]

	

    

    

		array __construct(
ServiceLocator
$sl, Module
$module)
    

    


	
		Construct the Action





Tags:





  

    return:  An array of credentials
  

  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  









	
Overridden in child classes as:

		

	
DynamicResponseActionController::__construct()

		

	

	


        
[ Top ]

  

  

	
	
method execute [line 104]

	

    

    

		string execute(
Request
$req, Response
$res)
    

    


	
		Execute this Action





Tags:





  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  









	
Overridden in child classes as:

		

	
DynamicResponseActionController::execute()

		
Execute this Action

	

	


        
Parameters:

    

    

          

        ServiceLocator  
        $req  
        A ServiceLocator instance to execute against
      

        

    


        
[ Top ]

  

  

	
	
method getComponents [line 158]

	

    

    

		array &getComponents(
)
    

    


	
		Register Components for this Action





Tags:





  

    return:  An associative array of Action => array(Parameters)
  

  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










        
[ Top ]

  

  

	
	
method getCredentials [line 66]

	

    

    

		array getCredentials(
)
    

    


	
		Retrieve the required credentials for Action execution





Tags:





  

    return:  An array of credentials
  

  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










        
[ Top ]

  

  

	
	
method getFilters [line 177]

	

    

    

		array &getFilters(
)
    

    


	
		Register Filters for this Action





Tags:





  

    return:  An associative array of Filter => array(Parameters)
  

  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










        
[ Top ]

  

  

	
	
method getModule [line 191]

	

    

    

		Module getModule(
)
    

    


	
		Retrieve this controller's module





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getRules [line 122]

	

    

    

		array getRules(
)
    

    


	
		Register rules for this Action





Tags:





  

    return:  An associative array of target => rule
  

  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










        
[ Top ]

  

  

	
	
method handleError [line 141]

	

    

    

		string handleError(
[mixed
$code = 0])
    

    


	
		Register rules for this Action





Tags:





  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










        
[ Top ]

  

  

	
	
method isSecure [line 85]

	

    

    

		bool isSecure(
)
    

    


	
		Retrieve the required credentials for Action execution





Tags:





  

    return:  True if secure, false otherwise
  

  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










        
[ Top ]

  

  

	
	
method validate [line 209]

	

    

    

		bool validate(
)
    

    


	
		Run validation for this Action





Tags:





  

    return:  True on success, otherwise return false or an error code               to be passed to handleError
  

  

    access:  public
  

  

    since:  4.0.0
  

  

    author:  Tyler Tompkins (ttompkins@mojavi.org)
  










        
[ Top ]

  






        

		    

		    Documentation generated on Tue, 21 Feb 2006 02:29:36 +0900 by phpDocumentor 1.3.0RC5