FrameworkConfiguration Class Reference

Inheritance diagram for FrameworkConfiguration:

Inheritance graph
[legend]
Collaboration diagram for FrameworkConfiguration:

Collaboration graph
[legend]

List of all members.


Detailed Description

A class for the configuration stuff implemented in a singleton design paddern.

NOTE: We cannot put this in inc/classes/ because it would be loaded (again) in class loader. See inc/loader/class_ClassLoader.php for instance

See also:
ClassLoader
Author:
Roland Haeder <webmaster@ship-simu.org>
Version:
0.0.0 Copyright (c) 2007, 2008 Roland Haeder, this is free software GNU GPL 3.0 or any newer version This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Definition at line 28 of file class_FrameworkConfiguration.php.


Public Member Functions

 __toString ()
 Compatiblity method to return this class' name.
 detectBaseUrl ()
 Dectect and return the base URL for all URLs and forms.
 detectDomain ()
 Detect safely and return the full domain where this script is installed.
 detectScriptPath ()
 Detect safely the script path without trailing slash which is the part between "http://your-domain.invalid/" and "script-name.php".
 getField ($fieldName)
 Getter for field name.
 readConfig ($cfgEntry)
 Read a configuration element.
 setConfigEntry ($cfgEntry, $cfgValue)
 Set a configuration entry.
 setDefaultTimezone ($zone)
 Setter for default time zone (must be correct!).
 setMagicQuotesRuntime ($enableQuotes)
 Setter for runtime magic quotes.
 updateDatabaseField ($fieldName, $fieldValue)
 Updates a given field with new value.

Static Public Member Functions

static getInstance ()
 Getter for an instance of this class.

Public Attributes

const EXCEPTION_CONFIG_ENTRY_IS_EMPTY = 0x130
const EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND = 0x131

Protected Member Functions

 __construct ()
 Protected constructor.

Private Member Functions

 loadIncludes (ArrayObject $arrayObject)
 A private include loader.

Private Attributes

 $config = array()
 The framework's main configuration array which will be initialized with hard-coded configuration data and might be overwritten/extended by config data from the database.

Static Private Attributes

static $cfgInstance = null
 The configuration instance itself.

The documentation for this class was generated from the following file:

Generated on Mon Dec 8 01:12:11 2008 for Ship-Simulator by  doxygen 1.5.6