README

Dead simple wrapper class for APC and APCu which capable of setting and getting cached data from a callback or a variable in one single line.

Requirements

PHP 5.3 or later
php-apc extension installed

Installation

Install with Composer:

$ composer require benjamindean/one-line-apc

Usage

require 'vendor/autoload.php';
$cache = new OneLineAPC();

By default, this class uses APC. To use APCu just pass it while instantiating the class:

$cache = new OneLineAPC('apcu');

Default TTL is 79200 (22 hours). To change it, call setTtl method:

$cache->setTtl(3600);

OR, specify it individually as a last argument to setCache or cached methods:

$cache->setCache($dataToCache, 'key', 3600);

Cached

The main and the most important method (the reason I created this class) is called cached:

$cache->cached('key', 'functionName');

functionName is the name of some function in your code which returns the data that needs to be cached. Any variable, integer or string will work too. You can also pass function arguments as a third argument here.

In case your function is within some class, pass it as an array of Object and a function name:

$cache->cached('key', array($obj, 'functionName'));

You can find out more about callbacks here.

Examples

Class method

class ReturnData {
    public function fetchData($url) {
        return file_get_contents($url);
    }
}

$obj = new ReturnData();

$apc = new OneLineAPC();
$apc->setTtl(3600);

return $apc->cached('key', array($obj, 'fetchData'), array('http://example.com/'));

Function

function fetchData($url) {
    return file_get_contents($url);
}

$apc = new OneLineAPC();
$apc->setTtl(3600);

return $apc->cached('key', 'fetchData', array('http://example.com/'));

Variable

$something = 'Data to be cached';

$apc = new OneLineAPC();

return $apc->cached('key', $something, false, 3600);

Notes

If apc or apcu is not loaded, this class will generate "Notice", instead of "Fatal Error".

benjamindean / one-line-apc

Maintainers

Details