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

Class: ZNF_Action_ActionMapping

Source Location: /Action/ActionMapping.php

Class ZNF_Action_ActionMapping

Class Overview

ZNF_Action_ActionMapping represents the informations that the controller ZNF_Action_RequestProcessor knows about the mapping.

The mapping is considered from a particular request to an instance of a particular ZNF_Action_Action class.

The ZNF_Action_ActionMapping instance used to select a particular ZNF_Action_Action is passed on to that ZNF_Action_Action, thereby providing access to any custom configuration taken from the module configuration file and included in the ZNF_Action_ActionMapping object.

Located in /Action/ActionMapping.php [line 45]



		
				Author(s):
		
		
		API Tags:
Access:  public

Information Tags:
Version:  SVN $Id: ActionMapping.php 43 2007-06-26 23:36:35Z aronnax $
Copyright:  2004-2007 The ZNF Development Team
Link:  http://www.zeronotice.org
Since:  Release 0.5.0
License:  LGPL

Properties

Methods

[ Top ]
Property Summary
string   $_forward   The forward attribute of the action element.
array   $_forwardsConfig   The forward elements of the action element.
array   $_globalForwardsConfig   The forward elements of the global-forwards element.
string   $_include   The include attribute of the action element.
string   $_input   The input attribute of the action element.
string   $_name   The name attribute of the action element.
string   $_nextPath   The nextPath attribute of the action element.
string   $_parameter   The parameter attribute of the action element.
string   $_parameterValue   The parameterValue attribute of the action element.
string   $_path   The path attribute of the action element.
string   $_roles   The roles attribute of the action element.
string   $_scope   The scope attribute of the action element.
string   $_type   The type attribute of the action element.
string   $_validate   The validate attribute of the action element.

[ Top ]
Method Summary
ZNF_Action_ActionMapping   __construct()   Constructs a new ZNF_Action_ActionMapping object.
void   __destruct()   Destroys the ZNF_Action_ActionMapping object.
void   addForwardsConfig()   Adds the forwards configuration.
void   addGlobalForwardsConfig()   Adds the global forwards configuration.
ZNF_Action_ActionForward   findForward()   Returns the ZNF_Action_ActionForward object defining how forwarding to the specified logical name should be handled.
string   getForward()   Returns the value of the forward property.
string   getInclude()   Returns the value of the include property.
string   getInput()   Returns the value of the input property.
string   getName()   Returns the value of the name property.
string   getNextPath()   Returns the value of the nextPath property.
string   getParameter()   Returns the value of the parameter property.
string   getParameterValue()   Returns the value of the parameterValue property.
string   getPath()   Returns the value of the path property.
string   getRoles()   Returns the value of the roles property.
string   getScope()   Returns the value of the scope property.
string   getType()   Returns the value of the type property.
string   getValidate()   Returns the value of the validate property.
void   setForward()   Sets the value of the forward property.
void   setInclude()   Sets the value of the include property.
void   setInput()   Sets the value of the input property.
void   setName()   Sets the value of the name property.
void   setNextPath()   Sets the value of the nextPath property.
void   setParameter()   Sets the value of the parameter property.
void   setParameterValue()   Sets the value of the parameterValue property.
void   setPath()   Sets the value of the path property.
void   setRoles()   Sets the value of the roles property.
void   setScope()   Sets the value of the scope property.
void   setType()   Sets the value of the type property.
void   setValidate()   Sets the value of the validate property.

[ Top ]
Properties
string   $_forward = null [line 54]

The forward attribute of the action element.

API Tags:
Access:  protected


[ Top ]
array   $_forwardsConfig = null [line 158]

The forward elements of the action element.

API Tags:
Access:  protected


[ Top ]
array   $_globalForwardsConfig = null [line 150]

The forward elements of the global-forwards element.

API Tags:
Access:  protected


[ Top ]
string   $_include = null [line 62]

The include attribute of the action element.

API Tags:
Access:  protected


[ Top ]
string   $_input = null [line 70]

The input attribute of the action element.

API Tags:
Access:  protected


[ Top ]
string   $_name = null [line 78]

The name attribute of the action element.

API Tags:
Access:  protected


[ Top ]
string   $_nextPath = null [line 86]

The nextPath attribute of the action element.

API Tags:
Access:  protected


[ Top ]
string   $_parameter = null [line 94]

The parameter attribute of the action element.

API Tags:
Access:  protected


[ Top ]
string   $_parameterValue = null [line 102]

The parameterValue attribute of the action element.

API Tags:
Access:  protected


