juhara/zzzmiddleware

A cache middleware for Slim Framework (3.0) using ZzzCache

v1.0.16 2018-09-09 23:34 UTC

Requires

• php: >=5.4
• juhara/zzzcache: ~1.0
• slim/slim: ^3.0

Requires (Dev)

• php: >=5.6
• phpunit/phpunit: ^5

Apache-2.0

• Zamrony P. Juhara

• php
• cache
• library
• middleware
• slim
• slim-3

README

Cache middleware for Slim Framework 3.0 using ZzzCache

Requirement

• PHP >= 5.4
• Composer
• Slim Framework 3.0
• ZzzCache

Installation

Run through composer

$ composer require juhara/zzzmiddleware

How to use

Register CacheMiddleware to Slim Dependency Container

<?php
...
use Juhara\ZzzCache\Contracts\CacheInterface;
use Juhara\ZzzCache\Cache;
use Juhara\ZzzCache\Storages\File;
use Juhara\ZzzCache\Helpers\ExpiryCalculator;
use Juhara\ZzzCache\Helpers\Md5Hash;

$container[CacheInterface::class] = function ($c) {
    // create a file-based cache where all cache
    // files is stored in directory name
    // app/storages/cache with
    // filename prefixed with string 'cache'
    return new Cache(
        new File(
            new Md5Hash(),
            'app/storages/cache/',
            'cache'
        ),
        new ExpiryCalculator()
    );
};

use Juhara\CacheMiddleware\CacheMidleware;
use Juhara\CacheMiddleware\ResponseCacheFactory;

$container[CacheMiddleware::class] = function ($c) {
    $cache = $c->get(CacheInterface::class);
    $factory = new ResponseCacheFactory();
    return new CacheMiddleware($cache, $factory);
};

Add CacheMiddleware to Slim Application

use Slim\App;
use  Juhara\CacheMiddleware\CacheMiddleware;

$app = new App($settings);
...
$app->add(CacheMiddleware::class);

Create Proper Configuration

If using Juhara\ZzzCache\Storages\File as storage, then you need to make sure that directory of cache is writeable by web server.

Example

See example application to understand how to use CacheMiddleware.

Contributing

Just create PR if you want to improve it.

Thank you.