From ac0f66d21516a62a0faefef829edb346db07992b Mon Sep 17 00:00:00 2001 From: Wouter J Date: Mon, 17 Mar 2014 16:07:17 +0100 Subject: [PATCH] Updated the description of cache warmers --- reference/dic_tags.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/reference/dic_tags.rst b/reference/dic_tags.rst index cbb8ca4c6a9..8e2658cead6 100644 --- a/reference/dic_tags.rst +++ b/reference/dic_tags.rst @@ -406,7 +406,8 @@ kernel.cache_warmer **Purpose**: Register your service to be called during the cache warming process Cache warming occurs whenever you run the ``cache:warmup`` or ``cache:clear`` -task (unless you pass ``--no-warmup`` to ``cache:clear``). The purpose is +task (unless you pass ``--no-warmup`` to ``cache:clear``). It is also run when +handling the request, if it wasn't done by one of the commands yet. The purpose is to initialize any cache that will be needed by the application and prevent the first user from any significant "cache hit" where the cache is generated dynamically. @@ -423,7 +424,7 @@ the :class:`Symfony\\Component\\HttpKernel\\CacheWarmer\\CacheWarmerInterface` i { public function warmUp($cacheDir) { - // do some sort of operations to "warm" your cache + // ... do some sort of operations to "warm" your cache } public function isOptional() @@ -433,8 +434,9 @@ the :class:`Symfony\\Component\\HttpKernel\\CacheWarmer\\CacheWarmerInterface` i } The ``isOptional`` method should return true if it's possible to use the -application without calling this cache warmer. In Symfony 2.0, optional warmers -are always executed anyways, so this function has no real effect. +application without calling this cache warmer. In Symfony, optional warmers +are always executed by default (you can change this by using the +``--no-optional-warmers`` option when executing the command). To register your warmer with Symfony, give it the ``kernel.cache_warmer`` tag: