Access.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/

namespace Xoops\Core\Cache;

use Stash\Pool;
use Stash\Invalidation;
use Stash\Interfaces\PoolInterface;

class Access
{
    protected $pool = null;

    public function __construct(PoolInterface $pool)
    {
        $this->pool = $pool;
    }

    public function write($key, $value, $ttl = null)
    {
        $item = $this->pool->getItem($key);
        return $item->set($value, $ttl);
    }

    public function read($key)
    {
        $item = $this->pool->getItem($key);
        $value = $item->get(Invalidation::NONE);
        return ($item->isMiss()) ? false : $value;
    }

    public function delete($key)
    {
        $item = $this->pool->getItem($key);
        return $item->clear();
    }

    public function cacheRead($cacheKey, $regenFunction, $ttl = null, $args = null)
    {
        if (is_null($args)) {
            $varArgs = array();
        } else {
            $varArgs = func_get_args();
            array_shift($varArgs); // pull off $key
            array_shift($varArgs); // pull off $regenFunction
            array_shift($varArgs); // pull off $ttl
        }

        $item = $this->pool->getItem($cacheKey);

        // Get the data from cache using the Stash\Invalidation::PRECOMPUTE technique
        // for dealing with stampedes
        $cachedContent = $item->get(Invalidation::PRECOMPUTE);

        // Check to see if the cache missed, which could mean that it either didn't exist or was stale.
        if ($item->isMiss()) {
            // Mark this instance as the one regenerating the cache.
            $item->lock();

            // Run the relatively expensive code.
            $cachedContent = call_user_func_array($regenFunction, $varArgs);

            // save result
            $item->set($cachedContent, $ttl);
        }

        return $cachedContent;
    }

    public function garbageCollect()
    {
        return $this->pool->purge();
    }

    public function clear()
    {
        return $this->pool->flush();
    }

    public function pool()
    {
        return $this->pool;
    }
}