46 lines
2.0 KiB
Markdown
46 lines
2.0 KiB
Markdown
# Filesystem PSR-6 Cache pool
|
|
[](https://gitter.im/php-cache/cache?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
|
[](https://packagist.org/packages/cache/filesystem-adapter)
|
|
[](https://codecov.io/github/php-cache/filesystem-adapter?branch=master)
|
|
[](https://packagist.org/packages/cache/filesystem-adapter)
|
|
[](https://packagist.org/packages/cache/filesystem-adapter)
|
|
[](LICENSE)
|
|
|
|
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](http://www.php-cache.com).
|
|
|
|
This implementation is using the excellent [Flysystem](http://flysystem.thephpleague.com/).
|
|
|
|
### Install
|
|
|
|
```bash
|
|
composer require cache/filesystem-adapter
|
|
```
|
|
|
|
### Use
|
|
|
|
To create an instance of `FilesystemCachePool` you need to configure a `Filesystem` and its adapter.
|
|
|
|
```php
|
|
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:
|
|
|
|
```php
|
|
$pool = new FilesystemCachePool($filesystem);
|
|
$pool->setFolder('path/to/cache');
|
|
```
|
|
|
|
### Contribute
|
|
|
|
Contributions are very welcome! Send a pull request to the [main repository](https://github.com/php-cache/cache) or
|
|
report any issues you find on the [issue tracker](http://issues.php-cache.com).
|