@@ -406,7 +406,8 @@ kernel.cache_warmer
406
406
**Purpose**: Register your service to be called during the cache warming process
407
407
408
408
Cache warming occurs whenever you run the ``cache:warmup`` or ``cache:clear``
409
- task (unless you pass ``--no-warmup`` to ``cache:clear``). The purpose is
409
+ task (unless you pass ``--no-warmup`` to ``cache:clear``). It is also run when
410
+ handling the request, if it wasn't done by one of the commands yet. The purpose is
410
411
to initialize any cache that will be needed by the application and prevent
411
412
the first user from any significant " cache hit" where the cache is generated
412
413
dynamically.
@@ -423,7 +424,7 @@ the :class:`Symfony\\Component\\HttpKernel\\CacheWarmer\\CacheWarmerInterface` i
423
424
{
424
425
public function warmUp($cacheDir)
425
426
{
426
- // do some sort of operations to " warm" your cache
427
+ // ... do some sort of operations to " warm" your cache
427
428
}
428
429
429
430
public function isOptional()
@@ -433,8 +434,9 @@ the :class:`Symfony\\Component\\HttpKernel\\CacheWarmer\\CacheWarmerInterface` i
433
434
}
434
435
435
436
The ``isOptional`` method should return true if it's possible to use the
436
- application without calling this cache warmer. In Symfony 2.0, optional warmers
437
- are always executed anyways, so this function has no real effect.
437
+ application without calling this cache warmer. In Symfony, optional warmers
438
+ are always executed by default (you can change this by using the
439
+ ``--no-optional-warmers`` option when executing the command).
438
440
439
441
To register your warmer with Symfony, give it the ``kernel.cache_warmer`` tag:
440
442
0 commit comments