Maslosoft Cache API

Namespaces

• Maslosoft
  • Cache
    • Adapters
    • Helpers
    • Interfaces

Classes

• Cache

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 

<?php

/**
 * This software package is licensed under New BSD license.
 *
 * @package maslosoft/cache
 * @licence New BSD
 *
 * @copyright Copyright (c) Peter Maselkowski <pmaselkowski@gmail.com>
 *
 */

namespace Maslosoft\Cache;

use Maslosoft\Cache\Adapters\Apc;
use Maslosoft\Cache\Adapters\Memcached;
use Maslosoft\Cache\Adapters\StaticVar;
use Maslosoft\Cache\Helpers\AdapterFactory;
use Maslosoft\Cache\Interfaces\CacheAdapterInterface;
use Maslosoft\Cache\Interfaces\CacheInterface;
use Maslosoft\EmbeDi\EmbeDi;

/**
 * Cache
 *
 * @author Piotr Maselkowski <pmaselkowski at gmail.com>
 */
class Cache implements CacheInterface
{

    const Minute = 60;
    const Hour = 3600;
    const Day = 86400;
    const Week = 604800;

    /**
     * Assumed 30 days
     */
    const Month = 18144000;

    /**
     * Assumed 91 days
     */
    const Quarter = 7862400;
    const Year = 31536000;
    const DefaultCacheId = 'cache';

    /**
     * Adapters configuration
     * @var mixed[]
     */
    public $adapters = [
        Memcached::class => true,
        Apc::class => true,
        StaticVar::class => true,
    ];

    /**
     * Default cache timeout
     * @var int
     */
    public $timeout = 600;

    /**
     * Namespace for cache keys. This is to allow multi-tenant applications.
     * @var string
     */
    public $keyspace = '';

    /**
     *
     * @var CacheInterface
     */
    private $_adapter = null;

    /**
     *
     * @var EmbeDi
     */
    private $_di = null;

    /**
     * Instances of cache
     * @var Cache[]
     */
    private static $caches = [];

    public function __construct($instanceId = 'cache')
    {
        $this->_di = new EmbeDi($instanceId);
        $this->_di->configure($this);
    }

    /**
     * Get flyweight instance of Cache component.
     * Only one instance will be created for each `$cacheId`.
     *
     * @new
     * @param string $cacheId
     * @return Cache
     */
    public static function fly($cacheId = self::DefaultCacheId)
    {
        if (empty($cacheId))
        {
            $cacheId = self::DefaultCacheId;
        }
        if (empty(self::$caches[$cacheId]))
        {
            self::$caches[$cacheId] = new static($cacheId);
        }
        return self::$caches[$cacheId];
    }

    public function init()
    {
        $this->_di->store($this);
    }

    /**
     * Get cached object.
     *
     * Optionally if fail, call callback and store it's return value.
     * In this case this will also return callback value.
     *
     * When using with callback optionally `$timeout` can be specified.
     *
     * @param string $key
     * @param callback $callback
     * @param int $timeout
     * @return mixed
     */
    public function get($key, $callback = null, $timeout = null)
    {
        $data = $this->getAdapter()->get($this->keyspace . $key);
        if (null === $callback)
        {
            return $data;
        }
        if (empty($data))
        {
            $data = call_user_func($callback);
            $this->set($key, $data, $timeout);
        }
        return $data;
    }

    public function has($key)
    {
        return $this->getAdapter()->has($this->keyspace . $key);
    }

    public function set($key, $data, $timeout = null)
    {
        if (null === $timeout)
        {
            $timeout = $this->timeout;
        }
        return $this->getAdapter()->set($this->keyspace . $key, $data, $timeout);
    }

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

    /**
     * Alias to clear
     */
    public function flush()
    {
        $this->clear();
    }

    public function remove($key)
    {
        return $this->getAdapter()->remove($this->keyspace . $key);
    }

    /**
     * Get cache adapter
     * @return CacheAdapterInterface
     */
    private function getAdapter()
    {
        if (null === $this->_adapter)
        {
            $this->_adapter = AdapterFactory::create($this->adapters, $this);
        }
        return $this->_adapter;
    }

}