Index

\com\setasign\SetaFramework
1. SimpleCache
  1. Fastcache
    1. Drivers
      1. Predis
        
        Config
        
        Driver
        
        Item

com\setasign\SetaFramework\SimpleCache\Fastcache\Drivers\Predis

Item CacheItemInterface defines an interface for interacting with objects inside a cache.

File: /SetaFramework/src/SimpleCache/Fastcache/Drivers/Predis/Item.php

Class hierarchy

Phpfastcache\Drivers\Predis\Item
- Item

Implements

\JsonSerializable
\Phpfastcache\Core\Item\ExtendedCacheItemInterface
\Phpfastcache\Core\Item\TaggableCacheItemInterface
\Phpfastcache\Event\EventManagerDispatcherInterface
\Phpfastcache\Util\ClassNamespaceResolverInterface
\Psr\Cache\CacheItemInterface

Summary

Constants

TAG_STRATEGY_ALL

public const \Phpfastcache\Core\Item\TaggableCacheItemInterface::TAG_STRATEGY_ALL = 2

Allows you to get cache item(s) by ALL of the specified matching tag(s) The cache item CAN have additional tag(s)

TAG_STRATEGY_ONE

public const \Phpfastcache\Core\Item\TaggableCacheItemInterface::TAG_STRATEGY_ONE = 1

Allows you to get cache item(s) by at least ONE of the specified matching tag(s). Default behavior

TAG_STRATEGY_ONLY

public const \Phpfastcache\Core\Item\TaggableCacheItemInterface::TAG_STRATEGY_ONLY = 4

Allows you to get cache item(s) by ONLY the specified matching tag(s) The cache item CANNOT have additional tag(s)

Static Properties

$namespaces

static protected array<string, string> \Phpfastcache\Util\ClassNamespaceResolverTrait::$namespaces = array()

Properties

$creationDate

protected \Phpfastcache\Core\Item\CacheItemTrait::$creationDate

$data

protected \Phpfastcache\Core\Item\CacheItemTrait::$data

$driver

protected \Phpfastcache\Core\Item\ExtendedCacheItemTrait::$driver

$encodedKey

protected \Phpfastcache\Core\Item\ExtendedCacheItemTrait::$encodedKey

$eventManager

protected \Phpfastcache\Event\EventManagerInterface \Phpfastcache\Event\EventManagerDispatcherTrait::$eventManager

$expirationDate

protected \Phpfastcache\Core\Item\CacheItemTrait::$expirationDate

$isHit

protected \Phpfastcache\Core\Item\CacheItemTrait::$isHit = false

$key

protected \Phpfastcache\Core\Item\CacheItemTrait::$key

$modificationDate

protected \Phpfastcache\Core\Item\CacheItemTrait::$modificationDate

$removedTags

protected string[] \Phpfastcache\Core\Item\TaggableCacheItemTrait::$removedTags = array()

$tags

protected string[] \Phpfastcache\Core\Item\TaggableCacheItemTrait::$tags = array()

Static Methods

buildTokenClasses()

protected static \Phpfastcache\Util\ClassNamespaceResolverTrait::buildTokenClasses (

string $namespace,
string $class,
string[] $classes,
int $index,
array<array<mixed>|string> $tokens

): array

Parameters

$namespace : string
$class : string
$classes : string[]
$index : int
$tokens : array<array<mixed>|string>

buildTokenNamespace()

protected static \Phpfastcache\Util\ClassNamespaceResolverTrait::buildTokenNamespace (

int $index,
array<array<mixed>|string> $tokens

): string

Parameters

$index : int
$tokens : array<array<mixed>|string>

createClassMap()

protected static \Phpfastcache\Util\ClassNamespaceResolverTrait::createClassMap (

string $dir

): array

Iterate over all files in the given directory searching for classes.

NOTICE: This method has been borrowed from Symfony ClassLoader 3.4 since they deprecated the whole component as of SF4. Our thanks to them.

Parameters

$dir : string: The directory to search in or an iterator

Return Values

A class map array

findClasses()

protected static \Phpfastcache\Util\ClassNamespaceResolverTrait::findClasses (

string $path

): array

Extract the classes in the given file.

NOTICE: This method has been borrowed from Symfony ClassLoader 3.4 since they deprecated the whole component as of SF4. Our thanks to them.

Parameters

$path : string: The file to check

Return Values

The found classes

getClassNamespace()

public static \Phpfastcache\Util\ClassNamespaceResolverTrait::getClassNamespace (

void

): string

Methods

__construct()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::__construct (

\Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface $driver,
string $key,
\Phpfastcache\Event\EventManagerInterface $em

)

Item constructor.

Parameters

$driver : \Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface
$key : string
$em : \Phpfastcache\Event\EventManagerInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

_getData()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::_getData (

void

): ?mixed

addTag()

