Suitmedia\Cacheable\CacheableDecorator

Complexity

Total Complexity

11

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	generateCustomTags()	0	12	2
A	generateTags()	0	15	4
A	methodIsCacheable()	0	4	1
B	__call()	0	24	3

<?php

namespace Suitmedia\Cacheable;

use Illuminate\Database\Eloquent\Model;
use Suitmedia\Cacheable\Contracts\CacheableRepository;
use Suitmedia\Cacheable\Exceptions\MethodNotFoundException;

class CacheableDecorator
{
    /**
     * Cacheable Repository.
     *
     * @var \Suitmedia\Cacheable\Contracts\CacheableRepository
     */
    private $repository;

    /**
     * Cacheable service object.
     *
     * @var \Suitmedia\Cacheable\CacheableService
     */
    private $service;

    /**
     * Class constructor.
     *
     * @param \Suitmedia\Cacheable\CacheableService              $service
     * @param \Suitmedia\Cacheable\Contracts\CacheableRepository $repository
     */
    public function __construct(CacheableService $service, CacheableRepository $repository)
    {
        $this->service = $service;
        $this->repository = $repository;
    }

    /**
     * Generate custom cache tags.
     *
     * @param array $tags
     * @param Model $object
     *
     * @return array

Consider making the return type a bit more specific; maybe use array<string,boolean>.

     */
    private function generateCustomTags($tags, Model $object)
    {
        $class = last(explode('\\', get_class($object)));
        $customTags = [$class.':'.$object->getKey() => true];

        foreach ($tags as $tag) {
            $key = $tag.':'.$class.':'.$object->getKey();
            $customTags[$key] = true;
        }

        return $customTags;
    }

    /**
     * Generate cache tags.
     *
     * @param mixed $args
     *
     * @return array
     */
    private function generateTags($args)
    {
        $args = (array) $args;
        $tags = (array) $this->repository->cacheTags();
        $customTagInstances = (array) $this->service->getConfiguration('customTags');
        $customTags = [];

        foreach ($args as $arg) {
            if (is_object($arg) && in_array(get_class($arg), $customTagInstances)) {
                $customTags = array_merge($customTags, $this->generateCustomTags($tags, $arg));
            }
        }

        return array_merge($tags, array_keys($customTags));
    }

    /**
     * Finds whether the metod is cacheable.
     *
     * @param string $method
     *
     * @return bool
     */
    private function methodIsCacheable($method)
    {
        return !in_array($method, $this->repository->cacheExcept());
    }

    /**
     * Dynamically call methods from repository.
     *
     * @param string $method
     * @param mixed  $args
     *
     * @return mixed
     */
    public function __call($method, $args)
    {
        $repository = $this->repository;

        if (!method_exists($repository, $method)) {
            throw (new MethodNotFoundException())->setRepositoryMethod(
                get_class($repository),
                $method
            );
        }

        if (!$this->methodIsCacheable($method)) {
            return call_user_func_array([$repository, $method], $args);
        }

        return $this->service->retrieve(
            $this->generateTags($args),
            $repository->cacheKey($method, $args),
            $repository->cacheDuration(),
            function () use ($repository, $method, $args) {
                return call_user_func_array([$repository, $method], $args);
            }
        );
    }
}