Improve column merging

tansautn · tansautn · commit c7622e17077f · 2024-10-14T17:19:25.000+07:00
Add field map to formatter method
diff --git a/src/Contracts/FormatterInterface.php b/src/Contracts/FormatterInterface.php
@@ -36,5 +36,18 @@
  */
 interface FormatterInterface
 {
-    public function formatValue($value);
+    /**
+     * Format a value for export.
+     *
+     * This method is called once for each cell value that is exported.
+     * The default implementation simply returns the value as is,
+     * but you can override this method in your class to change the
+     * behavior.
+     *
+     * @param mixed  $value The value that is being exported.
+     * @param string $mappingKey The key of the mapped column that is being exported.
+     *
+     * @return mixed The formatted value.
+     */
+    public function formatValue($value, $mappingKey);
 }
diff --git a/src/Traits/ExcelExportable.php b/src/Traits/ExcelExportable.php
@@ -29,8 +29,6 @@
 namespace Zuko\Flex2Cell\Traits;
 
 
-use Illuminate\Database\Eloquent\Model;
-use Illuminate\Support\Collection;
 use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
 use PhpOffice\PhpSpreadsheet\Spreadsheet;
 use PhpOffice\PhpSpreadsheet\Writer\Xls;
@@ -220,7 +218,9 @@ public function export(string $filename)
             $this->writeHeaders($sheet);
         }
         $rowIndex = $this->appendMode ? $sheet->getHighestRow() + 1 : 3; // Start from row 3 due to double header
