Remove tautologies

sonata-project · Dec 14, 2017 · d6ffaef · d6ffaef
1 parent f7e30a4
commit d6ffaef
Show file tree

Hide file tree

Showing 132 changed files with 384 additions and 2,373 deletions.
diff --git a/src/Admin/AbstractAdmin.php b/src/Admin/AbstractAdmin.php
diff --git a/src/Admin/AbstractAdminExtension.php b/src/Admin/AbstractAdminExtension.php
@@ -25,173 +25,104 @@
  */
 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 [];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getAccessMapping(AdminInterface $admin)
     {
         return [];
     }
 
-    /**
-     * {@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;
     }
 
     /**
      * Returns a list of default filters.
-     *
-     * @param AdminInterface $admin
-     * @param array          $filterValues
      */
     public function configureDefaultFilterValues(AdminInterface $admin, array &$filterValues)
     {

diff --git a/src/Admin/AdminExtensionInterface.php b/src/Admin/AdminExtensionInterface.php
@@ -25,100 +25,78 @@
  */
 interface AdminExtensionInterface
 {
-    /**
-     * @param FormMapper $formMapper
-     */
     public function configureFormFields(FormMapper $formMapper);
 
-    /**
-     * @param ListMapper $listMapper
-     */
     public function configureListFields(ListMapper $listMapper);
 
-    /**
-     * @param DatagridMapper $datagridMapper
-     */
     public function configureDatagridFilters(DatagridMapper $datagridMapper);
 
-    /**
-     * @param ShowMapper $showMapper
-     */
     public function configureShowFields(ShowMapper $showMapper);
 
-    /**
-     * @param AdminInterface  $admin
-     * @param RouteCollection $collection
-     */
     public function configureRoutes(AdminInterface $admin, RouteCollection $collection);
 
     /**
      * DEPRECATED: Use configureTabMenu instead.
      *
      * NEXT_MAJOR: remove this method.
      *
-     * @param AdminInterface    $admin
-     * @param MenuItemInterface $menu
-     * @param string            $action
-     * @param AdminInterface    $childAdmin
+     * @param string $action
      *
      * @deprecated
      */
-    public function configureSideMenu(AdminInterface $admin, MenuItemInterface $menu, $action, AdminInterface $childAdmin = null);
+    public function configureSideMenu(
+        AdminInterface $admin,
+        MenuItemInterface $menu,
+        $action,
+        AdminInterface $childAdmin = null
+    );
 
     /**
      * Builds the tab menu.
      *
-     * @param AdminInterface    $admin
-     * @param MenuItemInterface $menu
-     * @param string            $action
-     * @param AdminInterface    $childAdmin
+     * @param string $action
      */
-    public function configureTabMenu(AdminInterface $admin, MenuItemInterface $menu, $action, AdminInterface $childAdmin = null);
+    public function configureTabMenu(
+        AdminInterface $admin,
+        MenuItemInterface $menu,
+        $action,
+        AdminInterface $childAdmin = null
+    );
 
     /**
-     * @param AdminInterface $admin
-     * @param ErrorElement   $errorElement
-     * @param mixed          $object
+     * @param mixed $object
      */
     public function validate(AdminInterface $admin, ErrorElement $errorElement, $object);
 
     /**
-     * @param AdminInterface      $admin
-     * @param ProxyQueryInterface $query
-     * @param string              $context
+     * @param string $context
      */
     public function configureQuery(AdminInterface $admin, ProxyQueryInterface $query, $context = 'list');
 
     /**
      * Get a chance to modify a newly created instance.
      *
-     * @param AdminInterface $admin
-     * @param mixed          $object
+     * @param mixed $object
      */
     public function alterNewInstance(AdminInterface $admin, $object);
 
     /**
      * Get a chance to modify object instance.
      *
-     * @param AdminInterface $admin
-     * @param mixed          $object
+     * @param mixed $object
      */
     public function alterObject(AdminInterface $admin, $object);
 
     /**
      * Get a chance to add persistent parameters.
      *
-     * @param AdminInterface $admin
-     *
      * @return array
      */
     public function getPersistentParameters(AdminInterface $admin);
 
     /**
      * Return the controller access mapping.
      *
-     * @param AdminInterface $admin
-     *
      * @return array
      */
     // TODO: Uncomment in next major release
@@ -127,8 +105,7 @@ public function getPersistentParameters(AdminInterface $admin);
     /**
      * Returns the list of batch actions.
      *
-     * @param AdminInterface $admin
-     * @param array          $actions
+     * @param array $actions
      *
      * @return array
      */
@@ -138,54 +115,46 @@ public function getPersistentParameters(AdminInterface $admin);
     /**
      * Get a chance to modify export fields.
      *
-     * @param AdminInterface $admin
-     * @param string[]       $fields
+     * @param string[] $fields
      *
      * @return string[]
      */
     // TODO: Uncomment in next major release
     // public function configureExportFields(AdminInterface $admin, array $fields);
 
     /**
-     * @param AdminInterface $admin
-     * @param mixed          $object
+     * @param mixed $object
      */
     public function preUpdate(AdminInterface $admin, $object);
 
     /**
-     * @param AdminInterface $admin
-     * @param mixed          $object
+     * @param mixed $object
      */
     public function postUpdate(AdminInterface $admin, $object);
 
     /**
-     * @param AdminInterface $admin
-     * @param mixed          $object
+     * @param mixed $object
      */
     public function prePersist(AdminInterface $admin, $object);
 
     /**
-     * @param AdminInterface $admin
-     * @param mixed          $object
+     * @param mixed $object
      */
     public function postPersist(AdminInterface $admin, $object);
 
     /**
-     * @param AdminInterface $admin
-     * @param mixed          $object
+     * @param mixed $object
      */
     public function preRemove(AdminInterface $admin, $object);
 
     /**
-     * @param AdminInterface $admin
-     * @param mixed          $object
+     * @param mixed $object
      */
     public function postRemove(AdminInterface $admin, $object);
 
     /*
      * Get all action buttons for an action
      *
-     * @param AdminInterface $admin
      * @param array          $list
      * @param string         $action
      * @param mixed          $object
@@ -200,7 +169,6 @@ public function postRemove(AdminInterface $admin, $object);
      *
      * Returns a list of default filters
      *
-     * @param AdminInterface $admin
      * @param array          $filterValues
      */
     // public function configureDefaultFilterValues(AdminInterface $admin, array &$filterValues);