[Bug]: [Custom Reports] Report Configuration not compatible to classic-ui (#1605)

mcop1 · web-flow · commit 4aec3f33eec9 · 2026-01-19T08:57:17.000+01:00
* Added (de)hydrator for converting values from schema to core model

* Apply php-cs-fixer changes

* Adapted key for filterType to filter
diff --git a/src/Bundle/CustomReport/Hydrator/ColumnHydrator.php b/src/Bundle/CustomReport/Hydrator/ColumnHydrator.php
@@ -60,8 +60,8 @@ public function getCustomReportColumnConfiguration(Config $report): array
                 $column['id'] ?? '',
                 is_int($width) ? $width : null,
                 $column['displayType'] ?? null,
-                $column['filterType'] ?? null,
-                $column['filterDrilldown'] ?? null,
+                $column['filter'] ?? null,
+                $column['filter_drilldown'] ?? null,
                 $metadata && $metadata->isDisableOrderBy(),
                 $metadata && $metadata->isDisableFilterable(),
                 $metadata && $metadata->isDisableDropdownFilterable(),
@@ -72,6 +72,28 @@ public function getCustomReportColumnConfiguration(Config $report): array
         return $columnConfig;
     }
 
+    public function dehydrateColumnConfiguration(array $columnConfigurations): array
+    {
+        $dehydrated = [];
+        foreach ($columnConfigurations as $configuration) {
+            $dehydrated[] = [
+                'name' => $configuration['name'],
+                'display' => $configuration['display'],
+                'export' => $configuration['export'],
+                'order' => $configuration['order'],
+                'label' => $configuration['label'],
+                'action' => $configuration['action'],
+                'id' => $configuration['id'],
+                'width' => $configuration['width'],
+                'displayType' => $configuration['displayType'],
+                'filter' => $configuration['filterType'],
+                'filter_drilldown' => $configuration['filterDrilldown'],
+            ];
+        }
+
+        return $dehydrated;
+    }
+
     private function getMetadataMap(Config $report): array
     {
         $adapter = $this->adapterService->getAdapter($report);
diff --git a/src/Bundle/CustomReport/Hydrator/ColumnHydratorInterface.php b/src/Bundle/CustomReport/Hydrator/ColumnHydratorInterface.php
@@ -25,4 +25,6 @@ interface ColumnHydratorInterface
     public function hydrateColumnInfo(ColumnInformation $information): CustomReportColumnInformation;
 
     public function getCustomReportColumnConfiguration(Config $report): array;
+
+    public function dehydrateColumnConfiguration(array $columnConfigurations): array;
 }
diff --git a/src/Bundle/CustomReport/Hydrator/CustomReportHydrator.php b/src/Bundle/CustomReport/Hydrator/CustomReportHydrator.php
@@ -19,6 +19,8 @@
 use Pimcore\Bundle\StudioBackendBundle\Bundle\CustomReport\Schema\CustomReportDrillDownOption;
 use Pimcore\Bundle\StudioBackendBundle\Bundle\CustomReport\Schema\CustomReportTreeConfigNode;
 use Pimcore\Bundle\StudioBackendBundle\Bundle\CustomReport\Schema\CustomReportTreeNode;
