GacelaConfig::setProfilerEnabled() - Code Metrics - Inspection of "Update changelog" - gacela-project/gacela - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — feature/change-cache-to-profil... ( 160b60 )

by Chema

created 2022-09-27 21:25 UTC

GacelaConfig::setProfilerEnabled() A

↳ Parent: GacelaConfig

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Gacela\Framework\Bootstrap;

use Closure;
use Gacela\Framework\ClassResolver\Profiler\GacelaProfiler;
use Gacela\Framework\Config\ConfigReaderInterface;
use Gacela\Framework\Config\GacelaConfigBuilder\ConfigBuilder;
use Gacela\Framework\Config\GacelaConfigBuilder\MappingInterfacesBuilder;
use Gacela\Framework\Config\GacelaConfigBuilder\SuffixTypesBuilder;

final class GacelaConfig
{
    private ConfigBuilder $configBuilder;

    private SuffixTypesBuilder $suffixTypesBuilder;

    private MappingInterfacesBuilder $mappingInterfacesBuilder;

    /** @var array<string,class-string|object|callable> */

    private array $externalServices;

    private bool $cacheEnabled = true;

    private bool $profilerEnabled = false;

    private string $profilerDirectory = GacelaProfiler::DEFAULT_DIRECTORY_VALUE;

    /** @var list<string> */
    private array $projectNamespaces = [];

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

    /**
     * @param array<string,class-string|object|callable> $externalServices

     */
    public function __construct(array $externalServices = [])
    {
        $this->externalServices = $externalServices;
        $this->configBuilder = new ConfigBuilder();
        $this->suffixTypesBuilder = new SuffixTypesBuilder();
        $this->mappingInterfacesBuilder = new MappingInterfacesBuilder();
    }

    /**
     * @return Closure(GacelaConfig):void
     */
    public static function withPhpConfigDefault(): callable
    {
        return static function (self $config): void {
            $config->addAppConfig('config/*.php', 'config/local.php');
        };
    }

    /**
     * @param string $path define the path where Gacela will read all the config files
     * @param string $pathLocal define the path where Gacela will read the local config file
     * @param class-string<ConfigReaderInterface>|ConfigReaderInterface|null $reader Define the reader class which will read and parse the config files

     */
    public function addAppConfig(string $path, string $pathLocal = '', $reader = null): self
    {
        $this->configBuilder->add($path, $pathLocal, $reader);

        return $this;
    }

    public function addSuffixTypeFacade(string $suffix): self
    {
        $this->suffixTypesBuilder->addFacade($suffix);

        return $this;
    }

    public function addSuffixTypeFactory(string $suffix): self
    {
        $this->suffixTypesBuilder->addFactory($suffix);

        return $this;
    }

    public function addSuffixTypeConfig(string $suffix): self
    {
        $this->suffixTypesBuilder->addConfig($suffix);

        return $this;
    }

    public function addSuffixTypeDependencyProvider(string $suffix): self
    {
        $this->suffixTypesBuilder->addDependencyProvider($suffix);

        return $this;
    }

    /**
     * @param class-string $key
     * @param class-string|object|callable $value
     */
    public function addMappingInterface(string $key, $value): self
    {
        $this->mappingInterfacesBuilder->bind($key, $value);

        return $this;
    }

    /**
     * @return class-string|object|callable

     */
    public function getExternalService(string $key)
    {
        return $this->externalServices[$key];
    }

    /**
     * @param class-string|object|callable $value

     */
    public function addExternalService(string $key, $value): self
    {
        $this->externalServices[$key] = $value;

        return $this;
    }

    public function setCacheEnabled(bool $flag): self
    {
        $this->cacheEnabled = $flag;

        return $this;
    }

    public function setProfilerEnabled(bool $flag): self
    {
        $this->profilerEnabled = $flag;

        return $this;
    }

    public function setProfilerDirectory(string $dir): self
    {
        $this->profilerDirectory = $dir;

        return $this;
    }

    /**
     * @param list<string> $list
     */
    public function setProjectNamespaces(array $list): self
    {
        $this->projectNamespaces = $list;


        return $this;
    }

    /**
     * @param mixed $value
     */
    public function addAppConfigKeyValue(string $key, $value): self
    {
        $this->configKeyValues[$key] = $value;

        return $this;
    }

    /**
     * @param array<string, mixed> $config
     */
    public function addAppConfigKeyValues(array $config): self
    {
        $this->configKeyValues = array_merge($this->configKeyValues, $config);

        return $this;
    }

