[#414] Moved all 1.1 features to dev

wouterj · wouterj · commit ff3edeeb4545 · 2014-03-08T18:39:02.000+01:00
diff --git a/book/routing.rst b/book/routing.rst
@@ -248,7 +248,7 @@ order of precedence):
 
 * Explicit: The ``Route`` document itself can explicitly declare the target
   Controller if one is returned from ``getDefault('_controller')``.
-* By alias: The ``Route`` document returns a value from ``getDefault('type')``,
+* By type: The ``Route`` document returns a value from ``getDefault('type')``,
   which is then matched against the provided configuration from config.yml
 * By class: Requires the ``Route`` document to implement ``RouteObjectInterface``
   and return an object for ``getContent()``. The returned class type is
@@ -302,7 +302,7 @@ Here's an example of how to configure the above mentioned options:
                         cmf_content.controller::indexAction
                     </controllers-by-class>
 
-                    <templates-by-class alias="Symfony\Cmf\Bundle\ContentBundle\Document\StaticContent"
+                    <templates-by-class class="Symfony\Cmf\Bundle\ContentBundle\Document\StaticContent"
                     >
                         CmfContentBundle:StaticContent:index.html.twig
                     </templates-by-class>
diff --git a/bundles/create/introduction.rst b/bundles/create/introduction.rst
@@ -281,12 +281,30 @@ Access Control
 
 In order to limit who can edit content, the provided controllers as well as the
 JavaScript loader check if the current user is granted the configured
-``cmf_create.role``. By default the role is ``ROLE_ADMIN``.
+``cmf_create.security.role``. By default the role is ``ROLE_ADMIN``.
 
 .. tip::
 
     In order to have security in place, you need to configure a
     "Symfony2 firewall". Read more in the `Symfony2 security chapter`_.
+    If you do not do that, create.js will not be loaded and editing
+    will be disabled.
+
+    If you do not want to edit on the production domain directly, e.g.
+    because of caching, you can provide a second domain where you have
+    security configured and do the editing there.
+
+You can completely disable security checks by setting the role parameter to
+boolean ``false``. Then you need to configure access permissions on the routes
+defined in ``Resources/routing/rest.xml`` and, if activated, in ``image.xml``.
+If you set the role to false but do not configure any security,
+**every visitor of your site will be able to edit the content**.
+You also will need custom logic to decide whether to include the create.js
+JavaScript files.
+
+You can also use a custom security check service by implementing
+``Symfony\Cmf\Bundle\CreateBundle\Security\AccessCheckerInterface``
+and setting this service in ``cmf_create.security.checker_service``.
 
 If you need more fine grained access control, look into the CreatePHP
 ``RdfMapperInterface`` ``isEditable`` method.  You can extend a mapper and
@@ -296,9 +314,12 @@ editable.
 Load create.js JavaScript and CSS
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This bundle provides templates that load the required Javascript and CSS files
-based on Assetic. The Javascript loader also parametrizes the configuration
-for create.js and the chosen editor.
+This bundle provides a template that loads the required CSS files, as well as
+a controller action that loads the necessary JavaScript *if* the current user
+is allowed to edit according to
+:ref:`the security configuration <bundle_create_introduction_access_control>`.
+The JavaScript loader also parametrizes the configuration for create.js and
+WYSIWYG editor.
 
 Alternatively, you can of course use your own templates to include the assets
 needed by create.js.
@@ -356,6 +377,12 @@ For Symfony 2.1, the syntax is:
             '_locale' => $app->getRequest()->getLocale(),
         ) ?>
 
+.. tip::
+
+    You can include this call unconditionally. The controller checks if the
+    current user is allowed to edit and only in that case includes the
+    JavaScript.
+        
 .. note::
 
     The provided JavaScript file configures create.js and the editor. If you
