phpDocumentor ZNF
Action
[ class tree: ZNF ] [ index: ZNF ] [ all elements ]

Class: ZNF_Action_RequestProcessor

Source Location: /Action/RequestProcessor.php

Class ZNF_Action_RequestProcessor

Class Overview

ZNF_Action_RequestProcessor contains the processing logic flow.

Subclasses can customize the request processing behavior overriding the methods for which they wish to provide modified functionality.

Located in /Action/RequestProcessor.php [line 47]



		
				Author(s):
		
		
		API Tags:
Access:  public

Information Tags:
Version:  SVN $Id: RequestProcessor.php 44 2007-07-22 23:55:30Z evolic $
Copyright:  2004-2007 The ZNF Development Team
Link:  http://www.zeronotice.org
Since:  Release 0.5.0
License:  LGPL

Properties

Methods

[ Top ]
Property Summary
array   $_appModuleConfig   The configuration of the module in the application configuration file.

[ Top ]
Method Summary
ZNF_Action_RequestProcessor   __construct()   Constructs a new ZNF_Action_RequestProcessor object.
void   __destruct()   Destroys the ZNF_Action_RequestProcessor object.
boolean   postProcess()   Instruction executed after the execution of the process method.
boolean   preProcess()   Instruction executed before the execution of the process method.
boolean   process()   Processes the action requested with the default processing flow.
ZNF_Action_Action   _processActionCreate()   Finds the ZNF_Action_Action class to handle the action.
ZNF_Action_ActionForm   _processActionForm()   If the name property of the ZNF_Action_ActionMapping is found constructs a ZNF_Action_ActionForm object to process the input data.
ZNF_Action_ActionForward   _processActionPerform()   Calls the ZNF_Action_Action->execute() method and returns the result to the ZNF_Action_RequestProcessor->process() method.
boolean   _processException()   Handles the exception.
boolean   _processForward()   If the forward attribute for the current action is found calls ZNF_Action_RequestProcessor->process() with the forward found and break the current proccess flow.
boolean   _processForwardConfig()   Forwards or redirects to the specified destination, by the specified mechanism.
ZNF_Action_ActionMapping   _processMapping()   Extracts the mapping of the action requested from the configuration file.
boolean   _processPopulate()   Populates internal properties of the ZNF_Action_ActionForm object with the input data.
boolean   _processRoles()   Validates the authorization of the user to access to the action requested.
boolean   _processValidate()   Validates input data.

[ Top ]
Properties
array   $_appModuleConfig [line 56]

The configuration of the module in the application configuration file.

API Tags:
Access:  protected


[ Top ]
Methods
Constructor __construct  [line 64]

  ZNF_Action_RequestProcessor __construct( String $module  )

Constructs a new ZNF_Action_RequestProcessor object.

Parameters:
String   $module:  Name of the module requested

API Tags:
Access:  public


[ Top ]
Destructor __destruct  [line 620]

  void __destruct( )

Destroys the ZNF_Action_RequestProcessor object.


API Tags:
Access:  public


[ Top ]
postProcess  [line 89]

  boolean postProcess( )

Instruction executed after the execution of the process method.


API Tags:
Access:  public


[ Top ]
preProcess  [line 78]

  boolean preProcess( )

Instruction executed before the execution of the process method.


API Tags:
Access:  public


[ Top ]
process  [line 101]

  boolean process( string $path  )

Processes the action requested with the default processing flow.

Parameters:
string   $path: 

API Tags:
Access:  public


[ Top ]
_processActionCreate  [line 484]

  ZNF_Action_Action _processActionCreate( ZNF_Action_ActionMapping $mapping  )

Finds the ZNF_Action_Action class to handle the action.

Constructs an instance and returns it to the ZNF_Action_RequestProcessor->process() method.

Parameters:
ZNF_Action_ActionMapping   $mapping: 

API Tags:
Access:  protected


[ Top ]
_processActionForm  [line 290]

  ZNF_Action_ActionForm _processActionForm( ZNF_Action_ActionMapping $mapping  )

If the name property of the ZNF_Action_ActionMapping is found constructs a ZNF_Action_ActionForm object to process the input data.

If the package of which the ZNF_Action_ActionForm class belongs is not found a ZNF_Action_RequestProcessorException is raised.

Parameters:
ZNF_Action_ActionMapping   $mapping: 

API Tags:
Access:  protected


[ Top ]
_processActionPerform  [line 509]

  ZNF_Action_ActionForward _processActionPerform( ZNF_Action_Action $action, ZNF_Action_ActionForm $form, ZNF_Action_ActionMapping $mapping  )

Calls the ZNF_Action_Action->execute() method and returns the result to the ZNF_Action_RequestProcessor->process() method.

Parameters:
ZNF_Action_Action   $action: 
ZNF_Action_ActionForm   $form: 
ZNF_Action_ActionMapping   $mapping: 

API Tags:
Access:  protected


[ Top ]
_processException  [line 609]

  boolean _processException( Exception $e, ZNF_Action_ActionForm $form, ZNF_Action_ActionMapping $mapping  )

Handles the exception.

Parameters:
Exception   $e: 
ZNF_Action_ActionForm   $form: 
ZNF_Action_ActionMapping   $mapping: 

API Tags:
Access:  protected


[ Top ]
_processForward  [line 432]

  boolean _processForward( ZNF_Action_ActionMapping $mapping  )

If the forward attribute for the current action is found calls ZNF_Action_RequestProcessor->process() with the forward found and break the current proccess flow.

Parameters:
ZNF_Action_ActionMapping   $mapping: 

API Tags:
Access:  protected


[ Top ]
_processForwardConfig  [line 523]

  boolean _processForwardConfig( ZNF_Action_ActionForward $forward, ZNF_Action_ActionForm $form, ZNF_Action_ActionMapping $mapping  )

Forwards or redirects to the specified destination, by the specified mechanism.

Parameters:
ZNF_Action_ActionForward   $forward: 
ZNF_Action_ActionForm   $form: 
ZNF_Action_ActionMapping   $mapping: 

API Tags:
Access:  protected


[ Top ]
_processMapping  [line 147]

  ZNF_Action_ActionMapping _processMapping( string $path  )

Extracts the mapping of the action requested from the configuration file.

Parameters:
string   $path: 

API Tags:
Access:  protected


[ Top ]
_processPopulate  [line 358]

  boolean _processPopulate( ZNF_Action_ActionForm $form  )

Populates internal properties of the ZNF_Action_ActionForm object with the input data.

Parameters:
ZNF_Action_ActionForm   $form: 

API Tags:
Access:  protected


[ Top ]
_processRoles  [line 171]

  boolean _processRoles( ZNF_Action_ActionMapping $mapping  )

Validates the authorization of the user to access to the action requested.

Parameters:
ZNF_Action_ActionMapping   $mapping: 

API Tags:
Access:  protected


[ Top ]
_processValidate  [line 376]

  boolean _processValidate( ZNF_Action_ActionForm $form, ZNF_Action_ActionMapping $mapping  )

Validates input data.

Parameters:
ZNF_Action_ActionForm   $form: 
ZNF_Action_ActionMapping   $mapping: 

API Tags:
Access:  protected


[ Top ]

Documentation generated on Wed, 14 Nov 2007 23:47:40 +0100 by phpDocumentor 1.4.0