* @see ClassLoader
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
/**
* The configuration instance itself
*/
- private static $cfgInstance = null;
+ private static $configInstance = null;
// Some constants for the configuration system
const EXCEPTION_CONFIG_ENTRY_IS_EMPTY = 0x130;
// 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 $cfgInstance An instance of this class
+ * @return $configInstance An instance of this class
*/
public final static function getInstance () {
// is the instance there?
- if (is_null(self::$cfgInstance)) {
+ if (is_null(self::$configInstance)) {
// Create a config instance
- self::$cfgInstance = new FrameworkConfiguration();
+ self::$configInstance = new FrameworkConfiguration();
} // END - if
- return self::$cfgInstance;
+ return self::$configInstance;
}
/**
*/
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
}
$enableQuotes = (boolean) $enableQuotes;
// Set it
- @set_magic_quotes_runtime($enableQuotes);
+ set_magic_quotes_runtime($enableQuotes);
}
/**
*
* @param $arrayObject The array object with all include files
* @return void
+ * @deprecated
+ * @see ClassLoader
*/
private function loadIncludes (ArrayObject $arrayObject) {
// Load only if there are includes defined
$fqfn = $inc;
// Base path added? (Uni* / Windows)
- if ((substr($inc, 0, 1) != "/") && (substr($inc, 1, 1) != ":")) {
+ if ((substr($inc, 0, 1) != '/') && (substr($inc, 1, 1) != ':')) {
// Generate FQFN
- $fqfn = sprintf("%s/inc/extra/%s", $this->readConfig('base_path'), $inc);
+ $fqfn = $this->getConfigEntry('base_path') . '/inc/extra/' . $inc;
} // END - if
} // END - if
} // END - if
}
+ /**
+ * Checks wether the given configuration entry is set
+ *
+ * @param $configEntry The configuration entry we shall check
+ * @return $isset Wether the given configuration entry is set
+ */
+ protected function isConfigurationEntrySet ($configEntry) {
+ // Is it set?
+ $isset = isset($this->config[$configEntry]);
+
+ // Return the result
+ return $isset;
+ }
+
/**
* Read a configuration element.
*
* @throws ConfigEntryNotFoundException If a configuration element
* was not found
*/
- public function readConfig ($cfgEntry) {
+ public function getConfigEntry ($cfgEntry) {
// Cast to string
$cfgEntry = (string) $cfgEntry;
if (empty($cfgEntry)) {
// Entry is empty
throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
- } elseif (!isset($this->config[$cfgEntry])) {
+ } elseif (!$this->isConfigEntrySet($cfgEntry)) {
// Entry was not found!
throw new ConfigEntryNotFoundException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
}
- // Debug message
- if ((defined('DEBUG_CONFIG')) || (defined('DEBUG_ALL'))) {
- echo "[".__METHOD__."] Configuration entry ".$cfgEntry." requested.<br />\n";
- } // END - if
-
// Return the requested value
return $this->config[$cfgEntry];
}
}
/**
- * 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']));
}
/**
*
* @return $baseUrl Detected base URL
*/
- public function detectBaseUrl() {
+ public function detectBaseUrl () {
// Initialize the URL
- $baseUrl = "http";
+ $baseUrl = 'http';
// Do we have HTTPS?
- if (isset($_SERVER['HTTPS'])) {
+ if ($this->isHttpSecured()) {
// Add the >s< for HTTPS
- $baseUrl .= "s";
+ $baseUrl .= 's';
} // END - if
- // Construct the full URL now and secure it against CSRF attacks
- $baseUrl = $baseUrl . "://" . $this->detectDomain() . $this->detectScriptPath();
+ // Construct the full URL and secure it against CSRF attacks
+ $baseUrl = $baseUrl . '://' . $this->detectDomain() . $this->detectScriptPath();
// Return the URL
return $baseUrl;
*/
public function detectDomain () {
// Full domain is localnet.invalid by default
- $fullDomain = "localnet.invalid";
+ $fullDomain = 'localnet.invalid';
// Is the server name there?
if (isset($_SERVER['SERVER_NAME'])) {
}
/**
- * Detect safely the script path without trailing slash which is the part
+ * Detect safely the script path without trailing slash which is the glue
* between "http://your-domain.invalid/" and "script-name.php"
+ *
+ * @return $scriptPath The script path extracted from $_SERVER['SCRIPT_NAME']
*/
public function detectScriptPath () {
// Default is empty
- $scriptPath = "";
+ $scriptPath = '';
// Is the scriptname set?
if (isset($_SERVER['SCRIPT_NAME'])) {
- // Get dirname of it
- $scriptPath = dirname($_SERVER['SCRIPT_NAME']);
+ // Get dirname from it and replace back-slashes with slashes for lame OSes...
+ $scriptPath = str_replace("\\", '/', dirname($_SERVER['SCRIPT_NAME']));
} // END - if
// Return it
*
* @param $fieldName Field name which we shall get
* @return $fieldValue Field value from the user
+ * @throws NullPointerException If the result instance is null
*/
- function getField ($fieldName) {
- // Dummy method!
+ public final function getField ($fieldName) {
+ // Our super interface "FrameworkInterface" requires this
}
/**
- * Updates a given field with new value
+ * Generates a code for hashes from this class
*
- * @param $fieldName Field to update
- * @param $fieldValue New value to store
- * @return void
+ * @return $hashCode The hash code respresenting this class
*/
- public function updateDatabaseField ($fieldName, $fieldValue) {
- // Dummy method!
+ public function hashCode () {
+ return crc32($this->__toString());
}
}
-// [EOF]
+//
?>
projects / core.git / blobdiff