CI_Cache
===============

CodeIgniter Caching Class

This class enables you to create "Driver" libraries that add runtime ability
to extend the capabilities of a class via additional driver objects


* Class name: CI_Cache
* Namespace: 
* Parent class: [CI_Driver_Library](CI_Driver_Library.md)


Properties
----------


### $valid_drivers

    protected array $valid_drivers = array()

Array of drivers that are available to use with the driver class


* Visibility: **protected**


### $_cache_path

    protected string $_cache_path = NULL

Path of cache files (if file-based cache)


* Visibility: **protected**


### $_adapter

    protected mixed $_adapter = 'dummy'

Reference to the driver


* Visibility: **protected**


### $_backup_driver

    protected string $_backup_driver = 'dummy'

Fallback driver


* Visibility: **protected**


### $key_prefix

    public string $key_prefix = ''

Cache key prefix


* Visibility: **public**


### $lib_name

    protected string $lib_name

Name of the current class - usually the driver class


* Visibility: **protected**


Methods
-------


### __construct

    void CI_Cache::__construct(array $config)

Constructor

Initialize class properties based on the configuration array.

* Visibility: **public**


#### Arguments
* $config **array** - &lt;p&gt;= array()&lt;/p&gt;


### get

    mixed CI_Cache::get(string $id)

Get

Look for a value in the cache. If it exists, return the data
if not, return FALSE

* Visibility: **public**


#### Arguments
* $id **string**


### save

    boolean CI_Cache::save(string $id, mixed $data, integer $ttl, boolean $raw)

Cache Save


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;Cache ID&lt;/p&gt;
* $data **mixed** - &lt;p&gt;Data to store&lt;/p&gt;
* $ttl **integer** - &lt;p&gt;Cache TTL (in seconds)&lt;/p&gt;
* $raw **boolean** - &lt;p&gt;Whether to store the raw value&lt;/p&gt;


### delete

    boolean CI_Cache::delete(string $id)

Delete from Cache


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;Cache ID&lt;/p&gt;


### increment

    mixed CI_Cache::increment(string $id, integer $offset)

Increment a raw value


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;Cache ID&lt;/p&gt;
* $offset **integer** - &lt;p&gt;Step/value to add&lt;/p&gt;


### decrement

    mixed CI_Cache::decrement(string $id, integer $offset)

Decrement a raw value


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;Cache ID&lt;/p&gt;
* $offset **integer** - &lt;p&gt;Step/value to reduce by&lt;/p&gt;


### clean

    boolean CI_Cache::clean()

Clean the cache


* Visibility: **public**


### cache_info

    mixed CI_Cache::cache_info(string $type)

Cache Info


* Visibility: **public**


#### Arguments
* $type **string** - &lt;p&gt;= &#039;user&#039;    user/filehits&lt;/p&gt;


### get_metadata

    mixed CI_Cache::get_metadata(string $id)

Get Cache Metadata


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;key to get cache metadata on&lt;/p&gt;


### is_supported

    array CI_Cache::is_supported(string $driver)

Is the requested driver supported in this environment?


* Visibility: **public**


#### Arguments
* $driver **string** - &lt;p&gt;The driver to test&lt;/p&gt;


### __get

    object CI_Driver_Library::__get($child)

Get magic method

The first time a child is used it won't exist, so we instantiate it
subsequents calls will go straight to the proper child.

* Visibility: **public**
* This method is defined by [CI_Driver_Library](CI_Driver_Library.md)


#### Arguments
* $child **mixed**


### load_driver

    object CI_Driver_Library::load_driver($child)

Load driver

Separate load_driver call to support explicit driver load by library or user

* Visibility: **public**
* This method is defined by [CI_Driver_Library](CI_Driver_Library.md)


#### Arguments
* $child **mixed**