Class Driver in namespace com\setasign\SetaFramework\SimpleCache\Fastcache\Drivers\Predis in SetaFramework API Reference

Index

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

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

Driver

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

Class hierarchy

Phpfastcache\Drivers\Predis\Driver
- Driver

Implements

\Phpfastcache\Cluster\AggregatablePoolInterface
\Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface
\Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface
\Phpfastcache\Event\EventManagerDispatcherInterface
\Phpfastcache\Util\ClassNamespaceResolverInterface
\Psr\Cache\CacheItemPoolInterface

Summary

Constants

DRIVER_CDATE_WRAPPER_INDEX

public const \Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface::DRIVER_CDATE_WRAPPER_INDEX = 'c'

Creation date Index

DRIVER_CHECK_FAILURE

public const \Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface::DRIVER_CHECK_FAILURE = '%s is not installed or is misconfigured, cannot continue. Also, please verify the suggested dependencies in composer because as of the V6, 3rd party libraries are no longer required.%s'

DRIVER_CONNECT_FAILURE

public const \Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface::DRIVER_CONNECT_FAILURE = '%s failed to connect with the following error message: "%s" line %d in %s.'

DRIVER_DATA_WRAPPER_INDEX

public const \Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface::DRIVER_DATA_WRAPPER_INDEX = 'd'

DRIVER_EDATE_WRAPPER_INDEX

public const \Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface::DRIVER_EDATE_WRAPPER_INDEX = 'e'

Expiration date Index

DRIVER_KEY_WRAPPER_INDEX

public const \Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface::DRIVER_KEY_WRAPPER_INDEX = 'k'

DRIVER_MDATE_WRAPPER_INDEX

public const \Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface::DRIVER_MDATE_WRAPPER_INDEX = 'm'

Modification date Index

DRIVER_TAGS_KEY_PREFIX

public const \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::DRIVER_TAGS_KEY_PREFIX = '_TAG_'

DRIVER_TAGS_WRAPPER_INDEX

public const \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::DRIVER_TAGS_WRAPPER_INDEX = 'g'

MAX_ALL_KEYS_COUNT

public const \Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface::MAX_ALL_KEYS_COUNT = 9999

Hard-limit count of items returns by getAllItems()

TAG_STRATEGY_ALL

public const \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::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\Pool\TaggableCacheItemPoolInterface::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\Pool\TaggableCacheItemPoolInterface::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

$cacheItemClasses

static protected string[] \Phpfastcache\Core\Pool\DriverBaseTrait::$cacheItemClasses = array()

$namespaces

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

$unsupportedKeyChars

static protected string \Phpfastcache\Core\Pool\CacheItemPoolTrait::$unsupportedKeyChars = '{}()/\\@:'

Properties

$IO

protected \Phpfastcache\Core\Pool\CacheItemPoolTrait::$IO

$clusterPool

protected \Phpfastcache\Core\Pool\AggregatablePoolTrait::$clusterPool

$config

protected \Phpfastcache\Core\Pool\DriverBaseTrait::$config

$deferredList

protected \Phpfastcache\Core\Item\ExtendedCacheItemInterface[]|\Psr\Cache\CacheItemInterface[] \Phpfastcache\Core\Pool\CacheItemPoolTrait::$deferredList = array()

$driverName

protected \Phpfastcache\Core\Pool\DriverBaseTrait::$driverName

$eventManager

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

$instance

protected ?object \Phpfastcache\Core\Pool\DriverBaseTrait::$instance

$instanceId

protected \Phpfastcache\Core\Pool\DriverBaseTrait::$instanceId

$itemInstances

protected \Phpfastcache\Core\Item\ExtendedCacheItemInterface[]|\Psr\Cache\CacheItemInterface[] \Phpfastcache\Core\Pool\CacheItemPoolTrait::$itemInstances = 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

getConfigClass()

public static \Phpfastcache\Core\Pool\DriverBaseTrait::getConfigClass (

void

): string

getItemClass()

public static \Phpfastcache\Core\Pool\DriverBaseTrait::getItemClass (

void

): string

Methods

__construct()

