www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/http-kernel/CacheWarmer/CacheWarmerInterface.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Symfony\Component\HttpKernel\CacheWarmer;
  13
  14 /**
  15  * Interface for classes able to warm up the cache.
  16  *
  17  * @author Fabien Potencier <fabien@symfony.com>
  18  */
  19 interface CacheWarmerInterface extends WarmableInterface
  20 {
  21     /**
  22      * Checks whether this warmer is optional or not.
  23      *
  24      * Optional warmers can be ignored on certain conditions.
  25      *
  26      * A warmer should return true if the cache can be
  27      * generated incrementally and on-demand.
  28      *
  29      * @return bool true if the warmer is optional, false otherwise
  30      */
  31     public function isOptional();
  32 }