Config::loadAllConfigValues() - Code Metrics - Inspection of "Allow adding config key-values from GacelaConfig" - gacela-project/gacela - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — feature/178-allow-adding-key-v... ( 9721fa )

by Chema

created 2022-07-13 13:57 UTC

Config::loadAllConfigValues() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Gacela\Framework\Config;

use Gacela\Framework\Bootstrap\SetupGacela;
use Gacela\Framework\Bootstrap\SetupGacelaInterface;
use Gacela\Framework\Exception\ConfigException;

use function array_key_exists;

final class Config
{
    public const DEFAULT_CONFIG_VALUE = 'Gacela\Framework\Config::DEFAULT_CONFIG_VALUE';

    private static ?self $instance = null;

    private ?string $appRootDir = null;

    /** @var array<string,mixed> */
    private array $config = [];

    private ?SetupGacelaInterface $setup = null;

    private ?ConfigFactory $configFactory = null;

    private function __construct()
    {
    }

    public static function getInstance(): self
    {
        if (self::$instance === null) {
            self::$instance = new self();
        }

        return self::$instance;

    }

    /**
     * @internal
     */
    public static function resetInstance(): void
    {
        self::$instance = null;
    }

    /**
     * @param null|mixed $default
     *
     * @throws ConfigException
     *
     * @return mixed
     */
    public function get(string $key, $default = self::DEFAULT_CONFIG_VALUE)
    {
        if (empty($this->config)) {
            $this->init();
        }

        if ($default !== self::DEFAULT_CONFIG_VALUE && !$this->hasValue($key)) {
            return $default;
        }

        if (!$this->hasValue($key)) {
            throw ConfigException::keyNotFound($key, self::class);
        }

        return $this->config[$key];
    }

    /**
     * Force loading all config values in memory.
     *
     * @throws ConfigException
     */
    public function init(): void
    {
        $this->configFactory = null;
        $this->config = $this->loadAllConfigValues();
        $this->config = array_merge($this->config, $this->getSetupGacela()->getConfigKeyValues());
    }

    public function setAppRootDir(string $dir): self
    {
        $this->appRootDir = $dir;

        if (empty($this->appRootDir)) {
            $this->appRootDir = getcwd() ?: ''; // @codeCoverageIgnore
        }

        return $this;
    }

    public function getAppRootDir(): string
    {
        return $this->appRootDir ?? getcwd() ?: '';
    }

    public function getCacheDir(): string
    {
        return $this->getAppRootDir() . '/' . $this->getSetupGacela()->getCacheDirectory();
    }

    public function setSetup(SetupGacelaInterface $setup): self
    {
        $this->setup = $setup;

        return $this;
    }

    /**
     * @internal
     */
    public function getFactory(): ConfigFactory
    {
        if ($this->configFactory === null) {
            $this->configFactory = new ConfigFactory(
                $this->getAppRootDir(),
                $this->getSetupGacela()
            );
        }

        return $this->configFactory;

    }

    public function getSetupGacela(): SetupGacelaInterface
    {
        if ($this->setup === null) {
            $this->setup = new SetupGacela();
        }

        return $this->setup;

    }

    private function hasValue(string $key): bool
    {
        return array_key_exists($key, $this->config);
    }

