Documentation

CacheTrait

Cache trait for PSR-16 compatible "Simple Cache" implementation

Table of Contents

Properties

$defaultLifetime  : int|null
$miss  : stdClass
$namespace  : string
$validation  : bool

Methods

clear()  : bool
delete()  : bool
deleteMultiple()  : bool
doDeleteMultiple()  : bool
doGetMultiple()  : array<string|int, mixed>
doSetMultiple()  : bool
get()  : mixed|null
getMultiple()  : iterable<string|int, mixed>
has()  : bool
set()  : bool
setMultiple()  : bool
setValidation()  : void
convertTtl()  : int|null
getDefaultLifetime()  : int|null
getNamespace()  : string
init()  : void
Always call from constructor.
validateKey()  : void
validateKeys()  : void

Properties

$defaultLifetime

private int|null $defaultLifetime = null

Methods

clear()

public clear() : bool
Return values
bool

deleteMultiple()

public deleteMultiple(iterable<string|int, mixed> $keys) : bool
Parameters
$keys : iterable<string|int, mixed>
Tags
throws
InvalidArgumentException
Return values
bool

doDeleteMultiple()

public doDeleteMultiple(array<string|int, mixed> $keys) : bool
Parameters
$keys : array<string|int, mixed>
Return values
bool

doGetMultiple()

public doGetMultiple(array<string|int, mixed> $keys, mixed $miss) : array<string|int, mixed>
Parameters
$keys : array<string|int, mixed>
$miss : mixed
Return values
array<string|int, mixed>

doSetMultiple()

public doSetMultiple(array<string|int, mixed> $values, int|null $ttl) : bool
Parameters
$values : array<string|int, mixed>
$ttl : int|null
Return values
bool

get()

public get(string $key[, mixed|null $default = null ]) : mixed|null
Parameters
$key : string
$default : mixed|null = null
Tags
throws
InvalidArgumentException
Return values
mixed|null

getMultiple()

public getMultiple(iterable<string|int, mixed> $keys[, mixed|null $default = null ]) : iterable<string|int, mixed>
Parameters
$keys : iterable<string|int, mixed>
$default : mixed|null = null
Tags
throws
InvalidArgumentException
Return values
iterable<string|int, mixed>

set()

public set(string $key, mixed $value[, null|int|DateInterval $ttl = null ]) : bool
Parameters
$key : string
$value : mixed
$ttl : null|int|DateInterval = null
Tags
throws
InvalidArgumentException
Return values
bool

setMultiple()

public setMultiple(iterable<string|int, mixed> $values[, null|int|DateInterval $ttl = null ]) : bool
Parameters
$values : iterable<string|int, mixed>
$ttl : null|int|DateInterval = null
Tags
throws
InvalidArgumentException
Return values
bool

setValidation()

public setValidation(bool $validation) : void
Parameters
$validation : bool

convertTtl()

protected convertTtl(null|int|DateInterval $ttl) : int|null
Parameters
$ttl : null|int|DateInterval
Tags
throws
InvalidArgumentException
Return values
int|null

getDefaultLifetime()

protected getDefaultLifetime() : int|null
Return values
int|null

getNamespace()

protected getNamespace() : string
Return values
string

init()

Always call from constructor.

protected init([string $namespace = '' ][, null|int|DateInterval $defaultLifetime = null ]) : void
Parameters
$namespace : string = ''
$defaultLifetime : null|int|DateInterval = null
Tags
throws
InvalidArgumentException

        
On this page

Search results