Class Config in namespace com\setasign\SetaFramework\SimpleCache\Fastcache\Drivers\Redis in SetaFramework API Reference

Index

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

com\setasign\SetaFramework\SimpleCache\Fastcache\Drivers\Redis

Config

File: /SetaFramework/src/SimpleCache/Fastcache/Drivers/Redis/Config.php

Class hierarchy

Phpfastcache\Drivers\Redis\Config
- Config

Implements

\Phpfastcache\Config\ConfigurationOptionInterface
\Phpfastcache\Config\LockableConfigurationInterface

Summary

Methods

__construct()
enforceLockedProperty()
getCacheSlamsTimeout()
getClassName()
getDatabase()
getDefaultFileNameHashFunction()
getDefaultKeyHashFunction()
getDefaultSuperGlobalAccessor()
getDefaultTtl()
getHost()
getOptPrefix()
getPassword()
getPath()
getPort()
getRedisClient()
getSuperGlobalAccessor()
getTimeout()
isAutoTmpFallback()
isItemDetailedDate()
isLocked()
isPreventCacheSlams()
isUseStaticItemCaching()
isValidOption()
isValueSerializable()
lockedBy()
setAutoTmpFallback()
setCacheSlamsTimeout()
setDatabase()
setDefaultFileNameHashFunction()
setDefaultKeyHashFunction()
setDefaultTtl()
setHost()
setItemDetailedDate()
setOptPrefix()
setPassword()
setPath()
setPort()
setPreventCacheSlams()
setProperty()
setRedisClient()
setSuperGlobalAccessor()
setTimeout()
setUseStaticItemCaching()
toArray()

Properties

$autoTmpFallback
$cacheSlamsTimeout
$database
$defaultFileNameHashFunction
$defaultKeyHashFunction
$defaultTtl
$host
$itemDetailedDate
$optPrefix
$password
$path
$port
$preventCacheSlams
$redisClient
$superGlobalAccessor
$timeout
$useStaticItemCaching

Properties

$autoTmpFallback

protected \Phpfastcache\Config\ConfigurationOption::$autoTmpFallback = false

$cacheSlamsTimeout

protected \Phpfastcache\Config\ConfigurationOption::$cacheSlamsTimeout = 15

$database

protected \Phpfastcache\Drivers\Redis\Config::$database = 0

$defaultFileNameHashFunction

protected string|callable \Phpfastcache\Config\ConfigurationOption::$defaultFileNameHashFunction = 'md5'

$defaultKeyHashFunction

protected string|callable \Phpfastcache\Config\ConfigurationOption::$defaultKeyHashFunction = 'md5'

$defaultTtl

protected \Phpfastcache\Config\ConfigurationOption::$defaultTtl = 900

$host

protected \Phpfastcache\Drivers\Redis\Config::$host = '127.0.0.1'

$itemDetailedDate

protected \Phpfastcache\Config\ConfigurationOption::$itemDetailedDate = false

$optPrefix

protected \Phpfastcache\Drivers\Redis\Config::$optPrefix = ''

$password

protected \Phpfastcache\Drivers\Redis\Config::$password = ''

$path

protected \Phpfastcache\Config\ConfigurationOption::$path = ''

$port

protected \Phpfastcache\Drivers\Redis\Config::$port = 6379

$preventCacheSlams

protected \Phpfastcache\Config\ConfigurationOption::$preventCacheSlams = false

$redisClient

protected \Phpfastcache\Drivers\Redis\Config::$redisClient

$superGlobalAccessor

protected \Phpfastcache\Config\ConfigurationOption::$superGlobalAccessor

$timeout

protected \Phpfastcache\Drivers\Redis\Config::$timeout = 5

$useStaticItemCaching

protected \Phpfastcache\Config\ConfigurationOption::$useStaticItemCaching = true

Methods

__construct()

public \Phpfastcache\Config\ConfigurationOption::__construct (

array<string, mixed> $parameters = array ( )

)

Parameters

$parameters : array<string, mixed>

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidConfigurationException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidTypeException

enforceLockedProperty()

protected \Phpfastcache\Config\AbstractConfigurationOption::enforceLockedProperty (

string $propertyName

): void

Parameters

$propertyName : string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

getCacheSlamsTimeout()

getTimeout()

public \Phpfastcache\Drivers\Redis\Config::getTimeout (

void

): int

isAutoTmpFallback()

public \Phpfastcache\Config\ConfigurationOption::isAutoTmpFallback (

void

): bool

isItemDetailedDate()

public \Phpfastcache\Config\ConfigurationOption::isItemDetailedDate (

void

): bool

isLocked()

public \Phpfastcache\Config\AbstractConfigurationOption::isLocked (

void

): bool