+use Pimcore\Bundle\StudioBackendBundle\Bundle\CustomReport\Schema\CustomReportUpdate;
+use Pimcore\Bundle\StudioBackendBundle\Bundle\CustomReport\Service\AdapterServiceInterface;
 
 /**
  * @internal
@@ -27,6 +29,7 @@
 {
     public function __construct(
         private ColumnHydratorInterface $columnHydrator,
+        private readonly AdapterServiceInterface $adapterService
     ) {
     }
 
@@ -93,4 +96,36 @@ public function hydrateDrillDownOption(array $drillDownData): CustomReportDrillD
             $drillDownData['value'] ?? ''
         );
     }
+
+    public function dehydrateReportDetails(
+        Config $config,
+        CustomReportUpdate $customReportUpdate
+    ): Config {
+        $adapter = $this->adapterService->getAdapter($config);
+
+        $config->setSql($customReportUpdate->getSql());
+        $config->setColumnConfiguration(
+            $this->columnHydrator->dehydrateColumnConfiguration(
+                $customReportUpdate->getColumnConfigurations()
+            )
+        );
+        $config->setDataSourceConfig($customReportUpdate->getDataSourceConfig());
+        $config->setNiceName($customReportUpdate->getNiceName());
+        $config->setGroup($customReportUpdate->getGroup());
+        $config->setGroupIconClass($customReportUpdate->getGroupIconClass());
+        $config->setIconClass($customReportUpdate->getIconClass());
+        $config->setMenuShortcut($customReportUpdate->getMenuShortcut());
+        $config->setReportClass($customReportUpdate->getReportClass());
+        $config->setChartType($customReportUpdate->getChartType());
+        $config->setPieColumn($customReportUpdate->getPieColumn());
+        $config->setPieLabelColumn($customReportUpdate->getPieLabelColumn());
+        $config->setXAxis($customReportUpdate->getXAxis());
+        $config->setYAxis($customReportUpdate->getYAxis());
+        $config->setShareGlobally($customReportUpdate->getSharedGlobally());
+        $config->setSharedUserNames($customReportUpdate->getSharedUserNames());
+        $config->setSharedRoleNames($customReportUpdate->getSharedRoleNames());
+        $config->setPagination($adapter->getPagination());
+
+        return $config;
+    }
 }
diff --git a/src/Bundle/CustomReport/Hydrator/CustomReportHydratorInterface.php b/src/Bundle/CustomReport/Hydrator/CustomReportHydratorInterface.php
@@ -19,6 +19,7 @@
 use Pimcore\Bundle\StudioBackendBundle\Bundle\CustomReport\Schema\CustomReportDrillDownOption;
 use Pimcore\Bundle\StudioBackendBundle\Bundle\CustomReport\Schema\CustomReportTreeConfigNode;
 use Pimcore\Bundle\StudioBackendBundle\Bundle\CustomReport\Schema\CustomReportTreeNode;
+use Pimcore\Bundle\StudioBackendBundle\Bundle\CustomReport\Schema\CustomReportUpdate;
 
 /**
  * @internal
@@ -34,4 +35,9 @@ public function extractTreeData(Config $report): CustomReportTreeNode;
     public function extractChartData(array $chartData): CustomReportChartData;
 
     public function hydrateDrillDownOption(array $drillDownData): CustomReportDrillDownOption;
+
+    public function dehydrateReportDetails(
+        Config $config,
+        CustomReportUpdate $customReportUpdate
+    ): Config;
 }
diff --git a/src/Bundle/CustomReport/Repository/CustomReportRepository.php b/src/Bundle/CustomReport/Repository/CustomReportRepository.php
@@ -17,8 +17,6 @@
 use Pimcore\Bundle\CustomReportsBundle\Tool\Config;
 use Pimcore\Bundle\CustomReportsBundle\Tool\Config\Listing;
 use Pimcore\Bundle\StaticResolverBundle\Models\Tool\CustomReportResolverInterface;
-use Pimcore\Bundle\StudioBackendBundle\Bundle\CustomReport\Schema\CustomReportUpdate;
-use Pimcore\Bundle\StudioBackendBundle\Bundle\CustomReport\Service\AdapterServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotFoundException;
 use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotWriteableException;
 use Pimcore\Bundle\StudioBackendBundle\Security\Service\SecurityServiceInterface;
@@ -33,7 +31,6 @@ final class CustomReportRepository implements CustomReportRepositoryInterface
     use JsonHelperTrait;
 
     public function __construct(
-        private readonly AdapterServiceInterface $adapterService,
         private readonly SecurityServiceInterface $securityService,
         private readonly CustomReportResolverInterface $customReportResolver
     ) {
@@ -106,7 +103,7 @@ public function create(string $name): Config
     /**
      * {@inheritdoc}
      */
