Config::getConfigPath() - Code Metrics - Inspection of "General improvements and new features" - MarwanAlsoltany/amqp-agent - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#12)

by Marwan

created 2022-05-12 09:31 UTC

Config::getConfigPath() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	0
crap	1

<?php

/**
 * @author Marwan Al-Soltany <[email protected]>
 * @copyright Marwan Al-Soltany 2020
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

declare(strict_types=1);

namespace MAKS\AmqpAgent;

use Exception;
use MAKS\AmqpAgent\Helper\ArrayProxy;
use MAKS\AmqpAgent\Exception\ConfigFileNotFoundException;

/**
 * A class that turns the configuration file into an object.
 *
 * Example:
 * ```
 * $config = new Config('path/to/some/config-file.php'); // specific config
 * $config = new Config(); // default config
 * ```
 *
 * @since 1.0.0
 * @property array $connectionOptions
 * @property array $channelOptions
 * @property array $queueOptions
 * @property array $exchangeOptions
 * @property array $bindOptions
 * @property array $qosOptions
 * @property array $waitOptions
 * @property array $messageOptions
 * @property array $publishOptions
 * @property array $consumeOptions
 * @property array $rpcConnectionOptions
 * @property string $rpcQueueName
 */
final class Config
{
    /**
     * The default name of the configuration file.
     * @var string
     */
    public const DEFAULT_CONFIG_FILE_NAME = 'maks-amqp-agent-config';

    /**
     * The default path of the configuration file.
     * @var string
     */
    public const DEFAULT_CONFIG_FILE_PATH = __DIR__ . DIRECTORY_SEPARATOR . 'Config' . DIRECTORY_SEPARATOR . self::DEFAULT_CONFIG_FILE_NAME . '.php';

    /**
     * The multidimensional configuration array.
     * @var array
     */
    private $config;

    /**
     * Configuration file path.
     * @var string
     */
    private $configPath;


    /**
     * Config object constructor.
     * @param string|null $configPath [optional] The path to AMQP Agent configuration file.
     * @throws ConfigFileNotFoundException
     */
    public function __construct(?string $configPath = null)
    {
        $configFile = realpath($configPath ?? self::DEFAULT_CONFIG_FILE_PATH);

        if (!$configFile || !file_exists($configFile)) {
            throw new ConfigFileNotFoundException(
                "AMQP Agent configuration file cloud not be found, check if the given path \"{$configPath}\" exists."
            );
        }

        $this->config = include($configFile);
        $this->configPath = $configFile;

        $this->repair();
    }

    /**
     * Gets the the given key from the configuration array via public property access notation.
     * @param string $key
     * @return mixed
     */
    public function __get(string $key)
    {
        return $this->config[$key];
    }

    /**
     * Sets the the given key in the configuration array via public property assignment notation.
     * @param string $key
     * @param mixed $value
     * @return void
     */
    public function __set(string $key, $value)
    {
        $this->config[$key] = $value;
    }

    /**
     * Returns config file path if the object was casted to a string.
     * @return string
     */
    public function __toString()
    {
        return $this->configPath;
    }


    /**
     * Repairs the config array if first-level of the passed array does not have all keys.
     * @return void
     */
    private function repair(): void
    {
        $config = require(self::DEFAULT_CONFIG_FILE_PATH);

        foreach ($config as $key => $value) {
            if (!array_key_exists($key, $this->config)) {
                $this->config[$key] = [];
            }
        }

        unset($config);
    }

    /**
     * Checks whether a value exists in the configuration array via dot-notation representation.
     * @since 1.2.2
     * @param string $key The dotted key representation.
     * @return bool True if key is set otherwise false.
     */
    public function has(string $key): bool
    {
        $value = ArrayProxy::getArrayValueByKey($this->config, $key, null);

        return isset($value);
    }

    /**
     * Gets a value of a key from the configuration array via dot-notation representation.
     * @since 1.2.2
     * @param string $key The dotted key representation.
     * @return mixed The requested value or null.
     */
    public function get(string $key)
    {
        $value = ArrayProxy::getArrayValueByKey($this->config, $key);

        return $value;
    }

