aviat/banker

A caching library implementing PSR-6 (psr/cache) and PSR-16 (psr/simple-cache)

v4.1.2 2023-03-17 02:11 UTC

Requires

• php: >= 8
• ext-json: *
• predis/predis: ^v2.1.2
• psr/cache: ^3.0.0
• psr/log: ^1.1.0 || ^3.0.0
• psr/simple-cache: ^3.0.0

Requires (Dev)

• ext-apcu: *
• ext-memcached: *
• monolog/monolog: ^3.3.1
• phpunit/phpunit: ^10.0.16

Suggests

• ext-apcu: Required for apcu driver
• ext-memcached: Required for Memcached backend
• ext-phpiredis: Improves speed of Redis driver
• monolog/monolog: A good standard logging library

Provides

• psr/cache-implementation: ^3.0.0
• psr/simple-cache-implementation: ^3.0.0

MIT

• Timothy J Warren

• redis
• cache
• memcached
• psr-6
• psr6
• psr16
• psr-16

README

A Caching library implementing the PSR-6 and PSR-16 interfaces for several common cache backends

Cache Backends

• Apcu
• Memcached
• Redis
• Null - no persistence

Basic Usage (SimpleCache/PSR-16)

<?php
// $config is the configuration array
// $logger is an optional psr/log compatible logger
$cache = new Aviat\Banker\Teller($config, $logger);

// Get a value from the cache, returning $defaultValue
// if the value doesn't exist in the cache
$value = $cache->get($key, $defaultValue);

// Save a new value at the specified key
$saved = $cache->set($key, 'newValue');

Basic Usage (Pool/PSR-6)

<?php
// Create the pool
// $config is the configuration array
// $logger is an optional psr/log compatible logger
$pool = new Aviat\Banker\Pool($config, $logger);

// Grab an item from the cache
$item = $pool->getItem('foo');

// Was there a cache hit?
if ( ! $item->isHit())
{
	// ... Generation of value to cache
	$item->set($value);
	$item->save();
}
else
{
	$value = $item->get();
}

Configuration / Connection array

The config array passed to the Pool class constructor determines which server to connect to. Regardless of the backend, the basic structure is like so:

<?php
$config = [
	'driver' => 'null', // null, apcu, redis, memcached
	'connection' => [
		// Optional (For some drivers):
		// driver setup, see below for the structure for each
		// driver
	],
	'options' => [
		// Optional:
		// Set additional driver-specific options, like persistence for
		// Memcached, or a prefix for Redis keys
	]
];

Below are the connection arrays for each backend:

Memcached:

<?php
$config['connection'] = [
	'host' => 'localhost', // hostname or socket
	'port' => 11211,       // Port needs to be 0 if socket
	'persistent' => false, // Use persistent connection
];

Redis: See Predis documentation. An empty array will connect to localhost on port 6379.

Null, Apcu: No connection parameters