CodeIgniter v3.0.0 API
\

\CI_Cache_file

CodeIgniter File Caching Class

This class enables you to create drivers for a Library based on the Driver Library. It handles the drivers' access to the parent library

Summary

Methods
Properties
Constants
decorate()
__call()
__get()
__set()
__construct()
get()
save()
delete()
increment()
decrement()
clean()
cache_info()
get_metadata()
is_supported()
No public properties found
No constants found
_get()
$_parent
$_methods
$_properties
$_reflections
$_cache_path
N/A
No private methods found
No private properties found
N/A

Properties

$_parent

$_parent : object

Instance of the parent class

Type

object

$_methods

$_methods : array

List of methods in the parent class

Type

array

$_properties

$_properties : array

List of properties in the parent class

Type

array

$_reflections

$_reflections : array

Array of methods and properties for the parent class(es)

Type

array

$_cache_path

$_cache_path : string

Directory in which to save cache files

Type

string

Methods

decorate()

decorate(  $parent) : void

Decorate

Decorates the child with the parent driver lib's methods and properties

Parameters

$parent

__call()

__call(  $method,   $args = array()) : mixed

__call magic method

Handles access to the parent driver library's methods

Parameters

$method
$args

Returns

mixed

__get()

__get(  $var) : mixed

__get magic method

Handles reading of the parent driver library's properties

Parameters

$var

Returns

mixed

__set()

__set(  $var,   $val) : mixed

__set magic method

Handles writing to the parent driver library's properties

Parameters

$var
$val

Returns

mixed

__construct()

__construct() : void

Initialize file-based cache

get()

get(string  $id) : mixed

Fetch from cache

Parameters

string $id

Cache ID

Returns

mixed —

Data on success, FALSE on failure

save()

save(string  $id, mixed  $data, integer  $ttl = 60, boolean  $raw = FALSE) : boolean

Save into cache

Parameters

string $id

Cache ID
mixed $data

Data to store
integer $ttl

Time to live in seconds
boolean $raw

Whether to store the raw value (unused)

Returns

boolean —

TRUE on success, FALSE on failure

delete()

delete(  $id) : boolean

Delete from Cache

Parameters

$id

Returns

boolean —

true on success/false on failure

increment()

increment(string  $id, integer  $offset = 1) : \New

Increment a raw value

Parameters

string $id

Cache ID
integer $offset

Step/value to add

Returns

\New —

value on success, FALSE on failure

decrement()

decrement(string  $id, integer  $offset = 1) : \New

Decrement a raw value

Parameters

string $id

Cache ID
integer $offset

Step/value to reduce by

Returns

\New —

value on success, FALSE on failure

clean()

clean() : boolean

Clean the Cache

Returns

boolean —

false on failure/true on success

cache_info()

cache_info(  $type = NULL) : mixed

Cache Info

Not supported by file-based caching

Parameters

$type

Returns

mixed —

FALSE

get_metadata()

get_metadata(  $id) : mixed

Get Cache Metadata

Parameters

$id

Returns

mixed —

FALSE on failure, array on success.

is_supported()

is_supported() : boolean

Is supported

In the file driver, check to see that the cache directory is indeed writable

Returns

boolean

_get()

_get(string  $id) : mixed

Get all data

Internal method to get all the relevant data about a cache item

Parameters

string $id

Cache ID

Returns

mixed —

Data array on success or FALSE on failure