Webiny\Component\Rest\Response\Cache::purgeResult PHP Method

purgeResult() public static method

Purges the cached result.
public static purgeResult ( RequestBag $requestBag ) : boolean
$requestBag RequestBag
return boolean
    public static function purgeResult(RequestBag $requestBag)
    {
        // check if we have cache in settings
        if (!$requestBag->getApiConfig()->get('Cache', false) || $requestBag->getMethodData()['cache']['ttl'] <= 0) {
            return false;
        }
        $instance = new self($requestBag);
        return $instance->purgeCacheResult();
    }

Usage Example

Example #1
0
 public function testPurgeResult()
 {
     $requestBag = new RequestBag();
     // populate request bag and point the cache key creation to the mocked class
     $requestBag->setApi('CacheTest')->setMethodData(['cache' => ['ttl' => 100]])->setClassInstance(new MockCacheTestApiClass())->setClassData(['cacheKeyInterface' => true]);
     \Webiny\Component\Rest\Response\Cache::saveResult($requestBag, 'my result');
     $result = \Webiny\Component\Rest\Response\Cache::getFromCache($requestBag);
     $this->assertSame('my result', $result);
     \Webiny\Component\Rest\Response\Cache::purgeResult($requestBag);
     $result = \Webiny\Component\Rest\Response\Cache::getFromCache($requestBag);
     $this->assertFalse($result);
 }