silassiai/laravel-table-cache

Solution to easily cache tables records, the package uses the laravel Cache facade.

dev-main 2023-01-02 16:19 UTC

This package is auto-updated.

Last update: 2025-05-29 01:56:23 UTC


README

If you are working with a lot of data, it may not be best practice to work with collections (who are cached by laravel).

Instead of using (which returns a collection):

// for example in a cronjob that caches the users table
$users = cache()->rememberForever('users', function () {
    return DB::table('users')->pluck('email', 'id');
});
// when you need to check if this user exists somewhere later in your application
$users->where('email', 'john@do.nl')->exists();

We could do (which caches all the key values from the model directly in the cache):

// for example in a cronjob that caches the users table
User::cacheColumnKey('email')->withColumnValue('id');
// when you need to check if this user exists somewhere later in your application
User::cacheColumnKey('email')->isCached('john@do.nl');
// or if you need the value
User::cacheColumnKey('email')->getKeyValue('john@do.nl'); // returns the id in this case

Solution to easily cache tables records, the package uses the laravel Cache facade.

Installation

You can install the package via composer:

composer require silassiai/laravel-table-cache

Basic usage

Trait Key Value

You can add the TableCacheKeyValueTrait to you model to easily cache key value pairs (two columns) for your whole table. This can be handy when you want to cache the whole table after you seeded the model.

<?php

namespace App\Models;

use Silassiai\LaravelTableCache\Traits\TableCacheKeyValueTrait;

class BlackList
{
    use TableCacheKeyValueTrait;
}

next add to your seeder:

    public function run()
    {
        // Your seed code here...
        
        BlackList::cacheColumnKey('name')->withColumnValue('your_column_name');
    }

You can also use a default value:

    public function run()
    {
        // Your seed code here...
        
        BlackList::cacheColumnKey('name')->withDefaultValue(true);
    }

To check if the value has been cached

BlackList::cacheColumnKey('name')->isCached('suspicious.com')

To get the cached value

BlackList::cacheColumnKey('name')->getKeyValue('suspicious.com')

To check if the table column is already cached:

BlackList::hasTableKeyCached('name')