Rename AdminExtension to AbstractAdminExtension (#3824)

This follows Symfony coding standard rules.

Ref: http://symfony.com/doc/current/contributing/code/standards.html#naming-conventions

Admin/AbstractAdminExtension.php

@@ -0,0 +1,189 @@
+<?php
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\AdminBundle\Admin;
+
+use Knp\Menu\ItemInterface as MenuItemInterface;
+use Sonata\AdminBundle\Datagrid\DatagridMapper;
+use Sonata\AdminBundle\Datagrid\ListMapper;
+use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
+use Sonata\AdminBundle\Form\FormMapper;
+use Sonata\AdminBundle\Route\RouteCollection;
+use Sonata\AdminBundle\Show\ShowMapper;
+use Sonata\CoreBundle\Validator\ErrorElement;
+
+/**
+ * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
+ */
+abstract class AbstractAdminExtension implements AdminExtensionInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function configureFormFields(FormMapper $formMapper)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureListFields(ListMapper $listMapper)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureDatagridFilters(DatagridMapper $datagridMapper)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureShowFields(ShowMapper $showMapper)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureRoutes(AdminInterface $admin, RouteCollection $collection)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureSideMenu(AdminInterface $admin, MenuItemInterface $menu, $action, AdminInterface $childAdmin = null)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureTabMenu(AdminInterface $admin, MenuItemInterface $menu, $action, AdminInterface $childAdmin = null)
+    {
+        // Use configureSideMenu not to mess with previous overrides
+        // TODO remove once deprecation period is over
+        $this->configureSideMenu($admin, $menu, $action, $childAdmin);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function validate(AdminInterface $admin, ErrorElement $errorElement, $object)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureQuery(AdminInterface $admin, ProxyQueryInterface $query, $context = 'list')
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function alterNewInstance(AdminInterface $admin, $object)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function alterObject(AdminInterface $admin, $object)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getPersistentParameters(AdminInterface $admin)
+    {
+        return array();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getAccessMapping(AdminInterface $admin)
+    {
+        return array();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureBatchActions(AdminInterface $admin, array $actions)
+    {
+        return $actions;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureExportFields(AdminInterface $admin, array $fields)
+    {
+        return $fields;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function preUpdate(AdminInterface $admin, $object)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function postUpdate(AdminInterface $admin, $object)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function prePersist(AdminInterface $admin, $object)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function postPersist(AdminInterface $admin, $object)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function preRemove(AdminInterface $admin, $object)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function postRemove(AdminInterface $admin, $object)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configureActionButtons(AdminInterface $admin, $list, $action, $object)
+    {
+        return $list;
+    }
+}

Admin/AdminExtension.php

@@ -11,181 +11,17 @@
 
 namespace Sonata\AdminBundle\Admin;
 
-use Knp\Menu\ItemInterface as MenuItemInterface;
-use Sonata\AdminBundle\Datagrid\DatagridMapper;
-use Sonata\AdminBundle\Datagrid\ListMapper;
-use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
-use Sonata\AdminBundle\Form\FormMapper;
-use Sonata\AdminBundle\Route\RouteCollection;
-use Sonata\AdminBundle\Show\ShowMapper;
-use Sonata\CoreBundle\Validator\ErrorElement;
+@trigger_error(
+    'The '.__NAMESPACE__.'\AdminExtension class is deprecated since version 3.x and will be removed in 4.0.'
+    .' Use '.__NAMESPACE__.'\AbstractAdminExtension instead.',
+    E_USER_DEPRECATED
+);
 
 /**
- * Class AdminExtension.
+ * @deprecated since version 3.x, to be removed in 4.0. Use Sonata\AdminBundle\AbstractAdminExtension instead.
  *
- * @author  Thomas Rabaix <thomas.rabaix@sonata-project.org>
+ * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
  */
-abstract class AdminExtension implements AdminExtensionInterface
+abstract class AdminExtension extends AbstractAdminExtension
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function configureFormFields(FormMapper $formMapper)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function configureListFields(ListMapper $listMapper)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function configureDatagridFilters(DatagridMapper $datagridMapper)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function configureShowFields(ShowMapper $showMapper)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function configureRoutes(AdminInterface $admin, RouteCollection $collection)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function configureSideMenu(AdminInterface $admin, MenuItemInterface $menu, $action, AdminInterface $childAdmin = null)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function configureTabMenu(AdminInterface $admin, MenuItemInterface $menu, $action, AdminInterface $childAdmin = null)
-    {
-        // Use configureSideMenu not to mess with previous overrides
-        // TODO remove once deprecation period is over
-        $this->configureSideMenu($admin, $menu, $action, $childAdmin);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function validate(AdminInterface $admin, ErrorElement $errorElement, $object)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function configureQuery(AdminInterface $admin, ProxyQueryInterface $query, $context = 'list')
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function alterNewInstance(AdminInterface $admin, $object)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function alterObject(AdminInterface $admin, $object)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getPersistentParameters(AdminInterface $admin)
-    {
-        return array();
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getAccessMapping(AdminInterface $admin)
-    {
-        return array();
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function configureBatchActions(AdminInterface $admin, array $actions)
-    {
-        return $actions;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function configureExportFields(AdminInterface $admin, array $fields)
-    {
-        return $fields;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function preUpdate(AdminInterface $admin, $object)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function postUpdate(AdminInterface $admin, $object)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function prePersist(AdminInterface $admin, $object)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function postPersist(AdminInterface $admin, $object)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function preRemove(AdminInterface $admin, $object)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function postRemove(AdminInterface $admin, $object)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function configureActionButtons(AdminInterface $admin, $list, $action, $object)
-    {
-        return $list;
-    }
 }

Admin/Extension/LockExtension.php

@@ -11,7 +11,7 @@
 
 namespace Sonata\AdminBundle\Admin\Extension;
 
-use Sonata\AdminBundle\Admin\AdminExtension;
+use Sonata\AdminBundle\Admin\AbstractAdminExtension;
 use Sonata\AdminBundle\Admin\AdminInterface;
 use Sonata\AdminBundle\Form\FormMapper;
 use Sonata\AdminBundle\Model\LockInterface;
@@ -21,7 +21,7 @@ use Symfony\Component\Form\FormEvents;
 /**
  * @author Emmanuel Vella <vella.emmanuel@gmail.com>
  */
-class LockExtension extends AdminExtension
+class LockExtension extends AbstractAdminExtension
 {
     /**
      * @var string

CHANGELOG.md

@@ -14,6 +14,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Deprecated `BaseFieldDescription::camelize()`
 - Deprecated `AdminHelper::camelize()`
 - Deprecated `Admin` class
+- Deprecated `AdminExtension` class
 - Deprecated default template loading on exception mechanism
 
 ### Fixed

Event/AdminEventExtension.php

@@ -11,7 +11,7 @@
 
 namespace Sonata\AdminBundle\Event;
 
-use Sonata\AdminBundle\Admin\AdminExtension;
+use Sonata\AdminBundle\Admin\AbstractAdminExtension;
 use Sonata\AdminBundle\Admin\AdminInterface;
 use Sonata\AdminBundle\Datagrid\DatagridMapper;
 use Sonata\AdminBundle\Datagrid\ListMapper;
@@ -25,7 +25,7 @@ use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  *
  * @author  Thomas Rabaix <thomas.rabaix@sonata-project.org>
  */
-class AdminEventExtension extends AdminExtension
+class AdminEventExtension extends AbstractAdminExtension
 {
     protected $eventDispatcher;
 

Resources/doc/reference/extensions.rst

@@ -8,10 +8,10 @@ alter newly created objects and other admin features.
 
 .. code-block:: php
 
-    use Sonata\AdminBundle\Admin\AdminExtension;
+    use Sonata\AdminBundle\Admin\AbstractAdminExtension;
     use Sonata\AdminBundle\Form\FormMapper;
 
-    class PublishStatusAdminExtension extends AdminExtension
+    class PublishStatusAdminExtension extends AbstractAdminExtension
     {
         public function configureFormFields(FormMapper $formMapper)
         {

Resources/doc/reference/form_help_message.rst

@@ -89,12 +89,12 @@ This Extension for example adds a note field to some entities which use a custom
 
     namespace AppBundle\Admin\Extension;
 
-    use Sonata\AdminBundle\Admin\AdminExtension;
+    use Sonata\AdminBundle\Admin\AbstractAdminExtension;
     use Sonata\AdminBundle\Datagrid\DatagridMapper;
     use Sonata\AdminBundle\Form\FormMapper;
     use Sonata\AdminBundle\Show\ShowMapper;
 
-    class NoteAdminExtension extends AdminExtension
+    class NoteAdminExtension extends AbstractAdminExtension
     {
 
         // add this field to the datagrid every time its available

Tests/Admin/AdminTest.php

@@ -121,7 +121,7 @@ class AdminTest extends \PHPUnit_Framework_TestCase
         $securityHandler->isGranted($admin, 'CUSTOM_ROLE', $admin)->willReturn(true);
         $securityHandler->isGranted($admin, 'EXTRA_CUSTOM_ROLE', $admin)->willReturn(false);
         $customExtension = $this->prophesize(
-            'Sonata\AdminBundle\Admin\AdminExtension'
+            'Sonata\AdminBundle\Admin\AbstractAdminExtension'
         );
         $customExtension->getAccessMapping($admin)->willReturn(
             array('custom_action' => array('CUSTOM_ROLE', 'EXTRA_CUSTOM_ROLE'))
@@ -159,7 +159,7 @@ class AdminTest extends \PHPUnit_Framework_TestCase
         $securityHandler->isGranted($admin, 'CUSTOM_ROLE', $admin)->willReturn(true);
         $securityHandler->isGranted($admin, 'EXTRA_CUSTOM_ROLE', $admin)->willReturn(false);
         $customExtension = $this->prophesize(
-            'Sonata\AdminBundle\Admin\AdminExtension'
+            'Sonata\AdminBundle\Admin\AbstractAdminExtension'
         );
         $customExtension->getAccessMapping($admin)->willReturn(
             array('custom_action' => array('CUSTOM_ROLE', 'EXTRA_CUSTOM_ROLE'))
@@ -183,7 +183,7 @@ class AdminTest extends \PHPUnit_Framework_TestCase
         $securityHandler->isGranted($admin, 'CUSTOM_ROLE', $admin)->willReturn(true);
         $securityHandler->isGranted($admin, 'EXTRA_CUSTOM_ROLE', $admin)->willReturn(true);
         $customExtension = $this->prophesize(
-            'Sonata\AdminBundle\Admin\AdminExtension'
+            'Sonata\AdminBundle\Admin\AbstractAdminExtension'
         );
         $customExtension->getAccessMapping($admin)->willReturn(
             array('custom_action' => array('CUSTOM_ROLE', 'EXTRA_CUSTOM_ROLE'))
@@ -206,7 +206,7 @@ class AdminTest extends \PHPUnit_Framework_TestCase
         );
         $securityHandler->isGranted($admin, 'EDIT_ROLE', $admin)->willReturn(true);
         $customExtension = $this->prophesize(
-            'Sonata\AdminBundle\Admin\AdminExtension'
+            'Sonata\AdminBundle\Admin\AbstractAdminExtension'
         );
         $customExtension->getAccessMapping($admin)->willReturn(
             array('edit_action' => array('EDIT_ROLE'))

UPGRADE-3.x.md

@@ -5,6 +5,10 @@ UPGRADE 3.x
 
 The `Admin` class is deprecated. Use `AbstractAdmin` instead.
 
+## Deprecated AdminExtension class
+
+The `AdminExtension` class is deprecated. Use `AbstractAdminExtension` instead.
+
 ## Deprecated template fallback mechanism
 
 The Twig extension method that fallback to a default template when the specified one does not exist.