Add a configurePersistentParameters method

sonata-project · Feb 16, 2021 · fb33ec2 · fb33ec2
1 parent 0a107a3
commit fb33ec2
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 13 deletions.
diff --git a/docs/reference/routing.rst b/docs/reference/routing.rst
@@ -363,14 +363,14 @@ Persistent parameters
 
 In some cases, the interface might be required to pass the same parameters
 across the different ``Admin``'s actions. Instead of setting them in the
-template or doing other weird hacks, you can define a ``getPersistentParameters``
+template or doing other weird hacks, you can define a ``configurePersistentParameters``
 method. This method will be used when a link is being generated::
 
     // src/Admin/MediaAdmin.php
 
     final class MediaAdmin extends AbstractAdmin
     {
-        public function getPersistentParameters()
+        public function configurePersistentParameters()
         {
             if (!$this->getRequest()) {
                 return [];

diff --git a/src/Admin/AbstractAdmin.php b/src/Admin/AbstractAdmin.php
@@ -2128,22 +2128,29 @@ public function getClassnameLabel()
         return $this->classnameLabel;
     }
 
+    /**
+     * @final since sonata-project/admin-bundle 3.x
+     */
     public function getPersistentParameters()
     {
-        $parameters = [];
-
+        $parameters = $this->configurePersistentParameters();
         foreach ($this->getExtensions() as $extension) {
-            $params = $extension->getPersistentParameters($this);
+            // NEXT_MAJOR: Remove the check and the else part.
+            if (\method_exists($extension, 'configurePersistentParameters')) {
+                $parameters = $extension->configurePersistentParameters($this, $parameters);
+            } else {
+                $params = $extension->getPersistentParameters($this);
 
-            // NEXT_MAJOR: Remove this check, since return typehint is added
-            if (!\is_array($params)) {
-                throw new \RuntimeException(sprintf(
-                    'The %s::getPersistentParameters must return an array',
-                    \get_class($extension)
-                ));
-            }
+                // NEXT_MAJOR: Remove this check, since return typehint is added
+                if (!\is_array($params)) {
+                    throw new \RuntimeException(sprintf(
+                        'The %s::getPersistentParameters must return an array',
+                        \get_class($extension)
+                    ));
+                }
 
-            $parameters = array_merge($parameters, $params);
+                $parameters = array_merge($parameters, $params);
+            }
         }
 
         return $parameters;
@@ -2894,6 +2901,14 @@ protected function alterObject(object $object): void
     {
     }
 
+    /**
+     * @return array<string, mixed>
+     */
+    protected function configurePersistentParameters(): array
+    {
+        return [];
+    }
+
     /**
      * @return string[]
      */

diff --git a/src/Admin/AdminExtensionInterface.php b/src/Admin/AdminExtensionInterface.php
@@ -32,6 +32,7 @@
  * @method void  configureDefaultFilterValues(AdminInterface $admin, array &$filterValues)
  * @method void  configureDefaultSortValues(AdminInterface $admin, array &$sortValues)
  * @method void  configureFormOptions(AdminInterface $admin, array &$formOptions)
+ * @method array configurePersistentParameters(AdminInterface $admin, array $parameters)
  *
  * @phpstan-template T of object
  */
@@ -150,6 +151,10 @@ public function alterNewInstance(AdminInterface $admin, $object);
     public function alterObject(AdminInterface $admin, $object);
 
     /**
+     * NEXT_MAJOR: Remove this method.
+     *
+     * @deprecated since sonata-project/admin-bundle 3.x, use configurePersistentParameters() instead.
+     *
      * Get a chance to add persistent parameters.
      *
      * @return array<string, mixed>
@@ -158,6 +163,17 @@ public function alterObject(AdminInterface $admin, $object);
      */
     public function getPersistentParameters(AdminInterface $admin);
 
+    /**
+     * Get a chance to add persistent parameters.
+     *
+     * @param array<string, mixed> $parameters
+     *
+     * @return array<string, mixed>
+     *
+     * @phpstan-param AdminInterface<T> $admin
+     */
+//    public function configurePersistentParameters(AdminInterface $admin, array $parameters);
+
     /**
      * Return the controller access mapping.
      *