4 namespace Org\Mxchange\CoreFramework\Configuration;
6 // Import framework stuff
7 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
8 use Org\Mxchange\CoreFramework\Generic\NullPointerException;
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\String\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 - 2020 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 {
46 * The framework's main configuration array which will be initialized with
47 * hard-coded configuration data and might be overwritten/extended by
48 * config data from the database.
50 private static $config = [];
53 * Call-back instance (unused)
55 private $callbackInstance = NULL;
57 // Some constants for the configuration system
58 const EXCEPTION_CONFIG_KEY_IS_EMPTY = 0x130;
59 const EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND = 0x131;
60 const EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED = 0x132;
63 * Default constructor, the configuration entries are static, not the
68 public function __construct () {
73 * Compatiblity method to return this class' name
75 * @return __CLASS__ This class' name
77 public function __toString () {
78 return get_class($this);
82 * Checks whether the given configuration key is set
84 * @param $configKey The configuration key we shall check
85 * @return $isset Whether the given configuration key is set
86 * @throws NullPointerException If $configKey is NULL
87 * @throws InvalidArgumentException If $configKey is empty
89 public function isConfigurationEntrySet ($configKey) {
91 if (is_null($configKey)) {
93 throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
94 } elseif (!is_string($configKey)) {
96 throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
97 } elseif ((is_string($configKey)) && (empty($configKey))) {
99 throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
103 $isset = ((isset(self::$config[$configKey])) || (array_key_exists($configKey, self::$config)));
110 * Read a configuration element.
112 * @param $configKey The configuration element
113 * @return $configValue The fetched configuration value
114 * @throws NullPointerException If $configKey is NULL
115 * @throws InvalidArgumentException If $configKey is empty
116 * @throws NoConfigEntryException If a configuration element was not found
118 public function getConfigEntry ($configKey) {
120 if (is_null($configKey)) {
122 throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
123 } elseif (!is_string($configKey)) {
125 throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
126 } elseif ((is_string($configKey)) && (empty($configKey))) {
128 throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
131 // Convert dashes to underscore
132 $configKey = StringUtils::convertDashesToUnderscores($configKey);
134 // Is a valid configuration key provided?
135 if (!$this->isConfigurationEntrySet($configKey)) {
136 // Entry was not found!
137 throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND);
140 // Return the requested value
141 return self::$config[$configKey];
145 * Set a configuration key
147 * @param $configKey The configuration key we want to add/change
148 * @param $configValue The configuration value we want to set
150 * @throws NullPointerException If $configKey is NULL
151 * @throws InvalidArgumentException If $configKey is empty
152 * @throws InvalidArgumentException If $configValue has an unsupported variable type
154 public final function setConfigEntry ($configKey, $configValue) {
155 // Is a valid configuration key key provided?
156 if (is_null($configKey)) {
157 // Configuration key is null
158 throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
159 } elseif (!is_string($configKey)) {
161 throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
162 } elseif ((is_string($configKey)) && (empty($configKey))) {
164 throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
165 } elseif ((is_array($configValue)) || (is_object($configValue)) || (is_resource($configValue))) {
166 // These cannot be set as this is not intended for configuration values, please use FrameworkArrayObject instead.
167 throw new InvalidArgumentException(sprintf('configValue[]=%s for configKey=%s is not supported.', gettype($configValue), $configKey), self::EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED);
171 $configKey = StringUtils::convertDashesToUnderscores($configKey);
173 // Set the configuration value
174 //* NOISY-DEBUG: */ print(__METHOD__ . ':configEntry=' . $configKey . ',configValue[' . gettype($configValue) . ']=' . $configValue . PHP_EOL);
175 self::$config[$configKey] = $configValue;
178 ksort(self::$config);
182 * Getter for whole configuration array
184 * @return $config Configuration array
186 public final function getConfigurationArray () {
188 return self::$config;
192 * Unset a configuration key, the entry must be there or else an
193 * exception is thrown.
195 * @param $configKey Configuration key to unset
197 * @throws NullPointerException If $configKey is NULL
198 * @throws InvalidArgumentException If $configKey is empty
199 * @throws NoConfigEntryException If a configuration element was not found
201 public final function unsetConfigEntry ($configKey) {
202 // Validate parameters
203 if (is_null($configKey)) {
204 // Configuration key is null
205 throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
206 } elseif (!is_string($configKey)) {
208 throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
209 } elseif ((is_string($configKey)) && (empty($configKey))) {
211 throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
214 // Convert dashes to underscore
215 $configKey = StringUtils::convertDashesToUnderscores($configKey);
217 // Is the configuration key there?
218 if (!$this->isConfigurationEntrySet($configKey)) {
219 // Entry was not found!
220 throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND);
224 unset(self::$config[$configKey]);
228 * Getter for field name
230 * @param $fieldName Field name which we shall get
231 * @return $fieldValue Field value from the user
232 * @throws NullPointerException If the result instance is null
234 public final function getField ($fieldName) {
235 // The super interface "FrameworkInterface" requires this
236 throw new UnsupportedOperationException(array($this, __FUNCTION__), BaseFrameworkSystem::EXCEPTION_UNSPPORTED_OPERATION);
240 * Checks if given field is set
242 * @param $fieldName Field name to check
243 * @return $isSet Whether the given field name is set
244 * @throws NullPointerException If the result instance is null
246 public function isFieldSet ($fieldName) {
247 // The super interface "FrameworkInterface" requires this
248 throw new UnsupportedOperationException(array($this, __FUNCTION__), BaseFrameworkSystem::EXCEPTION_UNSPPORTED_OPERATION);
252 * Generates a code for hashes from this class
254 * @return $hashCode The hash code respresenting this class
256 public function hashCode () {
257 return crc32($this->__toString());
261 * Checks whether an object equals this object. You should overwrite this
262 * method to implement own equality checks
264 * @param $objectInstance An instance of a FrameworkInterface object
265 * @return $equals Whether both objects equals
267 public function equals (FrameworkInterface $objectInstance) {
270 $this->__toString() === $objectInstance->__toString()
272 $this->hashCode() === $objectInstance->hashCode()
280 * Setter for call-back instance
282 * @param $callbackInstance An instance of a FrameworkInterface class
285 public function setCallbackInstance (FrameworkInterface $callbackInstance) {
286 $this->callbackInstance = $callbackInstance;