hareland/multi-cache-remember

This package offers the rememberMany macro for the Laravel Cache facade, providing efficient retrieval of multiple cache keys with customizable expiration and callbacks for missing keys.

1.0.0 2023-07-31 12:38 UTC

Requires

• illuminate/support: ^6|^7|^8|^9|^10

Requires (Dev)

• mockery/mockery: ^1.0
• orchestra/testbench: ^7.10
• pestphp/pest: ^1.22
• pestphp/pest-plugin-laravel: ^1.3
• phpunit/phpunit: ^9.0

MIT

• hareland

README

What does this package solve?

This package offers the rememberMany macro for the Laravel Cache facade, providing efficient retrieval of multiple cache keys with customizable expiration and callbacks for missing keys.

The rememberMany macro for the Laravel Cache facade provides several advantages over the traditional method of looking up multiple cache keys one by one.

Why?

1. Reduced number of cache lookups: With the traditional method, each cache key is looked up individually, even if some of them are being retrieved in quick succession. With the rememberMany macro, all the requested keys are retrieved in a single call to Cache::many(), which can significantly reduce the number of cache lookups and improve performance.

2. Customizable cache expiration: The rememberMany macro allows you to specify an expiration time for all the cached values at once, which can simplify the cache management process and make it easier to ensure that your cached data is up-to-date.

3. Callbacks for missing keys: The rememberMany macro allows you to specify a callback function for each cache key, which will be called only if the key is not found in the cache. This is similar to the Cache::remember() method.

Install

composer require hareland/multi-cache-remember

Register ServiceProvider (if you must)

// in config/app.php
'providers' => [
    \Hareland\MultiCacheRemember\MultiCacheServiceProvider::class,
]

Usage

To set the default TTL, you can set this in config/services.php on the key multi_remember.default_ttl -> You will have to set it in seconds.

Simple (No custom TTL)

<?php

use Illuminate\Support\Facades\Cache;

[$user1, $user2, $meta] = Cache::rememberMany([
    'user:1' => fn ()=> \App\Models\User::findOrFail(1),
    'user:2' => fn ()=> \App\Models\User::findOrFail(2),
    'meta:11'=> fn ()=> \App\Models\Meta::findOrFail(11),
], 5);// 5 seconds is now the TTL for all the items.

Custom TTL on some keys

<?php

use Illuminate\Support\Facades\Cache;

[$topStats, $orgSales, $overview] = Cache::rememberMany([
    'dashboard.stats.top:user:1' => [fn() => \App\Models\Stats::findFor(request()->user()), 60 * 15],
    'dashboard.stats.sales:org:3' => [fn() => \App\Models\StatsForOrf::findFor(request()->user()->currentOrg), 60 * 5],
    'dashboard.stats.overview:org:3' => fn() => \App\Models\OverviewStats::findFor(request()->user()->currentOrg),
], 60); // 60 seconds is the default TTL for any keys that does not have a custom one.