FileAccess Orion

Capabilities
in package

Table of Contents

$baseCapabilities  : null|Capabilities
Base capabilities
$lockOnExpire  : null|bool
"lock-on-expire" support in seconds.
$marker  : stdClass
A marker to set/change capabilities
$maxKeyLength  : null|int
Max. key length
$maxTtl  : null|int
Max. TTL (0 means infinite)
$minTtl  : null|int
Min. TTL (0 means items never expire)
$namespaceIsPrefix  : null|bool
Namespace is prefix
$namespaceSeparator  : null|string
Namespace separator
$staticTtl  : null|bool
Static ttl
$storage  : StorageInterface
The storage instance
$supportedDatatypes  : null|array<string|int, mixed>
Supported datatypes
$supportedMetadata  : null|array<string|int, mixed>
Supported metdata
$ttlPrecision  : null|int
TTL precision
$useRequestTime  : null|bool
Use request time
__construct()  : mixed
Constructor
getAdapter()  : StorageInterface
Get the storage adapter
getExpiredRead()  : bool
Get if expired items are readable
getLockOnExpire()  : int
Get "lock-on-expire" support in seconds.
getMaxKeyLength()  : int
Get maximum key length
getMaxTtl()  : int
Get maximum supported time-to-live
getMinTtl()  : int
Get minimum supported time-to-live
getNamespaceIsPrefix()  : bool
Get if namespace support is implemented as prefix
getNamespaceSeparator()  : string
Get namespace separator if namespace is implemented as prefix
getStaticTtl()  : bool
Is the time-to-live handled static (on write) or dynamic (on read)
getSupportedDatatypes()  : array<string|int, mixed>
Get supported datatypes
getSupportedMetadata()  : array<string|int, mixed>
Get supported metadata
getTtlPrecision()  : float
Get time-to-live precision
getUseRequestTime()  : bool
Get use request time
setExpiredRead()  : Capabilities
Set if expired items are readable
setLockOnExpire()  : Capabilities
Set "lock-on-expire" support in seconds.
setMaxKeyLength()  : Capabilities
Set maximum key length
setMaxTtl()  : Capabilities
Set maximum supported time-to-live
setMinTtl()  : Capabilities
Set minimum supported time-to-live
setNamespaceIsPrefix()  : Capabilities
Set if namespace support is implemented as prefix
setNamespaceSeparator()  : Capabilities
Set the namespace separator if namespace is implemented as prefix
setStaticTtl()  : Capabilities
Set if the time-to-live handled static (on write) or dynamic (on read)
setSupportedDatatypes()  : Capabilities
Set supported datatypes
setSupportedMetadata()  : Capabilities
Set supported metadata
setTtlPrecision()  : Capabilities
Set time-to-live precision
setUseRequestTime()  : Capabilities
Set use request time
getCapability()  : mixed
Get a capability
setCapability()  : Capabilities
Change a capability

Properties

$lockOnExpire

"lock-on-expire" support in seconds.

protected null|bool $lockOnExpire

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

If it's NULL the capability isn't set and the getter returns the base capability or the default value.

$marker

A marker to set/change capabilities

protected stdClass $marker

$maxKeyLength

Max. key length

protected null|int $maxKeyLength

If it's NULL the capability isn't set and the getter returns the base capability or the default value.

$maxTtl

Max. TTL (0 means infinite)

protected null|int $maxTtl

If it's NULL the capability isn't set and the getter returns the base capability or the default value.

$minTtl

Min. TTL (0 means items never expire)

protected null|int $minTtl

If it's NULL the capability isn't set and the getter returns the base capability or the default value.

$namespaceIsPrefix

Namespace is prefix

protected null|bool $namespaceIsPrefix

If it's NULL the capability isn't set and the getter returns the base capability or the default value.

$namespaceSeparator

Namespace separator

protected null|string $namespaceSeparator

If it's NULL the capability isn't set and the getter returns the base capability or the default value.

$staticTtl

Static ttl

protected null|bool $staticTtl

If it's NULL the capability isn't set and the getter returns the base capability or the default value.

$supportedDatatypes

Supported datatypes

protected null|array<string|int, mixed> $supportedDatatypes

If it's NULL the capability isn't set and the getter returns the base capability or the default value.

$supportedMetadata

Supported metdata

protected null|array<string|int, mixed> $supportedMetadata