public \Phpfastcache\Core\Pool\CacheItemPoolTrait::__construct (

\Phpfastcache\Config\ConfigurationOptionInterface $config,
string $instanceId,
\Phpfastcache\Event\EventManagerInterface $em

)

Parameters

$config : \Phpfastcache\Config\ConfigurationOptionInterface
$instanceId : string
$em : \Phpfastcache\Event\EventManagerInterface

__driverBaseConstruct()

public \Phpfastcache\Core\Pool\DriverBaseTrait::__driverBaseConstruct (

\Phpfastcache\Config\ConfigurationOptionInterface $config,
string $instanceId,
\Phpfastcache\Event\EventManagerInterface $em

): void

Driver constructor.

Parameters

$config : \Phpfastcache\Config\ConfigurationOptionInterface
$instanceId : string
$em : \Phpfastcache\Event\EventManagerInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverCheckException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverConnectException

Throws \Phpfastcache\Exceptions\PhpfastcacheIOException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

appendItemsByTag()

public \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::appendItemsByTag (

string $tagName,
array|string $data,
int $strategy = \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::TAG_STRATEGY_ONE

): bool

Parameters

$tagName : string
$data : array|string
$strategy : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \ReflectionException

appendItemsByTags()

public \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::appendItemsByTags (

array $tagNames,
array|string $data,
int $strategy = \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::TAG_STRATEGY_ONE

): bool

Parameters

$tagNames : array
$data : array|string
$strategy : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \ReflectionException

assertCacheItemType()

protected \Phpfastcache\Core\Pool\DriverPoolAbstractTrait::assertCacheItemType (

\Psr\Cache\CacheItemInterface $item,
string $expectedClassType

): void

Parameters

$item : \Psr\Cache\CacheItemInterface
$expectedClassType : string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

attachItem()

public \Phpfastcache\Core\Pool\CacheItemPoolTrait::attachItem (

\Psr\Cache\CacheItemInterface $item

): static

Parameters

$item : \Psr\Cache\CacheItemInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

cleanItemTags()

protected \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::cleanItemTags (

\Phpfastcache\Core\Item\ExtendedCacheItemInterface $item

): void

Parameters

$item : \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

clear()

public \Phpfastcache\Core\Pool\CacheItemPoolTrait::clear (

void

): bool

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \Phpfastcache\Exceptions\PhpfastcacheIOException

commit()

public \Phpfastcache\Core\Pool\CacheItemPoolTrait::commit (

void

): bool

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

decode()

protected \Phpfastcache\Core\Pool\DriverBaseTrait::decode (

?string $value

): ?array

Decode data stored in the cache for driver that does not support non-scalar value storage.

Parameters

$value : ?string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

decrementItemsByTag()

public \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::decrementItemsByTag (

string $tagName,
int $step = 1,
int $strategy = \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::TAG_STRATEGY_ONE

): bool

Parameters

$tagName : string
$step : int
$strategy : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \ReflectionException

decrementItemsByTags()

public \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::decrementItemsByTags (

array $tagNames,
int $step = 1,
int $strategy = \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::TAG_STRATEGY_ONE

): bool

Parameters

$tagNames : array
$step : int
$strategy : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \ReflectionException

deleteItem()

public \Phpfastcache\Core\Pool\CacheItemPoolTrait::deleteItem (

string $key

): bool

Parameters

$key : string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

deleteItems()

public \Phpfastcache\Core\Pool\CacheItemPoolTrait::deleteItems (

array $keys

): bool

Parameters

$keys : array

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

deleteItemsByTag()

public \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::deleteItemsByTag (

string $tagName,
int $strategy = \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::TAG_STRATEGY_ONE

): bool

Parameters

$tagName : string
$strategy : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

deleteItemsByTags()

public \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::deleteItemsByTags (

array $tagNames,
int $strategy = \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::TAG_STRATEGY_ONE

): bool

Parameters

$tagNames : array
$strategy : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

detachAllItems()

public \Phpfastcache\Core\Pool\ExtendedCacheItemPoolTrait::detachAllItems (

void

): static

detachItem()

