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

Class: ZNF_Config_AppConfig

Source Location: /Config/AppConfig.php

Class ZNF_Config_AppConfig

Class Overview

ZNF_Config_AppConfig contains the collection of static application configuration informations.

Returns the ZNF_Config_AppConfig object reference with a singleton pattern.

Located in /Config/AppConfig.php [line 41]



		
				Author(s):
		
		
		API Tags:
Access:  public

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

Properties

Methods

[ Top ]
Constant Summary
CONFIG_FILE   Name of the configuration file.

[ Top ]
Property Summary
static mixed   $_appConfig   The ZNF_Config_AppConfig object reference.
array   $_config   The array of the configuration file.

[ Top ]
Method Summary
static ZNF_Config_AppConfig   getInstance()   Returns the reference to the ZNF_Config_AppConfig object with a singleton pattern.
ZNF_Config_AppConfig   __construct()   Private constructor to avoid ZNF_Config_AppConfig object creation.
void   __destruct()   Destroys the ZNF_Config_AppConfig object.
array   findAuthConfig()   Returns the authentication configuration.
array   findModule()   Returns the module for the defined name.
array   findWrongAuthConfig()   Returns the wrong authentication configuration.
string   getLang()   Returns the application lang.
string   getLangAutodetect()   Returns the application autodetected language.
string   getLocale()   Returns the application locale.
string   getSessionId()   Returns the application session ID.
string   getTheme()   Returns the application theme.
void   _parseConfiguration()   Parses and validates the configuration file.
void   __clone()   Private clonator to avoid ZNF_Config_AppConfig object clonation.

[ Top ]
Properties
static mixed   $_appConfig [line 55]

The ZNF_Config_AppConfig object reference.

API Tags:
Staticvar:  ZNF_Config_AppConfig $_appConfig:
Access:  protected


[ Top ]
array   $_config [line 63]

The array of the configuration file.

API Tags:
Access:  protected


[ Top ]
Methods
static method getInstance  [line 94]

  static ZNF_Config_AppConfig getInstance( )

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

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


API Tags:
Access:  public


[ Top ]
Constructor __construct  [line 70]

  ZNF_Config_AppConfig __construct( )

Private constructor to avoid ZNF_Config_AppConfig object creation.


API Tags:
Access:  private


[ Top ]
Destructor __destruct  [line 317]

  void __destruct( )

Destroys the ZNF_Config_AppConfig object.


API Tags:
Access:  public


[ Top ]
findAuthConfig  [line 282]

  array findAuthConfig( )

Returns the authentication configuration.


API Tags:
Access:  public


[ Top ]
findModule  [line 263]

  array findModule( string $module  )

Returns the module for the defined name.

Parameters:
string   $module: 

API Tags:
Access:  public


[ Top ]
findWrongAuthConfig  [line 300]

  array findWrongAuthConfig( )

Returns the wrong authentication configuration.


API Tags:
Access:  public


[ Top ]
getLang  [line 207]

  string getLang( )

Returns the application lang.


API Tags:
Access:  public


[ Top ]
getLangAutodetect  [line 229]

  string getLangAutodetect( )

Returns the application autodetected language.


API Tags:
Access:  public


[ Top ]
getLocale  [line 218]

  string getLocale( )

Returns the application locale.


API Tags:
Access:  public


[ Top ]
getSessionId  [line 240]

  string getSessionId( )

Returns the application session ID.


API Tags:
Access:  public


[ Top ]
getTheme  [line 251]

  string getTheme( )

Returns the application theme.


API Tags:
Access:  public


[ Top ]
_parseConfiguration  [line 111]

  void _parseConfiguration( )

Parses and validates the configuration file.

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


API Tags:
Access:  protected


[ Top ]
__clone  [line 80]

  void __clone( )

Private clonator to avoid ZNF_Config_AppConfig object clonation.


API Tags:
Access:  private


[ Top ]
Constants
CONFIG_FILE = 'znf-app-config.xml' [line 47]

Name of the configuration file.


[ Top ]

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