|
|
@@ -0,0 +1,197 @@
|
|
|
+Getting started with SonataAdminBundle
|
|
|
+======================================
|
|
|
+
|
|
|
+After installation of SonataAdminBundle you need to configure it for your models.
|
|
|
+Here is a quick checklist of what is needed to quickly setup SonataAdminBundle
|
|
|
+and create your first admin interface for the models of your application:
|
|
|
+
|
|
|
+* Step 1: Define SonataAdminBundle routes
|
|
|
+* Step 2: Setup the persistence service (ORM, ODM, ...)
|
|
|
+* Step 3: Create admin class
|
|
|
+* Step 4: Create admin service
|
|
|
+* Step 5: Configuration
|
|
|
+* Step 6: Security
|
|
|
+
|
|
|
+
|
|
|
+Step 1: Define SonataAdminBundle routes
|
|
|
+---------------------------------------
|
|
|
+
|
|
|
+SonataAdminBundle contains several routes. Import them by adding the following
|
|
|
+code to your application's routing file:
|
|
|
+
|
|
|
+.. code-block:: yaml
|
|
|
+
|
|
|
+ # app/config/routing.yml
|
|
|
+ admin:
|
|
|
+ resource: '@SonataAdminBundle/Resources/config/routing/sonata_admin.xml'
|
|
|
+ prefix: /admin
|
|
|
+
|
|
|
+ _sonata_admin:
|
|
|
+ resource: .
|
|
|
+ type: sonata_admin
|
|
|
+ prefix: /admin
|
|
|
+
|
|
|
+.. note::
|
|
|
+
|
|
|
+ If you're using XML or PHP to specify your application's configuration,
|
|
|
+ the above routing configuration must be placed in routing.xml or
|
|
|
+ routing.php according to your format (i.e. XML or PHP).
|
|
|
+
|
|
|
+At this point you can already access the admin dashboard by visiting the url:
|
|
|
+``http://yoursite.local/admin/dashboard``.
|
|
|
+
|
|
|
+
|
|
|
+Step 2: Setup the persistence service (ORM, ODM, ...)
|
|
|
+-----------------------------------------------------
|
|
|
+
|
|
|
+SonataAdminBundle does not impose persistance service (service for handling and
|
|
|
+controlling your models), however most likely your application will use some
|
|
|
+persistance service (like ORM or ODM for database and document stores) therefore
|
|
|
+you can use the following bundles officially supported by Sonata Project's admin
|
|
|
+bundle:
|
|
|
+
|
|
|
+* SonataDoctrineORMAdminBundle
|
|
|
+* SonataDoctrineMongoDBAdminBundle
|
|
|
+* SonataDoctrinePhpcrAdminBundle
|
|
|
+
|
|
|
+Propel users are warmly welcome to contribute and create a new bundle for Propel
|
|
|
+ORM that will integrate in SonataAdminBundle.
|
|
|
+
|
|
|
+Install a persistance servise you need and configure it according to their
|
|
|
+related documentation.
|
|
|
+
|
|
|
+Step 3: Create Admin class
|
|
|
+--------------------------
|
|
|
+
|
|
|
+Admin class represents mapping of your model and administration sections (forms,
|
|
|
+list, show). The easiest way to create an admin class for your model is to extend
|
|
|
+the Sonata\AdminBundle\Admin\Admin class. Here is a simple example from the
|
|
|
+SonataNewsBundle:
|
|
|
+
|
|
|
+.. code-block:: php
|
|
|
+
|
|
|
+ namespace Sonata\NewsBundle\Admin;
|
|
|
+
|
|
|
+ use Sonata\AdminBundle\Admin\Admin;
|
|
|
+ use Sonata\AdminBundle\Datagrid\ListMapper;
|
|
|
+ use Sonata\AdminBundle\Datagrid\DatagridMapper;
|
|
|
+ use Sonata\AdminBundle\Validator\ErrorElement;
|
|
|
+ use Sonata\AdminBundle\Form\FormMapper;
|
|
|
+
|
|
|
+ class TagAdmin extends Admin
|
|
|
+ {
|
|
|
+ protected function configureFormFields(FormMapper $formMapper)
|
|
|
+ {
|
|
|
+ $formMapper
|
|
|
+ ->add('name')
|
|
|
+ ->add('enabled', null, array('required' => false))
|
|
|
+ ;
|
|
|
+ }
|
|
|
+
|
|
|
+ protected function configureDatagridFilters(DatagridMapper $datagridMapper)
|
|
|
+ {
|
|
|
+ $datagridMapper
|
|
|
+ ->add('name')
|
|
|
+ ->add('posts')
|
|
|
+ ;
|
|
|
+ }
|
|
|
+
|
|
|
+ protected function configureListFields(ListMapper $listMapper)
|
|
|
+ {
|
|
|
+ $listMapper
|
|
|
+ ->addIdentifier('name')
|
|
|
+ ->add('slug')
|
|
|
+ ->add('enabled')
|
|
|
+ ;
|
|
|
+ }
|
|
|
+
|
|
|
+ public function validate(ErrorElement $errorElement, $object)
|
|
|
+ {
|
|
|
+ $errorElement
|
|
|
+ ->with('name')
|
|
|
+ ->assertMaxLength(array('limit' => 32))
|
|
|
+ ->end()
|
|
|
+ ;
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+
|
|
|
+Step 4: Create admin service
|
|
|
+----------------------------
|
|
|
+
|
|
|
+To notify your administration of your new admin class you need to create an
|
|
|
+admin service and link it into the framework by setting the sonata.admin tag.
|
|
|
+
|
|
|
+.. code-block:: xml
|
|
|
+
|
|
|
+ <container xmlns="http://symfony.com/schema/dic/services"
|
|
|
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
|
+ xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
|
|
|
+ <services>
|
|
|
+ <service id="sonata.admin.course" class="YourNS\AdminBundle\Admin\BlogAdmin">
|
|
|
+ <tag name="sonata.admin" manager_type="orm" group="Posts" label="Blog"/>
|
|
|
+ <argument />
|
|
|
+ <argument>YourNS\AdminBundle\Entity\Course</argument>
|
|
|
+ <argument>SonataAdminBundle:CRUD</argument>
|
|
|
+ <call method="setTranslationDomain">
|
|
|
+ <argument>YourNSAdminBundle</argument>
|
|
|
+ </call>
|
|
|
+ </service>
|
|
|
+ </services>
|
|
|
+ </container>
|
|
|
+
|
|
|
+
|
|
|
+Step 5: Configuration
|
|
|
+---------------------
|
|
|
+
|
|
|
+At this point you have basic administration for your model. If you wish to
|
|
|
+quickly customize your administration you can create some configuration options
|
|
|
+and change them according to your requirements:
|
|
|
+
|
|
|
+.. code-block:: yaml
|
|
|
+
|
|
|
+ # app/config/config.yml
|
|
|
+ sonata_admin:
|
|
|
+ title: Sonata Project
|
|
|
+ title_logo: /bundles/sonataadmin/logo_title.png
|
|
|
+ templates:
|
|
|
+ # default global templates
|
|
|
+ layout: SonataAdminBundle::standard_layout.html.twig
|
|
|
+ ajax: SonataAdminBundle::ajax_layout.html.twig
|
|
|
+
|
|
|
+ # default actions templates, should extend a global templates
|
|
|
+ list: SonataAdminBundle:CRUD:list.html.twig
|
|
|
+ show: SonataAdminBundle:CRUD:show.html.twig
|
|
|
+ edit: SonataAdminBundle:CRUD:edit.html.twig
|
|
|
+ dashboard_groups:
|
|
|
+ default: ~
|
|
|
+
|
|
|
+
|
|
|
+Linking the admin class to the dashboard is done automatically because of the
|
|
|
+default option you defined above:
|
|
|
+
|
|
|
+ dashboard_groups:
|
|
|
+ default: ~
|
|
|
+
|
|
|
+However you can define only admin groups you want to show in the dashboard by:
|
|
|
+
|
|
|
+ dashboard_groups:
|
|
|
+ sonata_page:
|
|
|
+ label: Page
|
|
|
+ items: ~
|
|
|
+
|
|
|
+More information can be found in the configuration chapter of this documentation.
|
|
|
+
|
|
|
+
|
|
|
+Step 6: Security
|
|
|
+----------------
|
|
|
+
|
|
|
+The last important step is security. By default, the SonataAdminBundle does not
|
|
|
+come with any user management for ultimate flexibility, however it is most
|
|
|
+likely your application requires such feature. The Sonata Project includes a
|
|
|
+``SonataUserBundle`` which integrates very popular ``FOSUserBundle``. Please
|
|
|
+refer to the security section of this documentation for more information.
|
|
|
+
|
|
|
+
|
|
|
+That should be it! Read next sections fore more verbose documentation of the
|
|
|
+SonataAdminBundle and how to tweak it for your requirements.
|
Thomas