Docs For Class PHRUTS

Class PHRUTS_ActionConfig

Description

A PHPBean representing the configuration information of an <action> element from a PHruts module configuration file.

author: John WILDENAUER <jwilde@users.sourceforge.net> (PHP4 port of Struts)
author: Olivier HENRY <oliv.henry@gmail.com> (PHP5 port of Struts)
version: $Id: PHRUTS_ActionConfig.php,v 1.6 2008/05/28 13:27:34 ohenry Exp $
copyright: Copyright PHruts 2008

Located in /config/PHRUTS_ActionConfig.php (line 31)

Variable Summary

string $attribute

boolean $configured

string $forward

array $forwards

string $include

string $input

PHRUTS_ModuleConfig $moduleConfig

string $name

string $parameter

string $path

string $prefix

array $roleNames

string $roles

string $scope

string $suffix

string $type

boolean $unknown

boolean $validate

Method Summary

void addForwardConfig (PHRUTS_ForwardConfig $config)

PHRUTS_ForwardConfig findForwardConfig (string $name)

array findForwardConfigs ()

void freeze ()

string getAttribute ()

string getForward ()

string getInclude ()

string getInput ()

PHRUTS_ModuleConfig getModuleConfig ()

string getName ()

string getParameter ()

string getPath ()

string getPrefix ()

array getRoleNames ()

string getRoles ()

string getScope ()

string getSuffix ()

string getType ()

boolean getUnknown ()

boolean getValidate ()

void removeForwardConfig (PHRUTS_ForwardConfig $config)

void setAttribute (string $attribute)

void setForward (string $forward)

void setInclude (string $include)

void setInput (string $input)

void setModuleConfig (PHRUTS_ModuleConfig $moduleConfig)

void setName (string $name)

void setParameter (string $parameter)

void setPath (string $path)

void setPrefix (string $prefix)

void setRoles (string $roles)

void setScope (string $scope)

void setSuffix (string $suffix)

void setType (string $type)

void setUnknown (boolean $unknown)

void setValidate (boolean $validate)

string __toString ()

Variables

string $attribute = null (line 87)

The request-scope or session-scope attribute name under which our form bean is accessed, if it is different from the form bean's specified name.

access: protected

boolean $configured = false (line 37)

Has this component been completely configured?

access: protected

string $forward = null (line 129)

Context-relative path of the web application resource that will process this request via PHRUTS_RequestDispatcher->doForward(), instead of instantiating and calling the PHRUTS_Action class specified by "type".

Exactly one of forward, include, or type must be specified.

access: protected

array $forwards = array() (line 598)

The set of local forward configurations for this action, if any, keyed by the name property.

access: protected

string $include = null (line 168)

Context-relative path of the web application resource that will process this request via PHRUTS_RequestDispatcher->doInclude(), instead of instantiating and calling the PHRUTS_Action class specified by "type".

Exactly one of forward, include, or type must be specified.

access: protected

string $input = null (line 207)

Context-relative path of the input form to which control should be returned if a validation error is encountered.

Required if "name" is specified and the input bean returns validation errors.

access: protected

PHRUTS_ModuleConfig $moduleConfig = null (line 56)

The module configuration with which we are associated.

access: protected

string $name = null (line 243)

Name of the form bean, if any, associated with this Action.

access: protected

string $parameter = null (line 275)

General purpose configuration parameter that can be used to pass extra information to the PHRUTS_Action instance selected by this Action.

PHruts does not itself use this value in any way.

access: protected

string $path = null (line 311)

Context-relative path of the submitted request, starting with a slash ("/") character.

access: protected

string $prefix = null (line 343)

Prefix used to match request parameter names to form bean property names, if any.

access: protected

array $roleNames = array() (line 420)

The set of security role names used to authorize access to this Action, as an array for faster access.

access: protected

string $roles = null (line 376)

Comma-delimited list of security role names allowed to request this Action.

access: protected

string $scope = 'session' (line 437)

Identifier of the scope ("request" or "session") within which our form bean is accessed, if any.

access: protected

string $suffix = null (line 470)

Suffix used to match request parameter names to form bean property names, if any.

access: protected

string $type = null (line 506)

Fully qualified PHP class name of the PHRUTS_Action class to be used to process requests for this mapping if the forward and include properties are not set.

Exactly one of forward, include, or type must be specified.

access: protected

boolean $unknown = false (line 531)

Indicate Action be configured as default one for this module, when true.

access: protected

boolean $validate = true (line 567)

Should the validate method of the form bean associated with this action be called?

access: protected

Methods

addForwardConfig (line 608)

Add a new PHRUTS_ForwardConfig instance to the set of global forwards associated with this action.

throws: PHRUTS_IllegalStateException
access: public

void addForwardConfig (PHRUTS_ForwardConfig $config)

PHRUTS_ForwardConfig $config: The new configuration instance to be added

findForwardConfig (line 622)

Return the forward configuration for the specified key, if any; otherwise return null.

access: public

PHRUTS_ForwardConfig findForwardConfig (string $name)

string $name: Name of the forward configuration to return

findForwardConfigs (line 639)

Return all forward configurations for this Action.

If there are none, a zero-length array is returned.

access: public

array findForwardConfigs ()

freeze (line 42)

Freeze the configuration of this action.

access: public

void freeze ()

getAttribute (line 96)

Return the request-scope or session-scope attribute name under which our form bean is accessed, if it is different from the form bean's specified name.

return: Attribute name under which our form bean is accessed.
access: public

string getAttribute ()

getForward (line 138)

Return context-relative path of the web application resource that will process this request.

return: Context-relative path of the web application resource that will process this request.
access: public

