Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ihor/cachalot
Caching rethought – cache a lot in a proper way.
https://github.com/ihor/cachalot
apcu cache couchbase memcache php redis xcache
Last synced: 8 days ago
JSON representation
Caching rethought – cache a lot in a proper way.
- Host: GitHub
- URL: https://github.com/ihor/cachalot
- Owner: ihor
- License: mit
- Created: 2013-01-16T13:28:49.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2021-04-21T11:26:02.000Z (over 3 years ago)
- Last Synced: 2024-10-01T10:37:08.721Z (about 1 month ago)
- Topics: apcu, cache, couchbase, memcache, php, redis, xcache
- Language: PHP
- Homepage: http://cachalot.readthedocs.org
- Size: 54.7 KB
- Stars: 25
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Cachalot
========
Cachalot (cache a lot) is an easy to use caching library. It supposed to do the only one thing - return cached callback result.
Installation
------------
Define the following requirement in your composer.json file:
```
"require": {
"ihor/cachalot": "2.3"
}
```
Usage
-----
```php
// With Cachalot cache you can easily cache results of different types of functions
$cache = new \Cachalot\ArrayCache();
// built-in functions
$length = $cache->getCached('strlen', ['hello world']);
// user defined functions
$unique = $cache->getCached('uniqueValues', [[1, 2, 3, 1, 2, 3]]);
// static methods
$result = $cache->getCached(['Calculator', 'subtract'], [1, 2]);
// instance methods
$square = $cache->getCached([new Calculator(), 'square'], [5]);
// anonymous functions
$reason = $cache->getCached($getErrorReason, [], \Cachalot\Cache::ONE_DAY, 'error-reason');
// callable objects
$trimed = $cache->getCached(new Trimmer(), [' hello world ']);
```
Reference
---------
### Cache API
##### getCached($callback, array $args = array(), $expireIn = 0, $suffix = null, $useSuffixAsKey = false)
Returns cached $callback result
```$callback``` is the function (callable) which results we want to be cached
```$args``` are the arguments passed to the ```$callback```
```$expireIn``` sets cache TTL in seconds
```$suffix``` is needed to avoid collisions when callback is an anonymous function
```$useSuffixAsKey``` when true cache suffix will be used as a cache key
```php
$length = $cache->getCached('strlen', ['hello world']);
```
To have possibility to use Cachalot as a regular caching library when needed it contains classic cache methods
##### contains($key)
Returns true if cache contains entry with given key
```php
if ($cache->contains('lastVisit')) {
echo 'This is not the first visit';
}
```
##### get($key)
Returns cached value by key or false if there is no cache entry for the given key
```php
if ($lastVisitDate = $cache->get('lastVisit')) {
echo sprintf('Last visit was at %s', $lastVisitDate);
}
```
##### set($key, $value, $expireIn = 0)
Caches value by key. When ```$expireIn = 0``` the value is cached forever
```php
$cache->set('lastVisit', time());
```
##### delete($key)
Deletes cache entry by key
```php
$cache->delete('lastVisit');
```
##### clear()
Deletes all cache entries
```php
$cache->clear();
```
### Back-ends
##### Cachalot\ApcCache
Stores data in [APC](http://php.net/manual/en/book.apc.php)
```php
$cache = new Cachalot\ApcCache();
```
##### Cachalot\XcacheCache
Stores data in [Xcache](https://xcache.lighttpd.net/)
```php
$cache = new Cachalot\XcacheCache();
```
##### Cachalot\MemcacheCache
Stores data in [Memcached](http://memcached.org) using [Memcache PHP extension](http://php.net/manual/en/book.memcache.php)
```php
$memcache = new \Memcache();
$memcache->connect('unix:///usr/local/var/run/memcached.sock', 0);
$cache = new \Cachalot\MemcacheCache($memcache);
```
##### Cachalot\MemcachedCache
Stores data in [Memcached](http://memcached.org) using [Memcached PHP extension](http://php.net/manual/en/book.memcached.php)
```php
$memcached = new \Memcached();
$memcached->addServer('/usr/local/var/run/memcached.sock', 0);
$cache = new \Cachalot\MemcachedCache($memcached);
```
##### Cachalot\RedisCache
Stores data in [Redis](http://redis.io)
```php
$redis = new \Redis();
$redis->connect('127.0.0.1');
$redis->select(1);
$cache = new \Cachalot\RedisCache($redis);
```
##### Cachalot\CouchbaseCache
Stores data in [Couchbase](http://www.couchbase.com/) using [Couchbase PHP SDK 1.x](http://docs.couchbase.com/couchbase-sdk-php-1.2/index.html)
```php
$couchbase = new \Couchbase('127.0.0.1', '', '', 'default');
$cache = new \Cachalot\CouchbaseCache($couchbase);
```
##### Cachalot\Couchbase2Cache
Stores data in [Couchbase](http://www.couchbase.com/) using [Couchbase PHP SDK 2.x](http://developer.couchbase.com/documentation/server/4.0/sdks/php-2.0/php-intro.html)
```php
$cluster = new \CouchbaseCluster('couchbase://localhost');
$bucket = $cluster->openBucket('default');
$cache = new \Cachalot\Couchbase2Cache($bucket);
```
##### Cachalot\ArrayCache
Stores data in PHP array
```php
$cache = new \Cachalot\ArrayCache();
```
##### Cachalot\BlackholeCache
Never stores any data
```php
$cache = new \Cachalot\BlackholeCache();
```