AbstractPhpFileCacheWarmer
in package
implements
CacheWarmerInterface
Interfaces, Classes and Traits
- CacheWarmerInterface
- Interface for classes able to warm up the cache.
Table of Contents
- $phpArrayFile : mixed
- __construct() : mixed
- isOptional() : bool
- Checks whether this warmer is optional or not.
- warmUp() : array<string|int, string>
- {@inheritdoc}
- doWarmUp() : bool
- warmUpPhpArrayAdapter() : array<string|int, string>
Properties
$phpArrayFile
private
mixed
$phpArrayFile
Methods
__construct()
public
__construct(string $phpArrayFile) : mixed
Parameters
- $phpArrayFile : string
-
The PHP file where metadata are cached
Return values
mixed —isOptional()
Checks whether this warmer is optional or not.
public
isOptional() : bool
Return values
bool —warmUp()
{@inheritdoc}
public
warmUp(string $cacheDir) : array<string|int, string>
Parameters
- $cacheDir : string
Return values
array<string|int, string> —A list of classes to preload on PHP 7.4+
doWarmUp()
protected
abstract doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter) : bool
Parameters
- $cacheDir : string
- $arrayAdapter : ArrayAdapter
Return values
bool —false if there is nothing to warm-up
warmUpPhpArrayAdapter()
protected
warmUpPhpArrayAdapter(PhpArrayAdapter $phpArrayAdapter, array<string|int, mixed> $values) : array<string|int, string>
Parameters
- $phpArrayAdapter : PhpArrayAdapter
- $values : array<string|int, mixed>
Return values
array<string|int, string> —A list of classes to preload on PHP 7.4+