Classes List

Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerAggregate

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * 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 <fabien@symfony.com> * * @final since version 3.4 */
class CacheWarmerAggregate implements CacheWarmerInterface
{
    protected $warmers = array();
    protected $optionalsEnabled = false;
    private $triggerDeprecation = false;

    public function __construct($warmers = array())
    {
        foreach ($warmers as $warmer) {
            $this->add($warmer);
        }
        $this->triggerDeprecation = true;
    }

    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;
    }

    /** * @deprecated since version 3.4, to be removed in 4.0, inject the list of clearers as a constructor argument instead. */
    public function setWarmers(array $warmers)
    {
        @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 3.4 and will be removed in 4.0, inject the list of clearers as a constructor argument instead.'__METHOD__), E_USER_DEPRECATED);

        $this->warmers = array();
        foreach ($warmers as $warmer) {
            $this->add($warmer);
        }
    }

    /** * @deprecated since version 3.4, to be removed in 4.0, inject the list of clearers as a constructor argument instead. */
    public function add(CacheWarmerInterface $warmer)
    {
        if ($this->triggerDeprecation) {
            @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 3.4 and will be removed in 4.0, inject the list of clearers as a constructor argument instead.'__METHOD__), E_USER_DEPRECATED);
        }

        $this->warmers[] = $warmer;
    }
}