PHP Cache provides PSR-6 and PSR-16 cache adapters, decorators, and integration tools. This repository contains the packages in the PHP Cache organization.
Version 3 requires PHP 8.2 or later and psr/cache 3.x. Packages that implement PSR-16 support psr/simple-cache 2.x and 3.x.
Some adapters also need a PHP extension or client library. Composer lists those requirements for each split package.
Install the package for the backend you use:
composer require cache/redis-adapter:^3.0
You can install every adapter and library through the aggregate package:
composer require cache/cache:^3.0
See the shared documentation for adapter features and examples.
The Redis and Predis adapters now store tag indexes as expiry-aware sorted sets under a reserved key prefix. Version 2 uses Redis sets under different keys.
All concrete adapters now store a generation snapshot with each tagged item. They also store a generation marker for each tag. The common adapters use portable SHA-256-based metadata keys. The item payload and marker make stale entries miss after invalidation.
Filesystem Adapter 3 hashes keys into shard directories instead of using raw cache keys as filenames.
Public cache keys that start with tag! or tagv! are reserved for tag metadata in cache/adapter-common 3.
Stop or drain all workers, clear each shared cache, and then deploy version 3. Follow the same sequence before a rollback. Do not run version 2 and 3 workers against the same cache.
Version 2 removes the APC adapter. Use cache/apcu-adapter instead.
APCu entries now use native arrays. Redis and Predis tag indexes now use sets instead of lists. Older workers cannot safely share these stores with version 2 workers.
NamespacedCachePool now encodes namespace bytes outside [A-Za-z0-9_.] and literal lowercase _x sequences. Public keys only encode structural | and ! bytes and literal lowercase _x sequences. Clear affected namespaced caches before an upgrade or rollback when these transformed values are present.
Custom adapters extending AbstractCachePool must add the PHP 8 and PSR-3 method signatures used by version 2. The Filesystem adapter now supports Flysystem 2 and 3, the Illuminate adapter supports Illuminate 11 through 13, and the Predis adapter supports Predis 2 and 3. Flysystem 1 and older client releases are no longer supported.
Use this sequence for an upgrade or rollback:
- Stop or drain every worker that uses the affected cache.
- Clear each affected APCu, Redis, Predis, or namespaced cache store.
- Deploy the target version and restart the workers.
Read CONTRIBUTING.md before opening a pull request. Report cache package issues on the GitHub issue tracker.