Updated Excel export

From now on, the Excel export supports ManyToOne relations. Also
DateTime objects can be used fo the export. Doc is updated.

Author: bobvandevijver

Builder/Admin/ExcelBuilder.php

@@ -24,16 +24,23 @@ public function getYamlKey()
   }
 
   public function getFileName(){
-    if(null === ($filename =$this->getVariable('filename'))){
+    if(null === ($filename = $this->getVariable('filename'))){
       $filename = 'admin_export_'. str_replace(' ', '_', strtolower($this->getGenerator()->getFromYaml('builders.list.params.title')));
     }
     return $filename;
   }
 
   public function getFileType(){
-    if(null === ($filetype =$this->getVariable('filetype'))){
+    if(null === ($filetype = $this->getVariable('filetype'))){
       $filetype = 'Excel2007';
     }
     return $filetype;
   }
+
+  public function getDateTimeFormat(){
+    if(null === ($dateTimeFormat = $this->getVariable('datetime_format'))){
+      $dateTimeFormat = 'Y-m-d H:i:s';
+    }
+    return $dateTimeFormat;
+  }
 }

Resources/doc/builders/excel-builder.md

@@ -10,10 +10,15 @@
 To use the Excel export make sure you have installed the recommended dependency `liuggio/excelbundle` (version `>= 2.0`) and enabled it in your AppKernel.php (`new Liuggio\ExcelBundle\LiuggioExcelBundle()`). Without this bundle enabled the ExcelAction will not work.
 
 ### 1. Usage
-The Excel builder provides an Excel export of the list view. The export uses the data that is visible on the screen (and the next pages) and thus uses the filters and scopes selected.
+The Excel builder provides an Excel export of the list view. The export uses the data that is visible on the screen (and the next pages) and thus uses the filters and scopes selected. You can use object associations by just entering a dot.
 
 ### 2. Options
 
 * `display`: The same as in list/new/show/edit, selects the columns to export
 * `filename`: Specify the export filename. When null 'admin_export_{list title}' is used
 * `filetype`: Default Excel2007. See the [excelbundle documention](https://github.com/liuggio/excelbundle#not-only-excel5) for the possible options.
+* `datetime_format`: Specify the DateTime format to be used in the Excel export. Default is `Y-m-d H:i:s`.
+
+### 3. Header titles in Excel
+
+The header titles are fully customizable just as every other block. Just use the `fields` key directly under the builder. This even works for associated fields like `person.fullname`.

Resources/templates/CommonAdmin/ExcelAction/ExcelBuilderAction.php.twig

@@ -77,7 +77,23 @@ class ExcelController extends ListController
       foreach($results as $rowData){
         {% set column = 0 %}
         {% for builder_column in builder.columns %}
-          $sheet->setCellValueByColumnAndRow({{ column }}, $row, $rowData->get{{ builder_column.getter|capitalize }}());
+
+          // Retrieve relations
+          $getter = '{{ builder_column.getter }}';
+          $data = $rowData;
+          while (($pos = strpos($getter, '.')) > 0){
+            $tempGetter = 'get' . ucfirst(substr($getter, 0, $pos));
+            $getter = substr($getter, $pos + 1);
+            $data = $data->$tempGetter();
+          }
+          $getter = 'get' . ucfirst($getter);
+          $data = $data->$getter();
+
+          // Convert DateTime object to given format
+          if ($data instanceof \DateTime){
+            $data = $data->format('{{ builder.dateTimeFormat }}');
+          }
+          $sheet->setCellValueByColumnAndRow({{ column }}, $row, $data);
           {% set column = column + 1 %}
         {% endfor %}
         $row++;