interface CacheWarmerInterface in Zircon Profile 8

Interface for classes able to warm up the cache.

@author Fabien Potencier <[e-mail]>

Hierarchy

• interface \Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface
  • interface \Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface

File

vendor/symfony/http-kernel/CacheWarmer/CacheWarmerInterface.php, line 19

Namespace

Symfony\Component\HttpKernel\CacheWarmer

interface CacheWarmerInterface extends WarmableInterface {

  /**
   * 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 bool true if the warmer is optional, false otherwise
   */
  public function isOptional();

}

Members

Name	Modifiers	Type	Description	Overrides
CacheWarmerInterface::isOptional	public	function	Checks whether this warmer is optional or not.	2
WarmableInterface::warmUp	public	function	Warms up the cache.	3