rah/rah_cache

Flat full-page caching plugin for Textpattern CMS

Installs: 24

Dependents: 1

Stars: 4

Watchers: 4

Forks: 1

Language: PHP

0.2.0 2013-07-21 13:50 UTC

README

Rah_cache is a very simple, experimental caching plugin for Textpattern CMS. It caches Texpattern’s dynamic pages as flat files.

As of now the plugin is very simple, and is intended as a building block rather than full caching suite. Among many missing features, it doesn’t do any cache management, or flushing. It doesn’t check if site’s content is newer than cache. Instead, it just writes pages to cache, and serves pages. Rest is up to the two callbacks the plugin comes with.

Installing

Using Composer:

$ composer require rah/rah_cache

Configuration

Configuration happens through your config.php. The plugin comes with Rah_Cache_Config class which you will be using to configure the plugin, and Rah_Cache_Handler that handles the cache. To configure the plugin extend or create a new instance of Rah_Cache_Config and pass it to Rah_Cache_Handler:

if (!class_exists('Rah_Cache_Handler'))
{
    include txpath . '/../../vendor/rah/rah_cache/src/Rah/Cache/Handler.php';

    class My_Site_Cache_Config extends Rah_Cache_Config
    {
        public $path = '/path/to/your/write/able/cache/directory';
    }

    new Rah_Cache_Handler(new My_Site_Cache_Config);
}

Place the above to your configuration file (textpattern/config.php).

Changelog

Version 0.2.0 – 2013/07/21

  • Added: Pass HTTP headers to rah_cache.store event handlers.

Version 0.1.2 – 2013/07/21

  • Fixed: Content-type extractions from sent HTTP headers.

Version 0.1.1 – 2013/07/21

  • Fixed: Issue with timezone offsets.

Version 0.1.0 – 2013/07/21

  • Initial release.