MemcacheCache.php

<?php
namespace Luracast\Restler;

/**
 * Class MemcacheCache provides a memcache based cache for Restler
 *
 * @category   Framework
 * @package    Restler
 * @author     Dave Drager <ddrager@gmail.com>
 * @copyright  2014 Luracast
 * @license    http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @link       http://luracast.com/products/restler/
 * @version    3.0.0rc5
 */
class MemcacheCache implements iCache
{
    /**
     * The namespace that all of the cached entries will be stored under.  This allows multiple APIs to run concurrently.
     *
     * @var string
     */
    static public $namespace;
    
    /**
     * @var string the memcache server hostname / IP address. For the memcache 
     * cache method.
     */
    static public $memcacheServer = '127.0.0.1';
    
    /**
     * @var int the memcache server port. For the memcache cache method. 
     */
    static public $memcachePort = 11211;

    
    private $memcache;

    /**
     * @param string $namespace
     */
    function __construct($namespace = 'restler')
    {
        self::$namespace = $namespace;
        if (function_exists('memcache_connect')) {
            $this->memcache = new \Memcache;
            $this->memcache->connect(self::$memcacheServer, self::$memcachePort);
        } else {
            $this->memcacheNotAvailable('Memcache is not available for use as Restler Cache. Please make sure the the memcache php extension is installed.');
        }
    }

    /**
     * store data in the cache
     *
     *
     * @param string $name
     * @param mixed $data
     *
     * @return boolean true if successful
     */
    public function set($name, $data)
    {
        function_exists('memcache_set') || $this->memcacheNotAvailable();

        try {
            return $this->memcache->set(self::$namespace . "-" . $name, $data);
        } catch
        (\Exception $exception) {
            return false;
        }
    }

    private function memcacheNotAvailable($message = 'Memcache is not available.')
    {
        throw new \Exception($message);
    }

    /**
     * retrieve data from the cache
     *
     *
     * @param string $name
     * @param bool $ignoreErrors
     *
     * @throws \Exception
     * @return mixed
     */
    public function get($name, $ignoreErrors = false)
    {
        function_exists('memcache_get') || $this->memcacheNotAvailable();

        try {
            return $this->memcache->get(self::$namespace . "-" . $name);
        } catch (\Exception $exception) {
            if (!$ignoreErrors) {
                throw $exception;
            }
            return null;
        }
    }

    /**
     * delete data from the cache
     *
     *
     * @param string $name
     * @param bool $ignoreErrors
     *
     * @throws \Exception
     * @return boolean true if successful
     */
    public function clear($name, $ignoreErrors = false)
    {
        function_exists('memcache_delete') || $this->memcacheNotAvailable();

        try {
            $this->memcache->delete(self::$namespace . "-" . $name);
        } catch (\Exception $exception) {
            if (!$ignoreErrors) {
                throw $exception;
            }
        }
    }

    /**
     * check if the given name is cached
     *
     *
     * @param string $name
     *
     * @return boolean true if cached
     */
    public function isCached($name)
    {
        function_exists('memcache_get') || $this->memcacheNotAvailable();
        $data = $this->memcache->get(self::$namespace . "-" . $name);
        return !empty($data);
    }

}