CacheWarmerAggregate
in package
implements
CacheWarmerInterface
Aggregates several cache warmers into a single one.
Tags
Interfaces, Classes and Traits
- CacheWarmerInterface
- Interface for classes able to warm up the cache.
Table of Contents
- $optionalsEnabled : mixed
- $warmers : mixed
- $triggerDeprecation : mixed
- __construct() : mixed
- add() : mixed
- enableOptionalWarmers() : mixed
- isOptional() : bool
- Checks whether this warmer is optional or not.
- setWarmers() : mixed
- warmUp() : mixed
- Warms up the cache.
Properties
$optionalsEnabled
protected
mixed
$optionalsEnabled
= false
$warmers
protected
mixed
$warmers
= []
$triggerDeprecation
private
mixed
$triggerDeprecation
= false
Methods
__construct()
public
__construct([mixed $warmers = [] ]) : mixed
Parameters
- $warmers : mixed = []
Return values
mixed —add()
public
add(CacheWarmerInterface $warmer) : mixed
Parameters
- $warmer : CacheWarmerInterface
Tags
Return values
mixed —enableOptionalWarmers()
public
enableOptionalWarmers() : mixed
Return values
mixed —isOptional()
Checks whether this warmer is optional or not.
public
isOptional() : bool
Return values
bool —always false
setWarmers()
public
setWarmers(array<string|int, mixed> $warmers) : mixed
Parameters
- $warmers : array<string|int, mixed>
Tags
Return values
mixed —warmUp()
Warms up the cache.
public
warmUp(string $cacheDir) : mixed
Parameters
- $cacheDir : string
-
The cache directory