Docs For Class PHRUTS

Class PHRUTS_ModuleConfig

Description

The collection of static configuration information that describes a PHruts-based module.

Multiple modules are identified by a <em>prefix</em> in the request URI. If no module prefix can be matched, the default configuration (with a prefix equal to a zero-length string) is selected.

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_ModuleConfig.php,v 1.6 2008/05/28 15:52:27 ohenry Exp $
copyright: Copyright PHruts 2008

Located in /config/PHRUTS_ModuleConfig.php (line 43)

Variable Summary

string $actionConfigClass

array $actionConfigs

boolean $configured

PHRUTS_ControllerConfig $controllerConfig

array $dataSources

array $formBeans

array $forwards

array $messageResources

array $plugIns

string $prefix

Method Summary

PHRUTS_ModuleConfig __construct (string $prefix)

void addActionConfig (PHRUTS_ActionConfig $config)

void addDataSourceConfig (PHRUTS_DataSourceConfig $config)

void addFormBeanConfig (PHRUTS_FormBeanConfig $config)

void addForwardConfig (PHRUTS_ForwardConfig $config)

void addMessageResourcesConfig (PHRUTS_MessageResourcesConfig $config)

void addPlugInConfig (PHRUTS_PlugInConfig $plugInConfig)

PHRUTS_ActionConfig findActionConfig (string $path)

array findActionConfigs ()

PHRUTS_DataSourceConfig findDataSourceConfig (string $key)

array findDataSourceConfigs ()

PHRUTS_FormBeanConfig findFormBeanConfig (string $name)

array findFormBeanConfigs ()

PHRUTS_ForwardConfig findForwardConfig (string $name)

array findForwardConfigs ()

PHRUTS_MessageResourcesConfig findMessageResourcesConfig (string $key)

array findMessageResourcesConfigs ()

array findPlugInConfigs ()

void freeze ()

string getActionConfigClass ()

boolean getConfigured ()

PHRUTS_ControllerConfig getControllerConfig ()

string getPrefix ()

void removeActionConfig (PHRUTS_ActionConfig $config)

void removeDataSourceConfig (PHRUTS_DataSourceConfig $config)

void removeFormBeanConfig (PHRUTS_FormBeanConfig $config)

void removeForwardConfig (PHRUTS_ForwardConfig $config)

void removeMessageResourcesConfig (PHRUTS_MessageResourcesConfig $config)

void setActionConfigClass (string $actionConfigClass)

void setControllerConfig (PHRUTS_ControllerConfig $cc)

void setPrefix (string $prefix)

Variables

string $actionConfigClass = 'phruts::config::PHRUTS_ActionConfig' (line 126)

The default class name to be used when creating action config instances.

access: protected

array $actionConfigs = array() (line 57)

The set of action configurations for this module, if any, keyed by the path property.

access: protected

boolean $configured = false (line 107)

Has this application been completely configured yet.

Once this flag has been set, any attempt to modify the configuration will return an PHRUTS_IllegalStateException.

access: protected

PHRUTS_ControllerConfig $controllerConfig = null (line 49)

The controller configuration object for this module

access: protected

array $dataSources = array() (line 89)

The set of data source configurations for this module, if any, keyed by the key property.

access: protected

array $formBeans = array() (line 65)

The set of form bean configurations for this module, if any, keyed by the name property.

access: protected

array $forwards = array() (line 73)

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

access: protected

array $messageResources = array() (line 81)

The set of message resources configurations for this module, if any, keyed by the key property.

access: protected

array $plugIns = array() (line 97)

The set of configured plug-in Actions for this module, if any, in the order they were declared and configured.

access: protected

string $prefix = null (line 119)

The prefix of the context-relative portion of the request URI, used to select this configuration versus others supported by the controller service.

A configuration with a prefix of a zero-length string is the default configuration for this web module.

access: protected

Methods

Constructor __construct (line 132)

access: public

PHRUTS_ModuleConfig __construct (string $prefix)

string $prefix: The prefix of the context-relative portion of the request URI.

addActionConfig (line 238)

Add a new PHRUTS_ActionConfig instance to the set associated with this module.

throws: PHRUTS_IllegalStateException - If this module configuration has been frozen
access: public

void addActionConfig (PHRUTS_ActionConfig $config)

PHRUTS_ActionConfig $config: The new configuration instance to be added

addDataSourceConfig (line 304)

Add a new PHRUTS_DataSourceConfig instance to the set associated with this module.

throws: PHRUTS_IllegalStateException - If this module configuration has been frozen
access: public

void addDataSourceConfig (PHRUTS_DataSourceConfig $config)

PHRUTS_DataSourceConfig $config: The new configuration instance to be added

addFormBeanConfig (line 255)

Add a new PHRUTS_FormBeanConfig instance to the set associated with this module.

throws: PHRUTS_IllegalStateException - If this module configuration has been frozen
access: public

void addFormBeanConfig (PHRUTS_FormBeanConfig $config)

PHRUTS_FormBeanConfig $config: The new configuration instance to be added

addForwardConfig (line 271)

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

throws: PHRUTS_IllegalStateException - If this module configuration has been frozen
access: public

void addForwardConfig (PHRUTS_ForwardConfig $config)

PHRUTS_ForwardConfig $config: The new configuration instance to be added

addMessageResourcesConfig (line 287)

Add a new PHRUTS_MessageResourcesConfig instance to the set associated with this module.

throws: PHRUTS_IllegalStateException - If this module configuration has been frozen
access: public

