soupmix/cache

Provides framework agnostic implementation of PSR-16 Simple Cache Interface

1.1 2022-12-24 03:46 UTC

Requires

• php: ^8.0
• psr/simple-cache: ^2.0

Requires (Dev)

• doctrine/coding-standard: ^11.0
• php-coveralls/php-coveralls: ^2.4
• phpunit/phpcov: ^8.2
• phpunit/phpunit: ^9.5

Suggests

• ext-apcu: If you use Apcu, you need this extension
• ext-memcached: If you use Memcahced, you need extension
• ext-redis: If you use PhpRedis, you need this extension

Provides

• psr/simple-cache-implementation: ^1.0.1

MIT

• Mehmet Korkmaz

• redis
• cache
• array
• memcached
• adapters
• simplecache
• apcu

README

Soupmix Cache provides framework-agnostic implementation of PSR-16 Simple Cache Interface.

1. Install and Connect to Service

It's recommended that you use Composer to install Soupmix Cache Adaptors.

Installation

$ composer require soupmix/cache

1.1 Redis

Connect to Redis (single instance) service

require_once '/path/to/composer/vendor/autoload.php';

$rConfig = ['host'=> "127.0.0.1"];
$handler = new Redis();
$handler->connect(
    $rConfig['host']
);

$cache = new Soupmix\Cache\RedisCache($handler);

1.2 Memcached

Connect to Memcached service

require_once '/path/to/composer/vendor/autoload.php';

$config = [
    'bucket' => 'test',
    'hosts'   => ['127.0.0.1'],
;
$handler = new Memcached($config['bucket']);
$handler->setOption(Memcached::OPT_LIBKETAMA_COMPATIBLE, true);
$handler->setOption(Memcached::OPT_BINARY_PROTOCOL, true);
if (!count($handler->getServerList())) {
    $hosts = [];
    foreach ($config['hosts'] as $host) {
        $hosts[] = [$host, 11211];
    }
    $handler->addServers($hosts);
}

$cache = new Soupmix\Cache\MemcachedCache($handler);

1.3 APCu

Usage

require_once '/path/to/composer/vendor/autoload.php';

$cache = new Soupmix\Cache\APCUCache();

1.4 PHP Array

Usage

require_once '/path/to/composer/vendor/autoload.php';

$cache = new Soupmix\Cache\ArrayCache();

2. Persist data in the cache, uniquely referenced by a key with an optional expiration TTL time.

$cache->set($key, $value, $ttl);

@param string $key: The key of the item to store

@param mixed $value: The value of the item to store

@param null|integer|DateInterval $ttl: Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that. Predefined DataIntervals: TTL_MINUTE, TTL_HOUR, TTL_DAY.

@return bool True on success and false on failure

$cache->set('my_key, 'my_value', TTL_DAY);

// returns bool(true)

3. Determine whether an item is present in the cache.

$cache->has($key);

@param string $key: The unique cache key of the item to delete

@return bool True on success and false on failure

$cache->has('my_key');

// returns bool(true)

4. Fetch a value from the cache.

$cache->get($key, default=null);

@param string $key: The unique key of this item in the cache @return mixed The value of the item from the cache, or null in case of cache miss

$cache->get('my_key');

// returns  string(8) "my_value"

5. Delete an item from the cache by its unique key

$cache->delete($key);

@param string $key: The unique cache key of the item to delete

@return bool True on success and false on failure

$cache->delete('my_key');

// returns bool(true)

6. Persisting a set of key => value pairs in the cache, with an optional TTL.

$cache->setMultiple(array $items);

@param array|Traversable $items: An array of key => value pairs for a multiple-set operation.

@param null|integer|DateInterval $ttl: Optional. The amount of seconds from the current time that the item will exist in the cache for. If this is null then the cache backend will fall back to its own default behaviour.

@return bool True on success and false on failure

$items = ['my_key_1'=>'my_value_1', 'my_key_2'=>'my_value_2'];
$cache->setMultiple($items);

// returns bool(true)

7. Obtain multiple cache items by their unique keys.

$cache->getMultiple($keys, $default=null);

@param array|Traversable $keys: A list of keys that can obtained in a single operation.

@return array An array of key => value pairs. Cache keys that do not exist or are stale will have a value of null.

$keys = ['my_key_1', 'my_key_2'];
$cache->getMultiple($keys);
/*
returns array(2) {
          ["my_key_1"]=>
          string(3) "my_value_1"
          ["my_key_2"]=>
          string(3) "my_value_2"
        }
*/

8. Delete multiple cache items in a single operation.

$cache->deleteMultiple($keys);

@param array|Traversable $keys: The array of string-based keys to be deleted

@return bool True on success and false on failure

$keys = ['my_key_1', 'my_key_2'];
$cache->deleteMultiple($keys);
 /*
 returns bool(true)
 */

9. Wipe clean the entire cache's keys (Flush)

@return bool True on success and false on failure

$cache->clear();
// returns bool(true)