public \Phpfastcache\Core\Pool\ExtendedCacheItemPoolTrait::detachItem (

\Psr\Cache\CacheItemInterface $item

): static

Parameters

$item : \Psr\Cache\CacheItemInterface

driverCheck()

public \Phpfastcache\Drivers\Predis\Driver::driverCheck (

void

): bool

driverClear()

protected Driver::driverClear (

void

): bool

driverConnect()

protected \Phpfastcache\Drivers\Predis\Driver::driverConnect (

void

): bool

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

driverDelete()

protected \Phpfastcache\Drivers\Predis\Driver::driverDelete (

string $key,
string $encodedKey

): bool

Parameters

$key : string
$encodedKey : string

driverDeleteMultiple()

protected \Phpfastcache\Drivers\Predis\Driver::driverDeleteMultiple (

string[] $keys

): bool

Parameters

$keys : string[]

driverPreWrap()

public \Phpfastcache\Core\Pool\DriverBaseTrait::driverPreWrap (

\Phpfastcache\Core\Item\ExtendedCacheItemInterface $item,
bool $stringifyDate = false

): array

Parameters

$item : \Phpfastcache\Core\Item\ExtendedCacheItemInterface
$stringifyDate : bool

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

driverRead()

protected \Phpfastcache\Drivers\Predis\Driver::driverRead (

\Phpfastcache\Core\Item\ExtendedCacheItemInterface $item

): ?array

Parameters

$item : \Phpfastcache\Core\Item\ExtendedCacheItemInterface

driverReadAllKeys()

protected \Phpfastcache\Drivers\Predis\Driver::driverReadAllKeys (

string $pattern = '*'

): \iterable

Parameters

$pattern : string

Exceptions

Throws \RedisException

driverReadMultiple()

protected \Phpfastcache\Drivers\Predis\Driver::driverReadMultiple (

\Phpfastcache\Core\Item\ExtendedCacheItemInterface ...$items

): array

Parameters

$items : \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \RedisException

driverUnwrapCdate()

public \Phpfastcache\Core\Pool\DriverBaseTrait::driverUnwrapCdate (

array<string, mixed> $wrapper

): ?\DateTimeInterface

Parameters

$wrapper : array<string, mixed>

driverUnwrapData()

public \Phpfastcache\Core\Pool\DriverBaseTrait::driverUnwrapData (

array<string, mixed> $wrapper

): ?mixed

Parameters

$wrapper : array<string, mixed>

Exceptions

Throws \Exception

driverUnwrapEdate()

public \Phpfastcache\Core\Pool\DriverBaseTrait::driverUnwrapEdate (

array<string, mixed> $wrapper

): \DateTimeInterface

Parameters

$wrapper : array<string, mixed>

driverUnwrapMdate()

public \Phpfastcache\Core\Pool\DriverBaseTrait::driverUnwrapMdate (

array<string, mixed> $wrapper

): ?\DateTimeInterface

Parameters

$wrapper : array<string, mixed>

driverUnwrapTags()

protected \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::driverUnwrapTags (

array<mixed> $wrapper

): array

Parameters

$wrapper : array<mixed>

driverWrite()

protected \Phpfastcache\Drivers\Predis\Driver::driverWrite (

\Phpfastcache\Core\Item\ExtendedCacheItemInterface $item

): bool

Parameters

$item : \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

driverWriteMultiple()

protected \Phpfastcache\Core\Pool\DriverPoolAbstractTrait::driverWriteMultiple (

\Phpfastcache\Core\Item\ExtendedCacheItemInterface ...$item

): bool

Parameters

$item : \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheUnsupportedMethodException

driverWriteTags()

protected \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::driverWriteTags (

\Phpfastcache\Core\Item\ExtendedCacheItemInterface $item

): bool

Parameters

$item : \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

encode()

protected \Phpfastcache\Core\Pool\DriverBaseTrait::encode (

mixed $data

): string

Encode data types such as object/array for driver that does not support non-scalar value

Parameters

$data : mixed

fetchItemsByTagFromBackend()

protected \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::fetchItemsByTagFromBackend (

string $tagName

): array

Parameters

