LaraCache

Using this package, you can cache your heavy and most used queries.

All you have to do is to define the CacheEntity objects in the model and specify a valid name and ttl for them.

LaraCache will handle the rest of process automatically. It will create and update cache entities based on ttl that you've defined for each entity.

Manually updating the cache entities of models after dispatching model events (creating, updating and deleting) isn't required, LaraCache manages them in the background and ensures the most up-to-date version of each cache entity.

🚀 If you find this project interesting, please consider supporting me on the open source journey

Requirements:

• PHP 8.0.2 or higher
• Laravel 8.40.0 or higher

Installation

1. Install the package via composer:

   composer require mostafaznv/laracache
   

2. Publish config file:

   php artisan vendor:publish --provider="Mostafaznv\LaraCache\LaraCacheServiceProvider"
   

3. Done

Usage

1. Add LaraCache trait to the model

   <?php
   
   namespace App\Models;
   
   use Illuminate\Database\Eloquent\Model;
   use Mostafaznv\LaraCache\Traits\LaraCache;
   
   class Article extends Model
   {
       use LaraCache;
   
       /**
        * Define Cache Entities Entities
        *
        * @return CacheEntity[]
        */
       public static function cacheEntities(): array
       {
           return [
               CacheEntity::make('list.forever')
                   ->cache(function() {
                       return Article::query()->latest()->get();
                   }),
   
               CacheEntity::make('latest')
                   ->validForRestOfDay()
                   ->cache(function() {
                       return Article::query()->latest()->first();
                   })
           ];
       }
   }
   

2. Retrieve Cache

   use App\Models\Article;
   use Mostafaznv\LaraCache\Facades\LaraCache;
   
   
   $cache = Article::cache()->get('latest');
   // or
   $cache = LaraCache::retrieve(Article::class, 'latest');
   

Table of Contents:

• Installation
  • Install the package via composer
  • Publish config file
• Usage
• CacheEntity Methods
• Disable/Enable Cache
  • Enable
  • Disable
• Update Cache Manually
  • Update an Entity
  • Update all Entities
  • Update all LaraCache Entities
• Delete Cache Manually
  • Delete an Entity
  • Delete an Entity Forever
  • Delete all Model Entities
  • Delete all Model Entities Forever
  • Delete all LaraCache Entities
• Config Properties
• Complete Example

CacheEntity Methods

Disable/Enable Cache

If you want to disable/enable cache, you can do it in the following two ways:

Disable

use App\Models\Article;
use Mostafaznv\LaraCache\Facades\LaraCache;


Article::cache()->disable();
// or 
LaraCache::disable(Article::class);

Enable

use App\Models\Article;
use Mostafaznv\LaraCache\Facades\LaraCache;


Article::cache()->enable();
// or 
LaraCache::enable(Article::class);

Update Cache Manually

Sometimes you want to update cache entities manually.

Update an Entity

use App\Models\Article;
use Mostafaznv\LaraCache\Facades\LaraCache;


Article::cache()->update('latest');
// or 
LaraCache::update(Article::class, 'latest');

Update all Entities

use App\Models\Article;
use Mostafaznv\LaraCache\Facades\LaraCache;


Article::cache()->updateAll();
// or 
LaraCache::updateAll(Article::class);

Update all LaraCache Entities

This will update all cache entities that stored using LaraCache (across all models)

use App\Models\Article;
use Mostafaznv\LaraCache\Facades\LaraCache;

 
LaraCache::updateAll();

Delete Cache Manually

Sometimes you want to delete cache entities manually. using these methods, you can do it.

Delete an Entity

Using this feature, you can delete cache entities temporary. after spending ttl, cache entity will be generated again.

use App\Models\Article;
use Mostafaznv\LaraCache\Facades\LaraCache;


Article::cache()->delete('latest');
// or 
LaraCache::delete(Article::class, 'latest');

Delete an Entity Forever

Using this feature, you can delete cache entities permanently. Cache item will be deleted forever and whenever you try to retrieve it, you will get null (or default value).

use App\Models\Article;
use Mostafaznv\LaraCache\Facades\LaraCache;


Article::cache()->delete('latest', true);
// or 
LaraCache::delete(Article::class, 'latest', true);

Note: Cache Entity will update after creating or updating records in your model

Delete all Model Entities

use App\Models\Article;
use Mostafaznv\LaraCache\Facades\LaraCache;


Article::cache()->deleteAll();
// or 
LaraCache::deleteAll(Article::class);

Delete all Model Entities Forever

use App\Models\Article;
use Mostafaznv\LaraCache\Facades\LaraCache;


Article::cache()->deleteAll(true);
// or 
LaraCache::deleteAll(Article::class, true);

Delete all LaraCache Entities

This will delete all cache entities that stored using LaraCache (across all models)

use App\Models\Article;
use Mostafaznv\LaraCache\Facades\LaraCache;

LaraCache::deleteAll();
// forever
LaraCache::deleteAll(forever: true);

Config Properties

Complete Example

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Mostafaznv\LaraCache\Traits\LaraCache;

class Article extends Model
{
    use LaraCache;
    
    /**
     * Define Cache Entities Entities
     *
     * @return CacheEntity[]
     */
    public static function cacheEntities(): array
    {
        return [
            CacheEntity::make('list.forever')
                ->forever()
                ->setDriver('redis')
                ->cache(function() {
                    return Article::query()->latest()->get();
                }),

            CacheEntity::make('list.day')
                ->isQueueable()
                ->validForRestOfDay()
                ->cache(function() {
                    return Article::query()->latest()->get();
                }),

            CacheEntity::make('list.week')
                ->validForRestOfWeek()
                ->cache(function() {
                    return Article::query()->latest()->get();
                }),

            CacheEntity::make('list.ttl')
                ->ttl(120)
                ->cache(function() {
                    return Article::query()->latest()->get();
                }),

            CacheEntity::make('latest')
                ->forever()
                ->cache(function() {
                    return Article::query()->latest()->first();
                }),

            CacheEntity::make('latest.no-create')
                ->refreshAfterCreate(false)
                ->cache(function() {
                    return Article::query()->latest()->first();
                }),

            CacheEntity::make('latest.no-update')
                ->refreshAfterUpdate(false)
                ->cache(function() {
                    return Article::query()->latest()->first();
                }),

            CacheEntity::make('latest.no-delete')
                ->refreshAfterDelete(false)
                ->cache(function() {
                    return Article::query()->latest()->first();
                }),

            CacheEntity::make('latest.no-restore')
                ->refreshAfterRestore(false)
                ->cache(function() {
                    return Article::query()->latest()->first();
                }),

            CacheEntity::make('empty.array')
                ->setDefault('empty value')
                ->cache(fn() => []),
        ];
    }
}

🚀 If you find this project interesting, please consider supporting me on the open source journey

License

This software is released under The MIT License (MIT).