X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fconfig%2Fclass_FrameworkConfiguration.php;h=6d3b99fb9d03187b10c31ecfbf12fbed4ddbf8a7;hb=1cc728fe28f6fe71a8d581a0dc1f2505bb0baa33;hp=f49c3c2979bc8afd625dfa5cf56b3efe9a88e825;hpb=ff66822b5fb6a92f5dc8af55290ecb89ec7f1aaf;p=shipsimu.git diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php index f49c3c2..6d3b99f 100644 --- a/inc/config/class_FrameworkConfiguration.php +++ b/inc/config/class_FrameworkConfiguration.php @@ -5,11 +5,12 @@ * 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 * - * @see ClassLoader + * @see ClassLoader * @author Roland Haeder - * @version 0.0 + * @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.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 @@ -22,19 +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 { - /** - * Include files which shall be included before the main loader. - */ - private $moreIncPre = null; - - /** - * Include files which shall be included after the main loader. - */ - private $moreIncPost = null; - +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 @@ -48,20 +39,23 @@ 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 () { - // Initialize both include lists - $this->moreIncPre = new ArrayObject(); - $this->moreIncPost = new ArrayObject(); + protected function __construct () { + // Empty for now } /** * "Create" a configuration instance + * + * @param $enableDebug Wether enable debug mode (default: off) + * @return $cfgInstance An instance of this configuration class */ public final static function createFrameworkConfiguration ($enableDebug = false) { /** @@ -69,7 +63,7 @@ class FrameworkConfiguration { * through the initial configuration. */ if (is_null(self::$cfgInstance)) { - // CFG: DEBUG-LEVEL + // CFG: ERROR-REPORTING @error_reporting(E_ALL | E_STRICT); /** @@ -127,7 +121,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) { @@ -155,26 +149,6 @@ class FrameworkConfiguration { } } - /** - * Load all includes before main loader and clears the array after usage - * - * @return void - */ - public function loadPreIncludes () { - $this->loadIncludes($this->moreIncPre); - unset($this->moreIncPre); - } - - /** - * Load all includes after main loader and clears the array after usage - * - * @return void - */ - public function loadPostIncludes () { - $this->loadIncludes($this->moreIncPost); - unset($this->moreIncPost); - } - /** * Define the database type which must be valid and will not be verified. * @@ -200,7 +174,7 @@ class FrameworkConfiguration { /** * Define the local file path * - * @param $path The database type. See path inc/database/. + * @param $path Local file path for include files. * @return void */ public function definePath ($path) { @@ -243,7 +217,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); @@ -274,7 +248,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); } // Set the configuration value @@ -292,6 +266,41 @@ class FrameworkConfiguration { public function __toString () { return get_class($this); } + + /** + * 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() . dirname($_SERVER['SCRIPT_NAME']); + + // 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 () { + // Detect the full domain + $fullDomain = htmlentities(strip_tags($_SERVER['SERVER_NAME']), ENT_QUOTES); + + // Return it + return $fullDomain; + } } // END - class // [EOF]