uea/slimcache

File based cache system of slim 3 php frameworks.

dev-master 2017-02-23 22:47 UTC

Requires

• slim/slim: ^3.7

MIT

• Uğur Ethem AYDIN

• framework
• file
• cache
• middleware
• slim
• filecache

README

File based cache system of slim 3 php frameworks.

The cache is a simple file based cache, I needed something for a very specific situation where I had many external API requests (essentially an API aggregator) to make and within a given time period they always made my routes give the same output.

I didn't need a database or anything fancy, and wasn't too fussed about performance.

So a file based cache made a lot of sense.

Installation

Installation is done via composer

composer require uea/slimcache dev-master

Requirements

This middleware works with slim 3.0

Setup

The middleware conforms to slims normal injection requirements. The example below is the basic setup of the cache. Once this has been implemented, it will automatically load any active cache records for the route currently being called and halt the execution of the application.

//Start up a new slim app
$app = new App($container);

// Add file cache middleware
$cache = new \UEA\SlimCache\Cache($app);
$app->add($cache);

Usage

To use the cache you simple need to cache the output of your route before returning it. The add method takes 3 arguments, the first one is the route name. The second one is the content, and the third argument is the response code status (e.g. 200) and fourthly duration of the cache in seconds. The default length is 1 hour. The second argument for the cache is the directory to store the cache files in. The directory must be writeable to the web user.

//Start up a new slim app
$app = new App($container);

// Add file cache middleware
$cache = new \UEA\SlimCache\Cache($app, 'path/to/cacheDirectory');
$app->add($cache);

//Configure the "foo" route and cache the output
$slim->get('/foo', function(\Slim\Http\Request $request, \Slim\Http\Response $response, $args) use ($cache) {
$response = 'foo response string';
$cache->add('/foo', $response);
return $response;
}
);

Alternatively you can tell the cache to store all routes called by simple placing the following line after you have run the slim app

//Run the slim app (like normal)
$app->run();

//Place the global cache afterwards, the next request at this route will be cached
$cache->add($slim->request->getUri()->getPath(), $slim->response->getBody()->__toString());

The cache has a few other simple methods. They are flush, get, remove. They essentially do what they say on the tin:

$cache = new \UEA\SlimCache\Cache($slim)

//Flush removes all entries
$cache->flush();

//Remove a single cache entry
$cache->remove('/foo');

//Get returns what is stored in the cache
$response = $cache->get('/foo');