mohamadtsn/laravel-eloquent-query-cache

Adding cache on your Laravel Eloquent queries' results is now a breeze.

Maintainers

Package info

github.com/mohamadtsn/laravel-eloquent-query-cache

Homepage

pkg:composer/mohamadtsn/laravel-eloquent-query-cache

Transparency log

Fund package maintenance!

mohamadtsn

Statistics

Installs: 0

Dependents: 0

Suggesters: 0

Stars: 0

3.6.1 2025-03-18 07:43 UTC

README

Latest Version on Packagist Total Downloads CI License: Apache-2.0

mohamadtsn/laravel-eloquent-query-cache is a maintained fork of the original rennokki/laravel-eloquent-query-cache package.

If you only need the core package behavior, use the original documentation above. This fork keeps the original package experience and adds a few improvements for modern Laravel applications and additional relationship caching scenarios.

Requirements

  • PHP 8.18.4
  • Laravel 10.x, 11.x, 12.x, or 13.x

Installation

composer require mohamadtsn/laravel-eloquent-query-cache

This is a library — there is no service provider to register. The trait wires everything by overriding the model's query builder.

Use the trait on models where query caching should be available:

use Mohamadtsn\QueryCache\Traits\QueryCacheable;

class Post extends Model
{
    use QueryCacheable;
}

What This Fork Adds

MorphTo caching support

The original package documentation covers the general caching API. This fork additionally supports cached morphTo relations with inherited cache configuration.

$commentable = $comment->commentable()
    ->cacheFor(now()->addHour())
    ->cacheTags(['commentable'])
    ->cachePrefix('comments')
    ->withPlainKey()
    ->first();

This is useful when you want polymorphic relations to behave the same way as the rest of your cached query chains.

Cache configuration inheritance for relationships

Custom cache options can now flow more consistently into supported relationship queries.

Typical examples:

  • cacheFor(...)
  • cacheTags([...])
  • cachePrefix(...)
  • withPlainKey()
  • cacheDriver(...)

Custom cache repository support

In addition to passing a driver name, you can pass a cache repository instance to cacheDriver():

use Illuminate\Support\Facades\Cache;

$posts = Post::query()
    ->cacheFor(300)
    ->cacheDriver(Cache::store('array'))
    ->get();

This is helpful when integrating the package into more customized application setups or when testing specific cache stores.

Using The Core API

The core query cache API remains aligned with the original package documentation. For the full feature set and the original behavior reference, see:

Common examples:

$posts = Post::cacheFor(3600)->get();

$post = Post::cacheFor(now()->addHour())->first();

$uncached = Post::dontCache()->get();

$tagged = Post::cacheFor(600)->cacheTags(['posts'])->get();

Testing

Tests run on Orchestra Testbench + sqlite. The default cache driver is array.

composer install
composer test                               # full suite (alias for vendor/bin/phpunit)

vendor/bin/phpunit --filter test_name       # single test
vendor/bin/phpunit tests/GetTest.php        # single file

CACHE_DRIVER=redis vendor/bin/phpunit       # exercise a tag-supporting driver

Code style is enforced by StyleCI (Laravel preset). CI runs the suite across PHP 8.18.4 × Laravel 10/11/12/13 × prefer-lowest/stable.

If you run the project through Docker:

docker run --rm -u $(id -u):$(id -g) -v "$PWD:/app" -w /app composer:2 sh -lc 'composer install'
docker run --rm -u $(id -u):$(id -g) -v "$PWD:/app" -w /app composer:2 sh -lc 'composer test'

Contributing

Please see CONTRIBUTING for details.

Security

If you discover a security issue, please open a private report with the repository maintainers instead of posting sensitive details publicly.