-        if ($this->data instanceof Collection || $this->data instanceof Model) {
+        /** @noinspection PhpUndefinedClassInspection */
+        /** @noinspection PhpUndefinedNamespaceInspection */
+        if ($this->data instanceof \Illuminate\Support\Collection || $this->data instanceof \Illuminate\Database\Eloquent\Model) {
             $this->data = $this->data->toArray();
         }
         foreach (array_chunk($this->data, $this->chunkSize) as $chunk) {
@@ -259,12 +259,15 @@ public function export(string $filename)
      */
     protected function writeHeaders($sheet)
     {
+        $this->headerRowIndex = 1; // Start with assuming headers are in the first row
         $columnIndex = 1;
         foreach ($this->headers as $header) {
             if (!in_array($header, $this->hiddens, true)) {
-                $sheet->setCellValue([$columnIndex, 1], $this->getHeader($header));
+                $displayHeader = $this->getHeader($header);
+                $sheet->setCellValue([$columnIndex, $this->headerRowIndex], $displayHeader);
                 if (isset($this->subHeaders[$header])) {
-                    $sheet->setCellValue([$columnIndex, 2], $this->getSubHeader($header));
+                    $sheet->setCellValue([$columnIndex, $this->headerRowIndex + 1], $this->getSubHeader($header));
+                    $this->headerRowIndex = 2; // If we have subheaders, main headers are now in row 2
                 }
                 $columnIndex++;
             }
@@ -428,7 +431,7 @@ protected function getColumnLetter($mappingKey)
      *
      * @param string $header The header
      *
-     * @return string The mapping key if found, null otherwise
+     * @return string|null The mapping key if found, null otherwise
      */
     protected function getMappingKeyFromHeader($header)
     {
@@ -440,7 +443,7 @@ protected function getMappingKeyFromHeader($header)
      *
      * @param string $mappingKey The mapping key
      *
-     * @return string The header if found, null otherwise
+     * @return string|null The header if found, null otherwise
      */
     protected function getHeaderFromMappingKey($mappingKey)
     {
@@ -450,7 +453,7 @@ protected function getHeaderFromMappingKey($mappingKey)
     private static function first(array $array, $callback = null, $default = null) {
         if (is_null($callback)) {
             if (empty($array)) {
-                return value($default);
+                return $default;
             }
 
             foreach ($array as $item) {
@@ -464,6 +467,6 @@ private static function first(array $array, $callback = null, $default = null) {
             }
         }
 
-        return value($default);
+        return $default;
     }
 }
diff --git a/src/Traits/HasExportAttributes.php b/src/Traits/HasExportAttributes.php
@@ -29,6 +29,8 @@
 namespace Zuko\Flex2Cell\Traits;
 
 
+use Zuko\Flex2Cell\Contracts\FormatterInterface;
+
 /**
  * Class HasExportAttributes
  *
@@ -53,7 +55,7 @@ trait HasExportAttributes
     public function setFormatters(array $formatters)
     {
         foreach ($formatters as $key => $formatter) {
-            if (is_string($formatter) && class_exists($formatter)) {
+            if (is_string($formatter) && class_exists($formatter) &&(new $formatter()) instanceof FormatterInterface) {
                 $formatter = new $formatter();
             }
             if (is_object($formatter) && method_exists($formatter, 'formatValue')) {
@@ -82,7 +84,7 @@ public function setFormatters(array $formatters)
     protected function formatValue($mappingKey, $value)
     {
         if (isset($this->formatters[$mappingKey])) {
-            return call_user_func($this->formatters[$mappingKey], $value);
+            return call_user_func($this->formatters[$mappingKey], [$value, $mappingKey]);
         }
         if (method_exists($this, 'format' . str_replace('.', '', ucwords($mappingKey, '.')) . 'Attribute')) {
             return $this->{'format' . str_replace('.', '', ucwords($mappingKey, '.')) . 'Attribute'}($value);
diff --git a/src/Traits/HasExportMerging.php b/src/Traits/HasExportMerging.php
@@ -76,17 +76,42 @@ protected function applyMerging($sheet)
     }
     protected function applyColumnMerging($sheet)
     {
+        $mergedRanges = [];
+        $hasShifted = false;
         foreach ($this->columnMergeRules as $rule) {
             $startColumn = $rule['start'];
             $endColumn = $rule['end'];
-            $sheet->mergeCells($startColumn . '1:' . $endColumn . '1');
-            $sheet->setCellValue($startColumn . '1', $rule['label']);
-            if ($rule['shiftDown']) {
-                $sheet->insertNewRowBefore(2);
-                for ($col = Coordinate::columnIndexFromString($startColumn);$col <= Coordinate::columnIndexFromString($endColumn);$col++) {
-                    $letter = Coordinate::stringFromColumnIndex($col);
-                    $originalHeader = $sheet->getCell($letter . '3')->getValue();
-                    $sheet->setCellValue($letter . '2', $originalHeader);
+            $targetRow = $this->headerRowIndex;
+            if ($rule['shiftDown'] ?? false) {
+                // Insert a new row above the current header row
+                if(!$hasShifted) {
+                    $sheet->insertNewRowBefore($this->headerRowIndex);
+                    $this->headerRowIndex++;
+                    $targetRow = ($this->headerRowIndex - 1);
+                    $hasShifted = true;
+                }
+                // Set the merged header value
+                $sheet->setCellValue($startColumn . $targetRow, $rule['label']);
+
+                // Merge the cells
+                $sheet->mergeCells($startColumn . $targetRow . ':' . $endColumn . $targetRow);
+                $startColumn = Coordinate::columnIndexFromString($startColumn);
+                $endColumn = Coordinate::columnIndexFromString($endColumn);
+                if(!in_array($ranges = range($startColumn, $endColumn), $mergedRanges, true)){
+                    $mergedRanges[] = $ranges;
+                }
+            } else {
+                // If not shifting down, merge at the current header row
+                $sheet->mergeCells($startColumn . $this->headerRowIndex . ':' . $endColumn . $this->headerRowIndex);
+                $sheet->setCellValue($startColumn . $this->headerRowIndex, $rule['label']);
+            }
+        }
+        if($hasShifted){
+            $flat = array_merge(...$mergedRanges);
+            foreach ($this->headers as $index => $header) {
+                if(!in_array($index, $flat, true)){
+                    $curLetter = Coordinate::stringFromColumnIndex($index);
+                    $sheet->mergeCells($curLetter . $this->headerRowIndex . ':' . $curLetter . ($this->headerRowIndex - 1));
                 }
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,6 @@`
`29`	`29`	`namespace Zuko\Flex2Cell\Traits;`
`30`	`30`
`31`	`31`
`32`		`-use Illuminate\Database\Eloquent\Model;`
`33`		`-use Illuminate\Support\Collection;`
`34`	`32`	`use PhpOffice\PhpSpreadsheet\Cell\Coordinate;`
`35`	`33`	`use PhpOffice\PhpSpreadsheet\Spreadsheet;`
`36`	`34`	`use PhpOffice\PhpSpreadsheet\Writer\Xls;`
`@@ -220,7 +218,9 @@ public function export(string $filename)`
`220`	`218`	`$this->writeHeaders($sheet);`
`221`	`219`	`}`
`222`	`220`	`$rowIndex = $this->appendMode ? $sheet->getHighestRow() + 1 : 3; // Start from row 3 due to double header`
`223`		`- if ($this->data instanceof Collection \|\| $this->data instanceof Model) {`
	`221`	`+ /** @noinspection PhpUndefinedClassInspection */`
	`222`	`+ /** @noinspection PhpUndefinedNamespaceInspection */`
	`223`	`+ if ($this->data instanceof \Illuminate\Support\Collection \|\| $this->data instanceof \Illuminate\Database\Eloquent\Model) {`
`224`	`224`	`$this->data = $this->data->toArray();`
`225`	`225`	`}`
`226`	`226`	`foreach (array_chunk($this->data, $this->chunkSize) as $chunk) {`
`@@ -259,12 +259,15 @@ public function export(string $filename)`
`259`	`259`	`*/`
`260`	`260`	`protected function writeHeaders($sheet)`
`261`	`261`	`{`
	`262`	`+ $this->headerRowIndex = 1; // Start with assuming headers are in the first row`
`262`	`263`	`$columnIndex = 1;`
`263`	`264`	`foreach ($this->headers as $header) {`
`264`	`265`	`if (!in_array($header, $this->hiddens, true)) {`
`265`		`- $sheet->setCellValue([$columnIndex, 1], $this->getHeader($header));`
	`266`	`+ $displayHeader = $this->getHeader($header);`
	`267`	`+ $sheet->setCellValue([$columnIndex, $this->headerRowIndex], $displayHeader);`
`266`	`268`	`if (isset($this->subHeaders[$header])) {`
`267`		`- $sheet->setCellValue([$columnIndex, 2], $this->getSubHeader($header));`
	`269`	`+ $sheet->setCellValue([$columnIndex, $this->headerRowIndex + 1], $this->getSubHeader($header));`
	`270`	`+ $this->headerRowIndex = 2; // If we have subheaders, main headers are now in row 2`
`268`	`271`	`}`
`269`	`272`	`$columnIndex++;`
`270`	`273`	`}`
`@@ -428,7 +431,7 @@ protected function getColumnLetter($mappingKey)`
`428`	`431`	`*`
`429`	`432`	`* @param string $header The header`
`430`	`433`	`*`
`431`		`- * @return string The mapping key if found, null otherwise`
	`434`	`+ * @return string\|null The mapping key if found, null otherwise`
`432`	`435`	`*/`
`433`	`436`	`protected function getMappingKeyFromHeader($header)`
`434`	`437`	`{`
`@@ -440,7 +443,7 @@ protected function getMappingKeyFromHeader($header)`
`440`	`443`	`*`
`441`	`444`	`* @param string $mappingKey The mapping key`
`442`	`445`	`*`
`443`		`- * @return string The header if found, null otherwise`
	`446`	`+ * @return string\|null The header if found, null otherwise`
`444`	`447`	`*/`
`445`	`448`	`protected function getHeaderFromMappingKey($mappingKey)`
`446`	`449`	`{`
`@@ -450,7 +453,7 @@ protected function getHeaderFromMappingKey($mappingKey)`
`450`	`453`	`private static function first(array $array, $callback = null, $default = null) {`
`451`	`454`	`if (is_null($callback)) {`
`452`	`455`	`if (empty($array)) {`
`453`		`- return value($default);`
	`456`	`+ return $default;`
`454`	`457`	`}`
`455`	`458`
`456`	`459`	`foreach ($array as $item) {`
`@@ -464,6 +467,6 @@ private static function first(array $array, $callback = null, $default = null) {`
`464`	`467`	`}`
`465`	`468`	`}`
`466`	`469`
`467`		`- return value($default);`
	`470`	`+ return $default;`
`468`	`471`	`}`
`469`	`472`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@`
`29`	`29`	`namespace Zuko\Flex2Cell\Traits;`
`30`	`30`
`31`	`31`
	`32`	`+use Zuko\Flex2Cell\Contracts\FormatterInterface;`
	`33`	`+`
`32`	`34`	`/**`
`33`	`35`	`* Class HasExportAttributes`
`34`	`36`	`*`
`@@ -53,7 +55,7 @@ trait HasExportAttributes`
`53`	`55`	`public function setFormatters(array $formatters)`
`54`	`56`	`{`
`55`	`57`	`foreach ($formatters as $key => $formatter) {`
`56`		`- if (is_string($formatter) && class_exists($formatter)) {`
	`58`	`+ if (is_string($formatter) && class_exists($formatter) &&(new $formatter()) instanceof FormatterInterface) {`
`57`	`59`	`$formatter = new $formatter();`
`58`	`60`	`}`
`59`	`61`	`if (is_object($formatter) && method_exists($formatter, 'formatValue')) {`
`@@ -82,7 +84,7 @@ public function setFormatters(array $formatters)`
`82`	`84`	`protected function formatValue($mappingKey, $value)`
`83`	`85`	`{`
`84`	`86`	`if (isset($this->formatters[$mappingKey])) {`
`85`		`- return call_user_func($this->formatters[$mappingKey], $value);`
	`87`	`+ return call_user_func($this->formatters[$mappingKey], [$value, $mappingKey]);`
`86`	`88`	`}`
`87`	`89`	`if (method_exists($this, 'format' . str_replace('.', '', ucwords($mappingKey, '.')) . 'Attribute')) {`
`88`	`90`	`return $this->{'format' . str_replace('.', '', ucwords($mappingKey, '.')) . 'Attribute'}($value);`