    /**
     * Sets a value of a key from the configuration array via dot-notation representation.
     * @since 1.2.2
     * @param string $key The dotted key representation.
     * @param mixed $value The value to set.
     * @return self
     */
    public function set(string $key, $value)
    {
        ArrayProxy::setArrayValueByKey($this->config, $key, $value);

        return $this;
    }

    /**
     * Returns the default configuration array.
     * @return array
     */
    public function getDefaultConfig(): array
    {
        return include(self::DEFAULT_CONFIG_FILE_PATH);
    }

    /**
     * Returns the current configuration array.
     * @return array
     */
    public function getConfig(): array
    {
        return $this->config;
    }

    /**
     * Sets a new configuration array to be used instead of the current.
     * @param array $config
     * @return self
     */
    public function setConfig(array $config)
    {
        $this->config = $config;

        $this->repair();

        return $this;
    }

    /**
     * Returns the path of the configuration file.
     * @return string
     */
    public function getConfigPath(): string
    {
        return $this->configPath;
    }

    /**
     * Sets the path of the configuration file and rebuilds the internal state of the object.
     * @param string $configPath
     * @return self
     * @throws ConfigFileNotFoundException
     */
    public function setConfigPath(string $configPath)
    {
        try {
            $this->config = include($configPath);
            $this->configPath = $configPath;

            $this->repair();
        } catch (Exception $error) {
            throw new ConfigFileNotFoundException(
                "Something went wrong when trying to include the file and rebuild the configuration, check if the given path \"{$configPath}\" exists.",
                (int)$error->getCode(),
                $error
            );
        }

        return $this;
    }
}


