Documentation

CacheWarmerInterface extends WarmableInterface

Interface for classes able to warm up the cache.

Tags
author

Fabien Potencier fabien@symfony.com

Table of Contents

isOptional()  : bool
Checks whether this warmer is optional or not.
warmUp()  : array<string|int, string>
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

warmUp()

Warms up the cache.

public warmUp(string $cacheDir) : array<string|int, string>
Parameters
$cacheDir : string
Return values
array<string|int, string>

A list of classes or files to preload on PHP 7.4+

Search results