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

Class: ZNF_Config_ModulesConfig

Source Location: /Config/ModulesConfig.php

Class ZNF_Config_ModulesConfig

Class Overview

ZNF_Config_ModulesConfig contains the collection of static module configuration informations.

Returns the ZNF_Config_ModulesConfig object reference of a specified module with a singleton pattern.

Located in /Config/ModulesConfig.php [line 39]



		
				Author(s):
		
		
		API Tags:
Access:  public

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

Properties

Methods

[ Top ]
Property Summary
static mixed   $_modulesConfig   The array of ZNF_Config_ModulesConfig object references.
array   $_config   The array of the configuration file.

[ Top ]
Method Summary
static ZNF_Config_ModulesConfig   getInstance()   Returns the reference to the ZNF_Config_ModulesConfig object with a singleton pattern.
ZNF_Config_ModulesConfig   __construct()   Private constructor to avoid ZNF_Config_ModulesConfig object creation.
void   __destruct()   Destroys the ZNF_Config_ModulesConfig object.
array   findActionConfig()   Returns the action configuration for the defined path.
array   findFormBeanConfig()   Returns the form bean configuration for the defined name.
array   getGlobalForwardsConfig()   Returns the global forwards configuration.
void   _parseConfiguration()   Parses and validates the configuration file.
void   __clone()   Private clonator to avoid ZNF_Config_ModulesConfig object clonation.

[ Top ]
Properties
static mixed   $_modulesConfig [line 48]

The array of ZNF_Config_ModulesConfig object references.

API Tags:
Staticvar:  array $_modulesConfig:
Access:  protected


[ Top ]
array   $_config [line 56]

The array of the configuration file.

API Tags:
Access:  protected


[ Top ]
Methods
static method getInstance  [line 89]

  static ZNF_Config_ModulesConfig getInstance( array $appModuleConfig  )

Returns the reference to the ZNF_Config_ModulesConfig object with a singleton pattern.

This object is shared by all the classes that require the module configuration.

Parameters:
array   $appModuleConfig: 

API Tags:
Access:  public


[ Top ]
Constructor __construct  [line 64]

  ZNF_Config_ModulesConfig __construct( array $appModuleConfig  )

Private constructor to avoid ZNF_Config_ModulesConfig object creation.

Parameters:
array   $appModuleConfig:  The module's application configuration

API Tags:
Access:  private


[ Top ]
Destructor __destruct  [line 486]

  void __destruct( )

Destroys the ZNF_Config_ModulesConfig object.


API Tags:
Access:  public


[ Top ]
findActionConfig  [line 454]

  array findActionConfig( string $path  )

Returns the action configuration for the defined path.

Parameters:
string   $path: 

API Tags:
Access:  public


[ Top ]
findFormBeanConfig  [line 471]

  array findFormBeanConfig( string $name  )

Returns the form bean configuration for the defined name.

Parameters:
string   $name: 

API Tags:
Access:  public


[ Top ]
getGlobalForwardsConfig  [line 438]

  array getGlobalForwardsConfig( )

Returns the global forwards configuration.


API Tags:
Access:  public


[ Top ]
_parseConfiguration  [line 107]

  void _parseConfiguration( array $appModuleConfig  )

Parses and validates the configuration file.

For performance reasons implements a caching mechanism that serializes the configuration file in an internal structure.

Parameters:
array   $appModuleConfig: 

API Tags:
Access:  protected


[ Top ]
__clone  [line 74]

  void __clone( )

Private clonator to avoid ZNF_Config_ModulesConfig object clonation.


API Tags:
Access:  private


[ Top ]

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