void addMessageResourcesConfig (PHRUTS_MessageResourcesConfig $config)

PHRUTS_MessageResourcesConfig $config: The new configuration instance to be added

addPlugInConfig (line 320)

Add a newly configured PHRUTS_PlugInConfig instance to the set of plug-in Actions for this module.

throws: PHRUTS_IllegalStateException - If this module configuration has been frozen
access: public

void addPlugInConfig (PHRUTS_PlugInConfig $plugInConfig)

PHRUTS_PlugInConfig $plugInConfig: The new configuration instance to be added

findActionConfig (line 334)

Return the action configuration for the specified path, if any; otherwise return null.

access: public

PHRUTS_ActionConfig findActionConfig (string $path)

string $path: The path of the action configuration to return

findActionConfigs (line 351)

Return the action configurations for this module.

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

access: public

array findActionConfigs ()

findDataSourceConfig (line 446)

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

access: public

PHRUTS_DataSourceConfig findDataSourceConfig (string $key)

string $key: Key of the data source configuration to return

findDataSourceConfigs (line 463)

Return the data source configurations for this module.

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

access: public

array findDataSourceConfigs ()

findFormBeanConfig (line 362)

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

access: public

PHRUTS_FormBeanConfig findFormBeanConfig (string $name)

string $name: Name of the form bean configuration to return

findFormBeanConfigs (line 379)

Return the form bean configurations for this module.

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

access: public

array findFormBeanConfigs ()

findForwardConfig (line 390)

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 407)

Return the forward configurations for this module.

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

access: public

array findForwardConfigs ()

findMessageResourcesConfig (line 418)

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

access: public

PHRUTS_MessageResourcesConfig findMessageResourcesConfig (string $key)

string $key: Key of the data source configuration to return

findMessageResourcesConfigs (line 435)

Return the message resources configurations for this module.

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

access: public

array findMessageResourcesConfigs ()

findPlugInConfigs (line 474)

Return the configured plug-in actions for this module.

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

access: public

array findPlugInConfigs ()

freeze (line 484)

Freeze the configuration of this module.

After this method returns, any attempt to modify the configuration will return an IllegalStateException.

access: public

void freeze ()

getActionConfigClass (line 213)

The default class name to be used when creating action config instances.

access: public

string getActionConfigClass ()

getConfigured (line 144)

Has this module been completely configured yet.

Once this flag has been set, any attempt to modify the configuration will return an IllegalStateException.

access: public

boolean getConfigured ()

getControllerConfig (line 153)

The controller configuration object for this module.

access: public

PHRUTS_ControllerConfig getControllerConfig ()

getPrefix (line 185)

The prefix of the context-relative portion of the request URI, used to select this configuration versus others supported by the controller service.

A configuration with a prefix of a zero-length string is the default configuration for this web module.

access: public

string getPrefix ()

removeActionConfig (line 528)

Remove the specified action configuration instance.

throws: PHRUTS_IllegalStateException - If this module configuration has been frozen
access: public

void removeActionConfig (PHRUTS_ActionConfig $config)

PHRUTS_ActionConfig $config: PHRUTS_ActionConfig instance to be removed

removeDataSourceConfig (line 589)

Remove the specified data source configuration instance.

throws: PHRUTS_IllegalStateException - If this module configuration has been frozen
access: public

void removeDataSourceConfig (PHRUTS_DataSourceConfig $config)

PHRUTS_DataSourceConfig $config: PHRUTS_DataSourceConfig instance to be removed

removeFormBeanConfig (line 543)

Remove the specified form bean configuration instance.

throws: PHRUTS_IllegalStateException - If this module configuration has been frozen
access: public

void removeFormBeanConfig (PHRUTS_FormBeanConfig $config)

PHRUTS_FormBeanConfig $config: PHRUTS_FormBeanConfig instance to be removed

removeForwardConfig (line 558)

Remove the specified forward configuration instance.

throws: PHRUTS_IllegalStateException - If this module configuration has been frozen
access: public

void removeForwardConfig (PHRUTS_ForwardConfig $config)

PHRUTS_ForwardConfig $config: PHRUTS_ForwardConfig instance to be removed

removeMessageResourcesConfig (line 573)

Remove the specified message resources configuration instance.

throws: PHRUTS_IllegalStateException - If this module configuration has been frozen
access: public

void removeMessageResourcesConfig (PHRUTS_MessageResourcesConfig $config)

PHRUTS_MessageResourcesConfig $config: PHRUTS_MessageResourcesConfig instance to be removed

setActionConfigClass (line 225)

The default class name to be used when creating action config instances.

throws: PHRUTS_IllegalStateException - If this module configuration has been frozen
access: public

void setActionConfigClass (string $actionConfigClass)

string $actionConfigClass: Default class name to be used when creating action config instances.

setControllerConfig (line 168)

The controller configuration object for this module.

throws: PHRUTS_IllegalStateException - If this module configuration has been frozen
access: public

void setControllerConfig (PHRUTS_ControllerConfig $cc)

PHRUTS_ControllerConfig $cc: The controller configuration object for this module.

setPrefix (line 201)

The prefix of the context-relative portion of the request URI, used to select this configuration versus others supported by the controller service.

A configuration with a prefix of a zero-length string is the default configuration for this web module.

throws: PHRUTS_IllegalStateException - If this module configuration has been frozen
access: public

void setPrefix (string $prefix)

string $prefix

Documentation generated on Sat, 31 May 2008 15:46:23 +0200 by phpDocumentor 1.4.1