Documentation

NoCache
in package
implements CacheInterface

A cache implementation that doesn't cache anything; to be passed as the $cache parameter of Prismic\Api::get when you don't want any caching.

This documentation right here introduces what the functions are supposed to do if there is a cache involved, even though in this class in particular, they all simply do nothing and return false.

Interfaces, Classes, Traits and Enums

CacheInterface
This is the interface you're supposed to implement if you want to use your own caching strategy with the kit.

Table of Contents

clear()  : void
Clears the whole cache
delete()  : void
Deletes a cache entry, from its key
get()  : mixed
Returns the value of a cache entry from its key
has()  : bool
Tests whether the cache has a value for a particular key
set()  : void
Stores a new cache entry

Methods

clear()

Clears the whole cache

public clear() : void
Return values
void

delete()

Deletes a cache entry, from its key

public delete(string $key) : void
Parameters
$key : string

the key of the cache entry

Return values
void

get()

Returns the value of a cache entry from its key

public get(string $key) : mixed
Parameters
$key : string

the key of the cache entry

Return values
mixed

the value of the entry, as it was passed to CacheInterface::set, null if not present in cache

has()

Tests whether the cache has a value for a particular key

public has(string $key) : bool
Parameters
$key : string

the key of the cache entry

Return values
bool

true if the cache has a value for this key, otherwise false

set()

Stores a new cache entry

public set(string $key, stdClass $value[, int $ttl = null ]) : void
Parameters
$key : string

the key of the cache entry

$value : stdClass

the value of the entry

$ttl : int = null

the time until this cache entry expires

Return values
void

Search results