diff --git a/bundles/phpcr_odm.rst b/bundles/phpcr_odm.rst
@@ -606,6 +606,12 @@ and remove them on the fly.
 phpcr_odm_reference_collection
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. caution::
+
+    This form type was deprecated in DoctrinePHPCRBundle 1.1 and will be
+    removed in DoctrinePHPCRBundle 1.2. You should use the `phpcr_document`_
+    type instead, which can do the same but better.
+
 This form type handles editing ``ReferenceMany`` collections on PHPCR-ODM
 documents.  It is a choice field with an added ``referenced_class`` required
 option that specifies the class of the referenced target document.
@@ -703,7 +709,16 @@ A service to use the generic initializer looks like this:
         $definition->addTag('doctrine_phpcr.initializer');
         $container->setDefinition('acme.phpcr.initializer', $definition);
 
-The ``doctrine:phpcr:repository:init`` command runs all tagged initializers.
+You can execute your initializers using the following command:
+
+.. code-block:: bash
+
+    $ php app/console doctrine:phpcr:repository:init
+
+.. versionadded:: 1.1
+
+    Since DoctrinePHPCRBundle 1.1 the load data fixtures command will automatically
+    execute the initializers after purging the database.
 
 Fixture Loading
 ---------------
diff --git a/cookbook/create_new_project_phpcr_odm.rst b/cookbook/create_new_project_phpcr_odm.rst
@@ -62,16 +62,7 @@ content repository.
         }
     }
 
-**Step 5**: (*optional*) Register the PHPCR-ODM annotations in ``app/autoload.php``::
-
-    // app/autoload.php
-
-    // ...
-    AnnotationRegistry::registerFile(
-        __DIR__.'/../vendor/doctrine/phpcr-odm/lib/Doctrine/ODM/PHPCR/Mapping/Annotations/DoctrineAnnotations.php'
-    );
-
-**Step 6**: Modify ``parameters.yml.dist``, adding the required PHPCR-ODM settings:
+**Step 5**: Modify ``parameters.yml.dist``, adding the required PHPCR-ODM settings:
 
 .. code-block:: yaml
 
@@ -142,7 +133,7 @@ content repository.
             ),
         ));
 
-**Step 8**: Run ``composer update``:
+**Step 7**: Run ``composer update``:
 
 .. code-block:: bash
 
diff --git a/cookbook/creating_a_cms/getting-started.rst b/cookbook/creating_a_cms/getting-started.rst
@@ -313,8 +313,9 @@ configuration:
     to understand these details right now. To learn more about PHPCR read
     :doc:`../database/choosing_storage_layer`.
 
-Execute the ``doctrine:phpcr:repository:init`` command to initialize (or
-reinitialize) the repository:
+The initalizers will be executed automatically when you load your data
+fixtures (as detailed in the next section) or alternatively you can execute
+them manually using the following command:
 
 .. code-block:: bash
 
@@ -361,13 +362,11 @@ Create a page for your CMS::
     use Acme\BasicCmsBundle\Document\Page;
     use Doctrine\Common\DataFixtures\FixtureInterface;
     use Doctrine\Common\Persistence\ObjectManager;
