Config::loadConfigurationFile() - Code Metrics - Inspection of "Cambios en la forma de cargar las clases globales." - rsanjoseo/alxarafe - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — main ( b6e144...1a2341 )

by Rafael

created 2023-01-20 19:23 UTC

Config::loadConfigurationFile() A

↳ Parent: Config

Complexity

Conditions	4
Paths	3

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	6
nc	3
nop	0
dl	0
loc	10
rs	10
c	0
b	0
f	0

<?php
/**
 * Copyright (C) 2022-2023  Rafael San José Tovar   <[email protected]>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

namespace Alxarafe\Core\Singletons;

use Symfony\Component\Yaml\Yaml;

/**
 * Class Config
 *
 * Carga la configuración y da soporte para su mantenimiento, leyéndola o guardándola
 * en un archivo yaml.
 *
 * @author  Rafael San José Tovar <[email protected]>
 *
 * @package Alxarafe\Core\Singletons
 */
abstract class Config
{
    /**
     * Ruta completa del fichero de configuración
     *
     * @var string
     */
    private static string $configFilename;

    /**
     * Contiene un array con el contenido íntegro del archivo de configuración.
     *
     * @var array
     */
    private static array $global;

    /**
     * Carga el fichero de configuración en la variable $global. Las constantes definidas
     * en el mismo, se definen como constantes de php con 'define'.
     *
     * @author Rafael San José Tovar <[email protected]>
     *
     * @return false|void
     */
    public static function load()
    {
        if (!isset(self::$global)) {
            self::$global = self::loadConfigurationFile();
            if (empty(self::$global)) {
                return false;
            }
        }
        self::defineConstants();
    }

    /**
     * Define todas las constantes de la sección 'constants' del archivo config.yaml
     * La sección constants contiene las constantes en grupos de tipo.
     * TODO: De momento se contempla boolean y el resto.
     *
     * @author  Rafael San José Tovar <[email protected]>
     */
    private static function defineConstants()
    {
        foreach (self::$global['constants'] ?? [] as $type => $types) {
            foreach ($types as $name => $value) {
                switch ($type) {
                    case 'boolean':
                        define($name, in_array(strtolower($value), ['1', 'true']));
                        break;
                    default:
                        define($name, $value);
                }
            }
        }
    }

    /**
     * Carga el fichero de configuración y lo retorna como un array
     *
     * @author Rafael San José Tovar <[email protected]>
     *
     * @return array
     */
    private static function loadConfigurationFile(): array
    {
        $filename = self::getConfigFileName();
        if (isset($filename) && file_exists($filename)) {
            $yaml = file_get_contents($filename);
            if ($yaml) {
                return YAML::parse($yaml);
            }
        }
        return [];
    }

    /**
     * Retorna el nombre del fichero de configuración comprobando que la carpeta
     * que lo debe de contener existe.
     * Si la carpeta no existe, la crea.
     *
     * @return string|null
     */
    private static function getConfigFileName(): ?string
    {
        if (isset(self::$configFilename)) {
            return self::$configFilename;
        }
        $filename = constant('CONFIGURATION_DIR') . 'config.yaml';
        if (
            file_exists($filename) || is_dir(constant('CONFIGURATION_DIR')) || mkdir(constant('CONFIGURATION_DIR'), 0777, true)) {
            self::$configFilename = $filename;
        }
        return self::$configFilename;
    }

    /**
     * Retorna el valor de una variable del archivo de configuración.
     * Si no existe, retorna null.
     *
     * @param string $module
     * @param string $section
     * @param string $name
     *
     * @return string|null ?string
     */
    public static function getVar(string $module, string $section, string $name): ?string
    {
        return self::$global[$module][$section][$name] ?? null;
    }

    /**
     * Retorna un array con todas las variables de un módulo.
     * Si no existe el módulo, retorna null.
     *
     * @author Rafael San José Tovar <[email protected]>
     *
     * @param string $module
     *
     * @return array|null
     */
    public static function getModuleVar(string $module): ?array
    {
        return self::$global[$module] ?? null;
    }

    /**
     * Return true y the config file exists
     *
     * @return bool
     */
    public static function configFileExists(): bool
    {
        return (file_exists(self::getConfigFileName()));
    }

    /**
     * Stores all the variables in a permanent file so that they can be loaded
     * later with loadConfigFile()
     * Returns true if there is no error when saving the file.
     *
     * @return bool
     */
    public static function saveConfigFile(): bool
    {
        $configFile = self::getConfigFileName();
        if (!isset($configFile)) {
            return false;
        }
        return file_put_contents($configFile, YAML::dump(self::$global, 3)) !== false;
    }

    /**
     * Stores a variable.
     *
     * @param string $module
     * @param string $section
     * @param string $name
     * @param string $value
     */
    public static function setVar(string $module, string $section, string $name, string $value)
    {
        self::$global[$module][$section][$name] = $value;
    }
}


