[V6˖] Cache Conditional

Sometimes you may need to use a lot of conditional statement based on a cache entry. This operation is often the same one: Checking if the cache entry exists, if it does then take the value from cache, otherwise do the nasty stuff and put it on the cache.

As of the V6 an helper is now available to make those operations easier:

⚠️ V9 USERS, THIS DOCUMENTATION is outdated ⚠️
As of the V9 the class has changed its name:
The class\Phpfastcache\Helper\CacheConditionalHelper is now deprecated , use \Phpfastcache\CacheContract instead

See the full documentation of Cache Contract here.

<?php

/**
 * @author Khoa Bui (khoaofgod)  <[email protected]> http://www.phpfastcache.com
 * @author Georges.L (Geolim4)  <[email protected]>
 */

use phpFastCache\CacheManager;
use phpFastCache\Helper\CacheConditionalHelper as CacheConditional;
use phpFastCache\Helper\TestHelper;
use Psr\Cache\CacheItemPoolInterface;

chdir(__DIR__);
require_once __DIR__ . '/../src/autoload.php';
$testHelper = new TestHelper('Cache Promise');
$defaultDriver = (!empty($argv[ 1 ]) ? ucfirst($argv[ 1 ]) : 'Files');
$cacheInstance = CacheManager::getInstance($defaultDriver, []);
$cacheKey = 'cacheKey';
$RandomCacheValue = str_shuffle(uniqid('pfc', true));


/**
 * Missing cache item test
 */
$cacheValue = (new CacheConditional($cacheInstance))->get($cacheKey, function() use ($cacheKey, $testHelper, $RandomCacheValue){

    /**
     * Here's your database/webservice/etc stuff
     */

    return $RandomCacheValue . '-1337';
});

if($cacheValue === $RandomCacheValue . '-1337'){
    $testHelper->printPassText(sprintf('The cache promise successfully returned expected value "%s".', $cacheValue));
}else{
    $testHelper->printFailText(sprintf('The cache promise returned an unexpected value "%s".', $cacheValue));
}

⚠️ Until the V7 the cache conditional does not allow you to set a custom expiration time. It's relying to the default cache configuration defaultTtl. See the drivers options page for more information. As of the V7 there's a third argument available to CacheConditional::get to pass an optional Int|\DateInterval parameter:

<?php

/**
 * @author Khoa Bui (khoaofgod)  <[email protected]> http://www.phpfastcache.com
 * @author Georges.L (Geolim4)  <[email protected]>
 */

use phpFastCache\CacheManager;
use phpFastCache\Helper\CacheConditionalHelper as CacheConditional;
use phpFastCache\Helper\TestHelper;
use Psr\Cache\CacheItemPoolInterface;

chdir(__DIR__);
require_once __DIR__ . '/../src/autoload.php';
$testHelper = new TestHelper('Cache Promise');
$defaultDriver = (!empty($argv[ 1 ]) ? ucfirst($argv[ 1 ]) : 'Files');
$cacheInstance = CacheManager::getInstance($defaultDriver, []);
$cacheKey = 'cacheKey';
$RandomCacheValue = str_shuffle(uniqid('pfc', true));
$customTtl = 60;

$cacheValue = (new CacheConditional($cacheInstance))->get($cacheKey, function () use ($RandomCacheValue) {

    /**
     * Here's your database/webservice/etc stuff
     */

    return $RandomCacheValue . '-1337';
}, $customTtl);

🆕 As of the v8.0.6 the callback can receive the $cacheItem as a first parameter:

$cacheValue = (new CacheConditional($cacheInstance))->get($cacheKey, function (CacheItemInterface $cacheItem) use ($RandomCacheValue) {

    /**
     * Here's your database/webservice/etc stuff
     */

    return $RandomCacheValue . '-1337';
}, $customTtl);