joomla/cache

Joomla Cache Package

The Cache Package

, _(*1)

This cache package is based on a version of the now accepted PSR-6 as it was in 2013., _(*2)

Deprecated

The joomla/cache package has been deprecated with no further updates planned., _(*3)

Options and General Usage

Following option as available across a cache storage types:, _(*4)

• ttl - Time to live.

use Joomla\Cache;

$options = array(
    'ttl' => 900,
);

$cache = new Cache\Runtime($options);

// Set a value in the cache.
$cache->set('key', 'value');

// Get the value back.
$value = $cache->get('key')->getValue();

// Remove the item from the cache.
$cache->remove('key');

// Clear all the items from the cache.
$cache->clear();

// Get multiple values from the cache at once.
$values = $cache->getMultiple(array('key1', 'key2'));

// Set multiple values from the cache at once.
$values = $cache->setMultiple(array('key1' => 'value1', 'key2' => 'value2'));

// Remove multiple values from the cache at once.
$values = $cache->removeMultiple(array('key1', 'key2'));

Cache Storage Types

The following storage types are supported., _(*5)

Apc

use Joomla\Cache;

$cache = new Cache\Apc;

File

The File cache allows the following additional options:, _(*6)

• file.path - the path where the cache files are to be stored.
• file.locking

use Joomla\Cache;

$options = array(
    'file.path' => __DIR__ . '/cache',
);

$cache = new Cache\File($options);

Memcached

use Joomla\Cache;

$cache = new Cache\Memcached;

None

use Joomla\Cache;

$cache = new Cache\None;

Runtime

use Joomla\Cache;

$cache = new Cache\Runtime;

Wincache

use Joomla\Cache;

$cache = new Cache\Wincache;

XCache

use Joomla\Cache;

$cache = new Cache\XCache;

Test Mocking

The Cache package provide a PHPUnit helper to mock a Cache\Cache object or an Cache\Item object. You can include your own optional overrides in the test class for the following methods:, _(*7)

• Cache\Cache::get: Add a method called mockCacheGet to your test class. If omitted, the helper will return a default mock for the Cache\Item class.
• Cache\Item::getValue: Add a method called mockCacheItemGetValue to your test class. If omitted, the mock Cache\Item will return "value" when this method is called.
• Cache\Item::isHit: Add a method called mockCacheItemIsHit to your test class. If omitted, the mock Cache\Item will return false when this method is called.

use Joomla\Cache\Tests\Mocker as CacheMocker;

class FactoryTest extends \PHPUnit_Framework_TestCase
{
    private $instance;

    //
    // The following mocking methods are optional.
    //

    /**
     * Callback to mock the Cache\Item::getValue method.
     *
     * @return  string
     */
    public function mockCacheItemGetValue()
    {
        // This is the default handling.
        // You can override this method to provide a custom return value.
        return 'value';
    }

    /**
     * Callback to mock the Cache\Item::isHit method.
     *
     * @return  boolean
     */
    public function mockCacheItemIsHit()
    {
        // This is the default handling.
        // You can override this method to provide a custom return value.
        return false;
    }

    /**
     * Callback to mock the Cache\Cache::get method.
     *
     * @param   string  $text  The input text.
     *
     * @return  string
     */
    public function mockCacheGet($key)
    {
        // This is the default handling.
        // You can override this method to provide a custom return value.
        return $this->createMockItem();
    }

    protected function setUp()
    {
        parent::setUp();

        $mocker = new CacheMocker($this);

        $this->instance = new SomeClass($mocker->createMockCache());
    }
}

Installation via Composer

Add "joomla/cache": "~1.0" to the require block in your composer.json and then run composer install., _(*8)

{
    "require": {
        "joomla/cache": "~1.0"
    }
}

Alternatively, you can simply run the following from the command line:, _(*9)

composer require joomla/cache "~1.0"

If you want to include the test sources, use, _(*10)

composer require --prefer-source joomla/cache "~1.0"