W3cubDocs

/Symfony 3.3

CacheWarmerInterface

interface CacheWarmerInterface implements WarmableInterface

Interface for classes able to warm up the cache.

Methods

warmUp(string $cacheDir)

Warms up the cache.

from WarmableInterface
bool isOptional()

Checks whether this warmer is optional or not.

Details

warmUp(string $cacheDir)

Warms up the cache.

Parameters

string $cacheDir The cache directory

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

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Component/HttpKernel/CacheWarmer/CacheWarmerInterface.html