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


* Class name: CI_Cache_file
* Namespace: 
* Parent class: [CI_Driver](CI_Driver.md)


Properties
----------


### $_cache_path

    protected string $_cache_path

Directory in which to save cache files


* Visibility: **protected**


### $_parent

    protected object $_parent

Instance of the parent class


* Visibility: **protected**


### $_methods

    protected array $_methods = array()

List of methods in the parent class


* Visibility: **protected**


### $_properties

    protected array $_properties = array()

List of properties in the parent class


* Visibility: **protected**


### $_reflections

    protected array $_reflections = array()

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


* Visibility: **protected**
* This property is **static**.


Methods
-------


### __construct

    void CI_Cache_file::__construct()

Initialize file-based cache


* Visibility: **public**


### get

    mixed CI_Cache_file::get(string $id)

Fetch from cache


* Visibility: **public**


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


### save

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

Save into cache


* 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;Time to live in seconds&lt;/p&gt;
* $raw **boolean** - &lt;p&gt;Whether to store the raw value (unused)&lt;/p&gt;


### delete

    boolean CI_Cache_file::delete($id)

Delete from Cache


* Visibility: **public**


#### Arguments
* $id **mixed**


### increment

    \New CI_Cache_file::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

    \New CI_Cache_file::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_file::clean()

Clean the Cache


* Visibility: **public**


### cache_info

    mixed CI_Cache_file::cache_info($type)

Cache Info

Not supported by file-based caching

* Visibility: **public**


#### Arguments
* $type **mixed**


### get_metadata

    mixed CI_Cache_file::get_metadata($id)

Get Cache Metadata


* Visibility: **public**


#### Arguments
* $id **mixed**


### is_supported

    boolean CI_Cache_file::is_supported()

Is supported

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

* Visibility: **public**


### _get

    mixed CI_Cache_file::_get(string $id)

Get all data

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

* Visibility: **protected**


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


### decorate

    void CI_Driver::decorate($parent)

Decorate

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

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


#### Arguments
* $parent **mixed**


### __call

    mixed CI_Driver::__call($method, $args)

__call magic method

Handles access to the parent driver library's methods

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


#### Arguments
* $method **mixed**
* $args **mixed**


### __get

    mixed CI_Driver::__get($var)

__get magic method

Handles reading of the parent driver library's properties

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


#### Arguments
* $var **mixed**


### __set

    mixed CI_Driver::__set($var, $val)

__set magic method

Handles writing to the parent driver library's properties

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


#### Arguments
* $var **mixed**
* $val **mixed**