devcuongnguyen/laravel-caching-model

A simple cache library for laravel eloquent model

1.0.0 2024-01-09 00:50 UTC

Requires

• php: ^7.0|^8.0
• laravel/framework: ^6.0|^7.0|^8.0

MIT

• devcuongnguyen

README

• Simple package for caching laravel eloquent model
• Support retrieve model stored in cache store by id (or other primary key)

Usage

1. Implement Cacheable interface then use HasCache trait:

use devcuongnguyen\CachingModel\Contracts\Cacheable;
use devcuongnguyen\CachingModel\HasCache;

class Setting extends Model implements Cacheable
{
    use HasCache;

    ...
}

1. use fromCache() static method to retrieve model data from cache storage

$cachedInstance = Setting::fromCache()->find($key);

Available methods:

1. public static function primaryCacheKey(): string;

• Return primary key for creating cache key
• Default: id

1. public static function getCacheKey($id): string;

• Return cache key for specific instance with primary key is $id

1. public static function cacheTimeout(): int;

• Return cache timeout

1. public function scopeCacheWithRelation($query);

• Specific relationship will cache together model

public function scopeCacheWithRelation($query)
{
    return $query->with('relationship:id);
}