<?php
+
// Own namespace
namespace CoreFramework\Configuration;
use CoreFramework\Generic\FrameworkInterface;
use CoreFramework\Generic\NullPointerException;
use CoreFramework\Generic\UnsupportedOperationException;
+use CoreFramework\Object\BaseFrameworkSystem;
use CoreFramework\Registry\Registerable;
+// Import SPL stuff
+use \InvalidArgumentException;
+
/**
* A class for the configuration stuff implemented in a singleton design paddern
*
*
* @see ClassLoader
* @author Roland Haeder <webmaster@shipsimu.org>
- * @version 0.0.0
+ * @version 1.0.1
* @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.shipsimu.org
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
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
private $callbackInstance = NULL;
// Some constants for the configuration system
- const EXCEPTION_CONFIG_KEY_IS_EMPTY = 0x130;
- const EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND = 0x131;
+ const EXCEPTION_CONFIG_KEY_IS_EMPTY = 0x130;
+ const EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND = 0x131;
const EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED = 0x132;
/**
- * Protected constructor
+ * Private constructor
*
* @return void
*/
- protected function __construct () {
+ private function __construct () {
// Empty for now
}
*/
public static final function getSelfInstance () {
// is the instance there?
- if (is_null(self::$configInstance)) {
+ if (is_null(self::$configInstance)) {
// Create a config instance
self::$configInstance = new FrameworkConfiguration();
} // END - if
return self::$configInstance;
}
- /**
- * Converts dashes to underscores, e.g. useable for configuration entries
- *
- * @param $str The string with maybe dashes inside
- * @return $str The converted string with no dashed, but underscores
- */
- private final function convertDashesToUnderscores ($str) {
- // Convert them all
- $str = str_replace('-', '_', $str);
-
- // Return converted string
- return $str;
- }
-
- /**
- * Setter for default time zone (must be correct!)
- *
- * @param $zone The time-zone string (e.g. Europe/Berlin)
- * @return void
- */
- public final function setDefaultTimezone ($zone) {
- // Is PHP version 5.1.0 or higher? Older versions are being ignored
- if (version_compare(phpversion(), '5.1.0', '>=')) {
- /*
- * Set desired time zone to prevent date() and related functions to
- * issue a E_WARNING.
- */
- date_default_timezone_set($zone);
- } // END - if
- }
-
- /**
- * Setter for runtime magic quotes
- *
- * @param $enableQuotes Whether enable magic runtime quotes (should be disabled for security reasons)
- * @return void
- * @todo This method encapsulates a deprecated PHP function and should be deprecated, too.
- */
- public final function setMagicQuotesRuntime ($enableQuotes) {
- // Is the PHP version < 5.4?
- if (version_compare(phpversion(), '5.4', '>=')) {
- // Then silently skip this part as set_magic_quotes_runtime() is deprecated
- return;
- } // END - if
-
- // Cast it to boolean
- $enableQuotes = (boolean) $enableQuotes;
-
- // Set it
- set_magic_quotes_runtime($enableQuotes);
- }
-
/**
* Checks whether the given configuration key is set
*
* @param $configKey The configuration key we shall check
- * @return $isset Whether the given configuration key is set
+ * @return $isset Whether the given configuration key is set
+ * @throws NullPointerException If $configKey is NULL
+ * @throws InvalidArgumentException If $configKey is empty
*/
public function isConfigurationEntrySet ($configKey) {
+ // Is it null?
+ if (is_null($configKey)) {
+ // Throw NPE
+ throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
+ } elseif (!is_string($configKey)) {
+ // Is not a string
+ throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
+ } elseif ((is_string($configKey)) && (empty($configKey))) {
+ // Entry is empty
+ throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
+ }
+
// Is it set?
- $isset = isset($this->config[$configKey]);
+ $isset = ((isset($this->config[$configKey])) || (array_key_exists($configKey, $this->config)));
// Return the result
return $isset;
*
* @param $configKey The configuration element
* @return $configValue The fetched configuration value
- * @throws ConfigEntryIsEmptyException If $configKey is empty
- * @throws NoConfigEntryException If a configuration element was not found
+ * @throws NullPointerException If $configKey is NULL
+ * @throws InvalidArgumentException If $configKey is empty
+ * @throws NoConfigEntryException If a configuration element was not found
*/
public function getConfigEntry ($configKey) {
+ // Is it null?
+ if (is_null($configKey)) {
+ // Throw NPE
+ throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
+ } elseif (!is_string($configKey)) {
+ // Is not a string
+ throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
+ } elseif ((is_string($configKey)) && (empty($configKey))) {
+ // Entry is empty
+ throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
+ }
+
// Convert dashes to underscore
- $configKey = self::convertDashesToUnderscores($configKey);
+ $configKey = BaseFrameworkSystem::convertDashesToUnderscores($configKey);
// Is a valid configuration key provided?
- if (empty($configKey)) {
- // Entry is empty
- throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
- } elseif (!$this->isConfigurationEntrySet($configKey)) {
+ if (!$this->isConfigurationEntrySet($configKey)) {
// Entry was not found!
throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND);
- }
+ } // END - if
// Return the requested value
return $this->config[$configKey];
* @param $configKey The configuration key we want to add/change
* @param $configValue The configuration value we want to set
* @return void
- * @throws ConfigEntryIsEmptyException If $configKey is empty
- * @throws ConfigValueTypeUnsupportedException If $configValue has an unsupported variable type
+ * @throws NullPointerException If $configKey is NULL
+ * @throws InvalidArgumentException If $configKey is empty
+ * @throws InvalidArgumentException If $configValue has an unsupported variable type
*/
public final function setConfigEntry ($configKey, $configValue) {
- // Cast to string
- $configKey = self::convertDashesToUnderscores($configKey);
-
// Is a valid configuration key key provided?
if (is_null($configKey)) {
// Configuration key is null
- throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
- } elseif ((empty($configKey)) || (!is_string($configKey))) {
+ throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
+ } elseif (!is_string($configKey)) {
+ // Is not a string
+ throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
+ } elseif ((is_string($configKey)) && (empty($configKey))) {
// Entry is empty
- throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
- } elseif ((is_null($configValue)) || (is_array($configValue)) || (is_object($configValue)) || (is_resource($configValue))) {
+ throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
+ } elseif ((is_array($configValue)) || (is_object($configValue)) || (is_resource($configValue))) {
// These cannot be set as this is not intended for configuration values, please use FrameworkArrayObject instead.
- throw new ConfigValueTypeUnsupportedException(array($this, $configKey, $configValue), self::EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED);
+ throw new InvalidArgumentException(sprintf('configValue[]=%s for configKey=%s is not supported.', gettype($configValue), $configKey), self::EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED);
}
+ // Cast to string
+ $configKey = BaseFrameworkSystem::convertDashesToUnderscores($configKey);
+
// Set the configuration value
//* NOISY-DEBUG: */ print(__METHOD__ . ':configEntry=' . $configKey . ',configValue[' . gettype($configValue) . ']=' . $configValue . PHP_EOL);
$this->config[$configKey] = $configValue;
*
* @param $configKey Configuration key to unset
* @return void
+ * @throws NullPointerException If $configKey is NULL
+ * @throws InvalidArgumentException If $configKey is empty
* @throws NoConfigEntryException If a configuration element was not found
*/
public final function unsetConfigEntry ($configKey) {
+ // Validate parameters
+ if (is_null($configKey)) {
+ // Configuration key is null
+ throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
+ } elseif (!is_string($configKey)) {
+ // Entry is empty
+ throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
+ } elseif ((is_string($configKey)) && (empty($configKey))) {
+ // Entry is empty
+ throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
+ }
+
// Convert dashes to underscore
- $configKey = self::convertDashesToUnderscores($configKey);
+ $configKey = BaseFrameworkSystem::convertDashesToUnderscores($configKey);
// Is the configuration key there?
if (!$this->isConfigurationEntrySet($configKey)) {
unset($this->config[$configKey]);
}
- /**
- * Detects the server address (SERVER_ADDR) and set it in configuration
- *
- * @return $serverAddress The detected server address
- * @throws UnknownHostnameException If SERVER_NAME cannot be resolved to an IP address
- * @todo Have to check some more entries from $_SERVER here
- */
- 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 (isset($_SERVER['SERVER_NAME'])) {
- // Resolve IP address
- $serverIp = ConsoleTools::resolveIpAddress($_SERVER['SERVER_NAME']);
-
- // Is it valid?
- if ($serverIp === false) {
- /*
- * Why is gethostbyname() returning the host name and not
- * false as many other PHP functions are doing? ;-(
- */
- throw new UnknownHostnameException(sprintf('Cannot resolve "%s" to an IP address. Please fix your setup.', $_SERVER['SERVER_NAME']));
- } // END - if
-
- // Al fine, set it
- $this->setServerAddress($serverIp);
- } else {
- // 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 $isSecured The detected HTTPS flag or null if failed
- */
- public function detectHttpSecured () {
- // Default is null
- $isSecured = NULL;
-
- // Is HTTPS set?
- if ($this->isHttpSecured()) {
- // Then use it
- $isSecured = $_SERVER['HTTPS'];
- } // END - if
-
- // Return it
- return $isSecured;
- }
-
- /**
- * Checks whether HTTPS is set in $_SERVER
- *
- * @return $isset Whether HTTPS is set
- */
- public function isHttpSecured () {
- return (isset($_SERVER['HTTPS']));
- }
-
- /**
- * 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 ($this->isHttpSecured()) {
- // Add the >s< for HTTPS
- $baseUrl .= 's';
- } // END - if
-
- // Construct the full URL 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 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 = '';
-
- // Is the scriptname set?
- if (isset($_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
- return $scriptPath;
- }
-
/**
* Getter for field name
*
*/
public final function getField ($fieldName) {
// The super interface "FrameworkInterface" requires this
- throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+ throw new UnsupportedOperationException(array($this, __FUNCTION__), BaseFrameworkSystem::EXCEPTION_UNSPPORTED_OPERATION);
}
/**
*/
public function isFieldSet ($fieldName) {
// The super interface "FrameworkInterface" requires this
- throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+ throw new UnsupportedOperationException(array($this, __FUNCTION__), BaseFrameworkSystem::EXCEPTION_UNSPPORTED_OPERATION);
}
/**
public function equals (FrameworkInterface $objectInstance) {
// Now test it
$equals = ((
- $this->__toString() === $objectInstance->__toString()
- ) && (
- $this->hashCode() === $objectInstance->hashCode()
- ));
+ $this->__toString() === $objectInstance->__toString()
+ ) && (
+ $this->hashCode() === $objectInstance->hashCode()
+ ));
// Return the result
return $equals;
projects / core.git / blobdiff