Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/php-strict/storable-cache
Storable cache store items more than their lifetime, up to time to save
https://github.com/php-strict/storable-cache
cache cache-storage caching caching-library php php-library php7 store
Last synced: 25 days ago
JSON representation
Storable cache store items more than their lifetime, up to time to save
- Host: GitHub
- URL: https://github.com/php-strict/storable-cache
- Owner: php-strict
- License: gpl-3.0
- Created: 2019-03-30T05:43:42.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-16T05:58:07.000Z (about 5 years ago)
- Last Synced: 2024-05-04T18:42:39.742Z (8 months ago)
- Topics: cache, cache-storage, caching, caching-library, php, php-library, php7, store
- Language: PHP
- Size: 59.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Storable Cache
[![Software License][ico-license]](LICENSE.txt)
[![Build Status][ico-travis]][link-travis]
[![codecov][ico-codecov]][link-codecov]
[![Codacy Badge][ico-codacy]][link-codacy]
Storable cache store items more than their lifetime, up to time to save,
and allow use stored items after expiration, in cases, for example, of db overload or errors.
Supported storages:
* arrays (not real storage, only for testing),
* files,
* memcached,
* redis,
* SQLite,
* MySQL (uses main db connection from app).
## Requirements
* PHP >= 7.2
* [php-strict/config](https://github.com/php-strict/config)
## Install
Install with [Composer](http://getcomposer.org):
```bash
composer require php-strict/storable-cache
```
## Usage
Basic usage:
```php
use PhpStrict\Config\Config;
use PhpStrict\StorableCache\StorableCache;
//instance of application configuration class, extending Config
//must provide cacheType property with correct storable cache type
//see PhpStrict\StorableCache\StorageTypes class
$config = new AppConfig();
$config->loadFromFile('config.ini');
//instance of StorableCache
$cache = new StorableCache($config);
//part of generating content method
if ($cache->has('contentKey') && !$cache->expired('contentKey')) {
return $cache->get('contentKey');
}
//part of generating content method
//saving generated content: key, value, ttl, tts (time to save)
$cache->set('contentKey', $content, 60, 3600);
```
Usage if content generating main process was failed and it is correct to use expired data:
```php
use PhpStrict\StorableCache\StorableCache;
//part of generating content method
//generating content failed
if ($cache->has('contentKey')) {
return $cache->get('contentKey');
}
throw Exception('Generating content failed');
//part of generating content method
```
## Tests
To execute the test suite, you'll need [Codeception](https://codeception.com/).
```bash
vendor\bin\codecept run
```
[ico-license]: https://img.shields.io/badge/license-GPL-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/php-strict/storable-cache/master.svg?style=flat-square
[link-travis]: https://travis-ci.org/php-strict/storable-cache
[ico-codecov]: https://codecov.io/gh/php-strict/storable-cache/branch/master/graph/badge.svg
[link-codecov]: https://codecov.io/gh/php-strict/storable-cache
[ico-codacy]: https://api.codacy.com/project/badge/Grade/366c3c7dd10641bea76ba5d2dcdfd6b6
[link-codacy]: https://www.codacy.com/app/php-strict/storable-cache?utm_source=github.com&utm_medium=referral&utm_content=php-strict/storable-cache&utm_campaign=Badge_Grade