https://github.com/publishing-kit/cache
Cache wrapper for the PublishingKit project
https://github.com/publishing-kit/cache
cache php php7 psr6 wrapper
Last synced: 6 months ago
JSON representation
Cache wrapper for the PublishingKit project
- Host: GitHub
- URL: https://github.com/publishing-kit/cache
- Owner: publishing-kit
- License: mit
- Created: 2019-12-02T21:32:46.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-09T10:00:12.000Z (over 4 years ago)
- Last Synced: 2025-03-14T20:07:31.902Z (7 months ago)
- Topics: cache, php, php7, psr6, wrapper
- Language: PHP
- Homepage: https://publishing-kit.github.io/
- Size: 91.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# cache
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-travis]][link-travis]
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]
PublishingKit/Cache is a wrapper around a PSR6-compatible caching library to make it more convenient to work with.
In addition, it also provides factory classes for creating instances of the following caches:
* `tedivm/stash`
* `symfony/cache`
* `doctrine/cache`, via the Doctrine bridge in PHP-Cache
However, the factory classes do not support every driver. If your driver of choice is not supported, feel free to submit a pull request for this.
In theory it should also be easy to add support for other PSR6-compatible caches. Again, if you want to see factory classes added for those caches, please submit a pull request.
## Install
Via Composer
``` bash
$ composer require publishing-kit/cache
```
## Usage
The wrapper can be instantiated by passing in any cache object that implements PSR6:
``` php
$wrapper = new PublishingKit\Cache\Services\Cache\Psr6Cache($cache);
```
The factory classes accept an array describing the cache in question. Here we create a Stash instance using Redis:
```php
$factory = new PublishingKit\Cache\Factories\StashCacheFactory();
$cache = $factory->make([
'driver' => 'redis',
'servers' => [[
'127.0.0.1',
'6379'
]]
]);
```
And here we do the same for Symfony Cache:
```php
$factory = new SymfonyCacheFactory();
$cache = $factory->make([
'driver' => 'redis',
'server' => 'redis://127.0.0.1:6379',
]);
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Testing
``` bash
$ composer test
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
## Security
If you discover any security related issues, please email 450801+matthewbdaly@users.noreply.github.com instead of using the issue tracker.
## Credits
- [Matthew Daly][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/publishing-kit/cache.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/publishing-kit/cache/master.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/publishing-kit/cache.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/publishing-kit/cache.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/publishing-kit/cache.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/publishing-kit/cache
[link-travis]: https://travis-ci.org/publishing-kit/cache
[link-scrutinizer]: https://scrutinizer-ci.com/g/publishing-kit/cache/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/publishing-kit/cache
[link-downloads]: https://packagist.org/packages/publishing-kit/cache
[link-author]: https://github.com/matthewbdaly
[link-contributors]: ../../contributors