interface CacheWarmerInterface implements WarmableInterface

Interface for classes able to warm up the cache.

Methods

warmUp(string $cacheDir)

Warms up the cache.

bool
isOptional()

Checks whether this warmer is optional or not.

Details

in WarmableInterface at line line 26
warmUp(string $cacheDir)

Warms up the cache.

Parameters

string $cacheDir The cache directory

at line line 31
bool isOptional()

Checks whether this warmer is optional or not.

Optional warmers can be ignored on certain conditions.

A warmer should return true if the cache can be generated incrementally and on-demand.

Return Value

bool true if the warmer is optional, false otherwise