4 namespace CoreFramework\Configuration;
6 // Import framework stuff
7 use CoreFramework\Console\Tools\ConsoleTools;
8 use CoreFramework\Dns\UnknownHostnameException;
9 use CoreFramework\Generic\FrameworkInterface;
10 use CoreFramework\Generic\NullPointerException;
11 use CoreFramework\Generic\UnsupportedOperationException;
12 use CoreFramework\Object\BaseFrameworkSystem;
13 use CoreFramework\Registry\Registerable;
16 use \InvalidArgumentException;
19 * A class for the configuration stuff implemented in a singleton design paddern
21 * NOTE: We cannot put this in framework/main/ because it would be loaded (again) in
22 * class loader. See framework/loader/class_ClassLoader.php for instance
25 * @author Roland Haeder <webmaster@shipsimu.org>
27 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
28 * @license GNU GPL 3.0 or any newer version
29 * @link http://www.shipsimu.org
31 * This program is free software: you can redistribute it and/or modify
32 * it under the terms of the GNU General Public License as published by
33 * the Free Software Foundation, either version 3 of the License, or
34 * (at your option) any later version.
36 * This program is distributed in the hope that it will be useful,
37 * but WITHOUT ANY WARRANTY; without even the implied warranty of
38 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
39 * GNU General Public License for more details.
41 * You should have received a copy of the GNU General Public License
42 * along with this program. If not, see <http://www.gnu.org/licenses/>.
44 class FrameworkConfiguration implements Registerable {
47 * The framework's main configuration array which will be initialized with
48 * hard-coded configuration data and might be overwritten/extended by
49 * config data from the database.
51 private static $config = array();
54 * Call-back instance (unused)
56 private $callbackInstance = NULL;
58 // Some constants for the configuration system
59 const EXCEPTION_CONFIG_KEY_IS_EMPTY = 0x130;
60 const EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND = 0x131;
61 const EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED = 0x132;
64 * Default constructor, the configuration entries are static, not the
69 public function __construct () {
74 * Compatiblity method to return this class' name
76 * @return __CLASS__ This class' name
78 public function __toString () {
79 return get_class($this);
83 * Checks whether the given configuration key is set
85 * @param $configKey The configuration key we shall check
86 * @return $isset Whether the given configuration key is set
87 * @throws NullPointerException If $configKey is NULL
88 * @throws InvalidArgumentException If $configKey is empty
90 public function isConfigurationEntrySet ($configKey) {
92 if (is_null($configKey)) {
94 throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
95 } elseif (!is_string($configKey)) {
97 throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
98 } elseif ((is_string($configKey)) && (empty($configKey))) {
100 throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
104 $isset = ((isset(self::$config[$configKey])) || (array_key_exists($configKey, self::$config)));
111 * Read a configuration element.
113 * @param $configKey The configuration element
114 * @return $configValue The fetched configuration value
115 * @throws NullPointerException If $configKey is NULL
116 * @throws InvalidArgumentException If $configKey is empty
117 * @throws NoConfigEntryException If a configuration element was not found
119 public function getConfigEntry ($configKey) {
121 if (is_null($configKey)) {
123 throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
124 } elseif (!is_string($configKey)) {
126 throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
127 } elseif ((is_string($configKey)) && (empty($configKey))) {
129 throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
132 // Convert dashes to underscore
133 $configKey = BaseFrameworkSystem::convertDashesToUnderscores($configKey);
135 // Is a valid configuration key provided?
136 if (!$this->isConfigurationEntrySet($configKey)) {
137 // Entry was not found!
138 throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND);
141 // Return the requested value
142 return self::$config[$configKey];
146 * Set a configuration key
148 * @param $configKey The configuration key we want to add/change
149 * @param $configValue The configuration value we want to set
151 * @throws NullPointerException If $configKey is NULL
152 * @throws InvalidArgumentException If $configKey is empty
153 * @throws InvalidArgumentException If $configValue has an unsupported variable type
155 public final function setConfigEntry ($configKey, $configValue) {
156 // Is a valid configuration key key provided?
157 if (is_null($configKey)) {
158 // Configuration key is null
159 throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
160 } elseif (!is_string($configKey)) {
162 throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
163 } elseif ((is_string($configKey)) && (empty($configKey))) {
165 throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
166 } elseif ((is_array($configValue)) || (is_object($configValue)) || (is_resource($configValue))) {
167 // These cannot be set as this is not intended for configuration values, please use FrameworkArrayObject instead.
168 throw new InvalidArgumentException(sprintf('configValue[]=%s for configKey=%s is not supported.', gettype($configValue), $configKey), self::EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED);
172 $configKey = BaseFrameworkSystem::convertDashesToUnderscores($configKey);
174 // Set the configuration value
175 //* NOISY-DEBUG: */ print(__METHOD__ . ':configEntry=' . $configKey . ',configValue[' . gettype($configValue) . ']=' . $configValue . PHP_EOL);
176 self::$config[$configKey] = $configValue;
179 ksort(self::$config);
183 * Getter for whole configuration array
185 * @return $config Configuration array
187 public final function getConfigurationArray () {
189 return self::$config;
193 * Unset a configuration key, the entry must be there or else an
194 * exception is thrown.
196 * @param $configKey Configuration key to unset
198 * @throws NullPointerException If $configKey is NULL
199 * @throws InvalidArgumentException If $configKey is empty
200 * @throws NoConfigEntryException If a configuration element was not found
202 public final function unsetConfigEntry ($configKey) {
203 // Validate parameters
204 if (is_null($configKey)) {
205 // Configuration key is null
206 throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
207 } elseif (!is_string($configKey)) {
209 throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
210 } elseif ((is_string($configKey)) && (empty($configKey))) {
212 throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
215 // Convert dashes to underscore
216 $configKey = BaseFrameworkSystem::convertDashesToUnderscores($configKey);
218 // Is the configuration key there?
219 if (!$this->isConfigurationEntrySet($configKey)) {
220 // Entry was not found!
221 throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND);
225 unset(self::$config[$configKey]);
229 * Getter for field name
231 * @param $fieldName Field name which we shall get
232 * @return $fieldValue Field value from the user
233 * @throws NullPointerException If the result instance is null
235 public final function getField ($fieldName) {
236 // The super interface "FrameworkInterface" requires this
237 throw new UnsupportedOperationException(array($this, __FUNCTION__), BaseFrameworkSystem::EXCEPTION_UNSPPORTED_OPERATION);
241 * Checks if given field is set
243 * @param $fieldName Field name to check
244 * @return $isSet Whether the given field name is set
245 * @throws NullPointerException If the result instance is null
247 public function isFieldSet ($fieldName) {
248 // The super interface "FrameworkInterface" requires this
249 throw new UnsupportedOperationException(array($this, __FUNCTION__), BaseFrameworkSystem::EXCEPTION_UNSPPORTED_OPERATION);
253 * Generates a code for hashes from this class
255 * @return $hashCode The hash code respresenting this class
257 public function hashCode () {
258 return crc32($this->__toString());
262 * Checks whether an object equals this object. You should overwrite this
263 * method to implement own equality checks
265 * @param $objectInstance An instance of a FrameworkInterface object
266 * @return $equals Whether both objects equals
268 public function equals (FrameworkInterface $objectInstance) {
271 $this->__toString() === $objectInstance->__toString()
273 $this->hashCode() === $objectInstance->hashCode()
281 * Setter for call-back instance
283 * @param $callbackInstance An instance of a FrameworkInterface class
286 public function setCallbackInstance (FrameworkInterface $callbackInstance) {
287 $this->callbackInstance = $callbackInstance;