RedisBackend extends AbstractBackend implements TaggableBackendInterface

A caching backend which stores cache entries by using Redis with phpredis PHP module. Redis is a noSQL database with very good scaling characteristics in proportion to the amount of entries and data size.

Tags

see

https://redis.io/

see

https://github.com/phpredis/phpredis

Table of Contents

Interfaces

TaggableBackendInterface

A contract for a cache backend which supports tagging.

Constants

FAKED_UNLIMITED_LIFETIME  = 31536000

Faked unlimited lifetime = 31536000 (1 Year).

IDENTIFIER_DATA_PREFIX  = 'identData:'

Key prefix for identifier->data entries

IDENTIFIER_TAGS_PREFIX  = 'identTags:'

Key prefix for identifier->tags sets

TAG_IDENTIFIERS_PREFIX  = 'tagIdents:'

Key prefix for tag->identifiers sets

Properties

$cacheIdentifier  : string

$compression  : bool

Indicates whether data is compressed or not (requires php zlib)

$compressionLevel  : int

-1 to 9, indicates zlib compression level: -1 = default level 6, 0 = no compression, 9 maximum compression

$connected  : bool

Indicates whether the server is connected

$connectionTimeout  : int

limit in seconds (default is 0 meaning unlimited)

$database  : int

Number of selected database, defaults to 0

$defaultLifetime  : int

Default lifetime of a cache entry in seconds

$hostname  : string

Hostname / IP of the Redis server, defaults to 127.0.0.1.

$keyPrefix  : string

Used as prefix for all Redis keys/identifiers

$password  : string|null

Password for authentication

$persistentConnection  : bool

Persistent connection

$port  : int

Port of the Redis server, defaults to 6379

$redis  : Redis

$username  : string|null

Username for authentication

Methods

__construct()  : mixed

collectGarbage()  : void

With the current internal structure, only the identifier to data entries have a redis internal lifetime. If an entry expires, attached identifier to tags and tag to identifiers entries will be left over.

findIdentifiersByTag()  : array<string|int, mixed>

Finds and returns all cache entry identifiers which are tagged by the specified tag.

flush()  : void

Removes all cache entries of this cache.

flushByTag()  : void

Removes all cache entries of this cache which are tagged with the specified tag.

flushByTags()  : void

Removes all cache entries of this cache which are tagged by any of the specified tags.

get()  : mixed

Loads data from the cache.

has()  : bool

Checks if a cache entry with the specified identifier exists.

initializeObject()  : void

remove()  : bool

Removes all cache entries matching the specified identifier.

set()  : void

Save data in the cache

setCache()  : void

Sets a reference to the cache frontend which uses this backend

setDefaultLifetime()  : void

Sets the default lifetime for this cache backend

getAuthentication()  : array<string|int, mixed>|string|null

Build the authentication value based on the configuration, returning an associative array in case `username` and `password` has been configured, the `password` as string if only password has been configured or `null` to indicate no-authentication configuration, which is also possible to be used with `redis`.

getDataIdentifier()  : string

getTagIdentifier()  : string

getTagsIdentifier()  : string

removeIdentifierEntriesAndRelations()  : void

Helper method for flushByTag() Gets list of identifiers and tags and removes all relations of those tags

setCompression()  : void

setCompressionLevel()  : void

Set data compression level.

setConnectionTimeout()  : void

Set connection timeout.

setDatabase()  : void

setHostname()  : void

setKeyPrefix()  : void

setPassword()  : void

Setter for authentication password

setPersistentConnection()  : void

setPort()  : void

setUsername()  : void