realpage/simple-cache

Simple caching based on the proposed PSR-16

simple-cache

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Simple implementation of the proposed psr-16 simplecache standard. It is recommended that you familiarize yourself with the proposal when using this package., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require jlaswell/simple-cache, <sub>(*4)</sub>

## Usage

Single values
``` php
$cache = new Jlaswell\SimpleCache\ArrayCache();
$cache->set('key1' 'value1');
// Do operations
$key1 = $cache->get('key1');

Multiple values ``` php $cache = new Jlaswell\SimpleCache\ArrayCache(); $cache->setMultiple(['key1' => 'value1', 'key2' => 'value2']); // Do operations $data = $cache->getMultiple(['key1', 'key2']);, <sub>(*5)</sub>

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed
recently.

## Testing

Tests for simple-cache are designed to be run against running instances of each
of the available drivers. This means that we utilize Docker to run instances of
each driver such as redis during testing. The following will start up all of the
available drivers and run all of the available tests.

``` bash
$ docker-compose up -d
$ composer test

simple-cache centralizes most unit tests into a single trait that is used for each driver's unit test. Each unit test simply implements a buildCache method, uses the CacheInterfaceTestCases trait, and tests will be run for that driver. The ArrayCacheTest is a good example to understand the structure and trait usage., <sub>(*6)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*7)</sub>

Security

If you discover any security related issues, please email john.n.laswell+github@gmail.com instead of using the issue tracker., <sub>(*8)</sub>

Credits

• John Laswell
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*9)</sub>