andrey-helldar / laravel-roles

src/Traits/Cacheable.php

<?php

namespace Helldar\Roles\Traits;

use Closure;
use Helldar\Roles\Facades\Config;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Str;

/** @mixin \Illuminate\Database\Eloquent\Model */
trait Cacheable
{
    protected function cache(string $prefix, Closure $callback, $values = [])
    {
        if ($this->allowCache()) {
            $key = $this->cacheKey($prefix, $values);
            $ttl = $this->cacheTtl();

            return Cache::remember($key, $ttl, $callback);
        }

        return $callback();
    }

    protected function cacheKey(string $prefix, $values = []): string
    {
        $values = Arr::flatten(Arr::wrap($values));

        return Str::slug(
            $prefix . '-' . $this->cacheUserKey() . '-' . implode('-', $values)
        );
    }

    protected function cacheUserKey(): string
    {
        return $this->getAttribute(

It seems like getAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $this->getKeyName()

It seems like getKeyName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        );
    }

    protected function cacheTtl(): int
    {
        return Config::cacheTtl();
    }

    protected function allowCache(): bool
    {
        return Config::useCache();
    }
}