Grid_Cache
Handles the caching for document grids.
Tags
Table of Contents
- GRID_CACHE_EXPIRY = DAY_IN_SECONDS
- $args : mixed
- $id : mixed
- $query : mixed
- __construct() : mixed
- Constructor.
- add_grid() : mixed
- Add a Grid to the cache.
- get_grid() : false|Document_Grid
- Retrieve a Grid from the cache.
- update_grid() : mixed
- Update a Grid in the cache.
- get_grid_cache_key() : mixed
- Get the Grid cache key.
Constants
GRID_CACHE_EXPIRY
public
mixed
GRID_CACHE_EXPIRY
= DAY_IN_SECONDS
Tags
Properties
$args
public
mixed
$args
Tags
$id
public
mixed
$id
Tags
$query
public
mixed
$query
Tags
Methods
__construct()
Constructor.
public
__construct(mixed $id, Table_Args $args, Grid_Query $query) : mixed
Parameters
- $id : mixed
- $args : Table_Args
- $query : Grid_Query
Tags
Return values
mixed —add_grid()
Add a Grid to the cache.
public
add_grid() : mixed
Tags
Return values
mixed —get_grid()
Retrieve a Grid from the cache.
public
static get_grid(mixed $id) : false|Document_Grid
Parameters
- $id : mixed
Tags
Return values
false|Document_Grid —update_grid()
Update a Grid in the cache.
public
update_grid([bool $update_totals = false ]) : mixed
Parameters
- $update_totals : bool = false
Tags
Return values
mixed —get_grid_cache_key()
Get the Grid cache key.
private
get_grid_cache_key() : mixed