vendor/zendframework/zend-cache/src/Psr/CacheItemPool/CacheItem.php

   1 <?php
   2 /**
   3  * @see       https://github.com/zendframework/zend-cache for the canonical source repository
   4  * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (http://www.zend.com)
   5  * @license   https://github.com/zendframework/zend-cache/blob/master/LICENSE.md New BSD License
   6  */
   7
   8 namespace Zend\Cache\Psr\CacheItemPool;
   9
  10 use DateInterval;
  11 use DateTimeImmutable;
  12 use DateTimeInterface;
  13 use DateTimeZone;
  14 use Psr\Cache\CacheItemInterface;
  15
  16 final class CacheItem implements CacheItemInterface
  17 {
  18     /**
  19      * Cache key
  20      * @var string
  21      */
  22     private $key;
  23
  24     /**
  25      * Cache value
  26      * @var mixed|null
  27      */
  28     private $value;
  29
  30     /**
  31      * True if the cache item lookup resulted in a cache hit or if they item is deferred or successfully saved
  32      * @var bool
  33      */
  34     private $isHit = false;
  35
  36     /**
  37      * Timestamp item will expire at if expiresAt() called, null otherwise
  38      * @var int|null
  39      */
  40     private $expiration = null;
  41
  42     /**
  43      * Seconds after item is stored it will expire at if expiresAfter() called, null otherwise
  44      * @var int|null
  45      */
  46     private $ttl = null;
  47
  48     /**
  49      * @var DateTimeZone
  50      */
  51     private $tz;
  52
  53     /**
  54      * Constructor.
  55      *
  56      * @param string $key
  57      * @param mixed $value
  58      * @param bool $isHit
  59      */
  60     public function __construct($key, $value, $isHit)
  61     {
  62         $this->key   = $key;
  63         $this->value = $isHit ? $value : null;
  64         $this->isHit = $isHit;
  65         $this->utc   = new DateTimeZone('UTC');
  66     }
  67
  68     /**
  69      * {@inheritdoc}
  70      */
  71     public function getKey()
  72     {
  73         return $this->key;
  74     }
  75
  76     /**
  77      * {@inheritdoc}
  78      */
  79     public function get()
  80     {
  81         return $this->value;
  82     }
  83
  84     /**
  85      * {@inheritdoc}
  86      */
  87     public function isHit()
  88     {
  89         if (! $this->isHit) {
  90             return false;
  91         }
  92         $ttl = $this->getTtl();
  93         return $ttl === null || $ttl > 0;
  94     }
  95
  96     /**
  97      * Sets isHit value
  98      *
  99      * This function is called by CacheItemPoolDecorator::saveDeferred() and is not intended for use by other calling
 100      * code.
 101      *
 102      * @param boolean $isHit
 103      * @return $this
 104      */
 105     public function setIsHit($isHit)
 106     {
 107         $this->isHit = $isHit;
 108
 109         return $this;
 110     }
 111
 112     /**
 113      * {@inheritdoc}
 114      */
 115     public function set($value)
 116     {
 117         $this->value = $value;
 118
 119         return $this;
 120     }
 121
 122     /**
 123      * {@inheritdoc}
 124      */
 125     public function expiresAt($expiration)
 126     {
 127         if (! ($expiration === null || $expiration instanceof DateTimeInterface)) {
 128             throw new InvalidArgumentException('$expiration must be null or an instance of DateTimeInterface');
 129         }
 130
 131         $this->expiration = $expiration instanceof DateTimeInterface ? $expiration->getTimestamp() : null;
 132         $this->ttl = null;
 133
 134         return $this;
 135     }
 136
 137     /**
 138      * {@inheritdoc}
 139      */
 140     public function expiresAfter($time)
 141     {
 142         if ($time instanceof DateInterval) {
 143             $now = new DateTimeImmutable('now', $this->utc);
 144             $end = $now->add($time);
 145             $this->ttl = $end->getTimestamp() - $now->getTimestamp();
 146         } elseif (is_int($time) || $time === null) {
 147             $this->ttl = $time;
 148         } else {
 149             throw new InvalidArgumentException(sprintf('Invalid $time "%s"', gettype($time)));
 150         }
 151
 152         $this->expiration = null;
 153
 154         return $this;
 155     }
 156
 157     /**
 158      * Returns number of seconds until item expires
 159      *
 160      * If NULL, the pool should use the default TTL for the storage adapter. If <= 0, the item has expired.
 161      *
 162      * @return int|null
 163      */
 164     public function getTtl()
 165     {
 166         $ttl = $this->ttl;
 167         if ($this->expiration !== null) {
 168             $ttl = $this->expiration - time();
 169         }
 170         return $ttl;
 171     }
 172 }