ConfigManager::read() - Code Metrics - Inspection of "Clean code, remove unused functions." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5b7bca...888408 )

by Thierry

created 2022-03-18 13:55 UTC

ConfigManager::read() A

↳ Parent: ConfigManager

Complexity

Conditions	5
Paths	5

Size

Total Lines	25
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	14
nc	5
nop	1
dl	0
loc	25
rs	9.4888
c	1
b	0
f	0

<?php

/**
 * ConfigManager.php - Jaxon config reader
 *
 * Extends the config reader in the jaxon-utils package, and provides exception handlers.
 *
 * @package jaxon-core

 * @author Thierry Feuzeu <[email protected]>
 * @copyright 2022 Thierry Feuzeu <[email protected]>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */


namespace Jaxon\Config;

use Jaxon\Utils\Config\Config;
use Jaxon\Utils\Config\Reader;
use Jaxon\Utils\Translation\Translator;
use Jaxon\Exception\SetupException;
use Jaxon\Utils\Config\Exception\DataDepth;
use Jaxon\Utils\Config\Exception\FileAccess;
use Jaxon\Utils\Config\Exception\FileContent;
use Jaxon\Utils\Config\Exception\FileExtension;
use Jaxon\Utils\Config\Exception\YamlExtension;

class ConfigManager

{
    /**
     * @var Config
     */
    protected $xConfig;


    /**
     * @var Reader
     */
    protected $xReader;

    /**
     * @var Translator
     */
    protected $xTranslator;

    /**
     * The constructor
     *
     * @param Config $xConfig

     * @param Reader $xReader

     * @param Translator $xTranslator

     */
    public function __construct(Config $xConfig, Reader $xReader, Translator $xTranslator)

    {
        $this->xConfig = $xConfig;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xReader = $xReader;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xTranslator = $xTranslator;
    }


    /**
     * Read a config file
     *
     * @param string $sConfigFile

     *
     * @return array
     * @throws SetupException
     */
    public function read(string $sConfigFile): array
    {
        try
        {
            return $this->xReader->read($sConfigFile);
        }
        catch(YamlExtension $e)
        {
            $sMessage = $this->xTranslator->trans('errors.yaml.install');
            throw new SetupException($sMessage);
        }
        catch(FileExtension $e)
        {
            $sMessage = $this->xTranslator->trans('errors.file.extension', ['path' => $sConfigFile]);
            throw new SetupException($sMessage);
        }
        catch(FileAccess $e)
        {
            $sMessage = $this->xTranslator->trans('errors.file.access', ['path' => $sConfigFile]);
            throw new SetupException($sMessage);
        }
        catch(FileContent $e)
        {
            $sMessage = $this->xTranslator->trans('errors.file.content', ['path' => $sConfigFile]);
            throw new SetupException($sMessage);
        }
    }


    /**
     * Read options from a config file and set the library config
     *
     * @param string $sConfigFile The full path to the config file

     * @param string $sConfigSection The section of the config file to be loaded
     *
     * @return void
     * @throws SetupException
     */
    public function load(string $sConfigFile, string $sConfigSection = '')
    {
        try
        {
            $this->xReader->load($this->xConfig, $sConfigFile, $sConfigSection);
        }
        catch(YamlExtension $e)
        {
            $sMessage = $this->xTranslator->trans('errors.yaml.install');
            throw new SetupException($sMessage);
        }
        catch(FileExtension $e)
        {
            $sMessage = $this->xTranslator->trans('errors.file.extension', ['path' => $sConfigFile]);
            throw new SetupException($sMessage);
        }
        catch(FileAccess $e)
        {
            $sMessage = $this->xTranslator->trans('errors.file.access', ['path' => $sConfigFile]);
            throw new SetupException($sMessage);
        }
        catch(FileContent $e)
        {
            $sMessage = $this->xTranslator->trans('errors.file.content', ['path' => $sConfigFile]);
            throw new SetupException($sMessage);
        }
        catch(DataDepth $e)
        {
            $sMessage = $this->xTranslator->trans('errors.data.depth',
                ['key' => $e->sPrefix, 'depth' => $e->nDepth]);
            throw new SetupException($sMessage);
        }
    }


