2016-01-18 14:59:30 +00:00
< ? 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 ;
2016-01-25 19:16:47 +00:00
use Psr\Log\LoggerInterface ;
2016-01-18 14:59:30 +00:00
use Symfony\Component\Cache\Exception\InvalidArgumentException ;
2018-04-15 01:21:41 +01:00
use Symfony\Component\Cache\Exception\LogicException ;
2018-08-01 09:02:13 +01:00
use Symfony\Contracts\Cache\ItemInterface ;
2016-01-18 14:59:30 +00:00
/**
* @ author Nicolas Grekas < p @ tchwork . com >
*/
2018-08-01 09:02:13 +01:00
final class CacheItem implements ItemInterface
2016-01-18 14:59:30 +00:00
{
2018-04-23 17:02:04 +01:00
private const METADATA_EXPIRY_OFFSET = 1527506807 ;
2016-06-13 15:28:45 +01:00
protected $key ;
protected $value ;
2016-12-09 17:34:32 +00:00
protected $isHit = false ;
2016-06-13 15:28:45 +01:00
protected $expiry ;
protected $defaultLifetime ;
2019-01-16 20:35:37 +00:00
protected $metadata = [];
protected $newMetadata = [];
2016-06-13 15:28:45 +01:00
protected $innerItem ;
protected $poolHash ;
2018-04-15 01:21:41 +01:00
protected $isTaggable = false ;
2016-01-18 14:59:30 +00:00
/**
* { @ inheritdoc }
*/
public function getKey ()
{
return $this -> key ;
}
/**
* { @ inheritdoc }
*/
public function get ()
{
return $this -> value ;
}
/**
* { @ inheritdoc }
*/
public function isHit ()
{
return $this -> isHit ;
}
/**
* { @ inheritdoc }
2019-08-20 21:53:36 +01:00
*
* @ return $this
2016-01-18 14:59:30 +00:00
*/
public function set ( $value )
{
$this -> value = $value ;
return $this ;
}
/**
* { @ inheritdoc }
2019-08-20 21:53:36 +01:00
*
* @ return $this
2016-01-18 14:59:30 +00:00
*/
public function expiresAt ( $expiration )
{
if ( null === $expiration ) {
2018-04-24 13:56:46 +01:00
$this -> expiry = $this -> defaultLifetime > 0 ? microtime ( true ) + $this -> defaultLifetime : null ;
2016-01-18 14:59:30 +00:00
} elseif ( $expiration instanceof \DateTimeInterface ) {
2018-04-24 13:56:46 +01:00
$this -> expiry = ( float ) $expiration -> format ( 'U.u' );
2016-01-18 14:59:30 +00:00
} else {
2018-07-26 09:45:46 +01:00
throw new InvalidArgumentException ( sprintf ( 'Expiration date must implement DateTimeInterface or be null, "%s" given' , \is_object ( $expiration ) ? \get_class ( $expiration ) : \gettype ( $expiration )));
2016-01-18 14:59:30 +00:00
}
return $this ;
}
/**
* { @ inheritdoc }
2019-08-20 21:53:36 +01:00
*
* @ return $this
2016-01-18 14:59:30 +00:00
*/
public function expiresAfter ( $time )
{
if ( null === $time ) {
2018-04-24 13:56:46 +01:00
$this -> expiry = $this -> defaultLifetime > 0 ? microtime ( true ) + $this -> defaultLifetime : null ;
2016-01-18 14:59:30 +00:00
} elseif ( $time instanceof \DateInterval ) {
2018-04-24 13:56:46 +01:00
$this -> expiry = microtime ( true ) + \DateTime :: createFromFormat ( 'U' , 0 ) -> add ( $time ) -> format ( 'U.u' );
2018-04-19 15:46:47 +01:00
} elseif ( \is_int ( $time )) {
2018-04-24 13:56:46 +01:00
$this -> expiry = $time + microtime ( true );
2016-01-18 14:59:30 +00:00
} else {
2018-07-26 09:45:46 +01:00
throw new InvalidArgumentException ( sprintf ( 'Expiration date must be an integer, a DateInterval or null, "%s" given' , \is_object ( $time ) ? \get_class ( $time ) : \gettype ( $time )));
2016-01-18 14:59:30 +00:00
}
return $this ;
}
2016-01-25 19:16:47 +00:00
2016-04-26 16:44:27 +01:00
/**
2018-08-01 09:02:13 +01:00
* { @ inheritdoc }
2016-04-26 16:44:27 +01:00
*/
2018-08-01 09:02:13 +01:00
public function tag ( $tags ) : ItemInterface
2016-04-26 16:44:27 +01:00
{
2018-04-15 01:21:41 +01:00
if ( ! $this -> isTaggable ) {
throw new LogicException ( sprintf ( 'Cache item "%s" comes from a non tag-aware pool: you cannot tag it.' , $this -> key ));
}
2019-06-13 11:57:15 +01:00
if ( ! is_iterable ( $tags )) {
2019-01-16 20:35:37 +00:00
$tags = [ $tags ];
2016-04-26 16:44:27 +01:00
}
foreach ( $tags as $tag ) {
2018-04-19 15:46:47 +01:00
if ( ! \is_string ( $tag )) {
2018-07-26 09:45:46 +01:00
throw new InvalidArgumentException ( sprintf ( 'Cache tag must be string, "%s" given' , \is_object ( $tag ) ? \get_class ( $tag ) : \gettype ( $tag )));
2016-04-26 16:44:27 +01:00
}
2018-04-23 17:02:04 +01:00
if ( isset ( $this -> newMetadata [ self :: METADATA_TAGS ][ $tag ])) {
2016-04-26 16:44:27 +01:00
continue ;
}
2018-04-19 15:46:47 +01:00
if ( '' === $tag ) {
2016-04-26 16:44:27 +01:00
throw new InvalidArgumentException ( 'Cache tag length must be greater than zero' );
}
2017-01-13 10:10:10 +00:00
if ( false !== strpbrk ( $tag , '{}()/\@:' )) {
2016-04-26 16:44:27 +01:00
throw new InvalidArgumentException ( sprintf ( 'Cache tag "%s" contains reserved characters {}()/\@:' , $tag ));
}
2018-04-23 17:02:04 +01:00
$this -> newMetadata [ self :: METADATA_TAGS ][ $tag ] = $tag ;
2016-04-26 16:44:27 +01:00
}
return $this ;
}
2018-08-01 09:02:13 +01:00
/**
* { @ inheritdoc }
*/
public function getMetadata () : array
{
return $this -> metadata ;
}
2016-12-09 17:34:32 +00:00
/**
* Returns the list of tags bound to the value coming from the pool storage if any .
*
* @ return array
2018-04-23 17:02:04 +01:00
*
* @ deprecated since Symfony 4.2 , use the " getMetadata() " method instead .
2016-12-09 17:34:32 +00:00
*/
public function getPreviousTags ()
{
2018-07-06 13:02:59 +01:00
@ trigger_error ( sprintf ( 'The "%s()" method is deprecated since Symfony 4.2, use the "getMetadata()" method instead.' , __METHOD__ ), E_USER_DEPRECATED );
2018-04-23 17:02:04 +01:00
2019-01-16 20:35:37 +00:00
return $this -> metadata [ self :: METADATA_TAGS ] ? ? [];
2018-04-23 17:02:04 +01:00
}
2016-04-20 10:13:42 +01:00
/**
* Validates a cache key according to PSR - 6.
*
2016-06-29 06:42:25 +01:00
* @ param string $key The key to validate
2016-04-20 10:13:42 +01:00
*
2017-08-24 07:39:03 +01:00
* @ return string
*
2017-01-13 09:44:13 +00:00
* @ throws InvalidArgumentException When $key is not valid
2016-04-20 10:13:42 +01:00
*/
public static function validateKey ( $key )
{
2018-04-19 15:46:47 +01:00
if ( ! \is_string ( $key )) {
2018-07-26 09:45:46 +01:00
throw new InvalidArgumentException ( sprintf ( 'Cache key must be string, "%s" given' , \is_object ( $key ) ? \get_class ( $key ) : \gettype ( $key )));
2016-04-20 10:13:42 +01:00
}
2018-04-19 15:46:47 +01:00
if ( '' === $key ) {
2016-04-20 10:13:42 +01:00
throw new InvalidArgumentException ( 'Cache key length must be greater than zero' );
}
2017-01-13 09:44:13 +00:00
if ( false !== strpbrk ( $key , '{}()/\@:' )) {
2016-04-27 07:45:20 +01:00
throw new InvalidArgumentException ( sprintf ( 'Cache key "%s" contains reserved characters {}()/\@:' , $key ));
2016-04-20 10:13:42 +01:00
}
2017-08-24 07:39:03 +01:00
return $key ;
2016-04-20 10:13:42 +01:00
}
2016-01-25 19:16:47 +00:00
/**
* Internal logging helper .
*
* @ internal
*/
2019-01-16 20:35:37 +00:00
public static function log ( LoggerInterface $logger = null , $message , $context = [])
2016-01-25 19:16:47 +00:00
{
if ( $logger ) {
$logger -> warning ( $message , $context );
} else {
2019-01-16 20:35:37 +00:00
$replace = [];
2016-01-25 19:16:47 +00:00
foreach ( $context as $k => $v ) {
if ( is_scalar ( $v )) {
$replace [ '{' . $k . '}' ] = $v ;
}
}
@ trigger_error ( strtr ( $message , $replace ), E_USER_WARNING );
}
}
2016-01-18 14:59:30 +00:00
}