3 * A class for the configuration stuff implemented in a singleton design paddern
5 * NOTE: We cannot put this in inc/classes/ because it would be loaded (again)
6 * in the class loader. See inc/loader/class_ClassLoader.php for instance
9 * @author Roland Haeder <webmaster@ship-simu.org>
11 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
12 * @license GNU GPL 3.0 or any newer version
13 * @link http://www.ship-simu.org
15 * This program is free software: you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation, either version 3 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 class FrameworkConfiguration implements Registerable {
30 * The framework's main configuration array which will be initialized with
31 * hard-coded configuration data and might be overwritten/extended by
32 * config data from the database.
34 private $config = array();
37 * The configuration instance itself
39 private static $cfgInstance = null;
41 // Some constants for the configuration system
42 const EXCEPTION_CONFIG_ENTRY_IS_EMPTY = 0x130;
43 const EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND = 0x131;
46 * Protected constructor
50 protected function __construct () {
55 * "Create" a configuration instance
57 * @param $enableDebug Wether enable debug mode (default: off)
58 * @return $cfgInstance An instance of this configuration class
60 public final static function createFrameworkConfiguration ($enableDebug = false) {
62 * For singleton design pattern because we only need a one-time-run
63 * through the initial configuration.
65 if (is_null(self::$cfgInstance)) {
66 // CFG: ERROR-REPORTING
67 @error_reporting(E_ALL | E_STRICT);
70 * Shall we enable the debug mode?
73 define('DEBUG_MODE', true);
77 * Crate a config instance
79 self::$cfgInstance = new FrameworkConfiguration();
85 return self::$cfgInstance;
89 * Getter for an instance of this class
91 * @return $cfgInstance An instance of this class
93 public final static function getInstance () {
94 return self::$cfgInstance;
98 * Setter for default time zone (must be correct!)
100 * @param $zone The time-zone string (e.g. Europe/Berlin)
103 public final function setDefaultTimezone ($zone) {
104 // At least 5.1.0 is required for this!
105 if (version_compare(phpversion(), "5.1.0")) {
106 @date_default_timezone_set($zone);
111 * Setter for runtime magic quotes
113 public final function setMagicQuotesRuntime ($enableQuotes) {
114 // Cast it to boolean
115 $enableQuotes = (boolean) $enableQuotes;
118 @set_magic_quotes_runtime($enableQuotes);
122 * A private include loader
124 * @param $arrayObject The array object with all include files
127 private function loadIncludes (ArrayObject $arrayObject) {
128 // Load only if there are includes defined
129 if (!is_null($arrayObject)) {
130 for ($idx = $arrayObject->getIterator(); $idx->valid(); $idx->next()) {
132 $inc = $idx->current();
134 // Is the file name really set?
136 // Base path is by default added
139 // Base path added? (Uni* / Windows)
140 if ((substr($inc, 0, 1) != "/") && (substr($inc, 1, 1) != ":")) {
142 $fqfn = sprintf("%s/inc/extra/%s", PATH, $inc);
146 // Include them all here
153 * Define the database type which must be valid and will not be verified.
155 * @param $type The database type. See path inc/database/.
158 public function defineDatabaseType ($type) {
159 // Is it defined or not?
160 if (defined('_DB_TYPE')) {
161 // Already defined! But we cannot throw an exception here... :(
162 ApplicationEntryPoint::app_die(sprintf("[%s:] Please define the database type only once in your application!",
168 define('_DB_TYPE', (string) $type);
172 * Define the local file path
174 * @param $path Local file path for include files.
177 public function definePath ($path) {
179 $path = (string) $path;
181 // Replace backslashes with slashes
182 $path = str_replace("\\", "/", $path);
184 // Is it defined or not?
185 if ((!is_dir($path)) || (!is_readable($path))) {
186 // Is not a valid path
187 ApplicationEntryPoint::app_die(sprintf("[%s:] Invalid path (not found) specified. Please make sure it is created.",
190 } elseif (defined('PATH')) {
191 // Already defined! But we cannot throw an exception here... :(
192 ApplicationEntryPoint::app_die(sprintf("[%s:] Please define the local file path only once in your application.",
198 define('PATH', $path);
202 * Read a configuration element.
204 * @param $cfgEntry The configuration element
205 * @return $cfgValue The fetched configuration value
206 * @throws ConfigEntryIsEmptyException If $cfgEntry is empty
207 * @throws ConfigEntryNotFoundException If a configuration element
210 public function readConfig ($cfgEntry) {
212 $cfgEntry = (string) $cfgEntry;
214 // Is a valid configuration entry provided?
215 if (empty($cfgEntry)) {
217 throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
218 } elseif (!isset($this->config[$cfgEntry])) {
219 // Entry was not found!
220 throw new ConfigEntryNotFoundException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
224 if ((defined('DEBUG_CONFIG')) || (defined('DEBUG_ALL'))) {
225 echo "[".__METHOD__."] Configuration entry ".$cfgEntry." requested.<br />\n";
228 // Return the requested value
229 return $this->config[$cfgEntry];
233 * Set a configuration entry.
235 * @param $cfgEntry The configuration entry we want to add/change
236 * @param $cfgValue The configuration value we want to set
238 * @throws ConfigEntryIsEmptyException If $cfgEntry is empty
240 public final function setConfigEntry ($cfgEntry, $cfgValue) {
242 $cfgEntry = (string) $cfgEntry;
243 $cfgValue = (string) $cfgValue;
245 // Is a valid configuration entry provided?
246 if (empty($cfgEntry)) {
248 throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
251 // Set the configuration value
252 $this->config[$cfgEntry] = $cfgValue;
255 ksort($this->config);
259 * Compatiblity method to return this class' name
261 * @return __CLASS__ This class' name
263 public function __toString () {
264 return get_class($this);
268 * Dectect and return the base URL for all URLs and forms
270 * @return $baseUrl Detected base URL
272 public function detectBaseUrl() {
273 // Initialize the URL
277 if (isset($_SERVER['HTTPS'])) {
278 // Add the >s< for HTTPS
282 // Construct the full URL now and secure it against CSRF attacks
283 $baseUrl = $baseUrl . "://" . $this->detectDomain() . dirname($_SERVER['SCRIPT_NAME']);
290 * Detect safely and return the full domain where this script is installed
292 * @return $fullDomain The detected full domain
294 public function detectDomain () {
295 // Full domain is localnet.invalid by default
296 $fullDomain = "localnet.invalid";
298 // Is the server name there?
299 if (isset($_SERVER['SERVER_NAME'])) {
300 // Detect the full domain
301 $fullDomain = htmlentities(strip_tags($_SERVER['SERVER_NAME']), ENT_QUOTES);
309 * Getter for field name
311 * @param $fieldName Field name which we shall get
312 * @return $fieldValue Field value from the user
314 function getField ($fieldName) {
319 * Updates a given field with new value
321 * @param $fieldName Field to update
322 * @param $fieldValue New value to store
325 public function updateDatabaseField ($fieldName, $fieldValue) {