xes/cacher

Simple file caching for PHP with string replacements

Overview

Cacher provides a simple caching functionality, usable with two lines of code., _(*1)

Installation

Add "xes/cacher": "dev-master" to your composer.json file., _(*2)

Usage

Before any HTML is output:, _(*3)

<?php
$cache = new xes\Cacher('/path/to/cache/folder');
$cache->start();
?>

The path must already exist and be writable by the web server., _(*4)

At the end of your script:, _(*5)

<?php
$cache->finish();
?>

String replacements

For content such as page title and meta descriptions, you may not know the values until later in the script. For this there is a replacement method in Cacher:, _(*6)

<title></title>

setReplacements( array(
    "" => $pageTitleFromDatabase,
    "" => $somethingElse
));
?>

This simply performs a find-and-replace on the HTML until the search text doesn't exist., _(*7)

The replacements array can also be passed directly to finish()., _(*8)

Settings

setEnabled(true/false) - choose if the cache should run or not. Useful for development environments., _(*9)

setFolder(path) - absolute path to the cache folder. Must be writable by web server., _(*10)

setTimeout(numberOfSeconds) - how many seconds should elapse until a cached file should be considered invalid., _(*11)

setSuffix(fileSuffix) - the file suffix appended to all cache files. .cache.html by default., _(*12)

setReplacements(array) - associative array of replacements in the format "find" -> "replace", _(*13)