FileAccess Orion

MemoryOptions extends AdapterOptions
in package

These are options specific to the APC adapter

Table of Contents

$__prioritizedProperties__  : array<string|int, string>
Prioritized properties ordered by prio to be set first in case a bulk of options sets set at once
$__strictMode__  : bool
We use the __ prefix to avoid collisions with properties in user-implementations.
$adapter  : null|StorageInterface
The adapter using these options
$keyPattern  : string
Validate key against pattern
$memoryLimit  : null|int
memory limit
$namespace  : string
Namespace option
$readable  : bool
Readable option
$ttl  : int|float
TTL option
$writable  : bool
Writable option
__construct()  : mixed
Constructor
__get()  : mixed
Get a configuration property
__isset()  : bool
Test if a configuration property is null
__set()  : void
Set a configuration property
__unset()  : void
Set a configuration property to NULL
getKeyPattern()  : string
Get key pattern
getMemoryLimit()  : int
Get memory limit
getNamespace()  : string
Get namespace
getReadable()  : bool
If reading data from cache enabled.
getTtl()  : float
Get time to live.
getWritable()  : bool
If writing data to cache enabled.
setAdapter()  : AdapterOptions
Adapter using this instance
setFromArray()  : AbstractOptions
Set one or more configuration properties
setKeyPattern()  : AdapterOptions
Set key pattern
setMemoryLimit()  : MemoryOptions
Set memory limit
setNamespace()  : AdapterOptions
Set namespace.
setReadable()  : AdapterOptions
Enable/Disable reading data from cache.
setTtl()  : AdapterOptions
Set time to live.
setWritable()  : AdapterOptions
Enable/Disable writing data to cache.
toArray()  : array<string|int, mixed>
Cast to array
normalizeMemoryLimit()  : int
Normalized a given value of memory limit into the number of bytes
normalizeTtl()  : void
Validates and normalize a TTL.
triggerOptionEvent()  : void
Triggers an option event if this options instance has a connection to an adapter implements EventsCapableInterface.

Properties

$__prioritizedProperties__

Prioritized properties ordered by prio to be set first in case a bulk of options sets set at once

protected array<string|int, string> $__prioritizedProperties__ = []

$__strictMode__

We use the __ prefix to avoid collisions with properties in user-implementations.

protected bool $__strictMode__ = true

$keyPattern

Validate key against pattern

protected string $keyPattern = ''

$memoryLimit

memory limit

protected null|int $memoryLimit = null

$namespace

Namespace option

protected string $namespace = 'zfcache'

$ttl

TTL option

protected int|float $ttl = 0

0 means infinite or maximum of adapter

Methods

__construct()

Constructor

public __construct([array<string|int, mixed>|Traversable|null $options = null ]) : mixed
Parameters
$options : array<string|int, mixed>|Traversable|null = null
Return values
mixed —

__get()

Get a configuration property

public __get(string $key) : mixed
Parameters
$key : string
Tags
see
ParameterObject::__get()
throws
BadMethodCallException
Return values
mixed —

__isset()

Test if a configuration property is null

public __isset(string $key) : bool
Parameters
$key : string
Tags
see
ParameterObject::__isset()
Return values
bool —

__set()

Set a configuration property

public __set(string $key, mixed $value) : void
Parameters
$key : string
$value : mixed
Tags
see
ParameterObject::__set()
throws
BadMethodCallException
Return values
void —

__unset()

Set a configuration property to NULL

public __unset(string $key) : void
Parameters
$key : string
Tags
see
ParameterObject::__unset()
throws
InvalidArgumentException
Return values
void —

getKeyPattern()

Get key pattern

public getKeyPattern() : string
Return values
string —

getMemoryLimit()

Get memory limit

public getMemoryLimit() : int

If the used memory of PHP exceeds this limit an OutOfSpaceException will be thrown.

Return values
int —

getNamespace()

Get namespace

public getNamespace() : string
Return values
string —

getReadable()

If reading data from cache enabled.

public getReadable() : bool
Return values
bool —

getTtl()

Get time to live.

public getTtl() : float
Return values
float —

getWritable()

If writing data to cache enabled.

public getWritable() : bool
Return values
bool —

setMemoryLimit()

Set memory limit

public setMemoryLimit(string|int $memoryLimit) : MemoryOptions
  • A number less or equal 0 will disable the memory limit
  • When a number is used, the value is measured in bytes. Shorthand notation may also be used.
  • If the used memory of PHP exceeds this limit an OutOfSpaceException will be thrown.
Parameters
$memoryLimit : string|int
Tags
link
http://php.net/manual/faq.using.php#faq.using.shorthandbytes
Return values
MemoryOptions —

Provides a fluent interface

toArray()

Cast to array

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

normalizeMemoryLimit()

Normalized a given value of memory limit into the number of bytes

protected normalizeMemoryLimit(string|int $value) : int
Parameters
$value : string|int
Tags
throws
InvalidArgumentException
Return values
int —

triggerOptionEvent()

Triggers an option event if this options instance has a connection to an adapter implements EventsCapableInterface.

protected triggerOptionEvent(string $optionName, mixed $optionValue) : void
Parameters
$optionName : string
$optionValue : mixed
Return values
void —

Search results