X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fconfig%2Fclass_FrameworkConfiguration.php;h=5006ea46680ef43d5be943444fcf8ad34a7b905f;hp=5d47232ca4bdcee9f7b5d65303e1091125628ee3;hb=768cc231b262ebeaa5aec373d9b7d97cc6b6ac95;hpb=49f84a522f0ccac3b70728cd41011a0be0eed8cf diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php index 5d47232c..5006ea46 100644 --- a/inc/config/class_FrameworkConfiguration.php +++ b/inc/config/class_FrameworkConfiguration.php @@ -8,7 +8,7 @@ * @see ClassLoader * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007 - 2009 Roland Haeder, this is free software + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -36,7 +36,7 @@ class FrameworkConfiguration implements Registerable { /** * The configuration instance itself */ - private static $configInstance = null; + private static $configInstance = NULL; // Some constants for the configuration system const EXCEPTION_CONFIG_ENTRY_IS_EMPTY = 0x130; @@ -51,12 +51,21 @@ class FrameworkConfiguration implements Registerable { // Empty for now } + /** + * Compatiblity method to return this class' name + * + * @return __CLASS__ This class' name + */ + public function __toString () { + return get_class($this); + } + /** * Getter for an instance of this class * * @return $configInstance An instance of this class */ - public final static function getInstance () { + public static final function getSelfInstance () { // is the instance there? if (is_null(self::$configInstance)) { // Create a config instance @@ -74,8 +83,8 @@ class FrameworkConfiguration implements Registerable { */ public final function setDefaultTimezone ($zone) { // At least 5.1.0 is required for this! - if (version_compare(phpversion(), "5.1.0")) { - @date_default_timezone_set($zone); + if (version_compare(phpversion(), '5.1.0')) { + date_default_timezone_set($zone); } // END - if } @@ -87,38 +96,21 @@ class FrameworkConfiguration implements Registerable { $enableQuotes = (boolean) $enableQuotes; // Set it - @set_magic_quotes_runtime($enableQuotes); + set_magic_quotes_runtime($enableQuotes); } /** - * A private include loader + * Checks wether the given configuration entry is set * - * @param $arrayObject The array object with all include files - * @return void + * @param $configEntry The configuration entry we shall check + * @return $isset Wether the given configuration entry is set */ - private function loadIncludes (ArrayObject $arrayObject) { - // Load only if there are includes defined - if (!is_null($arrayObject)) { - for ($idx = $arrayObject->getIterator(); $idx->valid(); $idx->next()) { - // Get include file - $inc = $idx->current(); - - // 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 = $this->readConfig('base_path') . '/inc/extra/' . $inc; - } // END - if - } // END - if - - // Include them all here - require($fqfn); - } - } // END - if + protected function isConfigurationEntrySet ($configEntry) { + // Is it set? + $isset = isset($this->config[$configEntry]); + + // Return the result + return $isset; } /** @@ -127,10 +119,10 @@ class FrameworkConfiguration implements Registerable { * @param $cfgEntry The configuration element * @return $cfgValue The fetched configuration value * @throws ConfigEntryIsEmptyException If $cfgEntry is empty - * @throws ConfigEntryNotFoundException If a configuration element + * @throws NoConfigEntryException If a configuration element * was not found */ - public function readConfig ($cfgEntry) { + public function getConfigEntry ($cfgEntry) { // Cast to string $cfgEntry = (string) $cfgEntry; @@ -138,9 +130,9 @@ class FrameworkConfiguration implements Registerable { if (empty($cfgEntry)) { // Entry is empty throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY); - } elseif (!isset($this->config[$cfgEntry])) { + } elseif (!$this->isConfigurationEntrySet($cfgEntry)) { // Entry was not found! - throw new ConfigEntryNotFoundException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND); + throw new NoConfigEntryException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND); } // Return the requested value @@ -174,12 +166,76 @@ class FrameworkConfiguration implements Registerable { } /** - * Compatiblity method to return this class' name + * Detects the server address (SERVER_ADDR) and set it in configuration * - * @return __CLASS__ This class' name + * @return $serverAddress The detected server address + * @todo We have to add some more entries from $_SERVER here */ - public function __toString () { - return get_class($this); + public function detectServerAddress () { + // Is the entry set? + if (!$this->isConfigurationEntrySet('server_addr')) { + // Is it set in $_SERVER? + if (isset($_SERVER['SERVER_ADDR'])) { + // Set it from $_SERVER + $this->setServerAddress($_SERVER['SERVER_ADDR']); + } elseif (class_exists('ConsoleTools')) { + // Run auto-detecting through console tools lib + ConsoleTools::acquireSelfIPAddress(); + } + } // END - if + + // Now get it from configuration + $serverAddress = $this->getServerAddress(); + + // Return it + return $serverAddress; + } + + /** + * Setter for SERVER_ADDR + * + * @param $serverAddress New SERVER_ADDR value to set + * @return void + */ + public function setServerAddress ($serverAddress) { + $this->setConfigEntry('server_addr', (string) $serverAddress); + } + + /** + * Getter for SERVER_ADDR + * + * @return $serverAddress New SERVER_ADDR value to set + */ + public function getServerAddress () { + return $this->getConfigEntry('server_addr'); + } + + /** + * Detects the HTTPS flag + * + * @return $https The detected HTTPS flag or null if failed + */ + public function detectHttpSecured () { + // Default is null + $https = NULL; + + // Is HTTPS set? + if ($this->isHttpSecured()) { + // Then use it + $https = $_SERVER['HTTPS']; + } // END - if + + // Return it + return $https; + } + + /** + * Checks wether HTTPS is set in $_SERVER + * + * @return $isset Wether HTTPS is set + */ + public function isHttpSecured () { + return (isset($_SERVER['HTTPS'])); } /** @@ -187,12 +243,12 @@ class FrameworkConfiguration implements Registerable { * * @return $baseUrl Detected base URL */ - public function detectBaseUrl() { + public function detectBaseUrl () { // Initialize the URL $baseUrl = 'http'; // Do we have HTTPS? - if (isset($_SERVER['HTTPS'])) { + if ($this->isHttpSecured()) { // Add the >s< for HTTPS $baseUrl .= 's'; } // END - if @@ -253,6 +309,34 @@ class FrameworkConfiguration implements Registerable { public final function getField ($fieldName) { // Our super interface "FrameworkInterface" requires this } + + /** + * Generates a code for hashes from this class + * + * @return $hashCode The hash code respresenting this class + */ + public function hashCode () { + return crc32($this->__toString()); + } + + /** + * Checks wether an object equals this object. You should overwrite this + * method to implement own equality checks + * + * @param $objectInstance An instance of a FrameworkInterface object + * @return $equals Wether both objects equals + */ + public function equals (FrameworkInterface $objectInstance) { + // Now test it + $equals = (( + $this->__toString() == $objectInstance->__toString() + ) && ( + $this->hashCode() == $objectInstance->hashCode() + )); + + // Return the result + return $equals; + } } // [EOF]