$tagName : string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

getAllItems()

public \Phpfastcache\Core\Pool\ExtendedCacheItemPoolTrait::getAllItems (

string $pattern = ''

): \iterable

Parameters

$pattern : string

getClassName()

public \Phpfastcache\Util\ClassNamespaceResolverTrait::getClassName (

void

): string

getConfig()

public \Phpfastcache\Core\Pool\DriverBaseTrait::getConfig (

void

): \Phpfastcache\Config\ConfigurationOptionInterface

getDefaultConfig()

public \Phpfastcache\Core\Pool\DriverBaseTrait::getDefaultConfig (

void

): \Phpfastcache\Config\ConfigurationOptionInterface

getDriverName()

public \Phpfastcache\Core\Pool\DriverBaseTrait::getDriverName (

void

): string

getEncodedKey()

public \Phpfastcache\Core\Pool\DriverBaseTrait::getEncodedKey (

string $key

): string

Parameters

$key : string

getEventManager()

public \Phpfastcache\Event\EventManagerDispatcherTrait::getEventManager (

void

): \Phpfastcache\Event\EventManagerInterface

getHelp()

public \Phpfastcache\Drivers\Predis\Driver::getHelp (

void

): string

getIO()

public \Phpfastcache\Core\Pool\CacheItemPoolTrait::getIO (

void

): \Phpfastcache\Entities\DriverIO

getInstanceId()

public \Phpfastcache\Core\Pool\DriverBaseTrait::getInstanceId (

void

): string

getItem()

public \Phpfastcache\Core\Pool\CacheItemPoolTrait::getItem (

string $key

): \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Parameters

$key : string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

getItems()

public \Phpfastcache\Core\Pool\CacheItemPoolTrait::getItems (

array $keys = array ( )

): \iterable

Parameters

$keys : array

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

getItemsAsJsonString()

public \Phpfastcache\Core\Pool\ExtendedCacheItemPoolTrait::getItemsAsJsonString (

array $keys = array ( ),
int $options = \JSON_THROW_ON_ERROR,
int $depth = 512

): string

Parameters

$keys : array
$options : int
$depth : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

getItemsByTag()

public \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::getItemsByTag (

string $tagName,
int $strategy = \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::TAG_STRATEGY_ONE

): array

Parameters

$tagName : string
$strategy : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

getItemsByTags()

public \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::getItemsByTags (

array $tagNames,
int $strategy = \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::TAG_STRATEGY_ONE

): array

Parameters

$tagNames : array
$strategy : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

getItemsByTagsAsJsonString()

public \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::getItemsByTagsAsJsonString (

array $tagNames,
int $option = \JSON_THROW_ON_ERROR,
int $depth = 512,
int $strategy = \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::TAG_STRATEGY_ONE

): string

Parameters

$tagNames : array
$option : int
$depth : int
$strategy : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

getKeys()

protected \Phpfastcache\Core\Pool\CacheItemPoolTrait::getKeys (

\Phpfastcache\Core\Item\ExtendedCacheItemInterface[] $items,
bool $encoded = false,
string $keyPrefix = ''

): array

Parameters

$items : \Phpfastcache\Core\Item\ExtendedCacheItemInterface[]
$encoded : bool
$keyPrefix : string

getStats()

public \Phpfastcache\Drivers\Predis\Driver::getStats (

void

): \Phpfastcache\Entities\DriverStatistic

getTagKey()

protected \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::getTagKey (

string $key

): string

Parameters

$key : string

getTagKeys()

protected \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::getTagKeys (

array<string> $keys

): array

Parameters

$keys : array<string>

handleExpiredCacheItem()

protected \Phpfastcache\Core\Pool\CacheItemPoolTrait::handleExpiredCacheItem (

\Phpfastcache\Core\Item\ExtendedCacheItemInterface $item

): void

Parameters

$item : \Phpfastcache\Core\Item\ExtendedCacheItemInterface

hasEventManager()

WARNING: This method is marked as deprecated!

Will be removed in v10

public \Phpfastcache\Event\EventManagerDispatcherTrait::hasEventManager (

void

): bool