If it's NULL the capability isn't set and the getter returns the base capability or the default value.

$ttlPrecision

TTL precision

protected null|int $ttlPrecision

If it's NULL the capability isn't set and the getter returns the base capability or the default value.

$useRequestTime

Use request time

protected null|bool $useRequestTime

If it's NULL the capability isn't set and the getter returns the base capability or the default value.

Methods

__construct()

Constructor

public __construct(StorageInterface $storage, stdClass $marker[, array<string|int, mixed> $capabilities = [] ][, null|Capabilities $baseCapabilities = null ]) : mixed
Parameters
$storage : StorageInterface
$marker : stdClass
$capabilities : array<string|int, mixed> = []
$baseCapabilities : null|Capabilities = null
Return values
mixed —

getExpiredRead()

Get if expired items are readable

public getExpiredRead() : bool
Tags
deprecated

This capability has been deprecated and will be removed in the future. Please use getStaticTtl() instead

Return values
bool —

getLockOnExpire()

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

public getLockOnExpire() : int
Return values
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

public getMaxKeyLength() : int
Return values
int —

-1 means unknown, 0 means infinite

getMaxTtl()

Get maximum supported time-to-live

public getMaxTtl() : int
Return values
int —

0 means infinite

getMinTtl()

Get minimum supported time-to-live

public getMinTtl() : int
Return values
int —

0 means items never expire

getNamespaceIsPrefix()

Get if namespace support is implemented as prefix

public getNamespaceIsPrefix() : bool
Return values
bool —

getNamespaceSeparator()

Get namespace separator if namespace is implemented as prefix

public getNamespaceSeparator() : string
Return values
string —

getStaticTtl()

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

public getStaticTtl() : bool
Return values
bool —

getSupportedDatatypes()

Get supported datatypes

public getSupportedDatatypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getSupportedMetadata()

Get supported metadata

public getSupportedMetadata() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getTtlPrecision()

Get time-to-live precision

public getTtlPrecision() : float
Return values
float —

getUseRequestTime()

Get use request time

public getUseRequestTime() : bool
Return values
bool —

setExpiredRead()

Set if expired items are readable

public setExpiredRead(stdClass $marker, bool $flag) : Capabilities
Parameters
$marker : stdClass
$flag : bool
Tags
deprecated

This capability has been deprecated and will be removed in the future. Please use setStaticTtl() instead

Return values
Capabilities —

Fluent interface

setLockOnExpire()

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

public setLockOnExpire(stdClass $marker, int $timeout) : Capabilities
Parameters
$marker : stdClass
$timeout : int
Return values
Capabilities —

Fluent interface

setNamespaceIsPrefix()

Set if namespace support is implemented as prefix

public setNamespaceIsPrefix(stdClass $marker, bool $flag) : Capabilities
Parameters
$marker : stdClass
$flag : bool
Return values
Capabilities —

Fluent interface

setNamespaceSeparator()

Set the namespace separator if namespace is implemented as prefix

public setNamespaceSeparator(stdClass $marker, string $separator) : Capabilities
Parameters
$marker : stdClass
$separator : string
Return values
Capabilities —

Fluent interface

setStaticTtl()

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

public setStaticTtl(stdClass $marker, bool $flag) : Capabilities
Parameters
$marker : stdClass
$flag : bool
Return values
Capabilities —

Fluent interface

setSupportedDatatypes()

Set supported datatypes

public setSupportedDatatypes(stdClass $marker, array<string|int, mixed> $datatypes) : Capabilities
Parameters
$marker : stdClass
$datatypes : array<string|int, mixed>
Tags
throws
InvalidArgumentException
Return values
Capabilities —

Fluent interface

setSupportedMetadata()

Set supported metadata

public setSupportedMetadata(stdClass $marker, array<string|int, string> $metadata) : Capabilities
Parameters
$marker : stdClass
$metadata : array<string|int, string>
Tags
throws
InvalidArgumentException
Return values
Capabilities —

Fluent interface

setUseRequestTime()

Set use request time

public setUseRequestTime(stdClass $marker, bool $flag) : Capabilities
Parameters
$marker : stdClass
$flag : bool
Return values
Capabilities —

Fluent interface

getCapability()

Get a capability

protected getCapability(string $property[, mixed $default = null ]) : mixed
Parameters
$property : string
$default : mixed = null
Return values
mixed —

Search results