Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openclassrooms/cache
Cache library
https://github.com/openclassrooms/cache
Last synced: 3 days ago
JSON representation
Cache library
- Host: GitHub
- URL: https://github.com/openclassrooms/cache
- Owner: OpenClassrooms
- License: mit
- Created: 2014-04-19T12:40:08.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-08-05T15:05:17.000Z (3 months ago)
- Last Synced: 2024-10-05T19:04:00.932Z (about 1 month ago)
- Language: PHP
- Size: 61.5 KB
- Stars: 0
- Watchers: 27
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cache
[](https://travis-ci.org/OpenClassrooms/Cache)
[](https://insight.sensiolabs.com/projects/cb725585-b433-4a21-96aa-30a0148ecd9f)
[](https://coveralls.io/r/OpenClassrooms/Cache?branch=master)
Cache adds features to Doctrine Cache implementation
- Default lifetime
- Fetch with a namespace
- Save with a namespace
- Cache invalidation through namespace strategy
- CacheProvider Builder
## Installation
The easiest way to install Cache is via [composer](http://getcomposer.org/).
Create the following `composer.json` file and run the `php composer.phar install` command to install it.
```json
{
"require": {
"openclassrooms/cache": "*"
}
}
```
```php
## Usage
### Instantiation
OC Cache needs a Doctrine CacheProvider to be instantiate.
```php
$cacheProvider = new ArrayCache();
$cache = new Cache($cacheProvider);
```
A Cache builder can be used.
```php
// Default builder, build a cache using ArrayCache Provider
$cache = new CacheBuilderImpl()->build();
// Using a CacheProvider
$cache = new CacheBuilderImpl()
->withCacheProvider($redisCache)
->build();
// Optional default lifetime
$cache = new CacheBuilderImpl()
->withCacheProvider($redisCache)
->withDefaultLifetime(300)
->build();
```
### Default lifetime
```php
$cache->setDefaultLifetime(300);
$cache->save($id, $data);
```
### Fetch with namespace
```php
$data = $cache->fetchWithNamespace($id, $namespaceId);
```
### Save with namespace
```php
// Namespace and life time can be null
$data = $cache->saveWithNamespace($id, $data, $namespaceId, $lifeTime);
```
### Cache invalidation
```php
$cache->invalidate($namespaceId);
```
### CacheProvider Builder
The library provides a CacheProvider Builder
```php
// Memcache
$cacheProvider = new CacheProviderBuilderImpl()
->create(CacheProviderType::MEMCACHE)
->withHost('127.0.0.1')
->withPort(11211) // Default 11211
->withTimeout(1) // Default 1
->build();
// Memcached
$cacheProvider = new CacheProviderBuilderImpl()
->create(CacheProviderType::MEMCACHED)
->withHost('127.0.0.1')
->withPort(11211) // Default 11211
->build();
// Redis
$cacheProvider = new CacheProviderBuilderImpl()
->create(CacheProviderType::REDIS)
->withHost('127.0.0.1')
->withPort(6379) // Default 6379
->withTimeout(0.0) // Default 0.0
->build();
// Array
$cacheProvider = new CacheProviderBuilderImpl()
->create(CacheProviderType::ARRAY_CACHE)
->build();
```