EasyDictionary\AbstractDictionary

Complexity

Total Complexity

27

Size/Duplication

Total Lines	244
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setDefaultView()	0	6	1
A	getDataProvider()	0	4	1
A	setDataProvider()	0	6	1
A	getIterator()	0	12	3
A	getDefaultView()	0	4	1
A	getData()	0	25	5
A	getCache()	0	4	1
A	setCache()	0	7	1
	loadData()	0	1	?
A	getName()	0	4	1
A	setName()	0	6	1
A	withView()	0	8	2
A	count()	0	4	1
A	search()	0	18	4
A	getSearchFields()	0	4	2
A	setSearchFields()	0	6	1

<?php

Missing file doc comment

declare(strict_types=1);

namespace EasyDictionary;

use EasyDictionary\Interfaces\DataProviderInterface;
use EasyDictionary\Interfaces\DictionaryInterface;
use Psr\SimpleCache\CacheInterface;

/**
 * Class AbstractDictionary
 * @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

abstract class AbstractDictionary implements DictionaryInterface
{
    /**

Missing short description in doc comment

     * @var string
     */
    protected $name = '';

    /**

Missing short description in doc comment

     * @var DataProviderInterface
     */
    protected $dataProvider = null;

    /**

Missing short description in doc comment

     * @var callable
     */
    protected $view = null;

    /**

Missing short description in doc comment

     * @var \Psr\SimpleCache\CacheInterface
     */
    protected $cache = null;

    /**

Missing short description in doc comment

     * @var int
     */
    protected $cacheTTL = 0;

    /**

Missing short description in doc comment

     * @var iterable
     */
    protected $data = [];

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @var bool
     */
    protected $dataLoaded = false;

    /**
     * AbstractDictionary constructor.
     * @param string $name

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

Missing parameter comment

     */
    public function __construct(string $name = '')
    {
        $this->setName($name);
    }

    /**

Missing short description in doc comment

     * @param callable|null $view

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 setDefaultView(callable $view = null)
    {
        $this->view = $view;

        return $this;
    }

    /**

Missing short description in doc comment

     * @return null|DataProviderInterface
     */
    public function getDataProvider(): ?DataProviderInterface
    {
        return $this->dataProvider;
    }

    /**

Missing short description in doc comment

     * @param DataProviderInterface $provider

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 setDataProvider(DataProviderInterface $provider)
    {
        $this->dataProvider = $provider;

        return $this;
    }

    /**

Missing short description in doc comment

     * @return \Iterator
     */
    public function getIterator(): iterable
    {
        $view = $this->getDefaultView();

        if (is_null($view)) {
            foreach ($this->getData() as $key => $item) {
                yield $key => $item;
            }
        } else {
            yield from $this->withView($view);
        }
    }

    /**

Missing short description in doc comment

     * @return callable|null
     */
    public function getDefaultView(): ?callable
    {
        return $this->view;
    }

    /**

Missing short description in doc comment

     * @return mixed
     */
    public function getData(): iterable
    {
        if (false === $this->dataLoaded) {
            $cache = $this->getCache();

            if (is_null($cache)) {
                $this->data = $this->loadData();
            } else {
                $key = static::class . '_' . $this->getName();

                try {
                    if (!($this->data = $cache->get($key, []))) {
                        $this->data = $this->loadData();
                        $cache->set($key, $this->data, $this->cacheTTL);
                    }
                } catch (\Psr\SimpleCache\InvalidArgumentException $e) {
                    $this->data = [];

It seems like array() of type array is incompatible with the declared type object<EasyDictionary\iterable> of property $data.

                }
            }

            $this->dataLoaded = true;
        }

        return $this->data;
    }

    /**

Missing short description in doc comment

     * @return CacheInterface
     */
    public function getCache(): ?CacheInterface
    {
        return $this->cache;
    }

    /**

Missing short description in doc comment

     * @param CacheInterface $cache

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param int $ttl

Missing parameter comment

Expected 12 spaces after parameter type; 1 found

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 setCache(CacheInterface $cache, int $ttl = 3600)
    {
        $this->cache = $cache;
        $this->cacheTTL = $ttl;

        return $this;
    }

    /**

Missing short description in doc comment

     * @return iterable
     */
    abstract protected function loadData(): iterable;

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param string $name

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return self

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function setName(string $name)
    {
        $this->name = $name;

        return $this;

The return type of return $this; (EasyDictionary\AbstractDictionary) is incompatible with the return type declared by the interface EasyDictionary\Interfaces\DictionaryInterface::setName of type string.

    }

    /**

Missing short description in doc comment

     * @param callable $callable

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return \Generator

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function withView(callable $callable = null): iterable
    {
        if (is_callable($callable)) {
            yield from call_user_func($callable, $this->getData());
        } else {
            yield from $this->getIterator();
        }
    }

    /**

Missing short description in doc comment

     * @return int
     */
    public function count(): int
    {
        return count($this->getData());
    }

    /**

Missing short description in doc comment

     * @param string $pattern

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param bool $strict

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return iterable

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function search(string $pattern, bool $strict = false): iterable
    {
        $data = [];
        $searchData = [];
        $searchFields = array_filter($this->getSearchFields($strict));
        foreach ($this as $key => $value) {
            $data[$key] = $value;

            if (is_array($value)) {
                $searchData[$key] = (string)$key . ' ' .
                    join(' ', empty($searchFields) ? $value : array_intersect_key($value, $searchFields));
            } else {
                $searchData[$key] = (string)$key . ' ' . (string)$value;
            }
        }

        return array_intersect_key($data, preg_grep($pattern, $searchData));

The return type of return array_intersect_key($data, preg_grep($pattern, $searchData)); (array) is incompatible with the return type declared by the interface EasyDictionary\Interfaces\DictionaryInterface::search of type EasyDictionary\Interfaces\iterable.

    }

    /**

Missing short description in doc comment

     * @param bool $strict

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return array

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function getSearchFields(bool $strict = false): array
    {
        return true === $strict ? array_filter($this->searchFields) : $this->searchFields;
    }

    /**

Missing short description in doc comment

     * @param array $searchFields

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 setSearchFields(array $searchFields)
    {
        $this->searchFields = $searchFields;

        return $this;
    }
}