agileplant/filesystem-adapter

A PSR-6 cache implementation using filesystem. This implementation supports tags

v1.0.0 2023-10-18 16:28 UTC

Requires

• php: >=7.4
• cache/adapter-common: ^1.0
• league/flysystem: ^3.0
• psr/cache: ^1.0 || ^2.0
• psr/simple-cache: ^1.0

Requires (Dev)

• cache/integration-tests: ^0.17
• phpunit/phpunit: ^7.5.20 || ^9.5.10

Provides

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

MIT

• Aaron Scherer
• Tobias Nyholm

• filesystem
• cache
• tag
• psr-6

README

This is a PSR-6 cache implementation using Filesystem. It is a part of the PHP Cache organisation. To read about features like tagging and hierarchy support please read the shared documentation at www.php-cache.com.

This implementation is using the excellent Flysystem.

Install

composer require cache/filesystem-adapter

Use

To create an instance of FilesystemCachePool you need to configure a Filesystem and its adapter.

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

$filesystemAdapter = new Local(__DIR__.'/');
$filesystem        = new Filesystem($filesystemAdapter);

$pool = new FilesystemCachePool($filesystem);

You can change the folder the cache pool will write to through the setFolder setter:

$pool = new FilesystemCachePool($filesystem);
$pool->setFolder('path/to/cache');

Contribute

Contributions are very welcome! Send a pull request to the main repository or report any issues you find on the issue tracker.