-    public function update(Config $config, CustomReportUpdate $parameters): Config
+    public function update(Config $config): Config
     {
         if (!$config->isWriteable()) {
             throw new NotWriteableException(
@@ -115,27 +112,6 @@ public function update(Config $config, CustomReportUpdate $parameters): Config
             );
         }
 
-        $adapter = $this->adapterService->getAdapter($config);
-
-        $config->setSql($parameters->getSql());
-        $config->setColumnConfiguration($parameters->getColumnConfigurations());
-        $config->setDataSourceConfig($parameters->getDataSourceConfig());
-        $config->setNiceName($parameters->getNiceName());
-        $config->setGroup($parameters->getGroup());
-        $config->setGroupIconClass($parameters->getGroupIconClass());
-        $config->setIconClass($parameters->getIconClass());
-        $config->setMenuShortcut($parameters->getMenuShortcut());
-        $config->setReportClass($parameters->getReportClass());
-        $config->setChartType($parameters->getChartType());
-        $config->setPieColumn($parameters->getPieColumn());
-        $config->setPieLabelColumn($parameters->getPieLabelColumn());
-        $config->setXAxis($parameters->getXAxis());
-        $config->setYAxis($parameters->getYAxis());
-        $config->setShareGlobally($parameters->getSharedGlobally());
-        $config->setSharedUserNames($parameters->getSharedUserNames());
-        $config->setSharedRoleNames($parameters->getSharedRoleNames());
-        $config->setPagination($adapter->getPagination());
-
         $config->save();
 
         return $config;
diff --git a/src/Bundle/CustomReport/Repository/CustomReportRepositoryInterface.php b/src/Bundle/CustomReport/Repository/CustomReportRepositoryInterface.php
@@ -14,7 +14,6 @@
 namespace Pimcore\Bundle\StudioBackendBundle\Bundle\CustomReport\Repository;
 
 use Pimcore\Bundle\CustomReportsBundle\Tool\Config;
-use Pimcore\Bundle\StudioBackendBundle\Bundle\CustomReport\Schema\CustomReportUpdate;
 use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotFoundException;
 use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotWriteableException;
 use Pimcore\Model\User;
@@ -43,7 +42,7 @@ public function create(string $name): Config;
     /**
      * @throws NotWriteableException
      */
-    public function update(Config $config, CustomReportUpdate $parameters): Config;
+    public function update(Config $config): Config;
 
     /**
      * @throws NotWriteableException
diff --git a/src/Bundle/CustomReport/Service/CustomReportService.php b/src/Bundle/CustomReport/Service/CustomReportService.php
@@ -115,7 +115,8 @@ public function createCustomReport(CustomReportAdd $parameters): CustomReportDet
     public function updateCustomReport(string $name, CustomReportUpdate $parameters): CustomReportDetails
     {
         $customReport = $this->getCustomReportByName($name);
-        $config = $this->customReportRepository->update($customReport, $parameters);
+        $this->customReportHydrator->dehydrateReportDetails($customReport, $parameters);
+        $config = $this->customReportRepository->update($customReport);
 
         return $this->customReportHydrator->extractReportDetails($config);
     }

Original file line number	Diff line number	Diff line change
`@@ -25,4 +25,6 @@ interface ColumnHydratorInterface`
`25`	`25`	`public function hydrateColumnInfo(ColumnInformation $information): CustomReportColumnInformation;`
`26`	`26`
`27`	`27`	`public function getCustomReportColumnConfiguration(Config $report): array;`
	`28`	`+`
	`29`	`+ public function dehydrateColumnConfiguration(array $columnConfigurations): array;`
`28`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,8 @@ public function createCustomReport(CustomReportAdd $parameters): CustomReportDet`
`115`	`115`	`public function updateCustomReport(string $name, CustomReportUpdate $parameters): CustomReportDetails`
`116`	`116`	`{`
`117`	`117`	`$customReport = $this->getCustomReportByName($name);`
`118`		`- $config = $this->customReportRepository->update($customReport, $parameters);`
	`118`	`+ $this->customReportHydrator->dehydrateReportDetails($customReport, $parameters);`
	`119`	`+ $config = $this->customReportRepository->update($customReport);`
`119`	`120`
`120`	`121`	`return $this->customReportHydrator->extractReportDetails($config);`
`121`	`122`	`}`