Summary

Fully Qualified Name:

Laminas\Cache\Storage\Capabilities

Description

Methods

Name	Description	Defined By
__construct()	Constructor	Capabilities
getAdapter()	Get the storage adapter	Capabilities
getExpiredRead()	Get if expired items are readable	Capabilities
getLockOnExpire()	Get "lock-on-expire" support in seconds.	Capabilities
getMaxKeyLength()	Get maximum key length	Capabilities
getMaxTtl()	Get maximum supported time-to-live	Capabilities
getMinTtl()	Get minimum supported time-to-live	Capabilities
getNamespaceIsPrefix()	Get if namespace support is implemented as prefix	Capabilities
getNamespaceSeparator()	Get namespace separator if namespace is implemented as prefix	Capabilities
getStaticTtl()	Is the time-to-live handled static (on write) or dynamic (on read)	Capabilities
getSupportedDatatypes()	Get supported datatypes	Capabilities
getSupportedMetadata()	Get supported metadata	Capabilities
getTtlPrecision()	Get time-to-live precision	Capabilities
getUseRequestTime()	Get use request time	Capabilities
setExpiredRead()	Set if expired items are readable	Capabilities
setLockOnExpire()	Set "lock-on-expire" support in seconds.	Capabilities
setMaxKeyLength()	Set maximum key length	Capabilities
setMaxTtl()	Set maximum supported time-to-live	Capabilities
setMinTtl()	Set minimum supported time-to-live	Capabilities
setNamespaceIsPrefix()	Set if namespace support is implemented as prefix	Capabilities
setNamespaceSeparator()	Set the namespace separator if namespace is implemented as prefix	Capabilities
setStaticTtl()	Set if the time-to-live handled static (on write) or dynamic (on read)	Capabilities
setSupportedDatatypes()	Set supported datatypes	Capabilities
setSupportedMetadata()	Set supported metadata	Capabilities
setTtlPrecision()	Set time-to-live precision	Capabilities
setUseRequestTime()	Set use request time	Capabilities

Method Details

__construct()

Constructor

Parameter Name	Type	Description
$storage	\StorageInterface
$marker	\stdClass
$capabilities	array
$baseCapabilities	null|\Capabilities

Returns:

getAdapter()

Get the storage adapter

Returns: \StorageInterface

getExpiredRead()

Get if expired items are readable

Returns: bool

getLockOnExpire()

Get "lock-on-expire" support in seconds.

Returns: int 0 = Expired items will never be retrieved >0 = Time in seconds an expired item could be retrieved -1 = Expired items could be retrieved forever

getMaxKeyLength()

Get maximum key length

Returns: int -1 means unknown, 0 means infinite

getMaxTtl()

Get maximum supported time-to-live

Returns: int 0 means infinite

getMinTtl()

Get minimum supported time-to-live

Returns: int 0 means items never expire

getNamespaceIsPrefix()

Get if namespace support is implemented as prefix

Returns: bool

getNamespaceSeparator()

Get namespace separator if namespace is implemented as prefix

Returns: string

getStaticTtl()

Is the time-to-live handled static (on write) or dynamic (on read)

Returns: bool

getSupportedDatatypes()

Get supported datatypes

Returns: array

getSupportedMetadata()

Get supported metadata

Returns: array

getTtlPrecision()

Get time-to-live precision

Returns: float

getUseRequestTime()

Get use request time

Returns: bool

setExpiredRead()

Set if expired items are readable

Parameter Name	Type	Description
$marker	\stdClass
$flag	bool

Returns: \Capabilities Fluent interface

setLockOnExpire()

Set "lock-on-expire" support in seconds.

Parameter Name	Type	Description
$marker	\stdClass
$timeout	int

Returns: \Capabilities Fluent interface

setMaxKeyLength()

Set maximum key length

Parameter Name	Type	Description
$marker	\stdClass
$maxKeyLength	int

Returns: \Capabilities Fluent interface

setMaxTtl()

Set maximum supported time-to-live

Parameter Name	Type	Description
$marker	\stdClass
$maxTtl	int

Returns: \Capabilities Fluent interface

setMinTtl()

Set minimum supported time-to-live

Parameter Name	Type	Description
$marker	\stdClass
$minTtl	int

Returns: \Capabilities Fluent interface

setNamespaceIsPrefix()

Set if namespace support is implemented as prefix

Parameter Name	Type	Description
$marker	\stdClass
$flag	bool

Returns: \Capabilities Fluent interface

setNamespaceSeparator()

Set the namespace separator if namespace is implemented as prefix

Parameter Name	Type	Description
$marker	\stdClass
$separator	string

Returns: \Capabilities Fluent interface

setStaticTtl()

Set if the time-to-live handled static (on write) or dynamic (on read)

Parameter Name	Type	Description
$marker	\stdClass
$flag	bool

Returns: \Capabilities Fluent interface

setSupportedDatatypes()

Set supported datatypes

Parameter Name	Type	Description
$marker	\stdClass
$datatypes	array

Returns: \Capabilities Fluent interface

setSupportedMetadata()

Set supported metadata

Parameter Name	Type	Description
$marker	\stdClass
$metadata	string[]

Returns: \Capabilities Fluent interface

setTtlPrecision()

Set time-to-live precision

Parameter Name	Type	Description
$marker	\stdClass
$ttlPrecision	float

Returns: \Capabilities Fluent interface

setUseRequestTime()

Set use request time

Parameter Name	Type	Description
$marker	\stdClass
$flag	bool

Returns: \Capabilities Fluent interface