123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187 |
- <?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;
- use Psr\Cache\CacheItemInterface;
- use Psr\Log\LoggerInterface;
- use Symfony\Component\Cache\Exception\InvalidArgumentException;
- /**
- * @author Nicolas Grekas <p@tchwork.com>
- */
- final class CacheItem implements CacheItemInterface
- {
- protected $key;
- protected $value;
- protected $isHit = false;
- protected $expiry;
- protected $defaultLifetime;
- protected $tags = [];
- protected $prevTags = [];
- protected $innerItem;
- protected $poolHash;
- /**
- * {@inheritdoc}
- */
- public function getKey()
- {
- return $this->key;
- }
- /**
- * {@inheritdoc}
- */
- public function get()
- {
- return $this->value;
- }
- /**
- * {@inheritdoc}
- */
- public function isHit()
- {
- return $this->isHit;
- }
- /**
- * {@inheritdoc}
- */
- public function set($value)
- {
- $this->value = $value;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function expiresAt($expiration)
- {
- if (null === $expiration) {
- $this->expiry = $this->defaultLifetime > 0 ? time() + $this->defaultLifetime : null;
- } elseif ($expiration instanceof \DateTimeInterface) {
- $this->expiry = (int) $expiration->format('U');
- } else {
- throw new InvalidArgumentException(sprintf('Expiration date must implement DateTimeInterface or be null, "%s" given', \is_object($expiration) ? \get_class($expiration) : \gettype($expiration)));
- }
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function expiresAfter($time)
- {
- if (null === $time) {
- $this->expiry = $this->defaultLifetime > 0 ? time() + $this->defaultLifetime : null;
- } elseif ($time instanceof \DateInterval) {
- $this->expiry = (int) \DateTime::createFromFormat('U', time())->add($time)->format('U');
- } elseif (\is_int($time)) {
- $this->expiry = $time + time();
- } else {
- throw new InvalidArgumentException(sprintf('Expiration date must be an integer, a DateInterval or null, "%s" given', \is_object($time) ? \get_class($time) : \gettype($time)));
- }
- return $this;
- }
- /**
- * Adds a tag to a cache item.
- *
- * @param string|string[] $tags A tag or array of tags
- *
- * @return static
- *
- * @throws InvalidArgumentException When $tag is not valid
- */
- public function tag($tags)
- {
- if (!\is_array($tags)) {
- $tags = [$tags];
- }
- foreach ($tags as $tag) {
- if (!\is_string($tag)) {
- throw new InvalidArgumentException(sprintf('Cache tag must be string, "%s" given', \is_object($tag) ? \get_class($tag) : \gettype($tag)));
- }
- if (isset($this->tags[$tag])) {
- continue;
- }
- if ('' === $tag) {
- throw new InvalidArgumentException('Cache tag length must be greater than zero');
- }
- if (false !== strpbrk($tag, '{}()/\@:')) {
- throw new InvalidArgumentException(sprintf('Cache tag "%s" contains reserved characters {}()/\@:', $tag));
- }
- $this->tags[$tag] = $tag;
- }
- return $this;
- }
- /**
- * Returns the list of tags bound to the value coming from the pool storage if any.
- *
- * @return array
- */
- public function getPreviousTags()
- {
- return $this->prevTags;
- }
- /**
- * Validates a cache key according to PSR-6.
- *
- * @param string $key The key to validate
- *
- * @return string
- *
- * @throws InvalidArgumentException When $key is not valid
- */
- public static function validateKey($key)
- {
- if (!\is_string($key)) {
- throw new InvalidArgumentException(sprintf('Cache key must be string, "%s" given', \is_object($key) ? \get_class($key) : \gettype($key)));
- }
- if ('' === $key) {
- throw new InvalidArgumentException('Cache key length must be greater than zero');
- }
- if (false !== strpbrk($key, '{}()/\@:')) {
- throw new InvalidArgumentException(sprintf('Cache key "%s" contains reserved characters {}()/\@:', $key));
- }
- return $key;
- }
- /**
- * Internal logging helper.
- *
- * @internal
- */
- public static function log(LoggerInterface $logger = null, $message, $context = [])
- {
- if ($logger) {
- $logger->warning($message, $context);
- } else {
- $replace = [];
- foreach ($context as $k => $v) {
- if (is_scalar($v)) {
- $replace['{'.$k.'}'] = $v;
- }
- }
- @trigger_error(strtr($message, $replace), E_USER_WARNING);
- }
- }
- }
|