README

Elephant - a highly performant PHP Cache Driver for Kirby 3

Commerical Usage

Support open source!

This plugin is free but if you use it in a commercial project please consider to sponsor me or make a donation.
If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?

Be kind. Share a little. Thanks.

‐ Bruno

Installation

unzip master.zip as folder site/plugins/kirby3-php-cachedriver or
git submodule add https://github.com/bnomei/kirby3-php-cachedriver.git site/plugins/kirby3-php-cachedriver or
composer require bnomei/kirby3-php-cachedriver

Usage

Cache methods

$cache = \Bnomei\PHPCache::singleton(); // or
$cache = elephant();

$cache->set('key', 'value', $expireInMinutes);
$value = elephant()->get('key', $default);

elephant()->remove('key');
elephant()->flush();

Cache file(s)

All data is written at the end of the php script life-cycle. This does not count against your script execution time but for example when you change value in the cache with each request writing that big file everytime the time might prove inefficient. Further more incremental updates will be written during script execution depending on the mono_dump setting. Additions to the cache will also be each written in temporary files to improve stability of the cache.

Serialization of data

This plugin defaults to a simple serialization logic which is quick but only serializes primitive data types, closures, objects that have a toArray()-method like Kirby\Cms\Field and Kirby\Toolkit\Obj. This should be enough for most usecases. If you need broader support set bnomei.php-cachedriver.serialize to json which will en- and decode your data as json before storing it. That is a bit slower but will ensure your data contains only primitive types without the hassle of serializing it manually before caching it.

OPCache

Make sure OPCache is configured to load the php files from the cache without any delay. Most probably you will have to set these values in your user.ini or something similar! If you do not set these values you might have outdated data being loaded from php files cached by OPCache instead of loading the right ones you want from disk.

opcache.enable=1
opcache.enable_cli=0 # default is 0, leave it like that
opcache.validate_timestamps=1
opcache.revalidate_freq=0 # default is 2, 0 => on every request

Thanks Al for helping me get these config values right.

Benchmark

elephant()->benchmark(1000);

php : 0.03383207321167  
file : 2.3811981678009

ATTENTION: This will create and remove a lot of cache files and php-cache files

No cache when debugging

When Kirbys global debug config is set to true the complete plugin cache will be flushed and no caches will be read. But entries will be created. This will make you live easier – trust me.

How to use Elephant with Lapse or Boost

You need to set the cache driver for the lapse plugin to php. Please be aware that the mono-mode is not suited for concurrent writes.

site/config/config.php

<?php
return [
    'bnomei.lapse.cache' => ['type' => 'php'],
    'bnomei.boost.cache' => ['type' => 'php'],
    //... other options
];

Setup Content-File Cache

Use Kirby 3 Boost to setup a cache for content files.

Settings

Disclaimer

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.

License

MIT

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.

bnomei / kirby3-php-cachedriver

Maintainers

Details