Manager::getDefaultDictionary() - Code Metrics - Inspection of "Merge branch 'dev'" - maxistua/easy-dictionary - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 3bddf7...37f0e3 )

by Max

created 2019-02-18 08:40 UTC

Manager::getDefaultDictionary() A

↳ Parent: Manager

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php


declare(strict_types=1);

namespace EasyDictionary;

use EasyDictionary\Exception\InvalidConfigurationException;
use EasyDictionary\Exception\RuntimeException;
use EasyDictionary\Interfaces\ConfigInterface;
use EasyDictionary\Interfaces\DataProviderInterface;
use EasyDictionary\Interfaces\DictionaryInterface;

/**
 * Class Manager
 *
 * @package EasyDictionary
 */

class Manager
{
    /**

     * @var ConfigInterface
     */
    protected $config;

    /**

     * @var array
     */
    protected $dictionaries = [];

    /**

     * @param ConfigInterface $config

     */
    public function __construct(ConfigInterface $config = null)
    {
        if (!is_null($config)) {
            $this->setConfig($config);
        }
    }

    /**
     * Returns Dictionary object
     *
     * @param string $name

     *
     * @return DictionaryInterface
     * @throws InvalidConfigurationException
     * @throws RuntimeException
     */
    public function get(string $name): ?DictionaryInterface
    {
        if (!isset($this->dictionaries[$name])) {
            $config = $this->getConfig();
            if (!$config) {
                throw new RuntimeException(sprintf('Config not found', $name));
            }

            $dictionaryConfig = $config->getDictionaryConfig()[$name] ?? null;
            if (!$dictionaryConfig) {
                throw new RuntimeException(sprintf('Dictionary with key "%s" not found', $name));
            }

            $this->add($this->create($name, $dictionaryConfig));
        }

        return $this->dictionaries[$name] ?? null;
    }

    /**

     * @return ConfigInterface
     */
    public function getConfig(): ?ConfigInterface
    {
        return $this->config;
    }

    /**

     * @param ConfigInterface $config

     *
     * @return $this
     */
    public function setConfig(ConfigInterface $config)
    {
        $this->config = $config;

        return $this;
    }

    /**

     * @param DictionaryInterface $dictionary

     *
     * @return $this
     * @throws RuntimeException
     */
    public function add(DictionaryInterface $dictionary)
    {
        $name = $dictionary->getName();

        if (isset($this->dictionaries[$name])) {
            throw new RuntimeException(sprintf('The dictionary with key "%s" already exists', $name));
        }

        $this->dictionaries[$name] = $dictionary;

        return $this;
    }

    /**

     * @param $name

     * @param $dictionaryConfig

     * @return DictionaryInterface

     * @throws InvalidConfigurationException

     */
    protected function create(string $name, array $dictionaryConfig): DictionaryInterface
    {
        $config = $this->getConfig();

        $dataProvider = $this->createDataProvider(
            $dictionaryConfig['data']['class'] ?? $config->getDefaultDataProviderClass(),
            $dictionaryConfig['data'] ?? []
        );

        $dictionary = $this->createDictionary(
            $dictionaryConfig['class'] ?? $config->getDefaultDictionaryClass()
        );

        $dictionary->setName($name);
        $dictionary->setDataProvider($dataProvider);
        $dictionary->setDefaultView($dictionaryConfig['view'] ?? ($config->getDefaultView() ?? null));
        $dictionary->setSearchFields($dictionaryConfig['searchFields'] ?? []);

        if (isset($dictionaryConfig['cache'])) {
            $dictionary->setCache(
                $config->getCache($dictionaryConfig['cache']),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
                $dictionaryConfig['cacheTTL'] ?? ConfigInterface::DEFAULT_CACHE_TTL
            );
        }

        return $dictionary;
    }

    /**

     * @param string $class

     * @param array $config

     *
     * @return DataProviderInterface
     * @throws InvalidConfigurationException
     */
    protected function createDataProvider(string $class, array $config): DataProviderInterface
    {
        if (!class_exists($class)) {
            throw new InvalidConfigurationException(sprintf('Class "%s" not found', $class));
        }

        $dataProvider = new $class($config);

        if (!($dataProvider instanceof DataProviderInterface)) {
            throw new InvalidConfigurationException(sprintf('Class "%s" is not implement required interface', $class));
        }

        return $dataProvider;
    }

