AbstractAdapter
in package
implements
AdapterInterface
Cache adapter abstract class
Tags
Interfaces, Classes and Traits
- AdapterInterface
- Cache adapter interface
Table of Contents
- $ttl : int
- Global time-to-live
- __construct() : mixed
- Constructor
- clear() : void
- Clear all stored values from cache
- deleteItem() : void
- Delete a value in cache
- destroy() : void
- 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
- saveItem() : void
- Save an item to cache
- setTtl() : AbstractAdapter
- Set the global time-to-live for the cache adapter
Properties
$ttl
Global time-to-live
protected
int
$ttl
= 0
Methods
__construct()
Constructor
public
__construct(int $ttl) : mixed
Instantiate the cache adapter object
Parameters
- $ttl : int
Return values
mixed —clear()
Clear all stored values from cache
public
abstract clear() : void
Return values
void —deleteItem()
Delete a value in cache
public
abstract deleteItem(string $id) : void
Parameters
- $id : string
Return values
void —destroy()
Destroy cache resource
public
abstract destroy() : void
Return values
void —getItem()
Get an item from cache
public
abstract getItem(string $id) : mixed
Parameters
- $id : string
Return values
mixed —getItemTtl()
Get the time-to-live for an item in cache
public
abstract getItemTtl(string $id) : int
Parameters
- $id : string
Return values
int —getTtl()
Get the global time-to-live for the cache object
public
getTtl() : int
Return values
int —hasItem()
Determine if the item exist in cache
public
abstract hasItem(string $id) : bool
Parameters
- $id : string
Return values
bool —saveItem()
Save an item to cache
public
abstract saveItem(string $id, mixed $value[, int $ttl = null ]) : void
Parameters
- $id : string
- $value : mixed
- $ttl : int = null
Return values
void —setTtl()
Set the global time-to-live for the cache adapter
public
setTtl(int $ttl) : AbstractAdapter
Parameters
- $ttl : int