Adding a "lazyStore" in Eloquent Models

[florianJacques]

Recently, I needed to store the result of a complex request in my model using lazy loading.

I thought it might be interesting to integrate this natively into the models, so that it can be used directly via __get / getAttribute.

Here is my base code:

<?php

namespace App\Traits;

trait HasLazyStore
{
    protected array $lazyStore = [];
    protected array $lazyStoreAttributeDependencies = [];

    protected static function bootHasLazyStore(): void
    {
        static::saved(function ($model) {
            $model->pruneLazyStoreOnSaved();
        });

        static::deleted(function ($model) {
            $model->clearLazyStore();
        });
    }

    /**
     * @param string $key
     * @param \Closure $callback
     * @param array|null $dependencies
     * @param bool $forceReload
     * @return mixed
     */
    public function rememberLazyStore(string $key, \Closure $callback, ?array $dependencies = [], bool $forceReload = false): mixed
    {
        if ($forceReload || !$this->hasLazyStore($key)) {
            $result = $callback();
            $this->setLazyStore($key, $result, $dependencies);
        }

        return $this->getLazyStore($key);
    }

    /**
     * @param string $key
     * @param mixed|null $default
     * @return mixed
     */
    public function getLazyStore(string $key, mixed $default = null): mixed
    {
        return $this->lazyStore[$key] ?? $default;
    }

    /**
     * @param string $key
     * @return bool
     */
    public function hasLazyStore(string $key): bool
    {
        return array_key_exists($key, $this->lazyStore);
    }

    /**
     * @return array
     */
    public function getAllLazyStore(): array
    {
        return $this->lazyStore;
    }

    /**
     * @param string $key
     * @param mixed $value
     * @param array|null $dependencies
     * @return $this
     */
    public function setLazyStore(string $key, mixed $value, ?array $dependencies = []): static
    {
        if (empty($dependencies)) {
            $dependencies = $this->lazyAttributeDependencies[$key] ?? [];
        }

        $this->lazyStore[$key] = $value;
        $this->lazyStoreAttributeDependencies[$key] = $dependencies;

        return $this;
    }

    /**
     * @param string $key
     * @return $this
     */
    public function unsetLazyStore(string $key): static
    {
        unset($this->lazyStore[$key]);
        unset($this->lazyStoreAttributeDependencies[$key]);

        return $this;
    }

    /**
     * @return $this
     */
    public function clearLazyStore(): static
    {
        $this->lazyStore = [];
        $this->lazyStoreAttributeDependencies = [];

        return $this;
    }

    /**
     * @return $this
     */
    public function pruneLazyStoreOnSaved(): static
    {
        $modifiedAttributes = array_keys($this->getDirty());

        if (!empty($modifiedAttributes)) {
            foreach ($this->lazyStoreAttributeDependencies as $key => $dependencies) {
                if (empty($dependencies) || array_intersect($dependencies, $modifiedAttributes)) {
                    $this->unsetLazyStore($key);
                }
            }
        }

        return $this;
    }

    /**
     * @param array $keys
     * @return $this
     */
    public function withoutLazyStore(array $keys = []): static
    {
        $model = clone $this;

        if (empty($keys)) {
            return $model->clearLazyStore();
        }

        foreach ($keys as $key) {
            $model->unsetLazyStore($key);
        }

        return $model;
    }
}

Example of usage:

 /**
     * @param bool $forceRefresh
     * @return ProductCollection
     */
    public function getProducts(bool $forceRefresh = false): ProductCollection
    {
        return $this->rememberLazyStore('products', function () {

            return Product::query()->whereIn('_id', $this->productIds)->get();
        }, ['productIds'], $forceRefresh);
    }

Here I store in the key "products" the result of the request, and it is automatically cleared if one of the dependencies (here 'productIds') has undergone a change.

Happy reading!