string getForward ()

getInclude (line 177)

Context-relative path of the web application resource that will process this request.

return: Context-relative path of the web application resource that will process this request.
access: public

string getInclude ()

getInput (line 216)

Get the context-relative path of the input form to which control should be returned if a validation error is encountered.

return: Context-relative path of the input form to which control should be returned if a validation error is encountered.
access: public

string getInput ()

getModuleConfig (line 63)

The module configuration with which we are associated.

access: public

PHRUTS_ModuleConfig getModuleConfig ()

getName (line 250)

Return name of the form bean, if any, associated with this Action.

access: public

string getName ()

getParameter (line 285)

Return general purpose configuration parameter that can be used to pass extra information to the PHRUTS_Action instance selected by this Action.

PHruts does not itself use this value in any way.

access: public

string getParameter ()

getPath (line 319)

Return context-relative path of the submitted request, starting with a slash ("/") character.

access: public

string getPath ()

getPrefix (line 351)

Return prefix used to match request parameter names to form bean property names, if any.

access: public

string getPrefix ()

getRoleNames (line 427)

Get array of security role names used to authorize access to this Action.

access: public

array getRoleNames ()

getRoles (line 381)

access: public

string getRoles ()

getScope (line 445)

Get the scope ("request" or "session") within which our form bean is accessed, if any.

access: public

string getScope ()

getSuffix (line 478)

Return suffix used to match request parameter names to form bean property names, if any.

access: public

string getSuffix ()

getType (line 511)

access: public

string getType ()

getUnknown (line 538)

Determine whether Action is configured as the default one for this module.

access: public

boolean getUnknown ()

getValidate (line 572)

access: public

boolean getValidate ()

removeForwardConfig (line 651)

Remove the specified forward configuration instance.

throws: PHRUTS_IllegalStateException
access: public

void removeForwardConfig (PHRUTS_ForwardConfig $config)

PHRUTS_ForwardConfig $config: ForwardConfig instance to be removed

setAttribute (line 113)

Set the request-scope or session-scope attribute name under which our form bean is accessed, if it is different from the form bean's specified name.

throws: PHRUTS_IllegalStateException
access: public

void setAttribute (string $attribute)

string $attribute: The request-scope or session-scope attribute name under which our form bean is accessed.

setForward (line 152)

Set the context-relative path of the web application resource that will process this request.

Exactly one of forward, include or type must be specified.

throws: PHRUTS_IllegalStateException
access: public

void setForward (string $forward)

string $forward: Context-relative path of the web application resource that will process this request.

setInclude (line 191)

Set context-relative path of the web application resource that will process this request.

Exactly one of forward, include or type must be specified.

throws: PHRUTS_IllegalStateException
access: public

void setInclude (string $include)

string $include: Context-relative path of the web application resource that will process this request.

setInput (line 231)

Set the context-relative path of the input form to which control should be returned if a validation error is encountered.

Required if "name" is specified and the input bean returns validation errors.

throws: PHRUTS_IllegalStateException
access: public

void setInput (string $input)

string $input: Context-relative path of the input form to which control should be returned if a validation error is encountered.

setModuleConfig (line 73)

The module configuration with which we are associated.

throws: PHRUTS_IllegalStateException
access: public

void setModuleConfig (PHRUTS_ModuleConfig $moduleConfig)

PHRUTS_ModuleConfig $moduleConfig

setName (line 260)

Set the name of the form bean, if any, associated with this Action.

throws: PHRUTS_IllegalStateException
access: public

void setName (string $name)

string $name: Name of the bean associated with this Action.

setParameter (line 298)

General purpose configuration parameter that can be used to pass extra information to the PHRUTS_Action instance selected by this Action.

PHruts does not itself use this value in any way.

throws: PHRUTS_IllegalStateException
access: public

void setParameter (string $parameter)

string $parameter: General purpose configuration parameter.

setPath (line 330)

Set context-relative path of the submitted request, starting with a slash ("/") character.

throws: PHRUTS_IllegalStateException
access: public

void setPath (string $path)

string $path: Context-relative path of the submitted request.

setPrefix (line 363)

Set prefix used to match request parameter names to form bean property names, if any.

throws: PHRUTS_IllegalStateException
access: public

void setPrefix (string $prefix)

string $prefix: Prefix used to match request parameter names to form bean property names, if any.

setRoles (line 389)

throws: PHRUTS_IllegalStateException
access: public

void setRoles (string $roles)

string $roles

setScope (line 457)

Set the scope ("request" or "session") within which our form bean is accessed, if any.

throws: PHRUTS_IllegalStateException
access: public

void setScope (string $scope)

string $scope: Scope ("request" or "session") within which our form bean is accessed, if any.

setSuffix (line 490)

Set suffix used to match request parameter names to form bean property names, if any.

throws: PHRUTS_IllegalStateException
access: public

void setSuffix (string $suffix)

string $suffix: Suffix used to match request parameter names to form bean property names, if any.

setType (line 519)

throws: PHRUTS_IllegalStateException
access: public

void setType (string $type)

string $type

setUnknown (line 549)

Set whether Action is configured as the default one for this module.

throws: PHRUTS_IllegalStateException
access: public

void setUnknown (boolean $unknown)

boolean $unknown: Indicates Action is configured as the default one for this module, when true.

setValidate (line 580)

throws: PHRUTS_IllegalStateException
access: public

void setValidate (boolean $validate)

boolean $validate

__toString (line 663)

Return a string representation of this object.

access: public

string __toString ()

Documentation generated on Sat, 31 May 2008 15:45:47 +0200 by phpDocumentor 1.4.1