hasItem()

public \Phpfastcache\Core\Pool\CacheItemPoolTrait::hasItem (

string $key

): bool

Parameters

$key : string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

incrementItemsByTag()

public \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::incrementItemsByTag (

string $tagName,
int $step = 1,
int $strategy = \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::TAG_STRATEGY_ONE

): bool

Parameters

$tagName : string
$step : int
$strategy : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \ReflectionException

incrementItemsByTags()

public \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::incrementItemsByTags (

array $tagNames,
int $step = 1,
int $strategy = \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::TAG_STRATEGY_ONE

): bool

Parameters

$tagNames : array
$step : int
$strategy : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \ReflectionException

isAggregatedBy()

public \Phpfastcache\Core\Pool\AggregatablePoolTrait::isAggregatedBy (

void

): ?\Phpfastcache\Cluster\ClusterPoolInterface

isAttached()

public \Phpfastcache\Core\Pool\CacheItemPoolTrait::isAttached (

\Psr\Cache\CacheItemInterface $item

): bool

Parameters

$item : \Psr\Cache\CacheItemInterface

prependItemsByTag()

public \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::prependItemsByTag (

string $tagName,
array|string $data,
int $strategy = \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::TAG_STRATEGY_ONE

): bool

Parameters

$tagName : string
$data : array|string
$strategy : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \ReflectionException

prependItemsByTags()

public \Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait::prependItemsByTags (

array $tagNames,
array|string $data,
int $strategy = \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface::TAG_STRATEGY_ONE

): bool

Parameters

$tagNames : array
$data : array|string
$strategy : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \ReflectionException

save()

public \Phpfastcache\Core\Pool\CacheItemPoolTrait::save (

\Psr\Cache\CacheItemInterface $item

): bool

Parameters

$item : \Psr\Cache\CacheItemInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheIOException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

saveDeferred()

public \Phpfastcache\Core\Pool\CacheItemPoolTrait::saveDeferred (

\Psr\Cache\CacheItemInterface $item

): bool

Parameters

$item : \Psr\Cache\CacheItemInterface

saveMultiple()

public \Phpfastcache\Core\Pool\ExtendedCacheItemPoolTrait::saveMultiple (

\Phpfastcache\Core\Item\ExtendedCacheItemInterface ...$items

): bool

Parameters

$items : \Phpfastcache\Core\Item\ExtendedCacheItemInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheCoreException

Throws \Phpfastcache\Exceptions\PhpfastcacheDriverException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setAggregatedBy()

public \Phpfastcache\Core\Pool\AggregatablePoolTrait::setAggregatedBy (

\Phpfastcache\Cluster\ClusterPoolInterface $clusterPool

): static

Parameters

$clusterPool : \Phpfastcache\Cluster\ClusterPoolInterface

setConfig()

public \Phpfastcache\Core\Pool\DriverBaseTrait::setConfig (

\Phpfastcache\Config\ConfigurationOptionInterface $config

): static

Parameters

$config : \Phpfastcache\Config\ConfigurationOptionInterface

setEventManager()

public \Phpfastcache\Event\EventManagerDispatcherTrait::setEventManager (

\Phpfastcache\Event\EventManagerInterface $em

): static

Parameters

$em : \Phpfastcache\Event\EventManagerInterface

setItem()

public \Phpfastcache\Core\Pool\CacheItemPoolTrait::setItem (

\Psr\Cache\CacheItemInterface $item

): static

Parameters

$item : \Psr\Cache\CacheItemInterface

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

throwUnsupportedDriverReadAllPattern()

public \Phpfastcache\Core\Pool\ExtendedCacheItemPoolTrait::throwUnsupportedDriverReadAllPattern (

string $linkReference = ''

): void

Parameters

$linkReference : string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

unserialize()

protected \Phpfastcache\Core\Pool\DriverBaseTrait::unserialize (

?string $value

): ?mixed

Parameters

$value : ?string

validateCacheKeys()

protected \Phpfastcache\Core\Pool\CacheItemPoolTrait::validateCacheKeys (

string ...$keys

): void

Parameters

$keys : string