public \Phpfastcache\Core\Item\TaggableCacheItemTrait::addTag (

string $tagName

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$tagName : string

addTags()

public \Phpfastcache\Core\Item\TaggableCacheItemTrait::addTags (

string[] $tagNames

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$tagNames : string[]

append()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::append (

array|string $data

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$data : array|string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidTypeException

clearRemovedTags()

public \Phpfastcache\Core\Item\TaggableCacheItemTrait::clearRemovedTags (

void

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

cloneInto()

public \Phpfastcache\Core\Item\TaggableCacheItemTrait::cloneInto (

\Phpfastcache\Core\Item\ExtendedCacheItemInterface $itemTarget,
?\Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface $itemPoolTarget = null

): void

Parameters

$itemTarget : \Phpfastcache\Core\Item\ExtendedCacheItemInterface
$itemPoolTarget : ?\Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

decrement()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::decrement (

int $step = 1

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$step : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidTypeException

demutateDatetime()

protected \Phpfastcache\Core\Item\CacheItemTrait::demutateDatetime (

\DateTimeInterface $dateTime

): \DateTimeInterface

Parameters

$dateTime : \DateTimeInterface

doesItemBelongToThatDriverBackend()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::doesItemBelongToThatDriverBackend (

\Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface $driverPool

): bool

Parameters

$driverPool : \Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface

expiresAfter()

public \Phpfastcache\Core\Item\CacheItemTrait::expiresAfter (

int|\DateInterval|null $time

): static

Parameters

$time : int|\DateInterval|null

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Exception

expiresAt()

public \Phpfastcache\Core\Item\CacheItemTrait::expiresAt (

?\DateTimeInterface $expiration

): static

Parameters

$expiration : ?\DateTimeInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

get()

public \Phpfastcache\Core\Item\CacheItemTrait::get (

void

): ?mixed

getClassName()

public \Phpfastcache\Util\ClassNamespaceResolverTrait::getClassName (

void

): string

getCreationDate()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::getCreationDate (

void

): \DateTimeInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

getDataAsJsonString()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::getDataAsJsonString (

int $options = \JSON_THROW_ON_ERROR,
int $depth = 512

): string

Return the data as a well-formatted string. Any scalar value will be cast to an array

Parameters

$options : int: \json_encode() options
$depth : int: \json_encode() depth

getDriverClass()

protected \Phpfastcache\Drivers\Predis\Item::getDriverClass (

void

): string

getEncodedKey()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::getEncodedKey (

void

): string

getEventManager()

public \Phpfastcache\Event\EventManagerDispatcherTrait::getEventManager (

void

): \Phpfastcache\Event\EventManagerInterface

getExpirationDate()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::getExpirationDate (

void

): \DateTimeInterface

getKey()

public \Phpfastcache\Core\Item\CacheItemTrait::getKey (

void

): string

getLength()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::getLength (

void

): int

Return the data length: Either the string length if it's a string (binary mode)

or the number of element (count) if it's an array

or the number returned by count() if it's an object implementing \Countable interface

-1 for anything else

getModificationDate()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::getModificationDate (

void

): \DateTimeInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

getRemovedTags()

public \Phpfastcache\Core\Item\TaggableCacheItemTrait::getRemovedTags (

void

): array

getTags()

public \Phpfastcache\Core\Item\TaggableCacheItemTrait::getTags (

void

): array

getTagsAsString()

public \Phpfastcache\Core\Item\TaggableCacheItemTrait::getTagsAsString (

string $separator = ', '

): string

Parameters

$separator : string

getTtl()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::getTtl (

void

): int

hasEventManager()

WARNING: This method is marked as deprecated!

Will be removed in v10

public \Phpfastcache\Event\EventManagerDispatcherTrait::hasEventManager (

void

): bool

hasTag()

public \Phpfastcache\Core\Item\TaggableCacheItemTrait::hasTag (

string $tagName

): bool

Parameters

$tagName : string

hasTags()

public \Phpfastcache\Core\Item\TaggableCacheItemTrait::hasTags (

string[] $tagNames,
int $strategy = \Phpfastcache\Core\Item\TaggableCacheItemInterface::TAG_STRATEGY_ONE

): bool

Parameters

$tagNames : string[]
$strategy : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

increment()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::increment (

int $step = 1

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$step : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidTypeException

isEmpty()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::isEmpty (

void

): bool

isExpired()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::isExpired (

void

): bool

isHit()

public \Phpfastcache\Core\Item\CacheItemTrait::isHit (

void

): bool

isNull()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::isNull (

void

): bool

isTagged()

public \Phpfastcache\Core\Item\TaggableCacheItemTrait::isTagged (

void

): bool

jsonSerialize()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::jsonSerialize (

void

): ?mixed

prepend()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::prepend (

array|string $data

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$data : array|string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidTypeException

removeTag()

public \Phpfastcache\Core\Item\TaggableCacheItemTrait::removeTag (

string $tagName

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$tagName : string

removeTags()

public \Phpfastcache\Core\Item\TaggableCacheItemTrait::removeTags (

string[] $tagNames

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$tagNames : string[]

set()

public \Phpfastcache\Core\Item\CacheItemTrait::set (

mixed $value

): static

Parameters

$value : mixed

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

setCreationDate()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::setCreationDate (

\DateTimeInterface $date

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$date : \DateTimeInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setDriver()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::setDriver (

\Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface $driver

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$driver : \Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

setEventManager()

public \Phpfastcache\Event\EventManagerDispatcherTrait::setEventManager (

\Phpfastcache\Event\EventManagerInterface $em

): static

Parameters

$em : \Phpfastcache\Event\EventManagerInterface

setExpirationDate()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::setExpirationDate (

\DateTimeInterface $expiration

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$expiration : \DateTimeInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

setHit()

public \Phpfastcache\Core\Item\CacheItemTrait::setHit (

bool $isHit

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$isHit : bool

setModificationDate()

public \Phpfastcache\Core\Item\ExtendedCacheItemTrait::setModificationDate (

\DateTimeInterface $date

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$date : \DateTimeInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setTags()

public \Phpfastcache\Core\Item\TaggableCacheItemTrait::setTags (

string[] $tags

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$tags : string[]

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException