Filesystem PSR-6 cache pool

This package provides PSR-6 and PSR-16 cache implementations backed by Flysystem. It supports Flysystem 2.x and 3.x.

Installation

composer require cache/filesystem-adapter:^2.0

Usage

use Cache\Adapter\Filesystem\FilesystemCachePool;
use League\Flysystem\Filesystem;
use League\Flysystem\Local\LocalFilesystemAdapter;

$filesystem = new Filesystem(new LocalFilesystemAdapter(__DIR__.'/storage'));
$pool = new FilesystemCachePool($filesystem);

The pool stores entries in the cache directory by default. Pass another directory to the constructor when needed:

$pool = new FilesystemCachePool($filesystem, 'path/to/cache');

Use the accessors when an extending app needs to inspect or replace the Flysystem instance or cache directory:

$pool->setFolder('tenant/cache');
$pool->setFilesystem($replacementFilesystem);

$folder = $pool->getFolder();
$filesystem = $pool->getFilesystem();

setFolder() normalizes forward and backward slashes. It removes empty and current-directory segments such as ..

It rejects folders that resolve to the Flysystem root or contain a parent-directory segment such as cache/... The constructor applies the same checks to its folder argument.

setFilesystem() creates the current cache directory on the replacement filesystem.

Contributing

Send pull requests to the main repository. Report issues on the GitHub issue tracker.