[ Top ]
string   $_path = null [line 110]

The path attribute of the action element.

API Tags:
Access:  protected


[ Top ]
string   $_roles = null [line 118]

The roles attribute of the action element.

API Tags:
Access:  protected


[ Top ]
string   $_scope = null [line 126]

The scope attribute of the action element.

API Tags:
Access:  protected


[ Top ]
string   $_type = null [line 134]

The type attribute of the action element.

API Tags:
Access:  protected


[ Top ]
string   $_validate = null [line 142]

The validate attribute of the action element.

API Tags:
Access:  protected


[ Top ]
Methods
Constructor __construct  [line 167]

  ZNF_Action_ActionMapping __construct( array $actionConfig, array $globalForwardsConfig  )

Constructs a new ZNF_Action_ActionMapping object.

Parameters:
array   $actionConfig: 
array   $globalForwardsConfig: 

API Tags:
Access:  public


[ Top ]
Destructor __destruct  [line 504]

  void __destruct( )

Destroys the ZNF_Action_ActionMapping object.


API Tags:
Access:  public


[ Top ]
addForwardsConfig  [line 470]

  void addForwardsConfig( array $value  )

Adds the forwards configuration.

Parameters:
array   $value: 

API Tags:
Access:  protected


[ Top ]
addGlobalForwardsConfig  [line 459]

  void addGlobalForwardsConfig( array $value  )

Adds the global forwards configuration.

Parameters:
array   $value: 

API Tags:
Access:  protected


[ Top ]
findForward  [line 486]

  ZNF_Action_ActionForward findForward( string $name  )

Returns the ZNF_Action_ActionForward object defining how forwarding to the specified logical name should be handled.

This is performed by checking the application configuration for the specified forwarding configuration. If no forwarding configuration can be found returns null.

Parameters:
string   $name:  The result of the ZNF_Action_Action->execute() method

API Tags:
Access:  public


[ Top ]
getForward  [line 195]

  string getForward( )

Returns the value of the forward property.


API Tags:
Access:  public


[ Top ]
getInclude  [line 217]

  string getInclude( )

Returns the value of the include property.


API Tags:
Access:  public


[ Top ]
getInput  [line 239]

  string getInput( )

Returns the value of the input property.


API Tags:
Access:  public


[ Top ]
getName  [line 261]

  string getName( )

Returns the value of the name property.


API Tags:
Access:  public


[ Top ]
getNextPath  [line 283]

  string getNextPath( )

Returns the value of the nextPath property.


API Tags:
Access:  public


[ Top ]
getParameter  [line 305]

  string getParameter( )

Returns the value of the parameter property.


API Tags:
Access:  public


[ Top ]
getParameterValue  [line 327]

  string getParameterValue( )

Returns the value of the parameterValue property.


API Tags:
Access:  public


[ Top ]
getPath  [line 349]

  string getPath( )

Returns the value of the path property.


API Tags:
Access:  public


[ Top ]
getRoles  [line 371]

  string getRoles( )

Returns the value of the roles property.


API Tags:
Access:  public


[ Top ]
getScope  [line 393]

  string getScope( )

Returns the value of the scope property.


API Tags:
Access:  public


[ Top ]
getType  [line 415]

  string getType( )

Returns the value of the type property.


API Tags:
Access:  public


[ Top ]
getValidate  [line 437]

  string getValidate( )

Returns the value of the validate property.


API Tags:
Access:  public


[ Top ]
setForward  [line 206]

  void setForward( string $value  )

Sets the value of the forward property.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setInclude  [line 228]

  void setInclude( string $value  )

Sets the value of the include property.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setInput  [line 250]

  void setInput( string $value  )

Sets the value of the input property.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setName  [line 272]

  void setName( string $value  )

Sets the value of the name property.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setNextPath  [line 294]

  void setNextPath( string $value  )

Sets the value of the nextPath property.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setParameter  [line 316]

  void setParameter( string $value  )

Sets the value of the parameter property.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setParameterValue  [line 338]

  void setParameterValue( string $value  )

Sets the value of the parameterValue property.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setPath  [line 360]

  void setPath( string $value  )

Sets the value of the path property.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setRoles  [line 382]

  void setRoles( string $value  )

Sets the value of the roles property.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setScope  [line 404]

  void setScope( string $value  )

Sets the value of the scope property.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setType  [line 426]

  void setType( string $value  )

Sets the value of the type property.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setValidate  [line 448]

  void setValidate( string $value  )

Sets the value of the validate property.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]

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