4 namespace Org\Mxchange\CoreFramework\Configuration;
6 // Import framework stuff
7 use Org\Mxchange\CoreFramework\Configuration\NoConfigEntryException;
8 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
9 use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
10 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
11 use Org\Mxchange\CoreFramework\Registry\Registerable;
12 use Org\Mxchange\CoreFramework\Utils\Strings\StringUtils;
15 use \InvalidArgumentException;
18 * A class for the configuration stuff implemented in a singleton design paddern
20 * NOTE: We cannot put this in framework/main/ because it would be loaded (again) in
21 * class loader. See framework/loader/class_ClassLoader.php for instance
24 * @author Roland Haeder <webmaster@shipsimu.org>
26 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2021 Core Developer Team
27 * @license GNU GPL 3.0 or any newer version
28 * @link http://www.shipsimu.org
30 * This program is free software: you can redistribute it and/or modify
31 * it under the terms of the GNU General Public License as published by
32 * the Free Software Foundation, either version 3 of the License, or
33 * (at your option) any later version.
35 * This program is distributed in the hope that it will be useful,
36 * but WITHOUT ANY WARRANTY; without even the implied warranty of
37 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
38 * GNU General Public License for more details.
40 * You should have received a copy of the GNU General Public License
41 * along with this program. If not, see <http://www.gnu.org/licenses/>.
43 class FrameworkConfiguration implements Registerable {
44 // Some constants for the configuration system
45 const EXCEPTION_CONFIG_KEY_IS_EMPTY = 0x130;
46 const EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND = 0x131;
47 const EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED = 0x132;
50 * The framework's main configuration array which will be initialized with
51 * hard-coded configuration data and might be overwritten/extended by
52 * config data from the database.
54 private static $configData = [];
57 * Call-back instance (unused)
59 private $callbackInstance = NULL;
62 * Default constructor, the configuration entries are static, not the
67 public function __construct () {
72 * Compatiblity method to return this class' name
74 * @return __CLASS__ This class' name
76 public function __toString () {
77 return get_class($this);
81 * Checks whether the given configuration key is set
83 * @param $configKey The configuration key we shall check
84 * @return $isset Whether the given configuration key is set
85 * @throws InvalidArgumentException If $configKey is empty
87 public function isConfigurationEntrySet (string $configKey) {
89 if (empty($configKey)) {
91 throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
95 $isset = ((isset(self::$configData[$configKey])) || (array_key_exists($configKey, self::$configData)));
102 * Read a configuration element.
104 * @param $configKey The configuration element
105 * @return $configValue The fetched configuration value
106 * @throws InvalidArgumentException If $configKey is empty
107 * @throws NoConfigEntryException If a configuration element was not found
109 public function getConfigEntry (string $configKey) {
111 if (empty($configKey)) {
113 throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
116 // Convert dashes to underscore
117 $configKey = StringUtils::convertDashesToUnderscores($configKey);
119 // Is a valid configuration key provided?
120 if (!$this->isConfigurationEntrySet($configKey)) {
121 // Entry was not found!
122 throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND);
125 // Return the requested value
126 return self::$configData[$configKey];
130 * Set a configuration key
132 * @param $configKey The configuration key we want to add/change
133 * @param $configValue The configuration value we want to set
135 * @throws InvalidArgumentException If $configKey is empty
136 * @throws InvalidArgumentException If $configValue has an unsupported variable type
138 public final function setConfigEntry (string $configKey, $configValue) {
139 // Is a valid configuration key key provided?
140 if (empty($configKey)) {
142 throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
143 } elseif ((is_array($configValue)) || (is_object($configValue)) || (is_resource($configValue))) {
144 // These cannot be set as this is not intended for configuration values, please use FrameworkArrayObject instead.
145 throw new InvalidArgumentException(sprintf('configValue[]=%s for configKey=%s is not supported.', gettype($configValue), $configKey), self::EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED);
149 $configKey = StringUtils::convertDashesToUnderscores($configKey);
151 // Set the configuration value
152 //* NOISY-DEBUG: */ print(__METHOD__ . ':configEntry=' . $configKey . ',configValue[' . gettype($configValue) . ']=' . $configValue . PHP_EOL);
153 self::$configData[$configKey] = $configValue;
156 ksort(self::$configData);
160 * Getter for whole configuration array
162 * @return $config Configuration array
164 public final function getConfigurationArray () {
166 return self::$configData;
170 * Unset a configuration key, the entry must be there or else an
171 * exception is thrown.
173 * @param $configKey Configuration key to unset
175 * @throws InvalidArgumentException If $configKey is empty
176 * @throws NoConfigEntryException If a configuration element was not found
178 public final function unsetConfigEntry (string $configKey) {
179 // Validate parameters
180 if (empty($configKey)) {
182 throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
185 // Convert dashes to underscore
186 $configKey = StringUtils::convertDashesToUnderscores($configKey);
188 // Is the configuration key there?
189 if (!$this->isConfigurationEntrySet($configKey)) {
190 // Entry was not found!
191 throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND);
195 unset(self::$configData[$configKey]);
199 * Generates a code for hashes from this class
201 * @return $hashCode The hash code respresenting this class
203 public function hashCode () {
204 return crc32($this->__toString());
208 * Checks whether an object equals this object. You should overwrite this
209 * method to implement own equality checks
211 * @param $objectInstance An instance of a FrameworkInterface object
212 * @return $equals Whether both objects equals
214 public function equals (FrameworkInterface $objectInstance) {
217 $this->__toString() === $objectInstance->__toString()
219 $this->hashCode() === $objectInstance->hashCode()
227 * Setter for call-back instance
229 * @param $callbackInstance An instance of a FrameworkInterface class
232 public function setCallbackInstance (FrameworkInterface $callbackInstance) {
233 $this->callbackInstance = $callbackInstance;
237 * Getter for field name
239 * @param $fieldName Field name which we shall get
240 * @return $fieldValue Field value from the user
241 * @throws NullPointerException If the result instance is null
243 public final function getField (string $fieldName) {
244 // The super interface "FrameworkInterface" requires this
245 throw new UnsupportedOperationException(array($this, __FUNCTION__), BaseFrameworkSystem::EXCEPTION_UNSPPORTED_OPERATION);
249 * Checks if given field is set
251 * @param $fieldName Field name to check
252 * @return $isSet Whether the given field name is set
253 * @throws NullPointerException If the result instance is null
255 public function isFieldSet (string $fieldName) {
256 // The super interface "FrameworkInterface" requires this
257 throw new UnsupportedOperationException(array($this, __FUNCTION__), BaseFrameworkSystem::EXCEPTION_UNSPPORTED_OPERATION);