2018-04-17 02:11:51 +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 ;
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 ;
2024-01-12 05:08:24 +00:00
protected $tags = [];
protected $prevTags = [];
2018-04-17 02:11:51 +00:00
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 }
2024-01-12 05:08:24 +00:00
*
* @ return $this
2018-04-17 02:11:51 +00:00
*/
public function set ( $value )
{
$this -> value = $value ;
return $this ;
}
/**
* { @ inheritdoc }
2024-01-12 05:08:24 +00:00
*
* @ return $this
2018-04-17 02:11:51 +00:00
*/
public function expiresAt ( $expiration )
{
if ( null === $expiration ) {
2024-01-12 05:08:24 +00:00
$this -> expiry = null ;
2018-04-17 02:11:51 +00:00
} elseif ( $expiration instanceof \DateTimeInterface ) {
$this -> expiry = ( int ) $expiration -> format ( 'U' );
} else {
2024-01-12 05:08:24 +00:00
throw new InvalidArgumentException ( sprintf ( 'Expiration date must implement DateTimeInterface or be null, "%s" given.' , \is_object ( $expiration ) ? \get_class ( $expiration ) : \gettype ( $expiration )));
2018-04-17 02:11:51 +00:00
}
return $this ;
}
/**
* { @ inheritdoc }
2024-01-12 05:08:24 +00:00
*
* @ return $this
2018-04-17 02:11:51 +00:00
*/
public function expiresAfter ( $time )
{
if ( null === $time ) {
2024-01-12 05:08:24 +00:00
$this -> expiry = null ;
2018-04-17 02:11:51 +00:00
} elseif ( $time instanceof \DateInterval ) {
$this -> expiry = ( int ) \DateTime :: createFromFormat ( 'U' , time ()) -> add ( $time ) -> format ( 'U' );
2024-01-12 05:08:24 +00:00
} elseif ( \is_int ( $time )) {
2018-04-17 02:11:51 +00:00
$this -> expiry = $time + time ();
} else {
2024-01-12 05:08:24 +00: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 )));
2018-04-17 02:11:51 +00:00
}
return $this ;
}
/**
* Adds a tag to a cache item .
*
* @ param string | string [] $tags A tag or array of tags
*
2024-01-12 05:08:24 +00:00
* @ return $this
2018-04-17 02:11:51 +00:00
*
* @ throws InvalidArgumentException When $tag is not valid
*/
public function tag ( $tags )
{
2024-01-12 05:08:24 +00:00
if ( ! \is_array ( $tags )) {
$tags = [ $tags ];
2018-04-17 02:11:51 +00:00
}
foreach ( $tags as $tag ) {
2024-01-12 05:08:24 +00:00
if ( ! \is_string ( $tag )) {
throw new InvalidArgumentException ( sprintf ( 'Cache tag must be string, "%s" given.' , \is_object ( $tag ) ? \get_class ( $tag ) : \gettype ( $tag )));
2018-04-17 02:11:51 +00:00
}
if ( isset ( $this -> tags [ $tag ])) {
continue ;
}
2024-01-12 05:08:24 +00:00
if ( '' === $tag ) {
throw new InvalidArgumentException ( 'Cache tag length must be greater than zero.' );
2018-04-17 02:11:51 +00:00
}
if ( false !== strpbrk ( $tag , '{}()/\@:' )) {
2024-01-12 05:08:24 +00:00
throw new InvalidArgumentException ( sprintf ( 'Cache tag "%s" contains reserved characters {}()/\@:.' , $tag ));
2018-04-17 02:11:51 +00:00
}
$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 )
{
2024-01-12 05:08:24 +00:00
if ( ! \is_string ( $key )) {
throw new InvalidArgumentException ( sprintf ( 'Cache key must be string, "%s" given.' , \is_object ( $key ) ? \get_class ( $key ) : \gettype ( $key )));
2018-04-17 02:11:51 +00:00
}
2024-01-12 05:08:24 +00:00
if ( '' === $key ) {
throw new InvalidArgumentException ( 'Cache key length must be greater than zero.' );
2018-04-17 02:11:51 +00:00
}
if ( false !== strpbrk ( $key , '{}()/\@:' )) {
2024-01-12 05:08:24 +00:00
throw new InvalidArgumentException ( sprintf ( 'Cache key "%s" contains reserved characters {}()/\@:.' , $key ));
2018-04-17 02:11:51 +00:00
}
return $key ;
}
/**
* Internal logging helper .
*
* @ internal
*/
2024-01-12 05:08:24 +00:00
public static function log ( LoggerInterface $logger = null , $message , $context = [])
2018-04-17 02:11:51 +00:00
{
if ( $logger ) {
$logger -> warning ( $message , $context );
} else {
2024-01-12 05:08:24 +00:00
$replace = [];
2018-04-17 02:11:51 +00:00
foreach ( $context as $k => $v ) {
if ( is_scalar ( $v )) {
$replace [ '{' . $k . '}' ] = $v ;
}
}
2024-01-12 05:08:24 +00:00
@ trigger_error ( strtr ( $message , $replace ), \E_USER_WARNING );
2018-04-17 02:11:51 +00:00
}
}
}