Table Xlsx Reader and Autofilter

phpstan-baseline.neon

@@ -1334,12 +1334,12 @@ parameters:
 			message: "#^Unreachable statement \\- code above always terminates\\.$#"
 			count: 8
 			path: src/PhpSpreadsheet/Reader/Xls.php
-		
+
 		-
 			message: "#^Cannot access property \\$r on SimpleXMLElement\\|null\\.$#"
 			count: 2
 			path: src/PhpSpreadsheet/Reader/Xlsx.php
-		
+
 		-
 			message: "#^Parameter \\#1 \\$haystack of function strpos expects string, string\\|false given\\.$#"
 			count: 1
@@ -2684,3 +2684,4 @@ parameters:
 			message: "#^Property PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xls\\\\Xf\\:\\:\\$diag is never read, only written\\.$#"
 			count: 1
 			path: src/PhpSpreadsheet/Writer/Xls/Xf.php
+

samples/Table/01_Table.php

@@ -1,6 +1,7 @@
 <?php
 
 use PhpOffice\PhpSpreadsheet\Spreadsheet;
+use PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter;
 use PhpOffice\PhpSpreadsheet\Worksheet\Table;
 use PhpOffice\PhpSpreadsheet\Worksheet\Table\TableStyle;
 
@@ -46,16 +47,37 @@
     ['2011', 'Q2', 'Belgium', 350],
     ['2011', 'Q3', 'Belgium', 450],
     ['2011', 'Q4', 'Belgium', 500],
+    ['2010', 'Q1', 'UK', 690],
+    ['2010', 'Q2', 'UK', 610],
+    ['2010', 'Q3', 'UK', 620],
+    ['2010', 'Q4', 'UK', 600],
+    ['2011', 'Q1', 'UK', 720],
+    ['2011', 'Q2', 'UK', 650],
+    ['2011', 'Q3', 'UK', 580],
+    ['2011', 'Q4', 'UK', 510],
+    ['2010', 'Q1', 'France', 510],
+    ['2010', 'Q2', 'France', 490],
+    ['2010', 'Q3', 'France', 460],
+    ['2010', 'Q4', 'France', 590],
+    ['2011', 'Q1', 'France', 620],
+    ['2011', 'Q2', 'France', 650],
+    ['2011', 'Q3', 'France', 415],
+    ['2011', 'Q4', 'France', 570],
 ];
 
 $spreadsheet->getActiveSheet()->fromArray($dataArray, null, 'A2');
 
 // Create Table
 $helper->log('Create Table');
-$table = new Table('A1:D17', 'Sales_Data');
+$table = new Table('A1:D33', 'Sales_Data');
 
 // Create Columns
 $table->getColumn('D')->setShowFilterButton(false);
+$table->getAutoFilter()->getColumn('A')
+    ->setFilterType(AutoFilter\Column::AUTOFILTER_FILTERTYPE_CUSTOMFILTER)
+    ->createRule()
+    ->setRule(AutoFilter\Column\Rule::AUTOFILTER_COLUMN_RULE_GREATERTHANOREQUAL, 2011)
+    ->setRuleType(AutoFilter\Column\Rule::AUTOFILTER_RULETYPE_CUSTOMFILTER);
 
 // Create Table Style
 $helper->log('Create Table Style');

src/PhpSpreadsheet/Reader/Xlsx.php

@@ -19,6 +19,7 @@
 use PhpOffice\PhpSpreadsheet\Reader\Xlsx\SheetViewOptions;
 use PhpOffice\PhpSpreadsheet\Reader\Xlsx\SheetViews;
 use PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles;
+use PhpOffice\PhpSpreadsheet\Reader\Xlsx\TableReader;
 use PhpOffice\PhpSpreadsheet\Reader\Xlsx\Theme;
 use PhpOffice\PhpSpreadsheet\Reader\Xlsx\WorkbookView;
 use PhpOffice\PhpSpreadsheet\ReferenceHelper;
@@ -908,7 +909,8 @@ protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
                             }
 
                             if ($this->readDataOnly === false) {
-                                $this->readAutoFilterTables($xmlSheet, $docSheet, $dir, $fileWorksheet, $zip);
+                                $this->readAutoFilter($xmlSheet, $docSheet);
+                                $this->readTables($xmlSheet, $docSheet, $dir, $fileWorksheet, $zip);
                             }
 
                             if ($xmlSheet && $xmlSheet->mergeCells && $xmlSheet->mergeCells->mergeCell && !$this->readDataOnly) {
@@ -2088,23 +2090,28 @@ private function readSheetProtection(Worksheet $docSheet, SimpleXMLElement $xmlS
         }
     }
 
