Jaxon\Config\ConfigManager

Complexity

Total Complexity

20

Size/Duplication

Total Lines	200
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setOptions()	0	11	2
A	read()	0	25	5
A	load()	0	31	6
A	getConfig()	0	3	1
A	__construct()	0	5	1
A	setOption()	0	3	1
A	newConfig()	0	11	2
A	getOption()	0	3	1
A	hasOption()	0	3	1

<?php

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

Package name "jaxon-core" is not valid; consider "Jaxoncore" instead

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

Missing @category tag in file comment

PHP version not specified

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

Missing doc comment for class ConfigManager

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

Expected 1 blank line(s) before first member var; 0 found

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

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

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

Missing parameter comment

Expected 5 spaces after parameter type; 1 found

     * @param Reader $xReader

Missing parameter comment

Expected 5 spaces after parameter type; 1 found

     * @param Translator $xTranslator

Missing parameter comment

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

Expected 2 blank lines before function; 1 found

    {
        $this->xConfig = $xConfig;

Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

        $this->xReader = $xReader;

Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

        $this->xTranslator = $xTranslator;
    }

Expected 2 blank lines after function; 1 found

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

Missing parameter comment

     *
     * @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);
        }
    }

Expected 2 blank lines after function; 1 found

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

Expected 4 spaces after parameter name; 1 found

     * @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);
        }
    }

Expected 2 blank lines after function; 1 found

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

Missing parameter comment

     *
     * @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);
        }
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 spaces after parameter name; 1 found

     * @param mixed $xValue The option value

Expected 2 spaces after parameter type; 1 found

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

Expected 2 blank lines after function; 1 found

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

Expected 4 spaces after parameter name; 1 found

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

Expected 2 spaces after parameter type; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * 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);
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

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

Expected 1 spaces after parameter name; 4 found

Expected 2 spaces after parameter type; 1 found

     * @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);
        }
    }

Expected 2 blank lines after function; 0 found

}