Add AbstractAdmin::configureExportFields extension point (#6348)

sonata-project · Sep 7, 2020 · 8146671 · 8146671
1 parent 57ee852
commit 8146671
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/docs/reference/action_export.rst b/docs/reference/action_export.rst
@@ -29,9 +29,9 @@ Picking which fields to export
 By default, all fields are exported. More accurately, it depends on the
 persistence backend you are using, but for instance, the doctrine ORM backend
 exports all fields (associations are not exported). If you want to change this
-behavior for a specific admin, you can override the ``getExportFields()`` method::
+behavior for a specific admin, you can override the ``configureExportFields()`` method::
 
-    public function getExportFields()
+    protected function configureExportFields(): array
     {
         return ['givenName', 'familyName', 'contact.phone', 'getAddress'];
     }

diff --git a/src/Admin/AbstractAdmin.php b/src/Admin/AbstractAdmin.php
@@ -658,11 +658,13 @@ public function getExportFormats()
     }
 
     /**
+     * @final since sonata-project/admin-bundle 3.x
+     *
      * @return array
      */
     public function getExportFields()
     {
-        $fields = $this->getModelManager()->getExportFields($this->getClass());
+        $fields = $this->configureExportFields();
 
         foreach ($this->getExtensions() as $extension) {
             if (method_exists($extension, 'configureExportFields')) {
@@ -3259,6 +3261,14 @@ public function canAccessObject($action, $object)
         return $this->hasAccess($action, $object);
     }
 
+    /**
+     * @return string[]
+     */
+    protected function configureExportFields(): array
+    {
+        return $this->getModelManager()->getExportFields($this->getClass());
+    }
+
     protected function configureQuery(ProxyQueryInterface $query): ProxyQueryInterface
     {
         return $query;