Interface CacheInterface

Summary

Fully Qualified Name: CodeIgniter\Cache\CacheInterface

Description

Cache interface

Methods

Name Description Defined By
clean() Will delete all items in the entire cache. CacheInterface
decrement() Performs atomic decrementation of a raw stored value. CacheInterface
delete() Deletes a specific item from the cache store. CacheInterface
get() Attempts to fetch an item from the cache store. CacheInterface
getCacheInfo() Returns information on the entire cache. CacheInterface
getMetaData() Returns detailed information about the specific item in the cache. CacheInterface
increment() Performs atomic incrementation of a raw stored value. CacheInterface
initialize() Takes care of any handler-specific setup that must be done. CacheInterface
isSupported() Determines if the driver is supported on this system. CacheInterface
save() Saves an item to the cache store. CacheInterface

Method Details

clean()

Will delete all items in the entire cache.

Returns: mixed

decrement()

Performs atomic decrementation of a raw stored value.

Parameter Name Type Description
$key string Cache
$offset int Step/value

Returns: mixed

delete()

Deletes a specific item from the cache store.

Parameter Name Type Description
$key string Cache

Returns: mixed

get()

Attempts to fetch an item from the cache store.

Parameter Name Type Description
$key string Cache

Returns: mixed

getCacheInfo()

Returns information on the entire cache.

The information returned and the structure of the data varies depending on the handler.

Returns: mixed

getMetaData()

Returns detailed information about the specific item in the cache.

Parameter Name Type Description
$key string Cache

Returns: mixed

increment()

Performs atomic incrementation of a raw stored value.

Parameter Name Type Description
$key string Cache
$offset int Step/value

Returns: mixed

initialize()

Takes care of any handler-specific setup that must be done.

Returns:

isSupported()

Determines if the driver is supported on this system.

Returns: bool

save()

Saves an item to the cache store.

Parameter Name Type Description
$key string Cache
$value mixed The
$ttl int Time

Returns: mixed

Top