Config::getInstance() - Code Metrics - Inspection of "Add Config::createWithSetup()" - gacela-project/gacela - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#218)

by Chema

created 2022-11-01 09:09 UTC

Config::getInstance() A

↳ Parent: Config

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2.0625

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	0
dl	0
loc	7
ccs	3
cts	4
cp	0.75
crap	2.0625
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Gacela\Framework\Config;

use Gacela\Framework\Bootstrap\SetupGacelaInterface;
use Gacela\Framework\EventListener\EventDispatcherInterface;
use Gacela\Framework\Exception\ConfigException;

use RuntimeException;

use function array_key_exists;

final class Config implements ConfigInterface
{
    private static ?self $instance = null;

    private static ?EventDispatcherInterface $eventDispatcher = null;

    private SetupGacelaInterface $setup;

    private ?ConfigFactory $configFactory = null;

    private ?string $appRootDir = null;

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

    private function __construct(SetupGacelaInterface $setup)
    {
        $this->setup = $setup;
    }

    public static function createWithSetup(SetupGacelaInterface $setup): self
    {
        self::$instance = new self($setup);

        return self::$instance;
    }

    public static function getInstance(): self
    {
        if (self::$instance === null) {
            throw new RuntimeException('You have to call createWithSetup() first.');
        }

        return self::$instance;
    }

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

    public static function getEventDispatcher(): EventDispatcherInterface
    {
        if (self::$eventDispatcher === null) {
            self::$eventDispatcher = self::getInstance()
                ->getSetupGacela()
                ->getEventDispatcher();
        }

        return self::$eventDispatcher;

    }

    /**
     * @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->hasKey($key)) {
            return $default;
        }

        if (!$this->hasKey($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 = rtrim($dir, DIRECTORY_SEPARATOR);

        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()
            . DIRECTORY_SEPARATOR
            . ltrim($this->getSetupGacela()->getFileCacheDirectory(), DIRECTORY_SEPARATOR);
    }

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

        return $this->configFactory;

    }

    public function getSetupGacela(): SetupGacelaInterface
    {
        return $this->setup;
    }

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

gacela-project / gacela

Pull Request — master (#218)

Config::getInstance() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like