weiz 22d166de26 | ||
---|---|---|
.. | ||
doc | ||
src | ||
tests | ||
.coveralls.yml | ||
.formatter.yml | ||
.gitignore | ||
.scrutinizer.yml | ||
.travis.yml | ||
LICENSE | ||
README.md | ||
build.xml | ||
composer.json | ||
phpunit.xml | ||
phpunit.xml.dist |
README.md
Cache
A simple cache library. Implements different adapters that you can use and change easily by a manager or similar.
Installation
With Composer
It is best installed it through packagist
by including desarrolla2/cache
in your project composer.json require:
"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
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
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
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
use Desarrolla2\Cache\Cache;
use Desarrolla2\Cache\Adapter\Memcache;
$adapter = new Memcache();
$cache = new Cache($adapter);
You can config your connection before
<?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
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 or the mongodb/mongodb 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
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
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.
db.items.createIndex( { "ttl": 1 }, { expireAfterSeconds: 30 } )
Mysqli
You need to create Mysql table as follow
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
use Desarrolla2\Cache\Cache;
use Desarrolla2\Cache\Adapter\Mysqli;
$adapter = new Mysqli();
$adapter->setOption('ttl', 3600);
$cache = new Cache($adapter);
<?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.
"require": {
//...
"predis/predis": "~1.0.0"
}
other version will have compatibility issues.
<?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
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.