瀏覽代碼

Update documentation

Thomas Rabaix 14 年之前
父節點
當前提交
2cd6983702

+ 4 - 2
Admin/Admin.php

@@ -348,6 +348,7 @@ abstract class Admin implements AdminInterface, DomainObjectInterface
      */
     protected function configureFormFields(FormMapper $form)
     {
+
     }
 
     /**
@@ -360,6 +361,7 @@ abstract class Admin implements AdminInterface, DomainObjectInterface
 
     }
 
+
     /**
      *
      * @param DatagridMapper
@@ -383,12 +385,12 @@ abstract class Admin implements AdminInterface, DomainObjectInterface
      *
      * @param RouteCollection
      */
-    public function configureRoutes(RouteCollection $collection)
+    protected function configureRoutes(RouteCollection $collection)
     {
 
     }
 
-    public function configureSideMenu(MenuItem $menu, $action, Admin $childAdmin = null)
+    protected function configureSideMenu(MenuItem $menu, $action, Admin $childAdmin = null)
     {
 
     }

+ 2 - 2
Resources/doc/reference/filter_field_definition.rst

@@ -21,7 +21,7 @@ Example
 
     class PostAdmin extends Admin
     {
-        public function configureDatagridFilters(DatagridMapper $datagrid)
+        protected function configureDatagridFilters(DatagridMapper $datagrid)
         {
             $datagrid
                 ->add('title');
@@ -76,7 +76,7 @@ this functionality.
 
     class PostAdmin extends Admin
     {
-        public function configureDatagridFilters(DatagridMapper $datagridMapper)
+        protected function configureDatagridFilters(DatagridMapper $datagridMapper)
         {
             $datagridMapper
                 ->add('title')

+ 4 - 4
Resources/doc/reference/form_field_definition.rst

@@ -18,7 +18,7 @@ Example
 
     class PostAdmin extends Admin
     {
-        public function configureFormFields(FormMapper $formMapper)
+        protected function configureFormFields(FormMapper $formMapper)
         {
             $formMapper
                 ->add('author', 'sonata_type_model', array(), array('edit' => 'list'))
@@ -92,7 +92,7 @@ model definition).
 
     class MediaAdmin extends Admin
     {
-        public function configureFormFields(FormMapper $form)
+        protected function configureFormFields(FormMapper $form)
         {
             $formMapper
                 ->add('name', null, array('required' => false))
@@ -138,7 +138,7 @@ With the ``standard`` and ``list`` options, you can create a new ``User`` by cli
 
     class PostAdmin extends Admin
     {
-        public function configureFormFields(FormMapper $formMapper)
+        protected function configureFormFields(FormMapper $formMapper)
         {
             $formMapper
                 ->with('General')
@@ -184,7 +184,7 @@ defining one of these options:
 
     class GalleryAdmin extends Admin
     {
-        public function configureFormFields(FormMapper $formMapper)
+        protected function configureFormFields(FormMapper $formMapper)
         {
             $formMapper
                 ->add('code')

+ 2 - 2
Resources/doc/reference/form_types_and_transformers.rst

@@ -50,7 +50,7 @@ Now you can edit the settings array with :
     class PageAdmin extends Admin
     {
 
-        public function configureFormFields(FormMapper $formMapper)
+        protected function configureFormFields(FormMapper $formMapper)
         {
             $formMapper
                 ->add('enabled')
@@ -87,7 +87,7 @@ Other options :
 
     class PostAdmin extends Admin
     {
-        public function configureFormFields(FormMapper $formMapper)
+        protected function configureFormFields(FormMapper $formMapper)
         {
             $formMapper
                 ->with('General')

+ 2 - 2
Resources/doc/reference/list_field_definition.rst

@@ -19,7 +19,7 @@ Example
 
     class PostAdmin extends Admin
     {
-        public function configureListFields(ListMapper $listMapper)
+        protected function configureListFields(ListMapper $listMapper)
         {
             $listMapper
                 ->addIdentifier('title')
@@ -107,7 +107,7 @@ If you need a specific layout for a row cell, you can define a custom template
 
     class MediaAdmin extends Admin
     {
-        public function configureListFields(ListMapper $listMapper)
+        protected function configureListFields(ListMapper $listMapper)
         {
             $listMapper
                 ->addIdentifier('id')

+ 2 - 2
Resources/doc/reference/routing.rst

@@ -13,7 +13,7 @@ Routing Definition
 ------------------
 
 You can set a ``baseRouteName`` property inside your ``Admin`` class, which
-represents the route prefix.  
+represents the route prefix.
 
 .. code-block:: php
 
@@ -56,7 +56,7 @@ defined by its name.
 
     class MediaAdmin extends Admin
     {
-        public function configureRoutes(RouteCollection $collection)
+        protected function configureRoutes(RouteCollection $collection)
         {
             $collection->add('duplicate');
             $collection->add('view', $this->getRouterIdParameter().'/view');

+ 1 - 1
Resources/doc/reference/saving_hooks.rst

@@ -28,7 +28,7 @@ is how the Admin bundle can be used to solve the issue by using the ``prePersist
 
     class UserAdmin extends Admin
     {
-        public function configureFormFields(FormMapper $formMapper)
+        protected function configureFormFields(FormMapper $formMapper)
         {
             $formMapper
                 ->with('General')

+ 4 - 4
Resources/doc/reference/update.rst

@@ -26,7 +26,7 @@ Example :
     {
         protected $userManager;
 
-        public function configureShowField(ShowMapper $showMapper)
+        protected function configureShowField(ShowMapper $showMapper)
         {
             $showMapper
                 ->add('author')
@@ -38,7 +38,7 @@ Example :
             ;
         }
 
-        public function configureFormFields(FormMapper $formMapper)
+        protected function configureFormFields(FormMapper $formMapper)
         {
             $formMapper
                 ->with('General')
@@ -59,7 +59,7 @@ Example :
             ;
         }
 
-        public function configureListFields(ListMapper $listMapper)
+        protected function configureListFields(ListMapper $listMapper)
         {
             $listMapper
                 ->addIdentifier('title')
@@ -70,7 +70,7 @@ Example :
             ;
         }
 
-        public function configureDatagridFilters(DatagridMapper $datagridMapper)
+        protected function configureDatagridFilters(DatagridMapper $datagridMapper)
         {
             $datagridMapper
                 ->add('title')

+ 6 - 6
Resources/doc/tutorial/creating_your_first_admin_class/defining_admin_class.rst

@@ -28,7 +28,7 @@ First, you need to create an Admin/PostAdmin.php file
 
     class PostAdmin extends Admin
     {
-        public function configureShowField(ShowMapper $showMapper)
+        protected function configureShowField(ShowMapper $showMapper)
         {
             $showMapper
                 ->add('enabled')
@@ -39,7 +39,7 @@ First, you need to create an Admin/PostAdmin.php file
             ;
         }
 
-        public function configureFormFields(FormMapper $formMapper)
+        protected function configureFormFields(FormMapper $formMapper)
         {
             $formMapper
                 ->with('General')
@@ -59,7 +59,7 @@ First, you need to create an Admin/PostAdmin.php file
             ;
         }
 
-        public function configureListFields(ListMapper $listMapper)
+        protected function configureListFields(ListMapper $listMapper)
         {
             $listMapper
                 ->addIdentifier('title')
@@ -69,7 +69,7 @@ First, you need to create an Admin/PostAdmin.php file
             ;
         }
 
-        public function configureDatagridFilters(DatagridMapper $datagridMapper)
+        protected function configureDatagridFilters(DatagridMapper $datagridMapper)
         {
             $datagridMapper
                 ->add('title')
@@ -99,7 +99,7 @@ First, you need to create an Admin/PostAdmin.php file
             $queryBuilder->setParameter('status', Comment::STATUS_MODERATE);
         }
 
-        public function configureSideMenu(MenuItem $menu, $action, Admin $childAdmin = null)
+        protected function configureSideMenu(MenuItem $menu, $action, Admin $childAdmin = null)
         {
             if (!$childAdmin && !in_array($action, array('edit'))) {
                 return;
@@ -269,7 +269,7 @@ Tweak the CommentAdmin class
             'message'
         );
 
-        public function configureFormFields(FormMapper $form)
+        protected function configureFormFields(FormMapper $form)
         {
             $form->add('status', array('choices' => Comment::getStatusList()), array('type' => 'choice'));
         }