class CI_Cache
-
is_supported($driver)
-
Parameters: - $driver (string) – the name of the caching driver
Returns: TRUE if supported, FALSE if not
Return type: bool
This method is automatically called when accessing drivers via
$this->cache->get()
. However, if the individual drivers are used, make sure to call this method to ensure the driver is supported in the hosting environment.1234567if
(
$this
->cache->apc->is_supported())
{
if
(
$data
=
$this
->cache->apc->get(
'my_cache'
))
{
// do things.
}
}
-
get($id)
-
Parameters: - $id (string) – Cache item name
Returns: Item value or FALSE if not found
Return type: mixed
This method will attempt to fetch an item from the cache store. If the item does not exist, the method will return FALSE.
1$foo
=
$this
->cache->get(
'my_cached_item'
);
-
save($id, $data[, $ttl = 60[, $raw = FALSE]])
-
Parameters: - $id (string) – Cache item name
- $data (mixed) – the data to save
- $ttl (int) – Time To Live, in seconds (default 60)
- $raw (bool) – Whether to store the raw value
Returns: TRUE on success, FALSE on failure
Return type: string
This method will save an item to the cache store. If saving fails, the method will return FALSE.
1$this
->cache->save(
'cache_item_id'
,
'data_to_cache'
);
Note
The
$raw
parameter is only utilized by APC and Memcache, in order to allow usage ofincrement()
anddecrement()
.
-
delete($id)
-
Parameters: - $id (string) – name of cached item
Returns: TRUE on success, FALSE on failure
Return type: bool
This method will delete a specific item from the cache store. If item deletion fails, the method will return FALSE.
1$this
->cache->
delete
(
'cache_item_id'
);
-
increment($id[, $offset = 1])
-
Parameters: - $id (string) – Cache ID
- $offset (int) – Step/value to add
Returns: New value on success, FALSE on failure
Return type: mixed
Performs atomic incrementation of a raw stored value.
12345// 'iterator' has a value of 2
$this
->cache->increment(
'iterator'
);
// 'iterator' is now 3
$this
->cache->increment(
'iterator'
, 3);
// 'iterator' is now 6
-
decrement($id[, $offset = 1])
-
Parameters: - $id (string) – Cache ID
- $offset (int) – Step/value to reduce by
Returns: New value on success, FALSE on failure
Return type: mixed
Performs atomic decrementation of a raw stored value.
12345// 'iterator' has a value of 6
$this
->cache->decrement(
'iterator'
);
// 'iterator' is now 5
$this
->cache->decrement(
'iterator'
, 2);
// 'iterator' is now 3
-
clean()
-
Returns: TRUE on success, FALSE on failure Return type: bool This method will ‘clean’ the entire cache. If the deletion of the cache files fails, the method will return FALSE.
1$this
->cache->clean();
-
cache_info()
-
Returns: Information on the entire cache database Return type: mixed This method will return information on the entire cache.
1var_dump(
$this
->cache->cache_info());
Note
The information returned and the structure of the data is dependent on which adapter is being used.
-
get_metadata($id)
-
Parameters: - $id (string) – Cache item name
Returns: Metadata for the cached item
Return type: mixed
This method will return detailed information on a specific item in the cache.
1var_dump(
$this
->cache->get_metadata(
'my_cached_item'
));
Note
The information returned and the structure of the data is dependent on which adapter is being used.
Please login to continue.