Laravel Cache
Installation
To get the latest version of Laravel Cache, simply require the project using Composer:
$ composer require dragon-code/laravel-cache
Or manually update require block of composer.json and run composer update.
{
"require": {
"dragon-code/laravel-cache": "^2.0"
}
}
Using
Keys And Tags
In addition to passing an explicit value, you can also pass objects and arrays to the keys and tags methods.
For example:
use DragonCode\Cache\Services\Cache;
use DragonCode\SimpleDataTransferObject\DataTransferObject;
$arr1 = ['foo', 'bar']
$arr2 = new ArrayObject(['foo', 'bar'])
$arr3 = DataTransferObject::make(['foo', 'bar'])
Cache::make()->key($arr1)->tags($arr1);
Cache::make()->key($arr2)->tags($arr3);
Cache::make()->key($arr2)->tags($arr3);
Cache::make()->key([$arr1, $arr2, $arr3, 'foo', 'bar'])->tags([$arr1, $arr2, $arr3, 'foo', 'bar']);
Cache::make()->key([$arr1, $arr2, $arr3, 'foo', 'bar'])->tags([$arr1, $arr2, $arr3, 'foo', 'bar']);
Cache::make()->key([$arr1, $arr2, $arr3, 'foo', 'bar'])->tags([$arr1, $arr2, $arr3, 'foo', 'bar']);
Keys Handling
Since the main problem of working with the cache's key compilation, this package solves it.
By passing values to the keys method, we get a ready-made key at the output.
For example:
use DragonCode\Cache\Services\Cache;
$cache = Cache::make()->key('foo', 'bar', [null, 'baz', 'baq']);
// Key is `acbd18db4cc2f85cedef654fccc4a4d8:37b51d194a7513e45b56f6524f2d51f2:73feffa4b7f6bb68e44cf984c85f6e88:b47951d522316fdd8811b23fc9c2f583`
This means that when writing to the cache, the tree view will be used.
For example:
use DragonCode\Cache\Services\Cache;
Cache::make()->key('foo', 'foo')->put('foo');
Cache::make()->key('foo', 'bar')->put('bar');
Cache::make()->key('baz')->put('baz');
// acbd18db4cc2f85cedef654fccc4a4d8:
// acbd18db4cc2f85cedef654fccc4a4d8: foo
// 37b51d194a7513e45b56f6524f2d51f2: bar
// 73feffa4b7f6bb68e44cf984c85f6e88: baz
When Enabled
Basic
By default, the cache will be written for 1 day.
use DragonCode\Cache\Services\Cache;
$cache = Cache::make()->key('foo', 'bar', ['baz', 'baq']);
$cache->put(static fn() => 'Some value');
// or
$cache->put('Some value');
// Contains cached `Some value`
$cache->get();
// Returns cached `Some value`
$cache->has();
// Returns `true`
$cache->forget();
// Will remove the key from the cache.
Custom TTL
The cache will be written for the specified number of minutes.
use DragonCode\Cache\Services\Cache;
$cache = Cache::make()
->ttl($minutes)
->key('foo', 'bar', ['baz', 'baq']);
$cache->put(static fn() => 'Some value');
// or
$cache->put('Some value');
// Contains cached `Some value`
$cache->get();
// Returns cached `Some value`
$cache->has();
// Returns `true`
$cache->forget();
// Will remove the key from the cache.
Tagged
For repositories that support tagging, the keys will be saved separated by tags.
use DragonCode\Cache\Services\Cache;
$cache = Cache::make()
->tags('actor', 'author')
->key('foo', 'bar', ['baz', 'baq']);
$cache->put(static fn() => 'Some value');
// or
$cache->put('Some value');
// Contains cached `Some value`
$cache->get();
// Returns cached `Some value`
$cache->has();
// Returns `true`
$cache->forget();
// Will remove the key from the cache.
To retrieve a tagged cache item, pass the same ordered list of tags to the tags method and then call the get method with the key you wish to retrieve:
use DragonCode\Cache\Services\Cache;
$cache = Cache::make()->key('foo', 'bar');
$cache->tags('actor', 'author')->put(static fn() => 'Some value');
// or
$cache->tags('actor', 'author')->put('Some value');
// Contains cached `Some value`
$cache->tags('actor', 'author')->get();
// Returns cached `Some value`
$cache->tags('actor')->get();
// Returns `null`
$cache->tags('author')->get();
// Returns `null`
See the official Laravel documentation.
When Disabled
Passing when = false will not write to the cache.
use DragonCode\Cache\Services\Cache;
$cache = Cache::make()
->when(false)
->key('foo', 'bar');
$value = $cache->put(static fn() => 'Some value');
// or
$value = $cache->put('Some value');
// Returns `Some value`
$cache->get();
// Returns `null`
$cache->has();
// Returns `false`
License
This package's licensed under the MIT License.
944 Jan 4, 2023
295 Nov 28, 2022
102 Sep 28, 2022
27 Dec 8, 2022
7.6k Jan 3, 2023
2.3k Dec 30, 2022
61 Jun 23, 2022
48 Sep 9, 2022
1 Oct 15, 2021
2 Oct 16, 2021
3 Dec 17, 2022
11 Apr 6, 2022
12 Feb 19, 2020
48 Sep 9, 2022
815 Dec 18, 2022
129 Nov 20, 2022
27 Nov 8, 2022
394 Nov 20, 2022
43 Oct 7, 2021