EasyDictionary\Manager

Complexity

Total Complexity

18

Size/Duplication

Total Lines	166
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	get()	0	18	4
A	getConfig()	0	4	1
A	setConfig()	0	6	1
A	add()	0	12	2
A	create()	0	27	2
A	createDataProvider()	0	14	3
A	createDictionary()	0	14	3

<?php

Missing file doc comment

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

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 ConfigInterface
     */
    protected $config;

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param ConfigInterface $config

Missing parameter comment

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

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

Missing parameter comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param ConfigInterface $config

Missing parameter comment

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

        return $this;
    }

    /**

Missing short description in doc comment

     * @param DictionaryInterface $dictionary

Missing parameter comment

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

    /**

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
    {
        $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']),

It seems like $config->getCache($dictionaryConfig['cache']) can be null; however, setCache() does not accept null, maybe add an additional type check?

                $dictionaryConfig['cacheTTL'] ?? ConfigInterface::DEFAULT_CACHE_TTL
            );
        }

        return $dictionary;
    }

    /**

Missing short description in doc comment

     * @param string $class

Missing parameter comment

     * @param array $config

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

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

    /**

Missing short description in doc comment

     * @param string $class

Missing parameter comment

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