Provides a SimpleCache (PSR-16) decorator for file fetchers
BSD-3-CLAUSE License
Provides simple caching decorators for FileFetcher implementations.
The FileFetcher decorators are constructed via FileFetcher\Cache\Factory
.
$factory->newCachingFetcher()
: Caches file contents via PSR-16 SimpleCache
$factory->newJeroenSimpleCacheFetcher()
: Caches file contents via jeroen/simple-cache
Once you constructed a FileFetcher, fetching a file is easy:
$fileContent = $fileFetcher->fetchFile($fileLocation);
To test your code you can use all the test doubles provided by FileFetcher itself.
To use the FileFetcher Cache library in your project, simply add a dependency on jeroen/file-fetcher-cache
to your project's composer.json
file. Here is a minimal example of a composer.json
file that just defines a dependency on FileFetcher Cache 1.x:
{
"require": {
"jeroen/file-fetcher-cache": "~1.0"
}
}
Start by installing the project dependencies by executing
composer update
You can run the tests by executing
make test
You can run the style checks by executing
make cs
To run all CI checks, execute
make ci
You can also invoke PHPUnit directly to pass it arguments, as follows
vendor/bin/phpunit --filter SomeClassNameOrFilter
Initial release with decorators for PSR-16 SimpleCache and jeroen/simple-cache.