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  *

    16  * @author Fabien Potencier <fabien@symfony.com>

    17  */

    18 interface CacheWarmerInterface

    19 {

    20     /**

    21      * Warms up the cache.

    22      *

    23      * @param string $cacheDir The cache directory

    24      */

    25     function warmUp($cacheDir);

    26 

    27     /**

    28      * Checks whether this warmer is optional or not.

    29      *

    30      * Optional warmers can be ignored on certain conditions.

    31      *

    32      * A warmer should return true if the cache can be

    33      * generated incrementally and on-demand.

    34      *

    35      * @return Boolean true if the warmer is optional, false otherwise

    36      */

    37     function isOptional();

    38 }