Extends the basic APCu Cache-Driver for Kirby with garbage collection and in-memory store
- unzip master.zip as folder
site/plugins/kirby3-apcu-cachedriver
or git submodule add https://github.com/bnomei/kirby3-apcu-cachedriver.git site/plugins/kirby3-apcu-cachedriver
orcomposer require bnomei/kirby3-apcu-cachedriver
Kirby ships with built-in support for File, Memcached, and APCu Cache Drivers. APCu is widely available and performs great. Its only drawback is the limited memory size compared to SQLite or Redis.
Usually, each call to the same cached item even repeated calls in the same HTTP request, would yield repeated requests to the APCu cache. With this plugin's in-memory store, retrieved items will be stored in a PHP array for the current http request and returned from there without the round trip to APCu. This might increase the total memory usage of your PHP script but significantly speeds up repeated calls. You can turn of this behaviour in the settings if you do not need it.
Kirby removes expired cached items only if they are requested again and then deemed expired or when the cache is flushed completely. This might result in long-expired items taking up memory in the cache.
The default APCu implementation does not actively collect garbage but only removes expired cache items when running out of memory. That is a perfectly fine strategy. This plugin minimizes this behaviour by actively purging expired items.
$cache = \Bnomei\ApcuCache::singleton(); // or
$cache = apcugc();
$cache->set('key', 'value', $expireInMinutes);
$value = apcugc()->get('key', $default);
apcugc()->remove('key');
apcugc()->flush();
apcugc()->benchmark(1000);
apcugc : 0.026898145675659
file : 0.13169479370117
ATTENTION: This will create and remove a lot of cache files and apcu entries
When Kirby's global debug config is set to true,
the complete plugin cache will be flushed, and no caches will be read. However, entries will be created. This will make your life easier—trust me.
You must set the cache driver for the lapse plugin to apcugc
.
site/config/config.php
<?php
return [
'bnomei.lapse.cache' => ['type' => 'apcugc'],
'bnomei.boost.cache' => ['type' => 'apcugc'],
//... other options
];
bnomei.apcu-cachedriver. | Default | Description |
---|---|---|
store | true |
keep accessed cache items stored in PHP memory for faster recurring access |
store-ignore | `` | if key contains that string then ignore |
- PHP APCu extension
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.
It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.