1		<?php
2
3		/**
4		* @author Marwan Al-Soltany <[email protected]>
5		* @copyright Marwan Al-Soltany 2020
6		* For the full copyright and license information, please view
7		* the LICENSE file that was distributed with this source code.
8		*/
9
10		declare(strict_types=1);
11
12		namespace MAKS\AmqpAgent;
13
14		use Exception;
15		use MAKS\AmqpAgent\Helper\ArrayProxy;
16		use MAKS\AmqpAgent\Exception\ConfigFileNotFoundException;
17
18		/**
19		* A class that turns the configuration file into an object.
20		*
21		* Example:
22		* ```
23		* $config = new Config('path/to/some/config-file.php'); // specific config
24		* $config = new Config(); // default config
25		* ```
26		*
27		* @since 1.0.0
28		* @property array $connectionOptions
29		* @property array $channelOptions
30		* @property array $queueOptions
31		* @property array $exchangeOptions
32		* @property array $bindOptions
33		* @property array $qosOptions
34		* @property array $waitOptions
35		* @property array $messageOptions
36		* @property array $publishOptions
37		* @property array $consumeOptions
38		* @property array $rpcConnectionOptions
39		* @property string $rpcQueueName
40		*/
41		final class Config
42		{
43		/**
44		* The default name of the configuration file.
45		* @var string
46		*/
47		public const DEFAULT_CONFIG_FILE_NAME = 'maks-amqp-agent-config';
48
49		/**
50		* The default path of the configuration file.
51		* @var string
52		*/
53		public const DEFAULT_CONFIG_FILE_PATH = __DIR__ . DIRECTORY_SEPARATOR . 'Config' . DIRECTORY_SEPARATOR . self::DEFAULT_CONFIG_FILE_NAME . '.php';
54
55		/**
56		* The multidimensional configuration array.
57		* @var array
58		*/
59		private $config;
60
61		/**
62		* Configuration file path.
63		* @var string
64		*/
65		private $configPath;
66
67
68		/**
69		* Config object constructor.
70		* @param string\|null $configPath [optional] The path to AMQP Agent configuration file.
71		* @throws ConfigFileNotFoundException
72		*/
73	23	public function __construct(?string $configPath = null)
74		{
75	23	$configFile = realpath($configPath ?? self::DEFAULT_CONFIG_FILE_PATH);
76
77	23	if (!$configFile \|\| !file_exists($configFile)) {
78	1	throw new ConfigFileNotFoundException(
79	1	"AMQP Agent configuration file cloud not be found, check if the given path \"{$configPath}\" exists."
80		);
81		}
82
83	23	$this->config = include($configFile);
84	23	$this->configPath = $configFile;
85
86	23	$this->repair();
87	23	}
88
89		/**
90		* Gets the the given key from the configuration array via public property access notation.
91		* @param string $key
92		* @return mixed
93		*/
94	5	public function __get(string $key)
95		{
96	5	return $this->config[$key];
97		}
98
99		/**
100		* Sets the the given key in the configuration array via public property assignment notation.
101		* @param string $key
102		* @param mixed $value
103		* @return void
104		*/
105	1	public function __set(string $key, $value)
106		{
107	1	$this->config[$key] = $value;
108	1	}
109
110		/**
111		* Returns config file path if the object was casted to a string.
112		* @return string
113		*/
114	1	public function __toString()
115		{
116	1	return $this->configPath;
117		}
118
119
120		/**
121		* Repairs the config array if first-level of the passed array does not have all keys.
122		* @return void
123		*/
124	23	private function repair(): void
125		{
126	23	$config = require(self::DEFAULT_CONFIG_FILE_PATH);
127
128	23	foreach ($config as $key => $value) {
129	23	if (!array_key_exists($key, $this->config)) {
130	4	$this->config[$key] = [];
131		}
132		}
133
134	23	unset($config);
135	23	}
136
137		/**
138		* Checks whether a value exists in the configuration array via dot-notation representation.
139		* @since 1.2.2
140		* @param string $key The dotted key representation.
141		* @return bool True if key is set otherwise false.
142		*/
143	1	public function has(string $key): bool
144		{
145	1	$value = ArrayProxy::getArrayValueByKey($this->config, $key, null);
146
147	1	return isset($value);
148		}
149
150		/**
151		* Gets a value of a key from the configuration array via dot-notation representation.
152		* @since 1.2.2
153		* @param string $key The dotted key representation.
154		* @return mixed The requested value or null.
155		*/
156	2	public function get(string $key)
157		{
158	2	$value = ArrayProxy::getArrayValueByKey($this->config, $key);
159
160	2	return $value;
161		}
162
163		/**
164		* Sets a value of a key from the configuration array via dot-notation representation.
165		* @since 1.2.2
166		* @param string $key The dotted key representation.
167		* @param mixed $value The value to set.
168		* @return self
169		*/
170	1	public function set(string $key, $value)
171		{
172	1	ArrayProxy::setArrayValueByKey($this->config, $key, $value);
173
174	1	return $this;
175		}
176
177		/**
178		* Returns the default configuration array.
179		* @return array
180		*/
181	1	public function getDefaultConfig(): array
182		{
183	1	return include(self::DEFAULT_CONFIG_FILE_PATH);
184		}
185
186		/**
187		* Returns the current configuration array.
188		* @return array
189		*/
190	3	public function getConfig(): array
191		{
192	3	return $this->config;
193		}
194
195		/**
196		* Sets a new configuration array to be used instead of the current.
197		* @param array $config
198		* @return self
199		*/
200	4	public function setConfig(array $config)
201		{
202	4	$this->config = $config;
203
204	4	$this->repair();
205
206	4	return $this;
207		}
208
209		/**
210		* Returns the path of the configuration file.
211		* @return string
212		*/
213	2	public function getConfigPath(): string
214		{
215	2	return $this->configPath;
216		}
217
218		/**
219		* Sets the path of the configuration file and rebuilds the internal state of the object.
220		* @param string $configPath
221		* @return self
222		* @throws ConfigFileNotFoundException
223		*/
224	2	public function setConfigPath(string $configPath)
225		{
226		try {
227	2	$this->config = include($configPath);
228	1	$this->configPath = $configPath;
229
230	1	$this->repair();
231	1	} catch (Exception $error) {
232	1	throw new ConfigFileNotFoundException(
233	1	"Something went wrong when trying to include the file and rebuild the configuration, check if the given path \"{$configPath}\" exists.",
234	1	(int)$error->getCode(),
235	1	$error
236		);
237		}
238
239	1	return $this;
240		}
241		}
242

MarwanAlsoltany / amqp-agent

Pull Request — master (#12)

Config::getConfigPath() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like