Merge pull request #449 from symfony-cmf/cmf-request-aware

dbu · dbu · commit af995a3a96e9 · 2014-04-23T16:38:44.000+02:00
update to removed cmf_request_aware
diff --git a/bundles/core/dependency_injection_tags.rst b/bundles/core/dependency_injection_tags.rst
@@ -4,15 +4,20 @@
 Dependency Injection Tags
 -------------------------
 
-.. _bundle-core-tags-request-aware:
-
 cmf_request_aware
 ~~~~~~~~~~~~~~~~~
 
-If you have services that need the request (e.g. for the publishing workflow
-or current menu item voters), you can tag them with ``cmf_request_aware`` to
-have a kernel listener inject the request. Any class used in such a tagged
-service must have the ``setRequest`` method or you will get a fatal error::
+.. caution::
+
+    This tag has been deprecated in CoreBundle 1.1 and will be removed
+    in CoreBundle 1.2. Since Symfony 2.3, you can profit from the fact
+    that the request is a `synchronized service`_.
+
+When working with the 1.0 version of the CMF in Symfony 2.2 and you have
+services that need the request (e.g. for the publishing workflow or current
+menu item voters), you can tag services with ``cmf_request_aware`` to have a
+kernel listener inject the request. Any class used in such a tagged service
+must have the ``setRequest`` method or you will get a fatal error::
 
     use Symfony\Component\HttpFoundation\Request;
 
@@ -26,20 +31,6 @@ service must have the ``setRequest`` method or you will get a fatal error::
         }
     }
 
-.. caution::
-
-    You should only use this tag on services that will be needed on every
-    request. If you use this tag excessively you will run into performance
-    issues. For seldom used services, you can inject the container in the
-    service definition and call ``$this->container->get('request')`` in your
-    code when you actually need the request.
-
-For Symfony 2.3, this tag is automatically translated to a
-`synchronized service`_ but Symfony 2.2 does not have that feature, so you can
-use this tag for bundles that you want to be able to work with Symfony 2.2. In
-custom applications that run with Symfony 2.3, there is no need for this tag,
-just use the synchronized service feature.
-
 cmf_published_voter
 ~~~~~~~~~~~~~~~~~~~
 
@@ -51,4 +42,4 @@ workflow.
 This tag has the attribute ``priority``. The lower the priority number, the
 earlier the voter gets to vote.
 
-.. _`synchronized service`: http://symfony.com/doc/current/cookbook/service_container/scopes.html#using-a-synchronized-service
+.. _`synchronized service`: http://symfony.com/doc/current/cookbook/service_container/scopes.html#a-using-a-synchronized-service
diff --git a/bundles/menu/voters.rst b/bundles/menu/voters.rst
@@ -19,7 +19,7 @@ unique page and it is perhaps preferable instead to indicate which menu item mos
 
 For example, you are developing a homepage application which features a blog.
 The blog index page has a menu item but there are no menu items for the posts
-associated with the blog and so none of the menu items will be highlighted. 
+associated with the blog and so none of the menu items will be highlighted.
 
 When the user is viewing a blog post you want the menu item for the blog to be
 highlighted. The CMF facilitates this with current item *voter* classes.
@@ -47,7 +47,7 @@ RequestContentIdentityVoter
 This voter looks at the ``content`` field of the menu item extras and compares
 it with the main content attribute of the request. The name for the main
 content attribute in the request is configurable with the ``content_key``
-option - if not set it defaults to the constant 
+option - if not set it defaults to the constant
 ``Symfony\Cmf\Bundle\RoutingBundle\Routing\DynamicRouter::CONTENT_KEY`` (which resolves to ``contentDocument``).
 
 You can enable this voter by adding the ``cmf_menu.voters.content_identity``
@@ -197,9 +197,8 @@ menu item.
 
 To use this voter you need to configure a custom service with the name of the
 content in the request and your model class to avoid calling getParent on
-objects that do not have that method.  You need to tag the service as
-``cmf_menu.voter`` and also as ``cmf_request_aware`` because it
-depends on the request. The service looks the same as for complete custom
+objects that do not have that method. You need to tag the service as
+``cmf_menu.voter``. The service looks the same as for complete custom
 voters (see below), except you do not need to write your own PHP code:
 
 .. configuration-block::
@@ -212,9 +211,10 @@ voters (see below), except you do not need to write your own PHP code:
                 arguments:
                     - contentDocument
                     - "%my_bundle.my_model_class%"
+                calls:
+                    - [setRequest, ["@?request="]]
                 tags:
                     - { name: "cmf_menu.voter" }
-                    - { name: "cmf_request_aware" }
 
     .. code-block:: xml
 
@@ -227,8 +227,15 @@ voters (see below), except you do not need to write your own PHP code:
                          class="Symfony\Cmf\Bundle\MenuBundle\Voter\RequestParentContentIdentityVoter">
                     <argument>contentDocument</argument>
                     <argument>%my_bundle.my_model_class%</argument>
+                    <call method="setRequest">
+                        <argument
+                            type="service"
+                            id="request"
+                            on-invalid="null"
+                            strict="false"
+                        />
+                    </call>
                     <tag name="cmf_menu.voter"/>
-                    <tag name="cmf_request_aware"/>
                 </service>
             </services>
 
@@ -240,8 +247,14 @@ voters (see below), except you do not need to write your own PHP code:
             'Symfony\Cmf\Bundle\MenuBundle\Voter\RequestParentContentIdentityVoter',
             array('contentDocument', '%my_bundle.my_model_class%')
         ));
+        $definition->addMethodCall('setRequest', array(
+            new Reference(
+                'request',
+                ContainerInterface::NULL_ON_INVALID_REFERENCE,
+                false
+            )
+        ));
         $definition->addTag('cmf_menu.voter');
