Chill-project/chill-bundles
6
0
Fork 0
mirror of https://gitlab.com/Chill-Projet/chill-bundles.git synced 2025-06-07 18:44:08 +00:00
Code Issues Actions Projects Releases Wiki Activity

fix grammar + improve comprehension

Browse Source
This commit is contained in:
Julien Fastré 2016-03-15 10:21:11 +01:00
parent 2b0bb364f5
commit 8eacdbc5fa
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
source/development/user-interface/delegated-blocks.rst
View File

@ -18,8 +18,8 @@ Examples :
This is possible using `the symfony dispatcher event <http://symfony.com/doc/current/components/event_dispatcher/index.html>`_. This is possible using `the symfony dispatcher event <http://symfony.com/doc/current/components/event_dispatcher/index.html>`_.
Inserting a delegated block inside of a template Inserting a delegated block inside a template
================================================ ==============================================
Use the twig function :code:`chill_delegated_block`. Use the twig function :code:`chill_delegated_block`.
@ -27,10 +27,12 @@ Example :
.. code-block:: html+jinja .. code-block:: html+jinja
{{ chill_delegated_block('my_block', { 'person': person }) }} <div class="my_block">{{ chill_delegated_block('my_block', { 'person': person }) }}</div>
In this example, the block name is :code:`my_block`, and the context is an array : :code:`{ 'person': person }`. In this example, the block name is :code:`my_block`, and the context is an array : :code:`{ 'person': person }`.
The :code:`div` will be filled with the html produced by the bundles which suscribed to the event :code:`chill_block.my_block`.
Subscribing to a delegated block Subscribing to a delegated block
================================= =================================
@ -40,6 +42,10 @@ You should listen to the event :code:`chill_block.block_name`, where `block_name
The event passed as argument will be an instance of :class:`Chill\MainBundle\Templating\Events\DelegatedBlockRenderingEvent`. The context will be available as an array, as described in subscriber example. You may add content to the page using the :method:`Chill\MainBundle\Templating\Events\DelegatedBlockRenderingEvent::addContent` method. The event passed as argument will be an instance of :class:`Chill\MainBundle\Templating\Events\DelegatedBlockRenderingEvent`. The context will be available as an array, as described in subscriber example. You may add content to the page using the :method:`Chill\MainBundle\Templating\Events\DelegatedBlockRenderingEvent::addContent` method.
.. warning::
The code inserted by the function :code:`chill_delegated_block` **should be html safe**. You are encouraged to use an instance of the templating engine (aka Twig) to produce clean html.
Example : Example :
.. code-block:: php .. code-block:: php