creating custom page in SonataAdmin

docs/cookbook/recipe_custom_view.rst

@@ -0,0 +1,122 @@
+Creating a Custom Admin View
+============================
+
+Sometimes, you may want to create an additional view in your Sonata admin
+but you do not have or need an Entity to connect it to. You also probably
+want to add it to the sidebar with the rest of your admin pages. Here we will
+present a full working example of how that is achievable.
+
+The recipe
+----------
+
+SonataAdmin provides a very straightforward way of adding your own custom
+view.
+
+To do this we need to:
+
+- create an admin class for your custom view;
+- extend the ``SonataAdmin:CRUD`` Controller and tell our admin class to
+  use it;
+- create a template that will represent your custom view.
+
+Create an admin class
+^^^^^^^^^^^^^^^^^^^^^
+
+First we need to create an admin class and we will clear all routes except
+``list``.
+
+::
+
+    <?php
+
+    // src/Admin/CustomViewAdmin.php
+
+    namespace App\Admin;
+
+    use Sonata\AdminBundle\Admin\AbstractAdmin;
+    use Sonata\AdminBundle\Route\RouteCollection;
+
+    class CustomViewAdmin extends AbstractAdmin
+    {
+        protected $baseRoutePattern = 'custom_view';
+        protected $baseRouteName = 'custom_view';
+
+        protected function configureRoutes(RouteCollection $collection)
+        {
+            $collection->clearExcept(['list']);
+        }
+    }
+
+Extending the Admin Controller
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Create your own Controller extending the one from SonataAdmin.
+
+::
+
+    <?php
+
+    // src/Controller/CustomViewCRUDController.php
+
+    namespace App\Controller;
+
+    use Sonata\AdminBundle\Controller\CRUDController;
+
+    class CustomViewCRUDController extends CRUDController
+    {
+        public function listAction()
+        {
+            return $this->renderWithExtraParams('admin/custom_view.html.twig');
+        }
+    }
+
+Admin classes by default use the ``SonataAdmin:CRUD`` controller, this is the third parameter
+of an admin service definition, you need to change it to your own.
+
+Register the Admin as a Service
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The difference between creating a normal admin class and this one is
+that we do not specify the Entity, we leave it as ``null``.
+
+.. code-block:: yaml
+
+    # config/services.yaml
+
+    services:
+        app.admin.custom_view:
+            class: App\Admin\CustomViewAdmin
+            tags:
+                - { name: sonata.admin, manager_type: orm, group: Demo, label: Custom View }
+            arguments:
+                - null
+                - null
+                - App\Controller\CustomViewCRUDController
+            public: true
+
+.. note::
+    If you are not using Symfony Flex, this service should be registered
+    in ``app/config/services.yml``.
+
+For more information about service configuration please refer to Step 3
+of :doc:`../getting_started/creating_an_admin`
+
+Create a template for the new custom page
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: html+jinja
+
+    {# templates/admin/custom_view.html.twig #}
+
+    {% extends '@SonataAdmin/standard_layout.html.twig' %}
+
+    {% block sonata_admin_content %}
+        Your content here
+    {% endblock %}
+
+The final view will look like this:
+
+.. figure:: ../images/custom_admin_view.png
+    :align: center
+    :alt: Custom view
+    :width: 700px

docs/index.rst

@@ -93,3 +93,4 @@ The demo website can be found at http://demo.sonata-project.org.
    cookbook/recipe_sortable_sonata_type_model
    cookbook/recipe_delete_field_group
    cookbook/recipe_data_mapper
+   cookbook/recipe_custom_view