    /**
     * @return array<string,mixed>
     */
    private function loadAllConfigValues(): array
    {
        return $this->getFactory()
            ->createConfigLoader()
            ->loadAll();
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Gacela\Framework\Config;
6
7		use Gacela\Framework\Bootstrap\SetupGacela;
8		use Gacela\Framework\Bootstrap\SetupGacelaInterface;
9		use Gacela\Framework\Exception\ConfigException;
10
11		use function array_key_exists;
12
13		final class Config
14		{
15		public const DEFAULT_CONFIG_VALUE = 'Gacela\Framework\Config::DEFAULT_CONFIG_VALUE';
16
17		private static ?self $instance = null;
18
19		private ?string $appRootDir = null;
20
21		/** @var array<string,mixed> */
22		private array $config = [];
23
24		private ?SetupGacelaInterface $setup = null;
25
26		private ?ConfigFactory $configFactory = null;
27
28		private function __construct()
29		{
30		}
31
32	48	public static function getInstance(): self
33		{
34	48	if (self::$instance === null) {
35	9	self::$instance = new self();
36		}
37
38	48	return self::$instance;
		0 ignored issues – show Bug Best Practice introduced 2022-05-21 20:07 UTC by Report Bug Copy Issue Report The expression `return self::instance` could return the type `null` which is incompatible with the type-hinted return `Gacela\Framework\Config\Config`. Consider adding an additional type-check to rule them out. Loading history...
39		}
40
41		/**
42		* @internal
43		*/
44	8	public static function resetInstance(): void
45		{
46	8	self::$instance = null;
47		}
48
49		/**
50		* @param null\|mixed $default
51		*
52		* @throws ConfigException
53		*
54		* @return mixed
55		*/
56	38	public function get(string $key, $default = self::DEFAULT_CONFIG_VALUE)
57		{
58	38	if (empty($this->config)) {
59	16	$this->init();
60		}
61
62	38	if ($default !== self::DEFAULT_CONFIG_VALUE && !$this->hasValue($key)) {
63	24	return $default;
64		}
65
66	23	if (!$this->hasValue($key)) {
67	1	throw ConfigException::keyNotFound($key, self::class);
68		}
69
70	22	return $this->config[$key];
71		}
72
73		/**
74		* Force loading all config values in memory.
75		*
76		* @throws ConfigException
77		*/
78	48	public function init(): void
79		{
80	48	$this->configFactory = null;
81	48	$this->config = $this->loadAllConfigValues();
82	48	$this->config = array_merge($this->config, $this->getSetupGacela()->getConfigKeyValues());
83		}
84
85	48	public function setAppRootDir(string $dir): self
86		{
87	48	$this->appRootDir = $dir;
88
89	48	if (empty($this->appRootDir)) {
90		$this->appRootDir = getcwd() ?: ''; // @codeCoverageIgnore
91		}
92
93	48	return $this;
94		}
95
96	48	public function getAppRootDir(): string
97		{
98	48	return $this->appRootDir ?? getcwd() ?: '';
99		}
100
101	25	public function getCacheDir(): string
102		{
103	25	return $this->getAppRootDir() . '/' . $this->getSetupGacela()->getCacheDirectory();
104		}
105
106	48	public function setSetup(SetupGacelaInterface $setup): self
107		{
108	48	$this->setup = $setup;
109
110	48	return $this;
111		}
112
113		/**
114		* @internal
115		*/
116	48	public function getFactory(): ConfigFactory
117		{
118	48	if ($this->configFactory === null) {
119	48	$this->configFactory = new ConfigFactory(
120	48	$this->getAppRootDir(),
121	48	$this->getSetupGacela()
122		);
123		}
124
125	48	return $this->configFactory;
		0 ignored issues – show Bug Best Practice introduced 2022-03-26 14:55 UTC by Report Bug Copy Issue Report The expression `return $this->configFactory` could return the type `null` which is incompatible with the type-hinted return `Gacela\Framework\Config\ConfigFactory`. Consider adding an additional type-check to rule them out. Loading history...
126		}
127
128	48	public function getSetupGacela(): SetupGacelaInterface
129		{
130	48	if ($this->setup === null) {
131		$this->setup = new SetupGacela();
132		}
133
134	48	return $this->setup;
		0 ignored issues – show Bug Best Practice introduced 2022-06-30 19:54 UTC by Report Bug Copy Issue Report The expression `return $this->setup` could return the type `null` which is incompatible with the type-hinted return `Gacela\Framework\Bootstrap\SetupGacelaInterface`. Consider adding an additional type-check to rule them out. Loading history...
135		}
136
137	38	private function hasValue(string $key): bool
138		{
139	38	return array_key_exists($key, $this->config);
140		}
141
142		/**
143		* @return array<string,mixed>
144		*/
145	48	private function loadAllConfigValues(): array
146		{
147	48	return $this->getFactory()
148	48	->createConfigLoader()
149	48	->loadAll();
150		}
151		}
152

gacela-project / gacela

Push — feature/178-allow-adding-key-v... ( 9721fa )

Config::loadAllConfigValues() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like