Skip to content

Added kernel.cache_clearer tag to the reference #2608

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2013
Merged

Added kernel.cache_clearer tag to the reference #2608

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions reference/dic_tags.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ the AsseticBundle has several tags that aren't listed here.
+-----------------------------------+---------------------------------------------------------------------------+
| `form.type_guesser`_ | Add your own logic for "form type guessing" |
+-----------------------------------+---------------------------------------------------------------------------+
| `kernel.cache_clearer`_ | Register your service to be called during the cache clearing process |
+-----------------------------------+---------------------------------------------------------------------------+
| `kernel.cache_warmer`_ | Register your service to be called during the cache warming process |
+-----------------------------------+---------------------------------------------------------------------------+
| `kernel.event_listener`_ | Listen to different events/hooks in Symfony |
Expand Down Expand Up @@ -144,6 +146,57 @@ tag its service definition with ``form.type_guesser`` (it has no options).
To see an example of how this class might look, see the ``ValidatorTypeGuesser``
class in the ``Form`` component.

kernel.cache_clearer
--------------------

**Purpose**: Register your service to be called during the cache clearing process

Cache clearing occurs whenever you call ``cache:clear`` command. If your
bundle caches files, you should add custom cache clearer for clearing those
files during the cache clearing process.

In order to register your custom cache clearer, first you must create a
service class::

// src/Acme/MainBundle/Cache/MyClearer.php
namespace Acme\MainBundle\Cache;

use Symfony\Component\HttpKernel\CacheClearer\CacheClearerInterface;

class MyClearer implements CacheClearerInterface
{
public function clear($cacheDir)
{
// clear your cache
}

}

Then register this class and tag it with ``kernel.cache:clearer``:

.. configuration-block::

.. code-block:: yaml

services:
my_cache_clearer:
class: Acme\MainBundle\Cache\MyClearer
tags:
- { name: kernel.cache_clearer }

.. code-block:: xml

<service id="my_cache_clearer" class="Acme\MainBundle\Cache\MyClearer">
<tag name="kernel.cache_clearer" />
</service>

.. code-block:: php

$container
->register('my_cache_clearer', 'Acme\MainBundle\Cache\MyClearer')
->addTag('kernel.cache_clearer')
;

kernel.cache_warmer
-------------------

Expand Down