    /**
     * Set the config options of the library
     *
     * @param array $aOptions

     *
     * @return void
     * @throws SetupException
     */
    public function setOptions(array $aOptions): void
    {
        try
        {
            $this->xConfig->setOptions($aOptions);
        }
        catch(DataDepth $e)
        {
            $sMessage = $this->xTranslator->trans('errors.data.depth',
                ['key' => $e->sPrefix, 'depth' => $e->nDepth]);
            throw new SetupException($sMessage);
        }
    }


    /**
     * Set the value of a config option
     *
     * @param string $sName The option name

     * @param mixed $xValue The option value

     *
     * @return void
     */
    public function setOption(string $sName, $xValue)
    {
        $this->xConfig->setOption($sName, $xValue);
    }


    /**
     * Get the value of a config option
     *
     * @param string $sName The option name

     * @param mixed $xDefault The default value, to be returned if the option is not defined

     *
     * @return mixed
     */
    public function getOption(string $sName, $xDefault = null)
    {
        return $this->xConfig->getOption($sName, $xDefault);
    }


    /**
     * Check the presence of a config option
     *
     * @param string $sName The option name
     *
     * @return bool
     */
    public function hasOption(string $sName): bool
    {
        return $this->xConfig->hasOption($sName);
    }


    /**
     * Get the library config
     *
     * @return Config
     */
    public function getConfig(): Config
    {
        return $this->xConfig;
    }


    /**
     * Create a new the config object
     *
     * @param array $aOptions    The options array

     * @param string $sKeys    The prefix of key of the config options
     *
     * @return Config
     * @throws SetupException
     */
    public function newConfig(array $aOptions = [], string $sKeys = ''): Config
    {
        try
        {
            return new Config($aOptions, $sKeys);
        }
        catch(DataDepth $e)
        {
            $sMessage = $this->xTranslator->trans('errors.data.depth',
                ['key' => $e->sPrefix, 'depth' => $e->nDepth]);
            throw new SetupException($sMessage);
        }
    }

}


1			<?php
2
3			/**
4			* ConfigManager.php - Jaxon config reader
5			*
6			* Extends the config reader in the jaxon-utils package, and provides exception handlers.
7			*
8			* @package jaxon-core
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Package name "jaxon-core" is not valid; consider "Jaxoncore" instead Loading history...
9			* @author Thierry Feuzeu <[email protected]>
10			* @copyright 2022 Thierry Feuzeu <[email protected]>
11			* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
12			* @link https://github.com/jaxon-php/jaxon-core
13			*/
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report PHP version not specified Loading history...
14
15			namespace Jaxon\Config;
16
17			use Jaxon\Utils\Config\Config;
18			use Jaxon\Utils\Config\Reader;
19			use Jaxon\Utils\Translation\Translator;
20			use Jaxon\Exception\SetupException;
21			use Jaxon\Utils\Config\Exception\DataDepth;
22			use Jaxon\Utils\Config\Exception\FileAccess;
23			use Jaxon\Utils\Config\Exception\FileContent;
24			use Jaxon\Utils\Config\Exception\FileExtension;
25			use Jaxon\Utils\Config\Exception\YamlExtension;
26
27			class ConfigManager
			0 ignored issues – show Coding Style introduced 2022-03-17 03:59 UTC by Report Bug Copy Issue Report Missing doc comment for class ConfigManager Loading history...
