PHP Interface Webiny\Component\Rest\Compiler\CacheDrivers\CacheDriverInterface

Show file Open project: Webiny/Framework Interface Usage Examples

Public Methods

Method	Description
delete ( $api, $class )	Delete the cache for the given api and class.
isFresh ( $api, $class, $version, $ttl ) : boolean	Checks if the cache is still fresh based on the given ttl.
read ( $api, $class, $version ) : boolean \| array	Read the compiled cache array.
save ( $api, $class, $version, $cacheArray )	Save the compiled cache array.

Method Details

delete() public method

Delete the cache for the given api and class.

public delete ( $api, $class )
$api		Name of the API.
$class		Name of the class.

isFresh() public method

Checks if the cache is still fresh based on the given ttl.

public isFresh ( $api, $class, $version, $ttl ) : boolean
$api		Name of the API.
$class		Name of the class.
$version		Version of the class.
$ttl		Unix timestamp against which the cache ttl should be compared.
return	boolean	Returns true if cache is till fresh, otherwise false.

read() public method

Read the compiled cache array.

public read ( $api, $class, $version ) : boolean \| array
$api		Name of the API.
$class		Name of the class.
$version		Version of the class.
return	boolean \| array	Returns the compiled cache array, or false if cache is not found.

save() public method

Save the compiled cache array.

public save ( $api, $class, $version, $cacheArray )
$api		Name of the API.
$class		Name of the class.
$version		Version of the class.
$cacheArray		The compiled class cache array.