    /**
     * @return array{
     *     external-services:array<string,class-string|object|callable>,
     *     config-builder:ConfigBuilder,
     *     suffix-types-builder:SuffixTypesBuilder,
     *     mapping-interfaces-builder:MappingInterfacesBuilder,
     *     cache-enabled:bool,
     *     profiler-enabled:bool,
     *     profiler-directory:string,
     *     project-namespaces:list<string>,
     *     config-key-values:array<string,mixed>,
     * }
     *
     * @internal
     */
    public function build(): array
    {
        return [
            'external-services' => $this->externalServices,
            'config-builder' => $this->configBuilder,
            'suffix-types-builder' => $this->suffixTypesBuilder,
            'mapping-interfaces-builder' => $this->mappingInterfacesBuilder,
            'cache-enabled' => $this->cacheEnabled,
            'profiler-enabled' => $this->profilerEnabled,
            'profiler-directory' => $this->profilerDirectory,
            'project-namespaces' => $this->projectNamespaces,
            'config-key-values' => $this->configKeyValues,
        ];
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Gacela\Framework\Bootstrap;
6
7		use Closure;
8		use Gacela\Framework\ClassResolver\Profiler\GacelaProfiler;
9		use Gacela\Framework\Config\ConfigReaderInterface;
10		use Gacela\Framework\Config\GacelaConfigBuilder\ConfigBuilder;
11		use Gacela\Framework\Config\GacelaConfigBuilder\MappingInterfacesBuilder;
12		use Gacela\Framework\Config\GacelaConfigBuilder\SuffixTypesBuilder;
13
14		final class GacelaConfig
15		{
16		private ConfigBuilder $configBuilder;
17
18		private SuffixTypesBuilder $suffixTypesBuilder;
19
20		private MappingInterfacesBuilder $mappingInterfacesBuilder;
21
22		/** @var array<string,class-string\|object\|callable> */
		1 ignored issue – show Documentation Bug introduced 2022-05-14 18:03 UTC by Report Bug Copy Issue Report The doc comment `array<string,class-string\|object\|callable>` at position `4` could not be parsed: Unknown type name 'class-string' at position 4 in array<string,class-string\|object\|callable>. Loading history...
23		private array $externalServices;
24
25		private bool $cacheEnabled = true;
26
27		private bool $profilerEnabled = false;
28
29		private string $profilerDirectory = GacelaProfiler::DEFAULT_DIRECTORY_VALUE;
30
31		/** @var list<string> */
32		private array $projectNamespaces = [];
33
34		/** @var array<string,mixed> */
35		private array $configKeyValues = [];
36
37		/**
38		* @param array<string,class-string\|object\|callable> $externalServices
		1 ignored issue – show Documentation Bug introduced 2022-05-14 18:03 UTC by Report Bug Copy Issue Report The doc comment `array<string,class-string\|object\|callable>` at position `4` could not be parsed: Unknown type name 'class-string' at position 4 in array<string,class-string\|object\|callable>. Loading history...
39		*/
40	47	public function __construct(array $externalServices = [])
41		{
42	47	$this->externalServices = $externalServices;
43	47	$this->configBuilder = new ConfigBuilder();
44	47	$this->suffixTypesBuilder = new SuffixTypesBuilder();
45	47	$this->mappingInterfacesBuilder = new MappingInterfacesBuilder();
46		}
47
48		/**
49		* @return Closure(GacelaConfig):void
50		*/
51	7	public static function withPhpConfigDefault(): callable
52		{
53	7	return static function (self $config): void {
54	7	$config->addAppConfig('config/*.php', 'config/local.php');
55		};
56		}
57
58		/**
59		* @param string $path define the path where Gacela will read all the config files
60		* @param string $pathLocal define the path where Gacela will read the local config file
61		* @param class-string<ConfigReaderInterface>\|ConfigReaderInterface\|null $reader Define the reader class which will read and parse the config files
		0 ignored issues – show Documentation Bug introduced 2022-05-05 07:56 UTC by Report Bug Copy Issue Report The doc comment `class-string<ConfigReade...figReaderInterface\|null` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<ConfigReaderInterface>\|ConfigReaderInterface\|null. Loading history...
62		*/
63	23	public function addAppConfig(string $path, string $pathLocal = '', $reader = null): self
64		{
65	23	$this->configBuilder->add($path, $pathLocal, $reader);
66
67	23	return $this;
68		}
69
70	5	public function addSuffixTypeFacade(string $suffix): self
71		{
72	5	$this->suffixTypesBuilder->addFacade($suffix);
73
74	5	return $this;
75		}
76
77	5	public function addSuffixTypeFactory(string $suffix): self
78		{
79	5	$this->suffixTypesBuilder->addFactory($suffix);
80
81	5	return $this;
82		}
83
84	5	public function addSuffixTypeConfig(string $suffix): self
85		{
86	5	$this->suffixTypesBuilder->addConfig($suffix);
87
88	5	return $this;
89		}
90
91	6	public function addSuffixTypeDependencyProvider(string $suffix): self
92		{
93	6	$this->suffixTypesBuilder->addDependencyProvider($suffix);
94
95	6	return $this;
96		}
97
98		/**
99		* @param class-string $key
100		* @param class-string\|object\|callable $value
101		*/
102	9	public function addMappingInterface(string $key, $value): self
103		{
104	9	$this->mappingInterfacesBuilder->bind($key, $value);
105
106	9	return $this;
107		}
108
109		/**
110		* @return class-string\|object\|callable
		0 ignored issues – show Documentation Bug introduced 2022-05-14 18:03 UTC by Report Bug Copy Issue Report The doc comment `class-string\|object\|callable` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string\|object\|callable. Loading history...
111		*/
112	4	public function getExternalService(string $key)
113		{
114	4	return $this->externalServices[$key];
115		}
116
117		/**
118		* @param class-string\|object\|callable $value
		0 ignored issues – show Documentation Bug introduced 2022-05-14 18:03 UTC by Report Bug Copy Issue Report The doc comment `class-string\|object\|callable` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string\|object\|callable. Loading history...
119		*/
120	2	public function addExternalService(string $key, $value): self
121		{
122	2	$this->externalServices[$key] = $value;
123
124	2	return $this;
125		}
126
127	11	public function setCacheEnabled(bool $flag): self
128		{
129	11	$this->cacheEnabled = $flag;
130
131	11	return $this;
132		}
133
134	2	public function setProfilerEnabled(bool $flag): self
135		{
136	2	$this->profilerEnabled = $flag;
137
138	2	return $this;
139		}
140
141	2	public function setProfilerDirectory(string $dir): self
142		{
143	2	$this->profilerDirectory = $dir;
144
145	2	return $this;
146		}
147
148		/**
149		* @param list<string> $list
150		*/
151	3	public function setProjectNamespaces(array $list): self
152		{
153	3	$this->projectNamespaces = $list;
		0 ignored issues – show Documentation Bug introduced 2022-06-30 19:54 UTC by Report Bug Copy Issue Report It seems like `$list` of type `array` is incompatible with the declared type `Gacela\Framework\Bootstrap\list` of property `$projectNamespaces`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
154
155	3	return $this;
156		}
157
158		/**
159		* @param mixed $value
160		*/
161	1	public function addAppConfigKeyValue(string $key, $value): self
162		{
163	1	$this->configKeyValues[$key] = $value;
164
165	1	return $this;
166		}
167
168		/**
169		* @param array<string, mixed> $config
170		*/
171	1	public function addAppConfigKeyValues(array $config): self
172		{
173	1	$this->configKeyValues = array_merge($this->configKeyValues, $config);
174
175	1	return $this;
176		}
177
178		/**
179		* @return array{
180		* external-services:array<string,class-string\|object\|callable>,
181		* config-builder:ConfigBuilder,
182		* suffix-types-builder:SuffixTypesBuilder,
183		* mapping-interfaces-builder:MappingInterfacesBuilder,
184		* cache-enabled:bool,
185		* profiler-enabled:bool,
186		* profiler-directory:string,
187		* project-namespaces:list<string>,
188		* config-key-values:array<string,mixed>,
189		* }
190		*
191		* @internal
192		*/
193	46	public function build(): array
194		{
195		return [
196	46	'external-services' => $this->externalServices,
197	46	'config-builder' => $this->configBuilder,
198	46	'suffix-types-builder' => $this->suffixTypesBuilder,
199	46	'mapping-interfaces-builder' => $this->mappingInterfacesBuilder,
200	46	'cache-enabled' => $this->cacheEnabled,
201	46	'profiler-enabled' => $this->profilerEnabled,
202	46	'profiler-directory' => $this->profilerDirectory,
203	46	'project-namespaces' => $this->projectNamespaces,
204	46	'config-key-values' => $this->configKeyValues,
205		];
206		}
207		}
208

gacela-project / gacela

Push — feature/change-cache-to-profil... ( 160b60 )

GacelaConfig::setProfilerEnabled() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like