jaxon-php / jaxon-core

src/App/Config/ConfigManager.php

<?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
 */

PHP version not specified

Missing @category tag in file comment

namespace Jaxon\App\Config;

use Jaxon\App\I18n\Translator;
use Jaxon\Exception\SetupException;
use Jaxon\Utils\Config\Config;
use Jaxon\Utils\Config\ConfigReader;
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 ConfigReader
     */
    protected $xConfigReader;

    /**
     * @var ConfigEventManager
     */
    protected $xEventManager;

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

    /**
     * The constructor
     *
     * @param ConfigReader $xConfigReader

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

     * @param ConfigEventManager $xEventManager

Missing parameter comment

     * @param Translator $xTranslator

Missing parameter comment

Expected 9 spaces after parameter type; 1 found

     */
    public function __construct(ConfigReader $xConfigReader, ConfigEventManager $xEventManager, Translator $xTranslator)

Expected 2 blank lines before function; 1 found

    {
        $this->xConfigReader = $xConfigReader;
        $this->xEventManager = $xEventManager;
        $this->xTranslator = $xTranslator;

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

        $this->xConfig = new Config();

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

    }

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->xConfigReader->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
        {
            // Read the options and save in the config.
            $this->xConfig->setOptions($this->read($sConfigFile), $sConfigSection);
            // Call the config change listeners.
            $this->xEventManager->onChange($this->xConfig, '');
        }
        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

Expected 2 spaces after parameter type; 1 found

     * @param string $sKeys

Missing parameter comment

     *
     * @return bool
     * @throws SetupException
     */
    public function setOptions(array $aOptions, string $sKeys = ''): bool
    {
        try
        {
            if(!$this->xConfig->setOptions($aOptions, $sKeys))
            {
                return false;
            }
            // Call the config change listeners.
            $this->xEventManager->onChange($this->xConfig, '');
            return true;
        }
        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);
        // Call the config change listeners.
        $this->xEventManager->onChange($this->xConfig, $sName);
    }

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 names of the options matching a given prefix
     *
     * @param string $sPrefix The prefix to match
     *
     * @return array
     */
    public function getOptionNames(string $sPrefix): array
    {
        return $this->xConfig->getOptionNames($sPrefix);
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 spaces after parameter type; 1 found

Expected 1 spaces after parameter name; 4 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

}