X-Git-Url: https://git.mxchange.org/?p=shipsimu.git;a=blobdiff_plain;f=inc%2Fconfig%2Fclass_FrameworkConfiguration.php;h=e3202603aba1317a735a0bfbf02dcc37b2206f3a;hp=957a3537d86a814ca0fe397a3abfa33971215ca3;hb=df33e264f3246f80756d7e2da55d7f7c40f9088c;hpb=87db91afa01eda4ca4f3b72a3f795cd2cc28d6f0 diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php index 957a353..e320260 100644 --- a/inc/config/class_FrameworkConfiguration.php +++ b/inc/config/class_FrameworkConfiguration.php @@ -2,15 +2,15 @@ /** * 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 the class loader. See inc/loader/class_ClassLoader.php for instance + * 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 ClassLoader - * @author Roland Haeder - * @version 0.3.0 - * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software + * @author Roland Haeder + * @version 0.0.0 + * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software * @license GNU GPL 3.0 or any newer version - * @link http://www.mxchange.org + * @link http://www.ship-simu.org * * 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 @@ -23,9 +23,9 @@ * 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 . + * along with this program. If not, see . */ -class FrameworkConfiguration { +class FrameworkConfiguration implements Registerable { /** * The framework's main configuration array which will be initialized with * hard-coded configuration data and might be overwritten/extended by @@ -39,53 +39,30 @@ class FrameworkConfiguration { private static $cfgInstance = null; // Some constants for the configuration system - const EXCEPTION_CONFIG_ENTRY_IS_EMPTY = 0xc00; - const EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND = 0xc01; + const EXCEPTION_CONFIG_ENTRY_IS_EMPTY = 0x130; + const EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND = 0x131; /** - * Private constructor + * Protected constructor + * + * @return void */ - private function __construct () { + protected function __construct () { // Empty for now } - /** - * "Create" a configuration instance - */ - public final static function createFrameworkConfiguration ($enableDebug = false) { - /** - * For singleton design pattern because we only need a one-time-run - * through the initial configuration. - */ - if (is_null(self::$cfgInstance)) { - // CFG: DEBUG-LEVEL - @error_reporting(E_ALL | E_STRICT); - - /** - * Shall we enable the debug mode? - */ - if ($enableDebug) { - define('DEBUG_MODE', true); - } - - /** - * Crate a config instance - */ - self::$cfgInstance = new FrameworkConfiguration(); - } - - /** - * Return the instance - */ - return self::$cfgInstance; - } - /** * Getter for an instance of this class * * @return $cfgInstance An instance of this class */ public final static function getInstance () { + // is the instance there? + if (is_null(self::$cfgInstance)) { + // Create a config instance + self::$cfgInstance = new FrameworkConfiguration(); + } // END - if + return self::$cfgInstance; } @@ -99,7 +76,7 @@ class FrameworkConfiguration { // At least 5.1.0 is required for this! if (version_compare(phpversion(), "5.1.0")) { @date_default_timezone_set($zone); - } + } // END - if } /** @@ -116,7 +93,7 @@ class FrameworkConfiguration { /** * A private include loader * - * @param $arrayObject The array object with all include files + * @param $arrayObject The array object with all include files * @return void */ private function loadIncludes (ArrayObject $arrayObject) { @@ -128,82 +105,30 @@ class FrameworkConfiguration { // Is the file name really set? if (!empty($inc)) { + // Base path is by default added + $fqfn = $inc; + // Base path added? (Uni* / Windows) if ((substr($inc, 0, 1) != "/") && (substr($inc, 1, 1) != ":")) { // Generate FQFN - $fqfn = sprintf("%s/inc/extra/%s", PATH, $inc); - } else { - // Base path is already added - $fqfn = $inc; - } - } + $fqfn = sprintf("%s/inc/extra/%s", $this->readConfig('base_path'), $inc); + } // END - if + } // END - if // Include them all here require($fqfn); } - } - } - - /** - * Define the database type which must be valid and will not be verified. - * - * @param $type The database type. See path inc/database/. - * @return void - */ - public function defineDatabaseType ($type) { - // Is it defined or not? - if (!defined('_DB_TYPE')) { - // Cast to string - $type = (string) $type; - - // Set the constant - define('_DB_TYPE', $type); - } else { - // Already defined! But we cannot throw an exception here... :( - ApplicationEntryPoint::app_die(sprintf("[%s:] Please define the database type only once in your application!", - __CLASS__ - )); - } - } - - /** - * Define the local file path - * - * @param $path The database type. See path inc/database/. - * @return void - */ - public function definePath ($path) { - // Cast to string - $path = (string) $path; - - // Replace backslashes with slashes - $path = str_replace("\\", "/", $path); - - // Is it defined or not? - if ((!is_dir($path)) || (!is_readable($path))) { - // Is not a valid path - ApplicationEntryPoint::app_die(sprintf("[%s:] Invalid path (not found) specified. Please make sure it is created.", - __CLASS__ - )); - } elseif (!defined('PATH')) { - // Set the constant - define('PATH', $path); - } else { - // Already defined! But we cannot throw an exception here... :( - ApplicationEntryPoint::app_die(sprintf("[%s:] Please define the local file path only once in your application.", - __CLASS__ - )); - } + } // END - if } /** * Read a configuration element. * - * @param $cfgEntry The configuration element + * @param $cfgEntry The configuration element * @return $cfgValue The fetched configuration value - * @throws ConfigEntryIsEmptyException If $cfgEntry is empty + * @throws ConfigEntryIsEmptyException If $cfgEntry is empty * @throws ConfigEntryNotFoundException If a configuration element - * was not found + * was not found */ public function readConfig ($cfgEntry) { // Cast to string @@ -212,7 +137,7 @@ class FrameworkConfiguration { // Is a valid configuration entry provided? if (empty($cfgEntry)) { // Entry is empty - throw new ConfigEntryIsEmptyException(__CLASS__, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY); + throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY); } elseif (!isset($this->config[$cfgEntry])) { // Entry was not found! throw new ConfigEntryNotFoundException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND); @@ -221,7 +146,7 @@ class FrameworkConfiguration { // Debug message if ((defined('DEBUG_CONFIG')) || (defined('DEBUG_ALL'))) { echo "[".__METHOD__."] Configuration entry ".$cfgEntry." requested.
\n"; - } + } // END - if // Return the requested value return $this->config[$cfgEntry]; @@ -230,8 +155,8 @@ class FrameworkConfiguration { /** * Set a configuration entry. * - * @param $cfgEntry The configuration entry we want to add/change - * @param $cfgValue The configuration value we want to set + * @param $cfgEntry The configuration entry we want to add/change + * @param $cfgValue The configuration value we want to set * @return void * @throws ConfigEntryIsEmptyException If $cfgEntry is empty */ @@ -243,8 +168,8 @@ class FrameworkConfiguration { // Is a valid configuration entry provided? if (empty($cfgEntry)) { // Entry is empty - throw new ConfigEntryIsEmptyException(__CLASS__, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY); - } + throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY); + } // END - if // Set the configuration value $this->config[$cfgEntry] = $cfgValue; @@ -261,7 +186,87 @@ class FrameworkConfiguration { public function __toString () { return get_class($this); } -} // END - class + + /** + * Dectect and return the base URL for all URLs and forms + * + * @return $baseUrl Detected base URL + */ + public function detectBaseUrl() { + // Initialize the URL + $baseUrl = "http"; + + // Do we have HTTPS? + if (isset($_SERVER['HTTPS'])) { + // Add the >s< for HTTPS + $baseUrl .= "s"; + } // END - if + + // Construct the full URL now and secure it against CSRF attacks + $baseUrl = $baseUrl . "://" . $this->detectDomain() . $this->detectScriptPath(); + + // Return the URL + return $baseUrl; + } + + /** + * Detect safely and return the full domain where this script is installed + * + * @return $fullDomain The detected full domain + */ + public function detectDomain () { + // Full domain is localnet.invalid by default + $fullDomain = "localnet.invalid"; + + // Is the server name there? + if (isset($_SERVER['SERVER_NAME'])) { + // Detect the full domain + $fullDomain = htmlentities(strip_tags($_SERVER['SERVER_NAME']), ENT_QUOTES); + } // END - if + + // Return it + return $fullDomain; + } + + /** + * Detect safely the script path without trailing slash which is the part + * between "http://your-domain.invalid/" and "script-name.php" + */ + public function detectScriptPath () { + // Default is empty + $scriptPath = ""; + + // Is the scriptname set? + if (isset($_SERVER['SCRIPT_NAME'])) { + // Get dirname of it + $scriptPath = dirname($_SERVER['SCRIPT_NAME']); + } // END - if + + // Return it + return $scriptPath; + } + + /** + * Getter for field name + * + * @param $fieldName Field name which we shall get + * @return $fieldValue Field value from the user + */ + function getField ($fieldName) { + // Dummy method! + } + + /** + * Updates a given field with new value + * + * @param $fieldName Field to update + * @param $fieldValue New value to store + * @return void + */ + public function updateDatabaseField ($fieldName, $fieldValue) { + // Dummy method! + } +} // [EOF] ?>