validus/cache

Provides cache for your Expressive project.

v1.1 2018-10-09 21:52 UTC

Requires

• php: ^7.1
• psr/cache: ^1.0
• psr/container: ^1.0
• psr/http-server-middleware: ^1.0
• psr/simple-cache: ^1.0
• symfony/cache: ^4.1

Requires (Dev)

• doctrine/dbal: ^2.8
• php-coveralls/php-coveralls: ^2.1
• phpstan/phpstan: ^0.10.3
• phpstan/phpstan-strict-rules: ^0.10.1
• phpunit/phpunit: ^7.0.1

MIT

• zend-expressive
• PSR-11
• symfony-cache
• container-interop-cache

README

Provides caching implementations for zend expressive projects.

PSR-6 and PSR-16 Cache factories for PSR-11 with Zend configuration provider.

Installation

The easiest way to install this package is through composer:

$ composer require validus/cache

Configuration

A complete example configuration can be found in example/full-config.php. Please note that the values in there are the defaults, and don't have to be supplied when you are not changing them. Keep your own configuration as minimal as possible. A minimal configuration can be found in example/simple-config.php

If your application uses the zend-component-installer Composer plugin, your configuration is complete; the shipped Validus\Cache\ConfigProvider registers the cache service.

Accessing the cache adapter

you can access the cache implementation via the container :

use Psr\Cache\CacheItemPoolInterface;
use Psr\SimpleCache\CacheInterface;

// $pool instanceof CacheItemPoolInterface
$pool = $container->get(CacheItemPoolInterface::class);

// $cache instanceof CacheInterface
$cache = $container->get(CacheInterface::class);

Middleware

Validus cache package comes with a CacheResetMiddleware, allowing you to reset the cache pool to its initial status after every request.

you can add the middleware to your config/pipeline.php file like this :

    $app->pipe(\Validus\Cache\Middleware\CacheResetMiddleware::class);

a factory for the middleware is already provided in the config provider so you don't have to worry about that as long as you are using zend-component-installer composer plugin.