class CacheWarmerAggregate in Zircon Profile 8

Aggregates several cache warmers into a single one.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerAggregate implements CacheWarmerInterface

1 file declares its use of CacheWarmerAggregate

CacheWarmerAggregateTest.php in vendor/symfony/http-kernel/Tests/CacheWarmer/CacheWarmerAggregateTest.php

File

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

Namespace

Symfony\Component\HttpKernel\CacheWarmer

class CacheWarmerAggregate implements CacheWarmerInterface {
  protected $warmers = array();
  protected $optionalsEnabled = false;
  public function __construct(array $warmers = array()) {
    foreach ($warmers as $warmer) {
      $this
        ->add($warmer);
    }
  }
  public function enableOptionalWarmers() {
    $this->optionalsEnabled = true;
  }

  /**
   * Warms up the cache.
   *
   * @param string $cacheDir The cache directory
   */
  public function warmUp($cacheDir) {
    foreach ($this->warmers as $warmer) {
      if (!$this->optionalsEnabled && $warmer
        ->isOptional()) {
        continue;
      }
      $warmer
        ->warmUp($cacheDir);
    }
  }

  /**
   * Checks whether this warmer is optional or not.
   *
   * @return bool always false
   */
  public function isOptional() {
    return false;
  }
  public function setWarmers(array $warmers) {
    $this->warmers = array();
    foreach ($warmers as $warmer) {
      $this
        ->add($warmer);
    }
  }
  public function add(CacheWarmerInterface $warmer) {
    $this->warmers[] = $warmer;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheWarmerAggregate::$optionalsEnabled	protected	property
CacheWarmerAggregate::$warmers	protected	property
CacheWarmerAggregate::add	public	function
CacheWarmerAggregate::enableOptionalWarmers	public	function
CacheWarmerAggregate::isOptional	public	function	Checks whether this warmer is optional or not. Overrides CacheWarmerInterface::isOptional
CacheWarmerAggregate::setWarmers	public	function
CacheWarmerAggregate::warmUp	public	function	Warms up the cache. Overrides WarmableInterface::warmUp
CacheWarmerAggregate::__construct	public	function