CacheWarmerAggregate.php in Zircon Profile 8.0

Namespace

Symfony\Component\HttpKernel\CacheWarmer

File

vendor/symfony/http-kernel/CacheWarmer/CacheWarmerAggregate.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\HttpKernel\CacheWarmer;


/**
 * Aggregates several cache warmers into a single one.
 *
 * @author Fabien Potencier <[e-mail]>
 */
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;
  }

}

Classes

Name	Description
CacheWarmerAggregate	Aggregates several cache warmers into a single one.