isPreventCacheSlams()

WARNING: This method is marked as deprecated!

This method is deprecated and will be soon moved to IOConfigurationOption class, which means they will only be available for IO drivers.

public \Phpfastcache\Config\ConfigurationOption::isPreventCacheSlams (

void

): bool

isUseStaticItemCaching()

public \Phpfastcache\Config\ConfigurationOption::isUseStaticItemCaching (

void

): bool

isValidOption()

public \Phpfastcache\Config\ConfigurationOption::isValidOption (

string $optionName

): bool

Parameters

$optionName : string

isValueSerializable()

public \Phpfastcache\Config\ConfigurationOption::isValueSerializable (

mixed $val

): bool

Parameters

$val : mixed

Exceptions

Throws \ReflectionException

lockedBy()

public \Phpfastcache\Config\AbstractConfigurationOption::lockedBy (

void

): \Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface

setAutoTmpFallback()

public \Phpfastcache\Config\ConfigurationOption::setAutoTmpFallback (

bool $autoTmpFallback

): static

Parameters

$autoTmpFallback : bool

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setCacheSlamsTimeout()

WARNING: This method is marked as deprecated!

This method is deprecated and will be soon moved to IOConfigurationOption class, which means they will only be available for IO drivers.

public \Phpfastcache\Config\ConfigurationOption::setCacheSlamsTimeout (

int $cacheSlamsTimeout

): static

Parameters

$cacheSlamsTimeout : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setDatabase()

public \Phpfastcache\Drivers\Redis\Config::setDatabase (

?int $database = null

): static

Parameters

$database : ?int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setDefaultFileNameHashFunction()

public \Phpfastcache\Config\ConfigurationOption::setDefaultFileNameHashFunction (

callable|string $defaultFileNameHashFunction

): static

Parameters

$defaultFileNameHashFunction : callable|string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidConfigurationException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setDefaultKeyHashFunction()

public \Phpfastcache\Config\ConfigurationOption::setDefaultKeyHashFunction (

callable|string $defaultKeyHashFunction

): static

Parameters

$defaultKeyHashFunction : callable|string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidConfigurationException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setDefaultTtl()

public \Phpfastcache\Config\ConfigurationOption::setDefaultTtl (

int $defaultTtl

): static

Parameters

$defaultTtl : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setHost()

public \Phpfastcache\Drivers\Redis\Config::setHost (

string $host

): static

Parameters

$host : string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setItemDetailedDate()

public \Phpfastcache\Config\ConfigurationOption::setItemDetailedDate (

bool $itemDetailedDate

): static

Parameters

$itemDetailedDate : bool

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setOptPrefix()

public \Phpfastcache\Drivers\Redis\Config::setOptPrefix (

string $optPrefix

): \Phpfastcache\Drivers\Redis\Config

Parameters

$optPrefix : string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setPassword()

public \Phpfastcache\Drivers\Redis\Config::setPassword (

string $password

): static

Parameters

$password : string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setPath()

public \Phpfastcache\Config\ConfigurationOption::setPath (

string $path

): static

Parameters

$path : string

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setPort()

public \Phpfastcache\Drivers\Redis\Config::setPort (

int $port

): static

Parameters

$port : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setPreventCacheSlams()

WARNING: This method is marked as deprecated!

This method is deprecated and will be soon moved to IOConfigurationOption class, which means they will only be available for IO drivers.

public \Phpfastcache\Config\ConfigurationOption::setPreventCacheSlams (

bool $preventCacheSlams

): static

Parameters

$preventCacheSlams : bool

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setProperty()

protected \Phpfastcache\Config\AbstractConfigurationOption::setProperty (

string $propertyName,
mixed $propertyValue

): static

Parameters

$propertyName : string
$propertyValue : mixed

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

setRedisClient()

public \Phpfastcache\Drivers\Redis\Config::setRedisClient (

?\Redis $redisClient

): \Phpfastcache\Drivers\Redis\Config

Parameters

$redisClient : ?\Redis

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setSuperGlobalAccessor()

public \Phpfastcache\Config\ConfigurationOption::setSuperGlobalAccessor (

?object $superGlobalAccessor

): static

Parameters

$superGlobalAccessor : ?object

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setTimeout()

public \Phpfastcache\Drivers\Redis\Config::setTimeout (

int $timeout

): static

Parameters

$timeout : int

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

setUseStaticItemCaching()

public \Phpfastcache\Config\ConfigurationOption::setUseStaticItemCaching (

bool $useStaticItemCaching

): static

Parameters

$useStaticItemCaching : bool

Exceptions

Throws \Phpfastcache\Exceptions\PhpfastcacheLogicException

toArray()

public \Phpfastcache\Config\ConfigurationOption::toArray (

void

): array