[Improvement] Add exportable flag to column definition

doc/03_Grid.md

@@ -8,6 +8,7 @@ in addition, it has a configuration which can be used to configure the column, l
 
 ## ColumnConfiguration
 A column configuration represents how the column should behave, for example if it should be sort-able or editable. 
+For the column to be exportable please make sure that it can be represented as a string.
 
 ## ColumnData
 A column data is the actual data for a column. It has a reference to the column and the actual data.

src/Asset/ExecutionEngine/AutomationAction/Messenger/Handler/CsvCreationHandler.php

@@ -57,8 +57,10 @@ public function __invoke(CsvCreationMessage $message): void
         }
         $settings = $this->extractConfigFieldFromJobStepConfig($message, Csv::JOB_STEP_CONFIG_SETTINGS->value);
         $columnCollection = $this->gridService->getConfigurationFromArray(
-            $this->extractConfigFieldFromJobStepConfig($message, Csv::JOB_STEP_CONFIG_CONFIGURATION->value)
+            $this->extractConfigFieldFromJobStepConfig($message, Csv::JOB_STEP_CONFIG_CONFIGURATION->value),
+            true
         );
+
         if (!isset($jobRun->getContext()[Csv::ASSET_EXPORT_DATA->value])) {
             $this->abort($this->getAbortData(
                 Config::CSV_CREATION_FAILED_MESSAGE->value,

src/Asset/ExecutionEngine/AutomationAction/Messenger/Handler/CsvDataCollectionHandler.php

@@ -85,8 +85,10 @@ public function __invoke(CsvCollectionMessage $message): void
 
             return;
         }
+
         $columnCollection = $this->gridService->getConfigurationFromArray(
-            $this->extractConfigFieldFromJobStepConfig($message, Csv::JOB_STEP_CONFIG_CONFIGURATION->value)
+            $this->extractConfigFieldFromJobStepConfig($message, Csv::JOB_STEP_CONFIG_CONFIGURATION->value),
+            true
         );
 
         try {

src/Grid/Column/ColumnDefinitionInterface.php

@@ -25,4 +25,6 @@ public function getConfig(mixed $config): array;
     public function isSortable(): bool;
 
     public function getFrontendType(): string;
+
+    public function isExportable(): bool;
 }

src/Grid/Column/Definition/MetaData/AssetDefinition.php

@@ -44,4 +44,9 @@ public function getFrontendType(): string
     {
         return FrontendType::ELEMENT_DROPZONE->value;
     }
+
+    public function isExportable(): bool
+    {
+        return true;
+    }
 }

src/Grid/Column/Definition/MetaData/CheckboxDefinition.php

@@ -44,4 +44,9 @@ public function getFrontendType(): string
     {
         return FrontendType::CHECKBOX->value;
     }
+
+    public function isExportable(): bool
+    {
+        return true;
+    }
 }

src/Grid/Column/Definition/MetaData/DataObjectDefinition.php

@@ -44,4 +44,9 @@ public function getFrontendType(): string
     {
         return FrontendType::ELEMENT_DROPZONE->value;
     }
+
+    public function isExportable(): bool
+    {
+        return true;
+    }
 }

src/Grid/Column/Definition/MetaData/DateDefinition.php

@@ -44,4 +44,9 @@ public function getFrontendType(): string
     {
         return FrontendType::DATETIME->value;
     }
+
+    public function isExportable(): bool
+    {
+        return true;
+    }
 }

src/Grid/Column/Definition/MetaData/DocumentDefinition.php

@@ -44,4 +44,9 @@ public function getFrontendType(): string
     {
         return FrontendType::ELEMENT_DROPZONE->value;
     }
+
+    public function isExportable(): bool
+    {
+        return true;
+    }
 }

src/Grid/Column/Definition/MetaData/InputDefinition.php

@@ -44,4 +44,9 @@ public function getFrontendType(): string
     {
         return FrontendType::INPUT->value;
     }
+
+    public function isExportable(): bool
+    {
+        return true;
+    }
 }

src/Grid/Column/Definition/MetaData/SelectDefinition.php

