CacheWarmerInterface
extends
WarmableInterface
in
Interface for classes able to warm up the cache.
Tags
Table of Contents
- isOptional() : bool
- Checks whether this warmer is optional or not.
- warmUp() : mixed
- Warms up the cache.
Methods
isOptional()
Checks whether this warmer is optional or not.
public
isOptional() : bool
Optional warmers can be ignored on certain conditions.
A warmer should return true if the cache can be generated incrementally and on-demand.
Return values
bool —true if the warmer is optional, false otherwise
warmUp()
Warms up the cache.
public
warmUp(string $cacheDir) : mixed
Parameters
- $cacheDir : string
-
The cache directory