Classes List

Symfony\Component\Cache\Traits\AbstractTrait

 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 
 195 
 196 
 197 
 198 
 199 
 200 
 201 
 202 
 203 
 204 
 205 
 206 
 207 
 208 
 209 
 210 
 211 
 212 
 213 
 214 
 215 
 216 
 217 
 218 
 219 
 220 
 221 
 222 
 223 
 224 
 225 
 226 
 227 
 228 
 229 
 230 
 231 
 232 
 233 
 234 
 235 
 236 
 237 
 238 
 239 
 240 
 241 
 242 
 243 
 244 
 245 
 246 
 247 
 248 
 249 
 250 
 251 
 252 
 253 
 254 
 255 
 256 
 257 
 258 
 259 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Cache\Traits;

use Psr\Log\LoggerAwareTrait;
use Symfony\Component\Cache\CacheItem;

/** * @author Nicolas Grekas <p@tchwork.com> * * @internal */
trait AbstractTrait
{
    use LoggerAwareTrait;

    private $namespace;
    private $namespaceVersion = '';
    private $versioningIsEnabled = false;
    private $deferred = array();

    /** * @var int|null The maximum length to enforce for identifiers or null when no limit applies */
    protected $maxIdLength;

    /** * Fetches several cache items. * * @param array $ids The cache identifiers to fetch * * @return array|\Traversable The corresponding values found in the cache */
    abstract protected function doFetch(array $ids);

    /** * Confirms if the cache contains specified cache item. * * @param string $id The identifier for which to check existence * * @return bool True if item exists in the cache, false otherwise */
    abstract protected function doHave($id);

    /** * Deletes all items in the pool. * * @param string The prefix used for all identifiers managed by this pool * * @return bool True if the pool was successfully cleared, false otherwise */
    abstract protected function doClear($namespace);

    /** * Removes multiple items from the pool. * * @param array $ids An array of identifiers that should be removed from the pool * * @return bool True if the items were successfully removed, false otherwise */
    abstract protected function doDelete(array $ids);

    /** * Persists several cache items immediately. * * @param array $values The values to cache, indexed by their cache identifier * @param int $lifetime The lifetime of the cached values, 0 for persisting until manual cleaning * * @return array|bool The identifiers that failed to be cached or a boolean stating if caching succeeded or not */
    abstract protected function doSave(array $values$lifetime);

    /** * {@inheritdoc} */
    public function hasItem($key)
    {
        $id = $this->getId($key);

        if (isset($this->deferred[$key])) {
            $this->commit();
        }

        try {
            return $this->doHave($id);
        } catch (\Exception $e) {
            CacheItem::log($this->logger'Failed to check if key "{key}" is cached'array('key' => $key'exception' => $e));

            return false;
        }
    }

    /** * {@inheritdoc} */
    public function clear()
    {
        if ($cleared = $this->versioningIsEnabled) {
            $this->namespaceVersion = 2;
            foreach ($this->doFetch(array('@'.$this->namespace)) as $v) {
                $this->namespaceVersion = 1 + (int) $v;
            }
            $this->namespaceVersion .= ':';
            $cleared = $this->doSave(array('@'.$this->namespace => $this->namespaceVersion), 0);
        }
        $this->deferred = array();

        try {
            return $this->doClear($this->namespace|| $cleared;
        } catch (\Exception $e) {
            CacheItem::log($this->logger'Failed to clear the cache'array('exception' => $e));

            return false;
        }
    }

    /** * {@inheritdoc} */
    public function deleteItem($key)
    {
        return $this->deleteItems(array($key));
    }

    /** * {@inheritdoc} */
    public function deleteItems(array $keys)
    {
        $ids = array();

        foreach ($keys as $key) {
            $ids[$key] = $this->getId($key);
            unset($this->deferred[$key]);
        }

        try {
            if ($this->doDelete($ids)) {
                return true;
            }
        } catch (\Exception $e) {
        }

        $ok = true;

        // When bulk-delete failed, retry each item individually
        foreach ($ids as $key => $id) {
            try {
                $e = null;
                if ($this->doDelete(array($id))) {
                    continue;
                }
            } catch (\Exception $e) {
            }
            CacheItem::log($this->logger'Failed to delete key "{key}"'array('key' => $key'exception' => $e));
            $ok = false;
        }

        return $ok;
    }

    /** * Enables/disables versioning of items. * * When versioning is enabled, clearing the cache is atomic and doesn't require listing existing keys to proceed, * but old keys may need garbage collection and extra round-trips to the back-end are required. * * Calling this method also clears the memoized namespace version and thus forces a resynchonization of it. * * @param bool $enable * * @return bool the previous state of versioning */
    public function enableVersioning($enable = true)
    {
        $wasEnabled = $this->versioningIsEnabled;
        $this->versioningIsEnabled = (bool) $enable;
        $this->namespaceVersion = '';

        return $wasEnabled;
    }

    /** * {@inheritdoc} */
    public function reset()
    {
        if ($this->deferred) {
            $this->commit();
        }
        $this->namespaceVersion = '';
    }

    /** * Like the native unserialize() function but throws an exception if anything goes wrong. * * @param string $value * * @return mixed * * @throws \Exception */
    protected static function unserialize($value)
    {
        if ('b:0;' === $value) {
            return false;
        }
        $unserializeCallbackHandler = ini_set('unserialize_callback_func'__CLASS__.'::handleUnserializeCallback');
        try {
            if (false !== $value = unserialize($value)) {
                return $value;
            }
            throw new \DomainException('Failed to unserialize cached value');
        } catch (\Error $e) {
            throw new \ErrorException($e->getMessage(), $e->getCode(), E_ERROR$e->getFile(), $e->getLine());
        } finally {
            ini_set('unserialize_callback_func'$unserializeCallbackHandler);
        }
    }

    private function getId($key)
    {
        CacheItem::validateKey($key);

        if ($this->versioningIsEnabled && '' === $this->namespaceVersion) {
            $this->namespaceVersion = '1:';
            foreach ($this->doFetch(array('@'.$this->namespace)) as $v) {
                $this->namespaceVersion = $v;
            }
        }

        if (null === $this->maxIdLength) {
            return $this->namespace.$this->namespaceVersion.$key;
        }
        if (\strlen($id = $this->namespace.$this->namespaceVersion.$key) > $this->maxIdLength) {
            $id = $this->namespace.$this->namespaceVersion.substr_replace(base64_encode(hash('sha256'$keytrue)), ':', -22);
        }

        return $id;
    }

    /** * @internal */
    public static function handleUnserializeCallback($class)
    {
        throw new \DomainException('Class not found: '.$class);
    }
}