344 lines
8.1 KiB
Markdown
Executable File
344 lines
8.1 KiB
Markdown
Executable File
# Cache [<img alt="SensioLabsInsight" src="https://insight.sensiolabs.com/projects/5f139261-1ac1-4559-846a-723e09319a88/small.png" align="right">](https://insight.sensiolabs.com/projects/5f139261-1ac1-4559-846a-723e09319a88)
|
|
|
|
A simple cache library. Implements different adapters that you can use and change
|
|
easily by a manager or similar.
|
|
|
|
|
|
[![Latest version][ico-version]][link-packagist]
|
|
[![Latest version][ico-pre-release]][link-packagist]
|
|
[![Software License][ico-license]][link-license]
|
|
[![Build Status][ico-travis]][link-travis]
|
|
[![Coverage Status][ico-coveralls]][link-coveralls]
|
|
[![Quality Score][ico-code-quality]][link-code-quality]
|
|
[![Sensiolabs Insight][ico-sensiolabs]][link-sensiolabs]
|
|
[![Total Downloads][ico-downloads]][link-downloads]
|
|
[![Today Downloads][ico-today-downloads]][link-downloads]
|
|
[![Gitter][ico-gitter]][link-gitter]
|
|
|
|
## Installation
|
|
|
|
### With Composer
|
|
|
|
It is best installed it through [packagist](http://packagist.org/packages/desarrolla2/cache)
|
|
by including `desarrolla2/cache` in your project composer.json require:
|
|
|
|
``` json
|
|
"require": {
|
|
// ...
|
|
"desarrolla2/cache": "~2.0"
|
|
}
|
|
```
|
|
|
|
### Without Composer
|
|
|
|
You can also download it from [Github] (https://github.com/desarrolla2/Cache),
|
|
but no autoloader is provided so you'll need to register it with your own PSR-0
|
|
compatible autoloader.
|
|
|
|
## Usage
|
|
|
|
|
|
``` php
|
|
<?php
|
|
|
|
use Desarrolla2\Cache\Cache;
|
|
use Desarrolla2\Cache\Adapter\NotCache;
|
|
|
|
$cache = new Cache(new NotCache());
|
|
|
|
$cache->set('key', 'myKeyValue', 3600);
|
|
|
|
// later ...
|
|
|
|
echo $cache->get('key');
|
|
|
|
```
|
|
|
|
## Adapters
|
|
|
|
### Apcu
|
|
|
|
Use it if you will you have APC cache available in your system.
|
|
|
|
``` php
|
|
<?php
|
|
|
|
use Desarrolla2\Cache\Cache;
|
|
use Desarrolla2\Cache\Adapter\Apcu;
|
|
|
|
$adapter = new Apcu();
|
|
$adapter->setOption('ttl', 3600);
|
|
$cache = new Cache($adapter);
|
|
|
|
```
|
|
|
|
### File
|
|
|
|
Use it if you will you have dont have other cache system available in your system
|
|
or if you like to do your code more portable.
|
|
|
|
``` php
|
|
<?php
|
|
|
|
use Desarrolla2\Cache\Cache;
|
|
use Desarrolla2\Cache\Adapter\File;
|
|
|
|
$cacheDir = '/tmp';
|
|
$adapter = new File($cacheDir);
|
|
$adapter->setOption('ttl', 3600);
|
|
$cache = new Cache($adapter);
|
|
|
|
```
|
|
|
|
### Memcache
|
|
|
|
Use it if you will you have mencache available in your system.
|
|
|
|
``` php
|
|
<?php
|
|
|
|
use Desarrolla2\Cache\Cache;
|
|
use Desarrolla2\Cache\Adapter\Memcache;
|
|
|
|
$adapter = new Memcache();
|
|
$cache = new Cache($adapter);
|
|
|
|
```
|
|
|
|
You can config your connection before
|
|
|
|
|
|
``` php
|
|
<?php
|
|
|
|
use Desarrolla2\Cache\Cache;
|
|
use Desarrolla2\Cache\Adapter\Memcache;
|
|
use \Memcache as Backend
|
|
|
|
$backend = new Backend();
|
|
// configure it here
|
|
|
|
$cache = new Cache(new Memcache($backend));
|
|
```
|
|
|
|
### Memcached
|
|
|
|
Is the same like mencache adapter.
|
|
|
|
### Memory
|
|
|
|
This is the fastest cache type, since the elements are stored in memory.
|
|
Cache Memory such is very volatile and is removed when the process terminates.
|
|
Also it is not shared between different processes.
|
|
|
|
Memory cache have a option "limit", that limit the max items in cache.
|
|
|
|
``` php
|
|
<?php
|
|
|
|
use Desarrolla2\Cache\Cache;
|
|
use Desarrolla2\Cache\Adapter\Memory;
|
|
|
|
$adapter = new Memory();
|
|
$adapter->setOption('ttl', 3600);
|
|
$adapter->setOption('limit', 200);
|
|
$cache = new Cache($adapter);
|
|
|
|
```
|
|
|
|
### Mongo
|
|
|
|
Use it to store the cache in a Mongo database. Requires the
|
|
[(legacy) mongo extension](http://php.net/mongo) or the
|
|
[mongodb/mongodb](https://github.com/mongodb/mongo-php-library) library.
|
|
|
|
You may pass either a database or collection object to the constructor. If a
|
|
database object is passed, the `items` collection within that DB is used.
|
|
|
|
``` php
|
|
<?php
|
|
|
|
use Desarrolla2\Cache\Cache;
|
|
use Desarrolla2\Cache\Adapter\Mongo;
|
|
|
|
$client = new MongoClient($dsn);
|
|
$database = $client->selectDatabase($dbname);
|
|
|
|
$adapter = new Mongo($database);
|
|
$adapter->setOption('ttl', 3600);
|
|
$cache = new Cache($adapter);
|
|
|
|
```
|
|
|
|
``` php
|
|
<?php
|
|
|
|
use Desarrolla2\Cache\Cache;
|
|
use Desarrolla2\Cache\Adapter\Mongo;
|
|
|
|
$client = new MongoClient($dsn);
|
|
$database = $client->selectDatabase($dbName);
|
|
$collection = $database->selectCollection($collectionName);
|
|
|
|
$adapter = new Mongo($collection);
|
|
$adapter->setOption('ttl', 3600);
|
|
$cache = new Cache($adapter);
|
|
|
|
```
|
|
|
|
_Note that expired cache items aren't automatically deleted. To keep your
|
|
database clean, you should create a
|
|
[ttl index](https://docs.mongodb.org/manual/core/index-ttl/)._
|
|
|
|
|
|
```
|
|
db.items.createIndex( { "ttl": 1 }, { expireAfterSeconds: 30 } )
|
|
```
|
|
|
|
### Mysqli
|
|
|
|
You need to create Mysql table as follow
|
|
|
|
```mysql
|
|
CREATE TABLE cache (
|
|
k varchar(255) NOT NULL,
|
|
v text NOT NULL,
|
|
t int(10) UNSIGNED NOT NULL
|
|
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
|
|
|
|
ALTER TABLE cache
|
|
ADD PRIMARY KEY (k) USING BTREE;
|
|
```
|
|
|
|
``` php
|
|
<?php
|
|
|
|
use Desarrolla2\Cache\Cache;
|
|
use Desarrolla2\Cache\Adapter\Mysqli;
|
|
|
|
$adapter = new Mysqli();
|
|
$adapter->setOption('ttl', 3600);
|
|
$cache = new Cache($adapter);
|
|
|
|
```
|
|
|
|
|
|
``` php
|
|
<?php
|
|
|
|
use Desarrolla2\Cache\Cache;
|
|
use Desarrolla2\Cache\Adapter\Mysqli;
|
|
use \mysqli as Backend
|
|
|
|
$backend = new Backend();
|
|
// configure it here
|
|
|
|
$cache = new Cache(new Mysqli($backend));
|
|
```
|
|
|
|
### NotCache
|
|
|
|
Use it if you will not implement any cache adapter is an adapter that will serve
|
|
to fool the test environments.
|
|
|
|
### Predis
|
|
|
|
Use it if you will you have redis available in your system.
|
|
|
|
You need to add predis as dependency in your composer file.
|
|
|
|
``` json
|
|
"require": {
|
|
//...
|
|
"predis/predis": "~1.0.0"
|
|
}
|
|
```
|
|
|
|
other version will have compatibility issues.
|
|
|
|
``` php
|
|
<?php
|
|
|
|
use Desarrolla2\Cache\Cache;
|
|
use Desarrolla2\Cache\Adapter\Predis;
|
|
|
|
$adapter = new Predis();
|
|
$cache = new Cache($adapter);
|
|
|
|
```
|
|
|
|
If you need to configure your predis client, you will instantiate it and pass it to constructor.
|
|
|
|
``` php
|
|
<?php
|
|
|
|
use Desarrolla2\Cache\Cache;
|
|
use Desarrolla2\Cache\Adapter\Predis;
|
|
use Predis\Client as Backend
|
|
|
|
$adapter = new Predis(new Backend($options));
|
|
$cache = new Cache($adapter);
|
|
|
|
```
|
|
|
|
## Methods
|
|
|
|
A `Desarrolla2\Cache\Cache` object has the following methods:
|
|
|
|
##### `delete(string $key)`
|
|
Delete a value from the cache
|
|
|
|
##### `get(string $key)`
|
|
Retrieve the value corresponding to a provided key
|
|
|
|
##### `has(string $key)`
|
|
Retrieve the if value corresponding to a provided key exist
|
|
|
|
##### `set(string $key , mixed $value [, int $ttl])`
|
|
Add a value to the cache under a unique key
|
|
|
|
##### `setOption(string $key, string $value)`
|
|
Set option for Adapter
|
|
|
|
##### `clearCache()`
|
|
Clean all expired records from cache
|
|
|
|
##### `dropCache()`
|
|
Clear all cache
|
|
|
|
|
|
## Coming soon
|
|
|
|
This library implements other adapters as soon as possible, feel free to send
|
|
new adapters if you think it appropriate.
|
|
|
|
This can be a list of pending tasks.
|
|
|
|
* Cleaning cache
|
|
* MemcachedAdapter
|
|
* Other Adapters
|
|
|
|
## Contact
|
|
|
|
You can contact with me on [@desarrolla2](https://twitter.com/desarrolla2).
|
|
|
|
[ico-version]: https://img.shields.io/packagist/v/desarrolla2/Cache.svg?style=flat-square
|
|
[ico-pre-release]: https://img.shields.io/packagist/vpre/desarrolla2/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/desarrolla2/Cache/master.svg?style=flat-square
|
|
[ico-coveralls]: https://img.shields.io/coveralls/desarrolla2/Cache/master.svg?style=flat-square
|
|
[ico-code-quality]: https://img.shields.io/scrutinizer/g/desarrolla2/cache.svg?style=flat-square
|
|
[ico-sensiolabs]: https://img.shields.io/sensiolabs/i/5f139261-1ac1-4559-846a-723e09319a88.svg?style=flat-square
|
|
[ico-downloads]: https://img.shields.io/packagist/dt/desarrolla2/cache.svg?style=flat-square
|
|
[ico-today-downloads]: https://img.shields.io/packagist/dd/desarrolla2/cache.svg?style=flat-square
|
|
[ico-gitter]: https://img.shields.io/badge/GITTER-JOIN%20CHAT%20%E2%86%92-brightgreen.svg?style=flat-square
|
|
|
|
[link-packagist]: https://packagist.org/packages/desarrolla2/cache
|
|
[link-license]: http://hassankhan.mit-license.org
|
|
[link-travis]: https://travis-ci.org/desarrolla2/Cache
|
|
[link-coveralls]: https://coveralls.io/github/desarrolla2/Cache
|
|
[link-code-quality]: https://scrutinizer-ci.com/g/desarrolla2/cache
|
|
[link-sensiolabs]: https://insight.sensiolabs.com/projects/5f139261-1ac1-4559-846a-723e09319a88
|
|
[link-downloads]: https://packagist.org/packages/desarrolla2/cache
|
|
[link-gitter]: https://gitter.im/desarrolla2/Cache?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
|