# CacheInterface

Chevere\Interfaces\Cache\CacheInterface

# Description

Describes the component in charge of caching PHP variables.

cached.php >>> <?php return 'my cached data';

# Constants

# ILLEGAL_KEY_CHARACTERS

Type string

'\\.\\/\\\\~\\:'

# Methods

# __construct

Parameters

dir: DirInterface

Throws

DirUnableToCreateException if $dir doesn't exists and unable to create

# dir

Provides access to the cache directory.

Return

DirInterface

# withPut

Put item in cache.

Parameters

key: CacheKeyInterface
var: VarStorableInterface

Return

self

Return an instance with the specified put.

This method MUST retain the state of the current instance, and return an instance that contains the specified put.

# without

Remove item from cache.

Parameters

key: CacheKeyInterface

Throws

FileUnableToRemoveException if unable to remove the cache file

Return

self

Return an instance with the specified removed.

This method MUST retain the state of the current instance, and return an instance that contains the specified removed.

# exists

Indicates whether the cache exists for the given key.

Parameters

key: CacheKeyInterface

Return

bool

# get

Get a cache item.

Parameters

key: CacheKeyInterface

Throws

OutOfBoundsException

Return

CacheItemInterface

# puts

Provides access to the array containing puts.

Return

array

return [
     'key' => [
             'checksum' => '<file_checksum>',
             'path' => '<the_file_path>'
     ],
];