-    use PHPCR\Util\NodeHelper;
 
     class LoadPageData implements FixtureInterface
     {
         public function load(ObjectManager $dm)
         {
-            NodeHelper::createPath($dm->getPhpcrSession(), '/cms/pages');
             $parent = $dm->find(null, '/cms/pages');
 
             $page = new Page();
@@ -391,14 +390,12 @@ and add some posts::
     use Doctrine\Common\DataFixtures\FixtureInterface;
     use Doctrine\Common\Persistence\ObjectManager;
     use Acme\BasicCmsBundle\Document\Post;
-    use PHPCR\Util\NodeHelper;
 
     class LoadPostData implements FixtureInterface
     {
         public function load(ObjectManager $dm)
         {
             $parent = $dm->find(null, '/cms/posts');
-            NodeHelper::createPath($dm->getPhpcrSession(), '/cms/posts');
 
             foreach (array('First', 'Second', 'Third', 'Forth') as $title) {
                 $post = new Post();
@@ -424,15 +421,6 @@ and load the fixtures:
 
 You should now have some data in your content repository.
 
-.. note::
-
-    The classes above use ``NodeHelper::createPath`` to create the paths
-    ``/cms/posts`` and ``/cms/pages`` - this is exactly what the
-    initializer did -- why do the classes do it again? This is a known issue - the
-    data fixtures loader will purge the workspace and it will **not** call the
-    initializer, so when using data fixtures it is currently necessary to manually
-    create the paths.
-
 .. _`routingautobundle documentation`: http://symfony.com/doc/current/cmf/bundles/routing_auto.html
 .. _`dynamicrouter to generate urls`: http://symfony.com/doc/current/cmf/bundles/routing/dynamic.html#url-generation-with-the-dynamicrouterA
 .. _`idempotent`: http://en.wiktionary.org/wiki/idempotent
diff --git a/cookbook/creating_a_cms/make-homepage.rst b/cookbook/creating_a_cms/make-homepage.rst
@@ -195,11 +195,6 @@ and verify that the ``cms`` node has been updated by using the
     disadvantage then is that there are two places where initialization
     choices take place - do whatever you prefer.
 
-As noted earlier, currently when data fixtures are loaded they will erase the
-workspace, including the paths created by the initializers. This means that
-each time you load your data fixtures you must also reinitialize the
-repository.
-
 Create the Make Homepage Button
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/cookbook/editions/cmf_core.rst b/cookbook/editions/cmf_core.rst
@@ -99,7 +99,6 @@ If you haven't done so already, make sure you have followed these steps from
 
 * Initialize ``DoctrinePHPCRBundle`` in ``app/AppKernel.php``
 * Ensure there is a ``doctrine_phpcr:`` section in ``app/config/config.yml``
-* Add the ``AnnotationRegistry::registerFile`` line to ``app/autoload.php``
 
 Configure the BlockBundle in your ``config.yml``:
 
diff --git a/cookbook/installing_configuring_doctrine_phpcr_odm.rst b/cookbook/installing_configuring_doctrine_phpcr_odm.rst
@@ -132,19 +132,6 @@ To install the above dependencies, run:
 
     $ php composer.phar update
 
-Register Annotations
-~~~~~~~~~~~~~~~~~~~~
-
-PHPCR-ODM uses annotations and these need to be registered in your
-``app/autoload.php`` file. Add the following line, immediately after the last
-``AnnotationRegistry::registerFile`` line::
-
-    // app/autoload.php
-
-    // ...
-    AnnotationRegistry::registerFile(__DIR__.'/../vendor/doctrine/phpcr-odm/lib/Doctrine/ODM/PHPCR/Mapping/Annotations/DoctrineAnnotations.php');
-    // ...
-
 Initialize Bundles
 ~~~~~~~~~~~~~~~~~~
 
diff --git a/reference/configuration/create.rst b/reference/configuration/create.rst
@@ -18,33 +18,49 @@ Configuration
 Security
 ~~~~~~~~
 
-The controller that receives save requests from create.js requires the user to
-have a specific role to control who is allowed to edit content. As it would
+The controller that receives save requests from create.js does a security check
+to determine whether the current user is allowed to edit content. As it would
 not be convenient to show the create.js editor to users not allowed to edit the
-site, the controller loading the create.js javascripts with the
-``includeJSFilesAction`` also checks this role. If the image controller is
-activated, it checks for this role as well.
+site, the controller loading the create.js JavaScript files with the
+``includeJSFilesAction`` also uses the same security check, as does the image
+upload controller if it is activated.
+
+The default security check checks if the user has a specified role. If nothing
+is configured, the default role is ``ROLE_ADMIN``. If you set the parameter to
+boolean ``false``, every user will be allowed to save changes through the REST
+controller.
+
+A last option is to configure your own ``checker_service`` to be used instead
+of the role based check.
+
+For more information, see the
+:ref:`security section in the bundle doc <bundle_create_introduction_access_control>`.
 
 .. configuration-block::
 
     .. code-block:: yaml
 
         cmf_create:
-            role: ROLE_ADMIN
+            security:
+                role: ROLE_ADMIN
+                checker_service: ~
 
     .. code-block:: xml
 
         <?xml version="1.0" charset="UTF-8" ?>
         <container xmlns="http://symfony.com/schema/dic/services">
-            <config xmlns="http://cmf.symfony.com/schema/dic/create"
-                role="ROLE_ADMIN"
-            />
+            <config xmlns="http://cmf.symfony.com/schema/dic/create">
+                <security role="ROLE_ADMIN" checker-service="null" />
+            </config>
         </container>
 
     .. code-block:: php
 
         $container->loadFromExtension('cmf_create', array(
-            'role' => 'ROLE_ADMIN',
+            'security' => array(
+                'role' => 'ROLE_ADMIN',
+                'checker_service' => null,
+            ),
         ));
 
 .. _config-create-persistence:
diff --git a/reference/configuration/menu.rst b/reference/configuration/menu.rst
@@ -27,6 +27,7 @@ persistence configuration has the following configuration:
                     enabled:              false
                     menu_basepath:        /cms/menu
                     content_basepath:     ~
+                    prefetch:             10
                     manager_name:         ~
                     menu_document_class:  Symfony\Cmf\Bundle\MenuBundle\Doctrine\Phpcr\Menu
                     node_document_class:  Symfony\Cmf\Bundle\MenuBundle\Doctrine\Phpcr\MenuNode
@@ -46,6 +47,7 @@ persistence configuration has the following configuration:
                         enabled="false"
                         menu-basepath="/cms/menu"
                         content-basepath="null"
+                        prefetch="10"
                         manager-name="null"
                         menu-document-class="null"
                         node-document-class="null"
@@ -66,6 +68,7 @@ persistence configuration has the following configuration:
                     'enabled' => false,
                     'menu_basepath' => '/cms/menu',
                     'content_basepath' => null,
+                    'prefetch' => 10,
                     'manager_name' => null,
                     'menu_document_class' => null,
                     'node_document_class' => null,
@@ -82,11 +85,6 @@ enabled
 
 .. include:: partials/persistence_phpcr_enabled.rst.inc
 
-manager_name
-""""""""""""
-
-.. include:: partials/persistence_phpcr_manager_name.rst.inc
-
 menu_basepath
 """""""""""""
 
@@ -115,17 +113,40 @@ the content branch of the document hierarchy in forms.
 If the :doc:`CoreBundle <../../bundles/core/index>` is registered, this will default to
 the value of ``%cmf_core.persistence.phpcr.basepath%/content``
 
-menu_document
-"""""""""""""
+.. versionadded:: 1.1
+
+    The prefetch functionality was added in MenuBundle 1.1.
+
+prefetch
+""""""""
+
+**type**: ``integer`` **default**: ``10``
+
+When rendering a menu, the whole menu tree needs to be loaded. To reduce the
+number of database requests that PHPCR needs to make, this setting makes the
+tree loader prefetch all menu nodes in one call.
+
+``10`` should be enough for most cases, if you have deeper menu structures you
+might want to increase this.
+
+To disable menu prefetch completely, set this option to ``0``.
+
+manager_name
+""""""""""""
+
+.. include:: partials/persistence_phpcr_manager_name.rst.inc
+
+menu_document_class
+"""""""""""""""""""
 
 **type**: ``string`` **default**: ``Symfony\Cmf\Bundle\MenuBundle\Doctrine\Phpcr\Menu``
 
 Specifies the document class which should represent an entire menu.
 
 This setting is used by the admin class.
 
-node_document
-"""""""""""""
+node_document_class
+"""""""""""""""""""
 
 **type**: ``string`` **default**: ``Symfony\Cmf\Bundle\MenuBundle\Doctrine\Phpcr\MenuNode``
 