-        $definition->addTag('cmf_request_aware');
 
         $container->setDefinition('my_bundle.menu_voter.parent', $definition);
 
@@ -253,15 +266,6 @@ Custom Voter
 Voters must implement the ``Symfony\Cmf\MenuBundle\Voter\VoterInterface``. To
 make the menu bundle notice the voter, tag it with ``cmf_menu.voter``.
 
-If your voter requires the current ``Request`` object in its decision making
-process you can add the :ref:`synchronized <bundle-core-tags-request-aware>`
-tag to your service container definition. 
-
-.. note::
-
-    This tag is not required for versions of Symfony >= 2.3, see the
-    :ref:`documentation <bundle-core-tags-request-aware>` for more information.
-
 If you need to know the content the menu item points to, look in the
 ``content`` field of the menu item extras: ``$item->getExtra('content');``.
 The ``ContentAwareFactory`` places the content referenced by the route there -
@@ -306,4 +310,3 @@ A voter will look something like this::
             return null;
         }
     }
-
diff --git a/cookbook/creating_a_cms/the-frontend.rst b/cookbook/creating_a_cms/the-frontend.rst
@@ -89,15 +89,15 @@ KnpMenuBundle::
     Don't forget to add the ``Knp\Menu\NodeInterface`` use statement!
 
 Menus are hierarchical, PHPCR-ODM is also hierarchical and so lends itself
-well to this use case. 
+well to this use case.
 
 Here you add an additional mapping, ``@Children``, which will cause PHPCR-ODM
 to populate the annotated property instance ``$children`` with the child
 documents of this document.
 
 The options are the options used by KnpMenu system when rendering the menu.
 The menu URL is inferred from the ``content`` option (note that you added the
-``RouteReferrersReadInterface`` to ``Page`` earlier). 
+``RouteReferrersReadInterface`` to ``Page`` earlier).
 
 The attributes apply to the HTML elements. See the `KnpMenu`_ documentation
 for more information.
@@ -157,28 +157,29 @@ Now you can register the ``PhpcrMenuProvider`` from the menu bundle in the servi
 configuration:
 
 .. configuration-block::
-    
+
     .. code-block:: yaml
 
-         # src/Acme/BasicCmsBundle/Resources/config/config.yml
-         services:
-             acme.basic_cms.menu_provider:
-                 class: Symfony\Cmf\Bundle\MenuBundle\Provider\PhpcrMenuProvider
-                 arguments:
-                     - '@cmf_menu.factory'
-                     - '@doctrine_phpcr'
-                     - /cms/pages
-                 tags:
-                     - { name: knp_menu.provider }
-                     - { name: cmf_request_aware }
+        # src/Acme/BasicCmsBundle/Resources/config/config.yml
+        services:
+            acme.basic_cms.menu_provider:
+                class: Symfony\Cmf\Bundle\MenuBundle\Provider\PhpcrMenuProvider
+                arguments:
+                    - '@cmf_menu.factory'
+                    - '@doctrine_phpcr'
+                    - /cms/pages
+                calls:
+                    - [setRequest, ["@?request="]]
+                tags:
+                    - { name: knp_menu.provider }
 
     .. code-block:: xml
 
         <?xml version="1.0" encoding="UTF-8" ?>
         <container xmlns="http://symfony.com/schema/dic/services"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xmlns:acme_demo="http://www.example.com/symfony/schema/"
-            xsi:schemaLocation="http://symfony.com/schema/dic/services 
+            xsi:schemaLocation="http://symfony.com/schema/dic/services
                 http://symfony.com/schema/dic/services/services-1.0.xsd">
 
             <!-- ... -->
@@ -190,18 +191,25 @@ configuration:
                     <argument type="service" id="cmf_menu.factory"/>
                     <argument type="service" id="doctrine_phpcr"/>
                     <argument>/cms/pages</argument>
+                    <call method="setRequest">
+                        <argument
+                            type="service"
+                            id="request"
+                            on-invalid="null"
+                            strict="false"
+                        />
+                    </call>
                     <tag name="knp_menu.provider" />
-                    <tag name="cmf_request_aware"/>
                 </service>
             </services>
         </container>
-        
+
     .. code-block:: php
 
         // src/Acme/BasicCmsBundle/Resources/config/config.php
         use Symfony\Component\DependencyInjection\Reference;
         // ...
-        
+
         $container
             ->register(
                 'acme.basic_cms.menu_provider',
@@ -210,8 +218,14 @@ configuration:
             ->addArgument(new Reference('cmf_menu.factory'))
             ->addArgument(new Reference('doctrine_phpcr'))
             ->addArgument('/cms/pages')
+            ->addMethodCall('setRequest', array(
+                new Reference(
+                    'request',
+                    ContainerInterface::NULL_ON_INVALID_REFERENCE,
+                    false
+                )
+            ))
             ->addTag('knp_menu.provider')
-            ->addTag('cmf_request_aware')
         ;
 
 and enable the twig rendering functionality of the KnpMenu bundle:
@@ -246,7 +260,7 @@ and finally you can render the menu!
 .. configuration-block::
 
     .. code-block:: jinja
-        
+
         {# src/Acme/BasicCmsBundle/Resources/views/Default/page.html.twig #}
 
         {# ... #}
@@ -255,7 +269,7 @@ and finally you can render the menu!
     .. code-block:: html+php
 
         <!-- src/Acme/BasicCmsBundle/Resources/views/Default/page.html.php -->
-        
+
         <!-- ... -->
         <?php echo $view['knp_menu']->render('main') ?>
 
