thegallagher/wordpress-psr-cache

dev-master 2017-05-27 07:40 UTC

Requires

• psr/cache: ^1.0
• psr/simple-cache: ^1.0

Requires (Dev)

• johnpbloch/wordpress-core: ^4.7

MIT

• David Gallagher

README

This library should be considered alpha and could change at any time. It is recommended that you specify a commit when using composer.

Installation

composer require thegallagher/wordpress-psr-cache:dev-master@dev

Usage Examples

<?php
// Include composer autoloader
require 'vendor/autoload.php';

// PSR-6
use TheGallagher\WordPressPsrCache\CacheItemPool;

$cacheKey = 'the_cache_item_key';
$cacheTtl = 600;
$cacheItemPool = new CacheItemPool();
$cacheItem = $cacheItemPool->getItem($cacheKey);
if (!$cacheItem->isHit()) {
    $value = SomeClass::someLongRunningMethod();
    $cacheItem->set($value);
    $cacheItem->expiresAfter($cacheTtl);
}
echo $cacheItem->get();

// PSR-16
use TheGallagher\WordPressPsrCache\SimpleCache;

$cacheKey = 'the_cache_item_key';
$cacheTtl = 600;
$cache = new SimpleCache();
$value = $cache->get($cacheKey);
if ($value === null) {
    $value = SomeClass::someLongRunningMethod();
    $cache->set($cacheKey, $value, $cacheTtl);
}
echo $value;
?>

Notes

• Stored values are effectively serialized twice, because the Transient API has no way to tell the difference between storing false and a cache miss.
• CacheItemPool::clear() always fails because the Transient API doesn't allow all values in transients to be cleared. This also applies to SimpleCache::clear() by default, since it proxies CacheItemPool.

License

The library is open-sourced software licensed under the MIT license.