mojavi
[ class tree: mojavi ] [ index: mojavi ] [ all elements ]
Packages:
mojavi


Files:
Action.class.php
ActionChain.class.php
Appender.class.php
Controller.class.php
ExecutionChain.class.php
ExecutionFilter.class.php
Filter.class.php
FilterChain.class.php
FilterList.class.php
Layout.class.php
Logger.class.php
LogManager.class.php
Message.class.php
Renderer.class.php
Request.class.php
User.class.php
Validator.class.php
ValidatorManager.class.php
View.class.php

Classes:
Action
ActionChain
Appender
Controller
ExecutionChain
ExecutionFilter
Filter
FilterChain
FilterList
Layout
Logger
LogManager
Message
Renderer
Request
User
Validator
ValidatorManager
View

Class: ActionChain

Source Location: /ActionChain.class.php

Class Overview




An ActionChain implementation allows you to execute multiple actions and  retrieve their results. This makes it a prime candidate for retrieving  information from external Action implementations.




Author(s):


    
                
  • Sean Kerr
    • 
      





        







Methods

















Inherited Variables





Inherited Methods














Class Details



[line 27]

An ActionChain implementation allows you to execute multiple actions and  retrieve their results. This makes it a prime candidate for retrieving  information from external Action implementations.



<note>      This class does not need to be included. It is part of the main library.  </note>





Tags:





  

    since:  2.0
  

  

    author:  Sean Kerr
  










[ Top ]








Class Methods



  

	
	
constructor ActionChain [line 55]

	

    

    

		ActionChain &ActionChain(
)
    

    


	
		Create a new ActionChain instance.





Tags:





  

    since:  2.0
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method execute [line 79]

	

    

    

		void execute(
Controller
&$controller, Request
&$request, User
&$user)
    

    


	
		Execute all registered actions.



<note>      This method should never be called manually.  </note>





Tags:





  

    since:  2.0
  

  

    access:  public
  












        
Parameters:

    

    

          

        Controller  
        &$controller  
        A Controller instance.
      

          

        Request  
        &$request  
        A Request instance.
      

          

        User  
        &$user  
        A User instance.
      

        

    


        
[ Top ]

  

  

	
	
method fetchResult [line 196]

	

    

    

		string &fetchResult(
string
$regName)
    

    


	
		Fetch the result of an executed action.





Tags:





  

    return:  A rendered view, if the given action exists and did render                 a view, otherwise NULL.
  

  

    since:  2.0
  

  

    access:  public
  












        
Parameters:

    

    

          

        string  
        $regName  
        An action registration name.
      

        

    


        
[ Top ]

  

  

	
	
method register [line 221]

	

    

    

		void register(
string
$regName, string
$modName, string
$actName, [array
$params = NULL])
    

    


	
		Register an action with the chain.





Tags:





  

    since:  2.0
  

  

    access:  public
  












        
Parameters:

    

    

          

        string  
        $regName  
        An action registration name.
      

          

        string  
        $modName  
        A module name.
      

          

        string  
        $actName  
        An action name.
      

          

        array  
        $params  
        An associative array of temporary request parameters.
      

        

    


        
[ Top ]

  

  

	
	
method setPreserve [line 238]

	

    

    

		void setPreserve(
bool
$preserve)
    

    


	
		Set the parameter preservation status.





Tags:





  

    since:  2.0
  

  

    access:  public
  












        
Parameters:

    

    

          

        bool  
        $preserve  
        A preservation status.
      

        

    


        
[ Top ]

  





        

		    

		    Documentation generated on Wed, 15 Jun 2005 11:43:17 +0900 by phpDocumentor 1.2.3