phapi/cache-redis

This package is abandoned and no longer maintained. No replacement package was suggested.

Cache provider using Redis as backend

1.0.0 2015-07-09 15:23 UTC

This package is not auto-updated.

Last update: 2021-02-05 22:01:10 UTC


README

Build status Code Climate Test Coverage

This Cache Provider uses Redis as backend to store the cached items.

Phapi has one important rule regarding cache: A working cache should **not** be a requirement for the application to work. So if Phapi is unable to connect to the cache backend it wont stop the execution. Instead the configured cache will be replaced with a dummy cache, new NullCache().

Installation

The package is not installed by default by the Phapi framework. Add the package as a dependency in composer to install the package.

$ composer require phapi/cache-redis:1.*

Configuration

Configure the package and add it to the container to enable it.

<?php
$container['cache'] = function ($container) {
    return new \Phapi\Cache\Redis\Redis($servers = [
        [
            'host' => 'localhost',
            'port' => 6379,
        ]
    ]);
};

The Redis cache provider does currently not support clusters.

See the configuration documentation for more information about how to configure the integration with the Phapi Framework.

General cache usage

<?php
// Add something to the cache
$cache->set('test', 'value');

// Read something from the cache
echo $cache->get('test'); // Will echo "value"

// Check if something exists in the cache
$bool = $cache->has('test');

// Remove from cache
$cache->clear('test');

// Flush the cache
$cache->flush();

License

Redis Cache Provider is licensed under the MIT License - see the license.md file for details

Contribute

Contribution, bug fixes etc are always welcome.