- Updated local libraries - PHP 7.1 support - New, proper caching method - Special cache folder
170 lines
3.8 KiB
PHP
170 lines
3.8 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
* This file is part of phpFastCache.
|
|
*
|
|
* @license MIT License (MIT)
|
|
*
|
|
* For full copyright and license information, please see the docs/CREDITS.txt file.
|
|
*
|
|
* @author Khoa Bui (khoaofgod) <khoaofgod@gmail.com> http://www.phpfastcache.com
|
|
* @author Georges.L (Geolim4) <contact@geolim4.com>
|
|
*
|
|
*/
|
|
|
|
namespace phpFastCache\Cache;
|
|
|
|
use Psr\Cache\CacheItemInterface;
|
|
|
|
/**
|
|
* Interface ExtendedCacheItemInterface
|
|
* @package phpFastCache\Cache
|
|
*/
|
|
interface ExtendedCacheItemInterface extends CacheItemInterface, \JsonSerializable
|
|
{
|
|
/**
|
|
* Returns the encoded key for the current cache item.
|
|
* Usually as a MD5 hash
|
|
*
|
|
* @return string
|
|
* The encoded key string for this cache item.
|
|
*/
|
|
public function getEncodedKey();
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function getUncommittedData();
|
|
|
|
/**
|
|
* @return \DateTimeInterface
|
|
*/
|
|
public function getExpirationDate();
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
public function getTtl();
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isExpired();
|
|
|
|
/**
|
|
* @param \phpFastCache\Cache\ExtendedCacheItemPoolInterface $driver
|
|
* @return mixed
|
|
*/
|
|
public function setDriver(ExtendedCacheItemPoolInterface $driver);
|
|
|
|
/**
|
|
* @param bool $isHit
|
|
* @return $this
|
|
* @throws \InvalidArgumentException
|
|
*/
|
|
public function setHit($isHit);
|
|
|
|
/**
|
|
* @param int $step
|
|
* @return $this
|
|
* @throws \InvalidArgumentException
|
|
*/
|
|
public function increment($step = 1);
|
|
|
|
/**
|
|
* @param int $step
|
|
* @return $this
|
|
* @throws \InvalidArgumentException
|
|
*/
|
|
public function decrement($step = 1);
|
|
|
|
/**
|
|
* @param array|string $data
|
|
* @return $this
|
|
* @throws \InvalidArgumentException
|
|
*/
|
|
public function append($data);
|
|
|
|
/**
|
|
* @param array|string $data
|
|
* @return $this
|
|
* @throws \InvalidArgumentException
|
|
*/
|
|
public function prepend($data);
|
|
|
|
|
|
/**
|
|
* Sets the expiration time for this cache item.
|
|
*
|
|
* @param int|\DateInterval $time
|
|
* The period of time from the present after which the item MUST be considered
|
|
* expired. An integer parameter is understood to be the time in seconds until
|
|
* expiration. If null is passed explicitly, a default value MAY be used.
|
|
* If none is set, the value should be stored permanently or for as long as the
|
|
* implementation allows.
|
|
*
|
|
* @return static
|
|
* The called object.
|
|
*
|
|
* @deprecated Use CacheItemInterface::expiresAfter() instead
|
|
*/
|
|
public function touch($time);
|
|
|
|
/**
|
|
* @param string $tagName
|
|
* @return $this
|
|
* @throws \InvalidArgumentException
|
|
*/
|
|
public function addTag($tagName);
|
|
|
|
/**
|
|
* @param array $tagNames
|
|
* @return $this
|
|
*/
|
|
public function addTags(array $tagNames);
|
|
|
|
|
|
/**
|
|
* @param array $tags
|
|
* @return $this
|
|
* @throws \InvalidArgumentException
|
|
*/
|
|
public function setTags(array $tags);
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function getTags();
|
|
|
|
/**
|
|
* @param string $separator
|
|
* @return mixed
|
|
*/
|
|
public function getTagsAsString($separator = ', ');
|
|
|
|
/**
|
|
* @param array $tagName
|
|
* @return $this
|
|
*/
|
|
public function removeTag($tagName);
|
|
|
|
/**
|
|
* @param array $tagNames
|
|
* @return $this
|
|
*/
|
|
public function removeTags(array $tagNames);
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function getRemovedTags();
|
|
|
|
/**
|
|
* Return the data as a well-formatted string.
|
|
* Any scalar value will be casted to an array
|
|
* @param int $option json_encode() options
|
|
* @param int $depth json_encode() depth
|
|
* @return string
|
|
*/
|
|
public function getDataAsJsonString($option = 0, $depth = 512);
|
|
} |