edwrodrig / file_cache
System for cache images and files for websites
Requires
- php: ^7.4
- ext-imagick: *
- ext-json: *
Requires (Dev)
- edwrodrig/image: ^3.0
- mikey179/vfsstream: ^1.6
- phpunit/phpunit: ^8.5
This package is auto-updated.
Last update: 2024-04-16 01:20:24 UTC
README
System for cache images and files for websites
My use cases
- Store result of image generation through different page generations.
- Salt the path of the files.
- Store different image formats.
- Modular and easy integration with other systems.
- Optimize and cache some assets like images and large file.
- I want to maintain the things as simple as possible
My infrastructure is targeted to Ubuntu 16.04 machines with last php7.2 installed from ppa:ondrej/php. I use some unix commands for some process like cp or ln. I'm sure that there are way to make it compatible with windows but I don't have time to program it and testing, but I'm open for pull requests to make it more compatible.
Documentation
The source code is documented using phpDocumentor style, so it should pop up nicely if you're using IDEs like PhpStorm or similar.
Examples
There is a example page how to use the cache. I have to add some other more clear cases.
Composer
composer require edwrodrig/file_cache
Testing
The test are built using PhpUnit. It generates images and compare the signature with expected ones. Maybe some test fails due metadata of some generated images, but at the moment I haven't any reported issue.
License
MIT license. Use it as you want at your own risk.
About language
I'm not a native english writer, so there may be a lot of grammar and orthographical errors on text, I'm just trying my best. But feel free to correct my language, any contribution is welcome and for me they are a learning instance.