Wallogit.com
2017 © Pedro Peláez
Self-invalidating cache for Laravel
![Software License][ico-license]
![Quality Score][ico-code-quality]
![Total Downloads][ico-downloads], (*1)
"There are only two hard problems in Computer Science: cache invalidation and naming things.", (*2)
-- Phil Karlton, (*3)
ManagedCache solves one of these., (*4)
When caching data (say, a fully hydrated User with all of its related data -- roles, subscriptions, preferences, etc.), you would normally have to invalidate that cache in every part of the code where one of those roles, subscriptions or preferences is modified., (*5)
ManagedCache lets you define the invalidation criteria in the same statement that caches the data., (*6)
ManagedCache uses tags to perform its automatic event-based invalidation. This means that your cache driver should support tags (the file and database drivers do not)., (*7)
ManagedCache currently only supports the Memcached cache driver. Support for other cache drivers such as Redis is planned., (*8)
Models that are used in invalidation conditions should have an integer primary key., (*9)
Via Composer, (*10)
``` bash $ composer require codefocus/managedcache, (*11)
## Quick start ### Provider Add `ManagedCacheProvider` to the "providers" array in `config/app.php` ``` php Codefocus\ManagedCache\Providers\ManagedCacheProvider::class
ManagedCache also provides a Facade., (*12)
To use it, add Codefocus\ManagedCache\Facades\ManagedCache to your use statements., (*13)
ManagedCache implements the Illuminate\Contracts\Cache\Store interface, and can be used as a drop-in replacement for the Cache Facade., (*14)
``` php // Retrieve a user. $user = User::with(['roles', 'subscriptions', 'preferences'])->find($userId);, (*15)
// Store data as you normally would. $cacheKey = 'users(' . $userId . ')'; ManagedCache::put($cacheKey, $user, 120);, (*16)
..., (*17)
// Retrieve data as you normally would. $user = ManagedCache::get($cacheKey);, (*18)
### Automatic invalidation To automatically invalidate this data, call the `setForgetConditions()` function at the start of the function chain, passing in an array of invalidation conditions. These invalidation conditions (`Codefocus\ManagedCache\Condition` objects) are named after the Eloquent events that trigger them, and can be created with intuitive helper functions: ``` php // Store data, and invalidate this cache when one of these conditions is met: // - This User is deleted // - This User is updated // - A Role is attached to this User // - A Role is detached from this User // - A Role attached to this User is updated // - A Subscription is attached to this User // - A Subscription is detached from this User // - A Subscription attached to this User is updated // - A Preference is attached to this User // - A Preference is detached from this User // - A Preference attached to this User is updated ManagedCache ::setForgetConditions(function ($conditionBuilder) use ($user) { return $conditionBuilder ->modelDeleted($user) ->modelUpdated($user) ->relatedModelAttached($user, Role::class) ->relatedModelDetached($user, Role::class) ->relatedModelUpdated($user, Role::class) ->relatedModelAttached($user, Subscription::class) ->relatedModelDetached($user, Subscription::class) ->relatedModelUpdated($user, Subscription::class) ->relatedModelAttached($user, Preference::class) ->relatedModelDetached($user, Preference::class) ->relatedModelUpdated($user, Preference::class); }) ->put($cacheKey, $user, 120);
As you can see, more complex data with many invalidation conditions could get cumbersome to define. To invalidate a cache key on any of the Eloquent events (created, updated, saved, deleted or restored) for the specified Model class or instance, use anyModelEvent() and anyRelatedModelEvent():, (*19)
``` php // Store data, and invalidate this cache when one of these conditions is met: // - This User is created, updated, saved, deleted or restored // - A Role attached to this User is created, updated, saved, deleted or restored // - A Subscription attached to this User is created, updated, saved, deleted or restored // - A Preference attached to this User is created, updated, saved, deleted or restored ManagedCache ::setForgetConditions(function ($conditionBuilder) use ($user) { return $conditionBuilder ->anyModelEvent($user) ->anyRelatedModelEvent($user, Role::class) ->anyRelatedModelEvent($user, Subscription::class) ->anyRelatedModelEvent($user, Preference::class); }) ->put($cacheKey, $user, 120);, (*20)
## Change log Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. ## Testing ``` bash $ composer test
Please see CONTRIBUTING for details., (*21)
If you discover any security related issues, please email info@codefocus.ca instead of using the issue tracker., (*22)
The MIT License (MIT). Please see License File for more information., (*23)
Self-invalidating cache for Laravel
MIT
laravel cache clear codefocus invalidation managedcache