@@ -46,4 +46,9 @@ public function getFrontendType(): string
     {
         return FrontendType::SELECT->value;
     }
+
+    public function isExportable(): bool
+    {
+        return true;
+    }
 }

src/Grid/Column/Definition/MetaData/TextareaDefinition.php

@@ -44,4 +44,9 @@ public function getFrontendType(): string
     {
         return FrontendType::TEXTAREA->value;
     }
+
+    public function isExportable(): bool
+    {
+        return true;
+    }
 }

src/Grid/Column/Definition/System/DatetimeDefinition.php

@@ -44,4 +44,9 @@ public function getFrontendType(): string
     {
         return FrontendType::DATETIME->value;
     }
+
+    public function isExportable(): bool
+    {
+        return true;
+    }
 }

src/Grid/Column/Definition/System/FileSizeDefinition.php

@@ -43,4 +43,9 @@ public function getFrontendType(): string
     {
         return FrontendType::INPUT->value;
     }
+
+    public function isExportable(): bool
+    {
+        return true;
+    }
 }

src/Grid/Column/Definition/System/ImageDefinition.php

@@ -43,4 +43,9 @@ public function getFrontendType(): string
     {
         return FrontendType::IMAGE->value;
     }
+
+    public function isExportable(): bool
+    {
+        return false;
+    }
 }

src/Grid/Column/Definition/System/IntegerDefinition.php

@@ -44,4 +44,9 @@ public function getFrontendType(): string
     {
         return FrontendType::INPUT->value;
     }
+
+    public function isExportable(): bool
+    {
+        return true;
+    }
 }

src/Grid/Column/Definition/System/StringDefinition.php

@@ -44,4 +44,9 @@ public function getFrontendType(): string
     {
         return FrontendType::INPUT->value;
     }
+
+    public function isExportable(): bool
+    {
+        return true;
+    }
 }

src/Grid/Service/GridService.php

@@ -155,12 +155,8 @@ public function getAssetGridConfiguration(): array
                 continue;
             }
 
-            $columns = array_merge(
-                $columns,
-                $collector->getColumnConfigurations(
-                    $this->getColumnDefinitions()
-                )
-            );
+            // rather use the spread operator instead of array_merge in a loop
+            $columns = [...$columns, ...$collector->getColumnConfigurations($this->getColumnDefinitions())];
         }
 
         foreach ($columns as $column) {
@@ -186,10 +182,14 @@ public function getDataObjectGridColumns(ClassDefinition $classDefinition): Colu
     /**
      * @throws InvalidArgumentException
      */
-    public function getConfigurationFromArray(array $config): ColumnCollection
+    public function getConfigurationFromArray(array $config, bool $isExport = false): ColumnCollection
     {
         $columns = [];
         foreach ($config as $column) {
+            if ($isExport && !$this->isExportable($column['type'])) {
+                throw new InvalidArgumentException('Column type is not exportable');
+            }
+
             try {
                 $columns[] = new Column(
                     key: $column['key'],
@@ -198,7 +198,7 @@ public function getConfigurationFromArray(array $config): ColumnCollection
                     group: $column['group'] ?? null,
                     config: $column['config']
                 );
-            } catch (Exception $e) {
+            } catch (Exception) {
                 throw new InvalidArgumentException('Invalid column configuration');
             }
         }
@@ -268,4 +268,13 @@ private function getColumnResolvers(): array
 
         return $this->columnResolvers;
     }
+
+    private function isExportable(string $type): bool
+    {
+        if (!array_key_exists($type, $this->getColumnDefinitions())) {
+            return false;
+        }
+
+        return $this->getColumnDefinitions()[$type]->isExportable();
+    }
 }

src/Grid/Service/GridServiceInterface.php

@@ -56,7 +56,7 @@ public function getGridValuesForElement(
         string $elementType
     ): array;
 
-    public function getConfigurationFromArray(array $config): ColumnCollection;
+    public function getConfigurationFromArray(array $config, bool $isExport = false): ColumnCollection;
 
     public function getAssetGrid(GridParameter $gridParameter): Collection;