1			<?php
2			/**
3			* Copyright (C) 2022-2023 Rafael San José Tovar <[email protected]>
4			*
5			* This program is free software; you can redistribute it and/or modify
6			* it under the terms of the GNU General Public License as published by
7			* the Free Software Foundation; either version 3 of the License, or
8			* (at your option) any later version.
9			*
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			*
15			* You should have received a copy of the GNU General Public License
16			* along with this program. If not, see <https://www.gnu.org/licenses/>.
17			*/
18
19			namespace Alxarafe\Core\Singletons;
20
21			use Symfony\Component\Yaml\Yaml;
22
23			/**
24			* Class Config
25			*
26			* Carga la configuración y da soporte para su mantenimiento, leyéndola o guardándola
27			* en un archivo yaml.
28			*
29			* @author Rafael San José Tovar <[email protected]>
30			*
31			* @package Alxarafe\Core\Singletons
32			*/
33			abstract class Config
34			{
35			/**
36			* Ruta completa del fichero de configuración
37			*
38			* @var string
39			*/
40			private static string $configFilename;
41
42			/**
43			* Contiene un array con el contenido íntegro del archivo de configuración.
44			*
45			* @var array
46			*/
47			private static array $global;
48
49			/**
50			* Carga el fichero de configuración en la variable $global. Las constantes definidas
51			* en el mismo, se definen como constantes de php con 'define'.
52			*
53			* @author Rafael San José Tovar <[email protected]>
54			*
55			* @return false\|void
56			*/
57			public static function load()
58			{
59			if (!isset(self::$global)) {
60			self::$global = self::loadConfigurationFile();
61			if (empty(self::$global)) {
62			return false;
63			}
64			}
65			self::defineConstants();
66			}
67
68			/**
69			* Define todas las constantes de la sección 'constants' del archivo config.yaml
70			* La sección constants contiene las constantes en grupos de tipo.
71			* TODO: De momento se contempla boolean y el resto.
72			*
73			* @author Rafael San José Tovar <[email protected]>
74			*/
75			private static function defineConstants()
76			{
77			foreach (self::$global['constants'] ?? [] as $type => $types) {
78			foreach ($types as $name => $value) {
79			switch ($type) {
80			case 'boolean':
81			define($name, in_array(strtolower($value), ['1', 'true']));
82			break;
83			default:
84			define($name, $value);
85			}
86			}
87			}
88			}
89
90			/**
91			* Carga el fichero de configuración y lo retorna como un array
92			*
93			* @author Rafael San José Tovar <[email protected]>
94			*
95			* @return array
96			*/
97			private static function loadConfigurationFile(): array
98			{
99			$filename = self::getConfigFileName();
100			if (isset($filename) && file_exists($filename)) {
101			$yaml = file_get_contents($filename);
102			if ($yaml) {
103			return YAML::parse($yaml);
104			}
105			}
106			return [];
107			}
108
109			/**
110			* Retorna el nombre del fichero de configuración comprobando que la carpeta
111			* que lo debe de contener existe.
112			* Si la carpeta no existe, la crea.
113			*
114			* @return string\|null
115			*/
116			private static function getConfigFileName(): ?string
117			{
118			if (isset(self::$configFilename)) {
119			return self::$configFilename;
120			}
121			$filename = constant('CONFIGURATION_DIR') . 'config.yaml';
122			if (
123			file_exists($filename) \|\| is_dir(constant('CONFIGURATION_DIR')) \|\| mkdir(constant('CONFIGURATION_DIR'), 0777, true)) {
124			self::$configFilename = $filename;
125			}
126			return self::$configFilename;
127			}
128
129			/**
130			* Retorna el valor de una variable del archivo de configuración.
131			* Si no existe, retorna null.
132			*
133			* @param string $module
134			* @param string $section
135			* @param string $name
136			*
137			* @return string\|null ?string
138			*/
139			public static function getVar(string $module, string $section, string $name): ?string
140			{
141			return self::$global[$module][$section][$name] ?? null;
142			}
143
144			/**
145			* Retorna un array con todas las variables de un módulo.
146			* Si no existe el módulo, retorna null.
147			*
148			* @author Rafael San José Tovar <[email protected]>
149			*
150			* @param string $module
151			*
152			* @return array\|null
153			*/
154			public static function getModuleVar(string $module): ?array
155			{
156			return self::$global[$module] ?? null;
157			}
158
159			/**
160			* Return true y the config file exists
161			*
162			* @return bool
163			*/
164			public static function configFileExists(): bool
165			{
166			return (file_exists(self::getConfigFileName()));
167			}
168
169			/**
170			* Stores all the variables in a permanent file so that they can be loaded
171			* later with loadConfigFile()
172			* Returns true if there is no error when saving the file.
173			*
174			* @return bool
175			*/
176			public static function saveConfigFile(): bool
177			{
178			$configFile = self::getConfigFileName();
179			if (!isset($configFile)) {
180			return false;
181			}
182			return file_put_contents($configFile, YAML::dump(self::$global, 3)) !== false;
183			}
184
185			/**
186			* Stores a variable.
187			*
188			* @param string $module
189			* @param string $section
190			* @param string $name
191			* @param string $value
192			*/
193			public static function setVar(string $module, string $section, string $name, string $value)
194			{
195			self::$global[$module][$section][$name] = $value;
196			}
197			}
198

rsanjoseo / alxarafe

Push — main ( b6e144...1a2341 )

Config::loadConfigurationFile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like