A simple and decoupled way to store resource consuming operations results in cache., (*1)
, (*2)
, (*3)
Contents
Installation
You can install the package using composer, (*4)
``` bash
$ composer require tequilarapido/result-cache, (*5)
## Usage
### Cache
* Create a class that extends ResultCache
``` php
use Tequilarapido\ResultCache\ResultCache;
class BooksCache extends ResultCache {
public function key() {
return 'app.books.all';
}
public function data() {
// Some heavy / resources consuming operations
// ...
return $books;
}
}
- Now you can simply call the get method to fetch cache. If the cache is invalid or not yet created, the operations will be executed.
``` php
class SomeController {
public function books() {
return (new BooksCache)->get();
}
}, (*6)
* Clean the cache
The package uses the default cache driver defined in your laravel application.
You can clean the cache using the `artisan cache:clear`
You can also clean the cache programmatically using :
``` php
(new BooksCache)->forget()
Application locale aware cache
Sometimes we need to cache something, but we need multiple versions depending on the application locale.
For this kind of use case we need to extend the LocaleAwareResultCache, and define the locales that are available in our application., (*7)
- Create a class that extends LocaleAwareResultCache
``` php
use Tequilarapido\ResultCache\LocaleAwareResultCache;, (*8)
class BooksCache extends LocaleAwareResultCache {, (*9)
public function key() {
return 'app.books.all';
}
public function data() {
// Some heavy / resources consuming operations
// We have access to $this->locale here to customize results according to locale
// ...
return $books;
}
public function supportedLocales() {
return ['en', 'fr', 'ar']
}
}, (*10)
* Now you can simply call the get method to fetch cache. If the cache is invalid or not yet created, the operations will be executed.
``` php
class SomeController {
public function books() {
return (new BooksCache)->setLocale($locale)->get();
}
}
The package uses the default cache driver defined in your laravel application., (*11)
You can clean the cache using the artisan cache:clear, (*12)
You can also clean the cache programmatically using :, (*13)
``` php
(new BooksCache)->forget(), (*14)
this will clean cache for all locales.
### Cache expiration
By default, cache is created for one day. You can override the protected `$minutes` property on
your cache class to specify how much minutes you want your cache before it gets invalidated.
``` php
use Tequilarapido\ResultCache\ResultCache;
class BooksCache extends ResultCache {
protected $minutes = 60; // One hour
// ...
}
Changelog
Please see CHANGELOG for more information what has changed recently., (*15)
Testing
bash
$ composer test, (*16)
Security
If you discover any security related issues, please email :author_email instead of using the issue tracker., (*17)
Contributing
Please see CONTRIBUTING for details., (*18)
Credits
License
The MIT License (MIT). Please see License File for more information., (*19)
Wallogit.com
