Skip to main content

Cache Engine

Sponsor Build Status Opensource ByJG GitHub source GitHub license GitHub release

A powerful, versatile cache implementation providing both PSR-6 and PSR-16 interfaces with support for multiple storage drivers.

Key Features

  • PSR-16 Simple Cache interface - Simple, straightforward caching API
  • PSR-6 Cache Pool interface - More verbose caching with fine-grained control
  • Multiple storage backends - Choose from memory, file system, Redis, Memcached and more
  • Atomic operations - Support for increment, decrement and add operations in compatible engines
  • Garbage collection - Automatic cleanup of expired items
  • PSR-11 container support - Retrieve cache keys via dependency container
  • Logging capabilities - PSR-3 compatible logging of cache operations

Quick Start

composer require "byjg/cache-engine"
// PSR-16 Simple Cache
$cache = new \ByJG\Cache\Psr16\FileSystemCacheEngine();
$cache->set('key', 'value', 3600); // Cache for 1 hour
$value = $cache->get('key');

// PSR-6 Cache Pool
$pool = \ByJG\Cache\Factory::createFilePool();
$item = $pool->getItem('key');
if (!$item->isHit()) {
$item->set('value');
$item->expiresAfter(3600);
$pool->save($item);
}
$value = $item->get();

Documentation

Getting Started

Available Cache Engines

EngineDescription
NoCacheEngineNo-op engine for disabling cache without code changes
ArrayCacheEngineIn-memory array cache (non-persistent between requests)
FileSystemCacheEngineFile system based caching
MemcachedEngineMemcached distributed caching
RedisCacheEngineRedis-based caching
SessionCacheEnginePHP session-based caching
TmpfsCacheEngineTmpfs-based caching
ShmopCacheEngineShared memory caching (deprecated)
KeyValueCacheEngineS3-Like or CloudflareKV storage (separate package)

Advanced Features

Running Unit Tests

vendor/bin/phpunit --stderr

Note: The --stderr parameter is required for SessionCacheEngine tests to run properly.

Dependencies


Open source ByJG