-    private function readAutoFilterTables(
+    private function readAutoFilter(
+        SimpleXMLElement $xmlSheet,
+        Worksheet $docSheet
+    ): void {
+        if ($xmlSheet && $xmlSheet->autoFilter) {
+            (new AutoFilter($docSheet, $xmlSheet))->load();
+        }
+    }
+
+    private function readTables(
         SimpleXMLElement $xmlSheet,
         Worksheet $docSheet,
         string $dir,
         string $fileWorksheet,
         ZipArchive $zip
     ): void {
-        if ($xmlSheet && $xmlSheet->autoFilter) {
-            // In older files, autofilter structure is defined in the worksheet file
-            (new AutoFilter($docSheet, $xmlSheet))->load();
-        } elseif ($xmlSheet && $xmlSheet->tableParts && (int) $xmlSheet->tableParts['count'] > 0) {
-            // But for Office365, MS decided to make it all just a bit more complicated
-            $this->readAutoFilterTablesInTablesFile($xmlSheet, $dir, $fileWorksheet, $zip, $docSheet);
+        if ($xmlSheet && $xmlSheet->tableParts && (int) $xmlSheet->tableParts['count'] > 0) {
+            $this->readTablesInTablesFile($xmlSheet, $dir, $fileWorksheet, $zip, $docSheet);
         }
     }
 
-    private function readAutoFilterTablesInTablesFile(
+    private function readTablesInTablesFile(
         SimpleXMLElement $xmlSheet,
         string $dir,
         string $fileWorksheet,
@@ -2127,8 +2134,8 @@ private function readAutoFilterTablesInTablesFile(
                         $relationshipFilePath = File::realpath($relationshipFilePath);
 
                         if ($this->fileExistsInArchive($this->zip, $relationshipFilePath)) {
-                            $autoFilter = $this->loadZip($relationshipFilePath);
-                            (new AutoFilter($docSheet, $autoFilter))->load();
+                            $tableXml = $this->loadZip($relationshipFilePath);
+                            (new TableReader($docSheet, $tableXml))->load();
                         }
                     }
                 }

src/PhpSpreadsheet/Reader/Xlsx/AutoFilter.php

@@ -4,20 +4,28 @@
 
 use PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column;
 use PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column\Rule;
+use PhpOffice\PhpSpreadsheet\Worksheet\Table;
 use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
 use SimpleXMLElement;
 
 class AutoFilter
 {
-    /** @var Worksheet */
-    private $worksheet;
+    /**
+     * @var Table|Worksheet
+     */
+    private $parent;
 
-    /** @var SimpleXMLElement */
+    /**
+     * @var SimpleXMLElement
+     */
     private $worksheetXml;
 
-    public function __construct(Worksheet $workSheet, SimpleXMLElement $worksheetXml)
+    /**
+     * @param Table|Worksheet $parent
+     */
+    public function __construct($parent, SimpleXMLElement $worksheetXml)
     {
-        $this->worksheet = $workSheet;
+        $this->parent = $parent;
         $this->worksheetXml = $worksheetXml;
     }
 
@@ -32,7 +40,7 @@ public function load(): void
 
     private function readAutoFilter(string $autoFilterRange, SimpleXMLElement $xmlSheet): void
     {
-        $autoFilter = $this->worksheet->getAutoFilter();
+        $autoFilter = $this->parent->getAutoFilter();
         $autoFilter->setRange($autoFilterRange);
 
         foreach ($xmlSheet->autoFilter->filterColumn as $filterColumn) {

src/PhpSpreadsheet/Reader/Xlsx/TableReader.php

@@ -0,0 +1,107 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheet\Reader\Xlsx;
+
+use PhpOffice\PhpSpreadsheet\Worksheet\Table;
+use PhpOffice\PhpSpreadsheet\Worksheet\Table\TableStyle;
+use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
+use SimpleXMLElement;
+
+class TableReader
+{
+    /**
+     * @var Worksheet
+     */
+    private $worksheet;
+
+    /**
+     * @var SimpleXMLElement
+     */
+    private $tableXml;
+
+    public function __construct(Worksheet $workSheet, SimpleXMLElement $tableXml)
+    {
+        $this->worksheet = $workSheet;
+        $this->tableXml = $tableXml;
+    }
+
+    /**
+     * Loads Table into the Worksheet.
+     */
+    public function load(): void
+    {
+        // Remove all "$" in the table range
+        $tableRange = (string) preg_replace('/\$/', '', $this->tableXml['ref'] ?? '');
+        if (strpos($tableRange, ':') !== false) {
+            $this->readTable($tableRange, $this->tableXml);
+        }
+    }
+
+    /**
+     * Read Table from xml.
+     */
+    private function readTable(string $tableRange, SimpleXMLElement $tableXml): void
+    {
+        $table = new Table($tableRange);
+        $table->setName((string) $tableXml['displayName']);
+        $table->setShowHeaderRow((string) $tableXml['headerRowCount'] !== '0');
+        $table->setShowTotalsRow((string) $tableXml['totalsRowCount'] === '1');
+
+        $this->readTableAutoFilter($table, $tableXml->autoFilter);
+        $this->readTableColumns($table, $tableXml->tableColumns);
+        $this->readTableStyle($table, $tableXml->tableStyleInfo);
+
+        (new AutoFilter($table, $tableXml))->load();
+        $this->worksheet->addTable($table);
+    }
+
+    /**
+     * Reads TableAutoFilter from xml.
+     */
+    private function readTableAutoFilter(Table $table, SimpleXMLElement $autoFilterXml): void
+    {
+        foreach ($autoFilterXml->filterColumn as $filterColumn) {
+            $column = $table->getColumnByOffset((int) $filterColumn['colId']);
+            $column->setShowFilterButton((string) $filterColumn['hiddenButton'] !== '1');
+        }
+    }
+
+    /**
+     * Reads TableColumns from xml.
+     */
+    private function readTableColumns(Table $table, SimpleXMLElement $tableColumnsXml): void
+    {
+        $offset = 0;
+        foreach ($tableColumnsXml->tableColumn as $tableColumn) {
+            $column = $table->getColumnByOffset($offset++);
+
+            if ($table->getShowTotalsRow()) {
+                if ($tableColumn['totalsRowLabel']) {
+                    $column->setTotalsRowLabel((string) $tableColumn['totalsRowLabel']);
+                }
+
+                if ($tableColumn['totalsRowFunction']) {
+                    $column->setTotalsRowFunction((string) $tableColumn['totalsRowFunction']);
+                }
+            }
+
+            if ($tableColumn->calculatedColumnFormula) {
+                $column->setColumnFormula((string) $tableColumn->calculatedColumnFormula);
+            }
+        }
+    }
+
+    /**
+     * Reads TableStyle from xml.
+     */
+    private function readTableStyle(Table $table, SimpleXMLElement $tableStyleInfoXml): void
+    {
+        $tableStyle = new TableStyle();
+        $tableStyle->setTheme((string) $tableStyleInfoXml['name']);
+        $tableStyle->setShowRowStripes((string) $tableStyleInfoXml['showRowStripes'] === '1');
+        $tableStyle->setShowColumnStripes((string) $tableStyleInfoXml['showColumnStripes'] === '1');
+        $tableStyle->setShowFirstColumn((string) $tableStyleInfoXml['showFirstColumn'] === '1');
+        $tableStyle->setShowLastColumn((string) $tableStyleInfoXml['showLastColumn'] === '1');
+        $table->setStyle($tableStyle);
+    }
+}

src/PhpSpreadsheet/Worksheet/Table.php

@@ -59,6 +59,13 @@ class Table
      */
     private $style;
 
+    /**
+     * Table AutoFilter.
+     *
+     * @var AutoFilter
+     */
+    private $autoFilter;
+
     /**
      * Create a new Table.
      *
@@ -70,9 +77,10 @@ class Table
      */
     public function __construct($range = '', string $name = '')
     {
+        $this->style = new TableStyle();
+        $this->autoFilter = new AutoFilter($range);
         $this->setRange($range);
         $this->setName($name);
-        $this->style = new TableStyle();
     }
 
     /**
@@ -193,6 +201,8 @@ public function setRange($range = ''): self
         }
 
         $this->range = $range;
+        $this->autoFilter->setRange($range);
+
         //    Discard any column ruless that are no longer valid within this range
         [$rangeStart, $rangeEnd] = Coordinate::rangeBoundaries($this->range);
         foreach ($this->columns as $key => $value) {
@@ -248,6 +258,7 @@ public function setWorksheet(?Worksheet $worksheet = null): self
         }
 
         $this->workSheet = $worksheet;
+        $this->autoFilter->setParent($worksheet);
 
         return $this;
     }
@@ -415,6 +426,24 @@ public function setStyle(TableStyle $style): self
         return $this;
     }
 
+    /**
+     * Get AutoFilter.
+     */
+    public function getAutoFilter(): AutoFilter
+    {
+        return $this->autoFilter;
+    }
+
+    /**
+     * Set AutoFilter.
+     */
+    public function setAutoFilter(AutoFilter $autoFilter): self
+    {
+        $this->autoFilter = $autoFilter;
+
+        return $this;
+    }
+
     /**
      * Implement PHP __clone to create a deep clone, not just a shallow copy.
      */