AbstractAdapter
in package
implements
AdapterInterface
AbstractYes
Cache adapter abstract class
Tags
Table of Contents
Interfaces
- AdapterInterface
- Cache adapter interface
Properties
- $clock : ClockInterface
- Clock used to resolve the current time
- $ttl : int
- Global time-to-live
Methods
- __construct() : mixed
- Constructor
- clear() : AbstractAdapter
- Clear all stored values from cache
- decrementItem() : int
- Atomically decrement a counter in cache, creating it at $initial if it doesn't exist
- deleteItem() : AbstractAdapter
- Delete a value in cache
- destroy() : AbstractAdapter
- Destroy cache resource
- getItem() : mixed
- Get an item from cache
- getItemTtl() : int
- Get the time-to-live for an item in cache
- getTtl() : int
- Get the global time-to-live for the cache object
- hasItem() : bool
- Determine if the item exist in cache
- incrementItem() : int
- Atomically increment a counter in cache, creating it at $initial if it doesn't exist
- saveItem() : AbstractAdapter
- Save an item to cache
- setTtl() : AbstractAdapter
- Set the global time-to-live for the cache adapter
- isFresh() : bool
- Determine if a cache envelope (with 'start'/'ttl' keys) is still within its time-to-live
Properties
$clock
Clock used to resolve the current time
protected
ClockInterface
$clock
$ttl
Global time-to-live
protected
int
$ttl
= 0
Methods
__construct()
Constructor
public
__construct([int $ttl = 0 ][, ClockInterface $clock = new ClockSystemClock() ]) : mixed
Instantiate the cache adapter object
Parameters
- $ttl : int = 0
- $clock : ClockInterface = new ClockSystemClock()
clear()
Clear all stored values from cache
public
abstract clear() : AbstractAdapter
Return values
AbstractAdapterdecrementItem()
Atomically decrement a counter in cache, creating it at $initial if it doesn't exist
public
abstract decrementItem(string $id[, int $amount = 1 ][, int $initial = 0 ][, int|null $ttl = null ]) : int
Parameters
- $id : string
- $amount : int = 1
- $initial : int = 0
- $ttl : int|null = null
Return values
intdeleteItem()
Delete a value in cache
public
abstract deleteItem(string $id) : AbstractAdapter
Parameters
- $id : string
Return values
AbstractAdapterdestroy()
Destroy cache resource
public
abstract destroy() : AbstractAdapter
Return values
AbstractAdaptergetItem()
Get an item from cache
public
abstract getItem(string $id[, mixed $default = false ]) : mixed
Parameters
- $id : string
- $default : mixed = false
getItemTtl()
Get the time-to-live for an item in cache
public
abstract getItemTtl(string $id[, int $default = 0 ]) : int
Parameters
- $id : string
- $default : int = 0
Return values
intgetTtl()
Get the global time-to-live for the cache object
public
getTtl() : int
Return values
inthasItem()
Determine if the item exist in cache
public
abstract hasItem(string $id) : bool
Parameters
- $id : string
Return values
boolincrementItem()
Atomically increment a counter in cache, creating it at $initial if it doesn't exist
public
abstract incrementItem(string $id[, int $amount = 1 ][, int $initial = 0 ][, int|null $ttl = null ]) : int
Parameters
- $id : string
- $amount : int = 1
- $initial : int = 0
- $ttl : int|null = null
Return values
intsaveItem()
Save an item to cache
public
abstract saveItem(string $id, mixed $value[, int|null $ttl = null ]) : AbstractAdapter
Parameters
- $id : string
- $value : mixed
- $ttl : int|null = null
Return values
AbstractAdaptersetTtl()
Set the global time-to-live for the cache adapter
public
setTtl(int $ttl) : AbstractAdapter
Parameters
- $ttl : int
Return values
AbstractAdapterisFresh()
Determine if a cache envelope (with 'start'/'ttl' keys) is still within its time-to-live
protected
isFresh(array<string|int, mixed> $envelope) : bool
Parameters
- $envelope : array<string|int, mixed>