    /**

     * @param string $class

     *
     * @return DictionaryInterface
     * @throws InvalidConfigurationException
     */
    public function createDictionary(string $class): DictionaryInterface
    {
        if (!class_exists($class)) {
            throw new InvalidConfigurationException(sprintf('Class "%s" not found', $class));
        }

        $dictionary = new $class;

        if (!($dictionary instanceof DictionaryInterface)) {
            throw new InvalidConfigurationException(sprintf('Class "%s" not found', $class));
        }

        return $dictionary;
    }
}


1			<?php
2
			0 ignored issues – show Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Missing file doc comment Loading history...
3			declare(strict_types=1);
4
5			namespace EasyDictionary;
6
7			use EasyDictionary\Exception\InvalidConfigurationException;
8			use EasyDictionary\Exception\RuntimeException;
9			use EasyDictionary\Interfaces\ConfigInterface;
10			use EasyDictionary\Interfaces\DataProviderInterface;
11			use EasyDictionary\Interfaces\DictionaryInterface;
12
13			/**
14			* Class Manager
15			*
16			* @package EasyDictionary
17			*/
			0 ignored issues – show Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Missing @author tag in class comment Loading history... Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
18			class Manager
19			{
20			/**
			0 ignored issues – show Coding Style introduced 2019-02-18 08:47 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
21			* @var ConfigInterface
22			*/
23			protected $config;
24
25			/**
			0 ignored issues – show Coding Style introduced 2019-02-18 08:47 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
26			* @var array
27			*/
28			protected $dictionaries = [];
29
30			/**
			0 ignored issues – show Coding Style introduced 2019-02-18 08:47 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
31			* @param ConfigInterface $config
			0 ignored issues – show Coding Style introduced 2019-02-18 08:47 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
32			*/
33			public function __construct(ConfigInterface $config = null)
34			{
35			if (!is_null($config)) {
36			$this->setConfig($config);
37			}
38			}
39
40			/**
41			* Returns Dictionary object
42			*
43			* @param string $name
			0 ignored issues – show Coding Style introduced 2019-02-18 08:47 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
44			*
45			* @return DictionaryInterface
46			* @throws InvalidConfigurationException
47			* @throws RuntimeException
48			*/
49			public function get(string $name): ?DictionaryInterface
50			{
51			if (!isset($this->dictionaries[$name])) {
52			$config = $this->getConfig();
53			if (!$config) {
54			throw new RuntimeException(sprintf('Config not found', $name));
55			}
56
57			$dictionaryConfig = $config->getDictionaryConfig()[$name] ?? null;
58			if (!$dictionaryConfig) {
59			throw new RuntimeException(sprintf('Dictionary with key "%s" not found', $name));
60			}
61
62			$this->add($this->create($name, $dictionaryConfig));
63			}
64
65			return $this->dictionaries[$name] ?? null;
66			}
67
68			/**
			0 ignored issues – show Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
69			* @return ConfigInterface
70			*/
71			public function getConfig(): ?ConfigInterface
72			{
73			return $this->config;
74			}
75
76			/**
			0 ignored issues – show Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
77			* @param ConfigInterface $config
			0 ignored issues – show Coding Style introduced 2019-02-18 08:47 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
78			*
79			* @return $this
80			*/
81			public function setConfig(ConfigInterface $config)
82			{
83			$this->config = $config;
84
85			return $this;
86			}
87
88			/**
			0 ignored issues – show Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
89			* @param DictionaryInterface $dictionary
			0 ignored issues – show Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
90			*
91			* @return $this
92			* @throws RuntimeException
93			*/
94			public function add(DictionaryInterface $dictionary)
95			{
96			$name = $dictionary->getName();
97
98			if (isset($this->dictionaries[$name])) {
99			throw new RuntimeException(sprintf('The dictionary with key "%s" already exists', $name));
100			}
101
102			$this->dictionaries[$name] = $dictionary;
103
104			return $this;
105			}
106
107			/**
			0 ignored issues – show Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Parameter `$name` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Parameter `$dictionaryConfig` should have a doc-comment as per coding-style. Loading history...
108			* @param $name
			0 ignored issues – show Coding Style Documentation introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Missing parameter name Loading history... Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Tag value indented incorrectly; expected 2 spaces but found 1 Loading history...
109			* @param $dictionaryConfig
			0 ignored issues – show Coding Style Documentation introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Missing parameter name Loading history... Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Tag value indented incorrectly; expected 2 spaces but found 1 Loading history...
110			* @return DictionaryInterface
			0 ignored issues – show Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Tag cannot be grouped with parameter tags in a doc comment Loading history...
111			* @throws InvalidConfigurationException
			0 ignored issues – show Coding Style introduced 2018-08-20 16:11 UTC by Report Bug Copy Issue Report Tag cannot be grouped with parameter tags in a doc comment Loading history...
112			*/
113			protected function create(string $name, array $dictionaryConfig): DictionaryInterface
114			{
115			$config = $this->getConfig();
116
117			$dataProvider = $this->createDataProvider(
118			$dictionaryConfig['data']['class'] ?? $config->getDefaultDataProviderClass(),
119			$dictionaryConfig['data'] ?? []
120			);
121
122			$dictionary = $this->createDictionary(
123			$dictionaryConfig['class'] ?? $config->getDefaultDictionaryClass()
124			);
125
126			$dictionary->setName($name);
127			$dictionary->setDataProvider($dataProvider);
128			$dictionary->setDefaultView($dictionaryConfig['view'] ?? ($config->getDefaultView() ?? null));
129			$dictionary->setSearchFields($dictionaryConfig['searchFields'] ?? []);
130
131			if (isset($dictionaryConfig['cache'])) {
132			$dictionary->setCache(
133			$config->getCache($dictionaryConfig['cache']),
			0 ignored issues – show Bug introduced 2019-02-18 08:47 UTC by Report Bug Copy Issue Report It seems like `$config->getCache($dictionaryConfig['cache'])` can be `null`; however, `setCache()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
134			$dictionaryConfig['cacheTTL'] ?? ConfigInterface::DEFAULT_CACHE_TTL
135			);
136			}
137
138			return $dictionary;
139			}
140
141			/**
			0 ignored issues – show Coding Style introduced 2019-02-18 08:47 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
142			* @param string $class
			0 ignored issues – show Coding Style introduced 2019-02-18 08:47 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
143			* @param array $config
			0 ignored issues – show Coding Style introduced 2019-02-18 08:47 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2019-02-18 08:47 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter type; 1 found Loading history...
144			*
145			* @return DataProviderInterface
146			* @throws InvalidConfigurationException
147			*/
148			protected function createDataProvider(string $class, array $config): DataProviderInterface
149			{
150			if (!class_exists($class)) {
151			throw new InvalidConfigurationException(sprintf('Class "%s" not found', $class));
152			}
153
154			$dataProvider = new $class($config);
155
156			if (!($dataProvider instanceof DataProviderInterface)) {
157			throw new InvalidConfigurationException(sprintf('Class "%s" is not implement required interface', $class));
158			}
159
160			return $dataProvider;
161			}
162
163			/**
			0 ignored issues – show Coding Style introduced 2019-02-18 08:47 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
164			* @param string $class
			0 ignored issues – show Coding Style introduced 2019-02-18 08:47 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
165			*
166			* @return DictionaryInterface
167			* @throws InvalidConfigurationException
168			*/
169			public function createDictionary(string $class): DictionaryInterface
170			{
171			if (!class_exists($class)) {
172			throw new InvalidConfigurationException(sprintf('Class "%s" not found', $class));
173			}
174
175			$dictionary = new $class;
176
177			if (!($dictionary instanceof DictionaryInterface)) {
178			throw new InvalidConfigurationException(sprintf('Class "%s" not found', $class));
179			}
180
181			return $dictionary;
182			}
183			}
184

maxistua / easy-dictionary

Push — master ( 3bddf7...37f0e3 )

Manager::getDefaultDictionary() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like