28			{
29			/**
30			* @var Config
31			*/
32			protected $xConfig;
			0 ignored issues – show Coding Style introduced 2022-03-17 03:59 UTC by Report Bug Copy Issue Report Expected 1 blank line(s) before first member var; 0 found Loading history...
33
34			/**
35			* @var Reader
36			*/
37			protected $xReader;
38
39			/**
40			* @var Translator
41			*/
42			protected $xTranslator;
43
44			/**
45			* The constructor
46			*
47			* @param Config $xConfig
			0 ignored issues – show Coding Style introduced 2022-03-13 11:44 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2022-03-13 11:44 UTC by Report Bug Copy Issue Report Expected 5 spaces after parameter type; 1 found Loading history...
48			* @param Reader $xReader
			0 ignored issues – show Coding Style introduced 2022-03-17 03:59 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2022-03-18 13:57 UTC by Report Bug Copy Issue Report Expected 5 spaces after parameter type; 1 found Loading history...
49			* @param Translator $xTranslator
			0 ignored issues – show Coding Style introduced 2022-03-17 03:59 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
50			*/
51			public function __construct(Config $xConfig, Reader $xReader, Translator $xTranslator)
			0 ignored issues – show Coding Style introduced 2022-03-17 03:59 UTC by Report Bug Copy Issue Report Expected 2 blank lines before function; 1 found Loading history...
52			{
53			$this->xConfig = $xConfig;
			0 ignored issues – show Coding Style introduced 2022-03-18 13:57 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
54			$this->xReader = $xReader;
			0 ignored issues – show Coding Style introduced 2022-03-18 13:57 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
55			$this->xTranslator = $xTranslator;
56			}
			0 ignored issues – show Coding Style introduced 2022-03-10 08:42 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
57
58			/**
59			* Read a config file
60			*
61			* @param string $sConfigFile
			0 ignored issues – show Coding Style introduced 2022-03-17 03:59 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
62			*
63			* @return array
64			* @throws SetupException
65			*/
66			public function read(string $sConfigFile): array
67			{
68			try
69			{
70			return $this->xReader->read($sConfigFile);
71			}
72			catch(YamlExtension $e)
73			{
74			$sMessage = $this->xTranslator->trans('errors.yaml.install');
75			throw new SetupException($sMessage);
76			}
77			catch(FileExtension $e)
78			{
79			$sMessage = $this->xTranslator->trans('errors.file.extension', ['path' => $sConfigFile]);
80			throw new SetupException($sMessage);
81			}
82			catch(FileAccess $e)
83			{
84			$sMessage = $this->xTranslator->trans('errors.file.access', ['path' => $sConfigFile]);
85			throw new SetupException($sMessage);
86			}
87			catch(FileContent $e)
88			{
89			$sMessage = $this->xTranslator->trans('errors.file.content', ['path' => $sConfigFile]);
90			throw new SetupException($sMessage);
91			}
92			}
			0 ignored issues – show Coding Style introduced 2019-12-07 05:40 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
93
94			/**
95			* Read options from a config file and set the library config
96			*
97			* @param string $sConfigFile The full path to the config file
			0 ignored issues – show Coding Style introduced 2021-12-10 16:39 UTC by Report Bug Copy Issue Report Expected 4 spaces after parameter name; 1 found Loading history...
98			* @param string $sConfigSection The section of the config file to be loaded
99			*
100			* @return void
101			* @throws SetupException
102			*/
103			public function load(string $sConfigFile, string $sConfigSection = '')
104			{
105			try
106			{
107			$this->xReader->load($this->xConfig, $sConfigFile, $sConfigSection);
108			}
109			catch(YamlExtension $e)
110			{
111			$sMessage = $this->xTranslator->trans('errors.yaml.install');
112			throw new SetupException($sMessage);
113			}
114			catch(FileExtension $e)
115			{
116			$sMessage = $this->xTranslator->trans('errors.file.extension', ['path' => $sConfigFile]);
117			throw new SetupException($sMessage);
118			}
119			catch(FileAccess $e)
120			{
121			$sMessage = $this->xTranslator->trans('errors.file.access', ['path' => $sConfigFile]);
122			throw new SetupException($sMessage);
123			}
124			catch(FileContent $e)
125			{
126			$sMessage = $this->xTranslator->trans('errors.file.content', ['path' => $sConfigFile]);
127			throw new SetupException($sMessage);
128			}
129			catch(DataDepth $e)
130			{
131			$sMessage = $this->xTranslator->trans('errors.data.depth',
132			['key' => $e->sPrefix, 'depth' => $e->nDepth]);
133			throw new SetupException($sMessage);
134			}
135			}
			0 ignored issues – show Coding Style introduced 2022-03-17 03:59 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
136
137			/**
138			* Set the config options of the library
139			*
140			* @param array $aOptions
			0 ignored issues – show Coding Style introduced 2022-03-18 13:57 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
141			*
142			* @return void
143			* @throws SetupException
144			*/
145			public function setOptions(array $aOptions): void
146			{
147			try
148			{
149			$this->xConfig->setOptions($aOptions);
150			}
151			catch(DataDepth $e)
152			{
153			$sMessage = $this->xTranslator->trans('errors.data.depth',
154			['key' => $e->sPrefix, 'depth' => $e->nDepth]);
155			throw new SetupException($sMessage);
156			}
157			}
			0 ignored issues – show Coding Style introduced 2022-03-17 03:59 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
158
159			/**
160			* Set the value of a config option
161			*
162			* @param string $sName The option name
			0 ignored issues – show Coding Style introduced 2022-03-18 13:57 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter name; 1 found Loading history...
163			* @param mixed $xValue The option value
			0 ignored issues – show Coding Style introduced 2022-03-17 03:59 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter type; 1 found Loading history...
164			*
165			* @return void
166			*/
167			public function setOption(string $sName, $xValue)
168			{
169			$this->xConfig->setOption($sName, $xValue);
170			}
			0 ignored issues – show Coding Style introduced 2022-03-18 13:57 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
171
172			/**
173			* Get the value of a config option
174			*
175			* @param string $sName The option name
			0 ignored issues – show Coding Style introduced 2022-03-18 13:57 UTC by Report Bug Copy Issue Report Expected 4 spaces after parameter name; 1 found Loading history...
176			* @param mixed $xDefault The default value, to be returned if the option is not defined
			0 ignored issues – show Coding Style introduced 2022-03-18 13:57 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter type; 1 found Loading history...
177			*
178			* @return mixed
179			*/
180			public function getOption(string $sName, $xDefault = null)
181			{
182			return $this->xConfig->getOption($sName, $xDefault);
183			}
			0 ignored issues – show Coding Style introduced 2022-03-18 13:57 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
184
185			/**
186			* Check the presence of a config option
187			*
188			* @param string $sName The option name
189			*
190			* @return bool
191			*/
192			public function hasOption(string $sName): bool
193			{
194			return $this->xConfig->hasOption($sName);
195			}
			0 ignored issues – show Coding Style introduced 2022-03-18 13:57 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
196
197			/**
198			* Get the library config
199			*
200			* @return Config
201			*/
202			public function getConfig(): Config
203			{
204			return $this->xConfig;
205			}
			0 ignored issues – show Coding Style introduced 2022-03-18 13:57 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
206
207			/**
208			* Create a new the config object
209			*
210			* @param array $aOptions The options array
			0 ignored issues – show Coding Style introduced 2022-03-17 03:59 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 4 found Loading history... Coding Style introduced 2021-12-10 16:39 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter type; 1 found Loading history...
211			* @param string $sKeys The prefix of key of the config options
212			*
213			* @return Config
214			* @throws SetupException
215			*/
216			public function newConfig(array $aOptions = [], string $sKeys = ''): Config
217			{
218			try
219			{
220			return new Config($aOptions, $sKeys);
221			}
222			catch(DataDepth $e)
223			{
224			$sMessage = $this->xTranslator->trans('errors.data.depth',
225			['key' => $e->sPrefix, 'depth' => $e->nDepth]);
226			throw new SetupException($sMessage);
227			}
228			}
			0 ignored issues – show Coding Style introduced 2022-03-17 03:59 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 0 found Loading history...
229			}
230

jaxon-php / jaxon-core

Push — master ( 5b7bca...888408 )

ConfigManager::read() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like