jgivoni/flysystem-cache-adapter

A PSR-6 compliant adapter decorator for Flysystem v3 that caches file metadata to improve performance.

3.2.3 2024-02-19 12:11 UTC

Requires

• php: ^8.1
• league/flysystem: ^3.0
• psr/cache: ^2.0|^3.0

Requires (Dev)

• ext-xdebug: *
• ext-zend-opcache: *
• league/flysystem-adapter-test-utilities: ^3.15
• league/flysystem-aws-s3-v3: ^3.15
• league/flysystem-memory: ^3.15
• mockery/mockery: ^1.6
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.3
• symfony/cache: ^6.3|^7.0

Suggests

• symfony/cache: Ready to use adapters for the most common caching backends

MIT

• Jakob Givoni

• performance
• metadata
• filesystem
• cache
• adapter
• decorator
• Flysystem
• psr-6

README

Changelog highlights

• 3.2.2
  • Purge cache on unsuccessful operations
• 3.1.2
  • Bugfix when retrieving metadata on file which is a cached folder
• 3.1
  • Support for PHP 8.3

Overwiew

This is the PSR-6 compliant cache adapter for Flysystem v3 you're looking for! The objective is to transparently cache file metadata and thereby improve performance when looking up whether a file exists, checking it's size or modification date etc. It can be easily configured to work with in-memory cache, Redis, Memcached, Doctrine or the filesystem or any of the other adapters available from Symfony.

This library is not a direct fork of any other repository but written from scratch by me. I aim to keep it maintained, but I already consider it mature and there are no plans to add any new features.

Why this library?

It supports Flysystem v3 and is currently maintained, which makes it superior to these other alternatives that I was able to find.

• league/flysystem-cached-adapter (only supports Flysystem v1 which is no longer maintained)
• lustmored/flysystem-v2-simple-cache-adapter (doesn't appear to be maintained since January 2022)

In case you're wondering, the first version is called version 3 to match the Flysystem version it corresponds to.

Installation

composer require jgivoni/flysystem-cache-adapter

Example usage

$cache = new \Symfony\Component\Cache\Adapter\RedisAdapter(...);

$filesystemAdapter = new \League\Flysystem\AwsS3V3\AwsS3V3Adapter(...);

$cachedFilesystemAdapter = new \jgivoni\Flysystem\Cache\CacheAdapter($filesystemAdapter, $cache);