Xetaravel\Livewire\Traits\WithCachedRows

Complexity

Total Complexity

4

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	cache()	0	16	3
A	useCachedRows()	0	3	1

<?php

declare(strict_types=1);

namespace Xetaravel\Livewire\Traits;

use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface;

trait WithCachedRows
{
    /**
     * Whatever we use the cache or not.
     *
     * @var bool
     */
    protected bool $useCache = false;

    /**
     * Modify the option to use the cache.
     *
     * @return void
     */
    public function useCachedRows(): void
    {
        $this->useCache = true;
    }

    /**
     * Function to store and get back queries result from the cache.
     *
     * @param mixed $callback The callback function. (The query stored)
     *
     * @return mixed
     *
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
    public function cache(mixed $callback): mixed
    {
        $cacheKey = $this->getId();

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

        // If we use the cache and the cache has the id, return it.
        if ($this->useCache && cache()->has($cacheKey)) {
            return cache()->get($cacheKey);
        }

        // Get the callback result.
        $result = $callback();

        // Store the result in the cache.
        cache()->put($cacheKey, $result);

        return $result;
    }
}