CacheWarmerInterface.php 820 B

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