stevenmaguire / laravel-cache
Seamlessly adding caching to Laravel service objects
Installs: 1 756
Dependents: 0
Suggesters: 0
Security: 0
Stars: 17
Watchers: 3
Forks: 0
Open Issues: 0
Requires
- php: >=5.5.0
- illuminate/database: ^5.0
- illuminate/support: ^5.0
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0
- squizlabs/php_codesniffer: ~2.0
This package is auto-updated.
Last update: 2024-10-14 10:28:27 UTC
README
Seamlessly adding caching to Laravel Eloquent service objects.
Install
Via Composer
$ composer require stevenmaguire/laravel-cache
Usage
Include the base service
Extend your service class with the EloquentCache class.
class UserRegistrar extends Stevenmaguire\Laravel\Services\EloquentCache { // }
Implement the interface and use the trait.
class UserRegistrar implements Stevenmaguire\Laravel\Contracts\Cacheable { use \Stevenmaguire\Laravel\Services\EloquentCacheTrait; }
Construct queries
Build queries using Eloquent and request cache object.
use App\User; use Stevenmaguire\Laravel\Services\EloquentCache; class UserRegistrar extends EloquentCache { public function __construct(User $user) { $this->user = $user; } public function getAllUsers() { $query = $this->user->query(); return $this->cache('all', $query); } public function getUserById($id) { $query = $this->user->where('id', $id); return $this->cache('id('.$id.')', $query, 'first'); } public function getRecent($skip = 0, $take = 100) { $query = $this->user->orderBy('created_at', 'desc') ->take($take) ->skip($skip); return $this->cache('recent('.$skip.','.$take.')', $query); } }
The cache
method takes three parameters:
- The unique key associated with the method's intentions
- The query
Builder
object for the Eloquent query - The optional verb,
get
,first
,list
,paginate
etc;get
by default
If the method associated with the optional verb takes parameters, like paginate
, the parameters can be expressed as a comma separated list following the verb and a colon. If a parameter expects an array of literal values, these may be expressed as a pipe delimited sting.
/** * Paginate users with all pagination parameters */ public function getAllUsers() { $query = $this->user->query(); return $this->cache('all', $query, 'paginate:15,id|email|name,sheet,2'); // $query->paginate(15, ['id', 'email', 'name'], 'sheet', 2); }
The cache service will automatically index all of the unique keys used by your application. These keys will be used when the flushCache
method is called on each service implementing the base cache service.
Configure caching
For each of the services you implement using the EloquentCache
you can configure the following:
Duration of cache minutes
use Stevenmaguire\Laravel\Services\EloquentCache; class UserRegistrar extends EloquentCache { protected $cacheForMinutes = 15; // }
Disable caching
use Stevenmaguire\Laravel\Services\EloquentCache; class UserRegistrar extends EloquentCache { protected $enableCaching = false; // }
Disable logging
use Stevenmaguire\Laravel\Services\EloquentCache; class UserRegistrar extends EloquentCache { protected $enableLogging = false; // }
Set a custom cache index for the keys
use Stevenmaguire\Laravel\Services\EloquentCache; class UserRegistrar extends EloquentCache { protected $cacheIndexKey = 'my-service-keys-index'; // }
Flushing cache
Each service object that implements caching via Stevenmaguire\Laravel\Services\EloquentCache
can flush its own cache, independently of other consuming services.
Your application can flush the cache for all keys within the service object serviceKey
group.
$userRegistrar->flushCache();
Your application can only flush the cache for keys within the service object serviceKey
group that match a particular regular expression pattern.
// Flush cache for all cached users with a single digit user id $userRegistrar->flushCache('^id\([0-9]{1}\)$');
Bind to IoC Container
use Illuminate\Support\ServiceProvider; class AppServiceProvider extends ServiceProvider { public function register() { $this->app->when('App\Handlers\Events\UserHandler') ->needs('Stevenmaguire\Laravel\Contracts\Cacheable') ->give('App\Services\UserRegistrar'); } }
In this particular example, UserHandler
is responsible for flushing the user service cache when a specific event occurs. The UserHandler
takes a dependacy on the flushCache
method within the UserRegistrar
service.
Testing
$ ./vendor/bin/phpunit
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email stevenmaguire@gmail.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.