feature #595 [WIP] Tutorial Updates for 1.2 (dantleech)

This PR was submitted for the dev branch but it was merged into the master branch instead (closes #595).

Discussion
----------

[WIP] Tutorial Updates for 1.2

Updates and improvements for 1.2.

Note there is a problem in that the RoutingAutoBundle intializes before the initializer that we create in the last chapter, causing it to fail.

We need to add support for initializer priority: doctrine/DoctrinePHPCRBundle#173

Commits
-------

dc3de60 [WIP] Tutorial Updates for 1.2

Author: wouterj

cookbook/database/create_new_project_phpcr_odm.rst

@@ -36,9 +36,9 @@ content repository.
         ...
         "require": {
             ...
-            "doctrine/phpcr-bundle": "1.2.*",
-            "doctrine/phpcr-odm": "1.2.*",
-            "jackalope/jackalope-doctrine-dbal": "1.2.*"
+            "doctrine/phpcr-bundle": "~1.2",
+            "doctrine/phpcr-odm": "~1.2",
+            "jackalope/jackalope-doctrine-dbal": "~1.1,>=1.1.2"
         }
     }
 

tutorial/content-to-controllers.rst

@@ -32,6 +32,12 @@ document::
         // ...
     } 
 
+And clear your cache:
+
+.. code-block:: bash
+
+    $ php app/console cache:clear
+
 Now you can call the method ``getRoutes`` on either ``Page`` or ``Post`` and retrieve all the
 routes which refer to that document ... pretty cool!
 
@@ -122,7 +128,7 @@ object and all the ``Posts`` to the view::
 
 The ``Page`` object is passed automatically as ``$contentDocument``.
 
-Add a corresponding Twig template (note that this works because you use the
+Add a corresponding template (note that this works because you use the
 ``@Template`` annotation):
 
 .. configuration-block::
@@ -157,10 +163,6 @@ Add a corresponding Twig template (note that this works because you use the
 
 Now have another look at: http://localhost:8000/page/home
 
-.. note::
-
-    If you get an error, try clearing the cache.
-
 Notice what is happening with the post object and the ``path`` function  - you
 pass the ``Post`` object and the ``path`` function will pass the object to the
 router and because it implements the ``RouteReferrersReadInterface`` the

tutorial/getting-started.rst

@@ -40,16 +40,13 @@ file in the previous step.
         ...
         require: {
             ...
-            "doctrine/phpcr-bundle": "1.1.*",
-            "jackalope/jackalope-doctrine-dbal": "1.1.0",
-            "symfony-cmf/routing-auto-bundle": "dev-master",
-            "symfony-cmf/menu-bundle": "1.2.*",
-            "sonata-project/doctrine-phpcr-admin-bundle": "1.1.*",
-            "symfony-cmf/tree-browser-bundle": "1.1.x-dev as 1.0",
-            "doctrine/data-fixtures": "1.0.*",
-            "phpcr/phpcr-utils": "1.1.*",
-            "symfony-cmf/routing-bundle": "1.2.*",
-            "symfony-cmf/routing": "1.2.*"
+            "symfony-cmf/routing-auto-bundle": "~1.0",
+            "symfony-cmf/menu-bundle": "~1.2",
+            "sonata-project/doctrine-phpcr-admin-bundle": "~1.2",
+            "symfony-cmf/tree-browser-bundle": "~1.1",
+            "doctrine/data-fixtures": "~1.0",
+            "symfony-cmf/routing-bundle": "~1.3",
+            "symfony-cmf/routing": "~1.3"
         },
         ...
     }

tutorial/make-homepage.rst

@@ -135,8 +135,11 @@ node::
     documents in initializers. With 1.0, you would need to manually set the
     ``phpcr:class`` property to the right value.
 
-Now *remove* the old initializer service (``acme_basiccms.basic_cms.phpcr.initializer``) and
-register your new site initializer:
+Now:
+
+1. *Remove* the initializer service that you created in the
+   :doc:`getting-started` chapter (``acme_basiccms.basic_cms.phpcr.initializer``).
+2. Register your new site initializer:
 
 .. configuration-block::
 
@@ -148,7 +151,7 @@ register your new site initializer:
             acme_basiccms.phpcr.initializer.site:
                 class: Acme\BasicCmsBundle\Initializer\SiteInitializer
                 tags:
-                    - { name: doctrine_phpcr.initializer }
+                    - { name: doctrine_phpcr.initializer, priority: 50 }
 
     .. code-block:: xml
 
@@ -165,7 +168,7 @@ register your new site initializer:
                 <!-- ... -->
                 <service id="acme_basiccms.phpcr.initializer.site"
                     class="Acme\BasicCmsBundle\Initializer\SiteInitializer">
-                    <tag name="doctrine_phpcr.initializer"/>
+                    <tag name="doctrine_phpcr.initializer" priority="50"/>
                 </service>
             </services>
 
@@ -181,9 +184,16 @@ register your new site initializer:
                 'acme_basiccms.phpcr.initializer.site',
                 'Acme\BasicCmsBundle\Initializer\SiteInitializer'
             )
-            ->addTag('doctrine_phpcr.initializer', array('name' => 'doctrine_phpcr.initializer')
+            ->addTag('doctrine_phpcr.initializer', array('name' => 'doctrine_phpcr.initializer', 'priority' => 50)
         ;
 
+.. note::
+
+    You may have noticed that you have set the priority of the initializer.
+    Initializers with high priorities will be called before initializers with
+    lower priorities. Here it is necessary to increase the priority of your
+    listener to prevent other initializers creating the `cms` node first.
+
 Now empty your repository, reinitialize it and reload your fixtures:
 
 .. code-block:: bash

tutorial/the-frontend.rst

@@ -21,7 +21,6 @@ dependency, :doc:`CoreBundle <../bundles/core/introduction>`, to your kernel::
         {
             $bundles = array(
                 // ...
-                new Knp\Bundle\MenuBundle\KnpMenuBundle(),
                 new Symfony\Cmf\Bundle\CoreBundle\CmfCoreBundle(),
                 new Symfony\Cmf\Bundle\MenuBundle\CmfMenuBundle(),
             );
@@ -30,11 +29,18 @@ dependency, :doc:`CoreBundle <../bundles/core/introduction>`, to your kernel::
         }
     }
 
+.. note::
+
+    The KnpMenuBundle is also required but was already included in the
+    :doc:`sonata-admin` chapter. If you skipped that chapter be sure to add
+    this bundle now.
+
 Modify the Page Document
 ------------------------
 
 The menu document has to implement the ``Knp\Menu\NodeInterface``
-provided by the KnpMenuBundle::
+provided by the KnpMenuBundle. Modify the Page document so that it
+implements the this interface::
 
     // src/Acme/BasicCmsBundle/Document/Page.php
     namespace Acme\BasicCmsBundle\Document;
@@ -45,6 +51,14 @@ provided by the KnpMenuBundle::
     use Doctrine\ODM\PHPCR\Mapping\Annotations as PHPCR;
 
     class Page implements RouteReferrersReadInterface, NodeInterface
+
+Now add the following to the document to fulfil the contract::
+
+    // src/Acme/BasicCmsBundle/Document/Page.php
+
+    // ...
+
+    class Page implements RouteReferrersReadInterface, NodeInterface
     {
         // ...