Suitmedia\Cacheable\Traits\Repository\CacheableTrait

Complexity

Total Complexity

9

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	baseClassName()	0	10	2
A	cacheDuration()	0	8	2
A	cacheExcept()	0	10	2
A	cacheKey()	0	7	1
A	cacheTags()	0	8	2
	model()	0	1	?

<?php

namespace Suitmedia\Cacheable\Traits\Repository;

use Illuminate\Support\Str;
use Suitmedia\Cacheable\Contracts\CacheableModel;

trait CacheableTrait
{
    /**
     * Get the base class name, without 'Repository' suffix.
     *
     * @return string
     */
    protected function baseClassName(): string
    {
        $class = class_basename(get_class($this));

        if (Str::endsWith($class, 'Repository')) {
            $class = substr($class, 0, -10);
        }

        return $class;
    }

    /**
     * Return the cache duration value in seconds,
     * which would be used by the repository.
     *
     * @return int
     */
    public function cacheDuration(): int
    {
        if (property_exists($this, 'cacheDuration')) {
            return (int) static::$cacheDuration;
        }

        return (int) config('cacheable.duration');
    }

    /**
     * Return an array of method names which
     * you don't wish to be cached.
     *
     * @return array
     */
    public function cacheExcept(): array
    {
        $result = (array) config('cacheable.except');

        if (property_exists($this, 'cacheExcept')) {
            $result = array_unique(array_merge($result, (array) static::$cacheExcept));
        }

        return $result;
    }

    /**
     * Generate cache key.
     *
     * @param string $method
     * @param mixed  $args
     *
     * @return string
     */
    public function cacheKey($method, $args): string
    {
        $class = $this->baseClassName();
        $args = sha1(serialize($args));

        return implode(':', [$class, $method, $args]);
    }

    /**
     * Return the cache tags which would
     * be used by the repository.
     *
     * @return mixed
     */
    public function cacheTags()
    {
        if (property_exists($this, 'cacheTags')) {
            return (array) static::$cacheTags;
        }

        return $this->model()->cacheTags();
    }

    /**
     * Return the primary model object which would
     * be used by the repository.
     *
     * @return \Suitmedia\Cacheable\Contracts\CacheableModel
     */
    abstract public function model(): CacheableModel;
}