EasyDictionary\Manager

Complexity

Total Complexity

19

Size/Duplication

Total Lines	197
Duplicated Lines	3.05 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getDefaultDictionary()	0	4	1
A	setDefaultDictionary()	0	6	1
A	getDefaultDataProvider()	0	4	1
A	setDefaultDataProvider()	0	6	1
A	get()	0	14	3
A	getConfig()	0	4	1
A	setConfig()	0	6	1
A	add()	0	12	2
B	create()	6	49	8

<?php

Missing file doc comment

declare(strict_types=1);

namespace EasyDictionary;

use EasyDictionary\Exception\InvalidConfigurationException;
use EasyDictionary\Exception\RuntimeException;
use Psr\SimpleCache\CacheInterface;

/**
 * Class Manager
 * @package EasyDictionary

There must be exactly one blank line before the tags in a doc comment

 */

Missing @category tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Manager
{
    /**

Missing short description in doc comment

     * @var string
     */
    public $defaultDictionary = 'EasyDictionary\Dictionary\Simple';

    /**

Missing short description in doc comment

     * @return string
     */
    public function getDefaultDictionary(): string
    {
        return $this->defaultDictionary;
    }

    /**

Missing short description in doc comment

     * @param string $defaultDictionary

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return $this

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function setDefaultDictionary(string $defaultDictionary)
    {
        $this->defaultDictionary = $defaultDictionary;

        return $this;
    }

    /**

Missing short description in doc comment

     * @return string
     */
    public function getDefaultDataProvider(): string
    {
        return $this->defaultDataProvider;
    }

    /**

Missing short description in doc comment

     * @param string $defaultDataProvider

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return $this

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function setDefaultDataProvider(string $defaultDataProvider)
    {
        $this->defaultDataProvider = $defaultDataProvider;

        return $this;
    }

    /**

Missing short description in doc comment

     * @var string
     */
    public $defaultDataProvider = 'EasyDictionary\DataProvider\Simple';

    /**
     * [
     *      "caches" => [
     *          "cache_name_2" => callable
     *      ]
     *      ["defaultView" => function (...$data):\Generator {},]
     *      "dictionaries" => [
     *          "dictionary_name" => [
     *              ["class" => EasyDictionary\DictionaryInterface,]
     *              ["dataType" => "flat|array"]
     *              ["cache" => "cache_name"]
     *              ["cacheTTL" => 60,]
     *              "data" => [
     *                  ["class" => EasyDictionary\DataProviderInterface,]
     *                  [data provider arguments]
     *              ],
     *              ["view" => function (...$data):\Generator {},]
     *              ["searchFields" => [<string>, ...]]
     *          ],
     *
     *          ...
     *      ]
     * ]
     *
     * @var array
     */
    public $config = [];

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param string $name

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return DictionaryInterface

Tag cannot be grouped with parameter tags in a doc comment

     * @throws InvalidConfigurationException

Tag cannot be grouped with parameter tags in a doc comment

     * @throws RuntimeException

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function get(string $name): DictionaryInterface
    {
        if (!isset($this->dictionaries[$name])) {
            $config = $this->getConfig()['dictionaries'][$name] ?? null;

            if (!$config) {
                throw new RuntimeException(sprintf('Dictionary with key "%s" not found', $name));
            }

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

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param array $config

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return $this

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function setConfig(array $config)
    {
        $this->config = $config;

        return $this;
    }

    /**

Missing short description in doc comment

     * @param DictionaryInterface $dictionary

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return $this

Tag cannot be grouped with parameter tags in a doc comment

     * @throws RuntimeException

Tag cannot be grouped with parameter tags in a doc comment

     */
    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;
    }

    /**

Missing short description in doc comment

Parameter $name should have a doc-comment as per coding-style.

Parameter $dictionaryConfig should have a doc-comment as per coding-style.

     * @param $name

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param $dictionaryConfig

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return DictionaryInterface

Tag cannot be grouped with parameter tags in a doc comment

     * @throws InvalidConfigurationException

Tag cannot be grouped with parameter tags in a doc comment

     */
    protected function create(string $name, array $dictionaryConfig): DictionaryInterface
    {
        $dictionaryClass = $dictionaryConfig['class'] ?? $this->getDefaultDictionary();
        if (!class_exists($dictionaryClass)) {
            throw new InvalidConfigurationException(sprintf('Class "%s" not found', $dictionaryClass));
        }

        $dataProviderClass = $dictionaryConfig['data']['class'] ?? $this->getDefaultDataProvider();
        if (!class_exists($dataProviderClass)) {
            throw new InvalidConfigurationException(sprintf('Class "%s" not found', $dataProviderClass));
        }

        /** @var DataProviderInterface $dataProvider */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $dataProvider = new $dataProviderClass($dictionaryConfig['data']);

        /** @var DictionaryInterface $dictionary */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $dictionary = new $dictionaryClass($name);
        $dictionary->setDataProvider($dataProvider);
        $dictionary->setDefaultView($dictionaryConfig['view'] ?? ($this->getConfig()['defaultView'] ?? null));
        $dictionary->setSearchFields($dictionaryConfig['searchFields'] ?? []);

        if (isset($dictionaryConfig['dataType'])) {
            $dictionary->setDataValueType($dictionaryConfig['dataType']);
        }

        if (isset($dictionaryConfig['cache'])) {
            $caches = $this->getConfig()['caches'] ?? [];

            if (!isset($caches[$dictionaryConfig['cache']])) {

This code seems to be duplicated across your project.

                throw new InvalidConfigurationException(sprintf('Cache "%s" not found', $dictionaryConfig['cache']));
            }

            if (!is_callable($caches[$dictionaryConfig['cache']])) {

This code seems to be duplicated across your project.

                throw new InvalidConfigurationException(sprintf('Cache "%s" not callable', $dictionaryConfig['cache']));
            }

            $cache = $caches[$dictionaryConfig['cache']]();

            if (!($cache instanceof CacheInterface)) {
                throw new InvalidConfigurationException(
                    sprintf('Object with class "%s" does not support expected interface', get_class($cache))
                );
            }

            $dictionary->setCache($cache, $dictionaryConfig['cacheTTL'] ?? 60);
        }

        return $dictionary;
    }
}