init

lib/PhpSpreadsheet/Worksheet/Table/Column.php

@@ -0,0 +1,240 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheet\Worksheet\Table;
+
+use PhpOffice\PhpSpreadsheet\Cell\DataType;
+use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
+use PhpOffice\PhpSpreadsheet\Spreadsheet;
+use PhpOffice\PhpSpreadsheet\Worksheet\Table;
+use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
+
+class Column
+{
+    /**
+     * Table Column Index.
+     */
+    private string $columnIndex;
+
+    /**
+     * Show Filter Button.
+     */
+    private bool $showFilterButton = true;
+
+    /**
+     * Total Row Label.
+     */
+    private ?string $totalsRowLabel = null;
+
+    /**
+     * Total Row Function.
+     */
+    private ?string $totalsRowFunction = null;
+
+    /**
+     * Total Row Formula.
+     */
+    private ?string $totalsRowFormula = null;
+
+    /**
+     * Column Formula.
+     */
+    private ?string $columnFormula = null;
+
+    /**
+     * Table.
+     */
+    private ?Table $table;
+
+    /**
+     * Create a new Column.
+     *
+     * @param string $column Column (e.g. A)
+     * @param ?Table $table Table for this column
+     */
+    public function __construct(string $column, ?Table $table = null)
+    {
+        $this->columnIndex = $column;
+        $this->table = $table;
+    }
+
+    /**
+     * Get Table column index as string eg: 'A'.
+     */
+    public function getColumnIndex(): string
+    {
+        return $this->columnIndex;
+    }
+
+    /**
+     * Set Table column index as string eg: 'A'.
+     *
+     * @param string $column Column (e.g. A)
+     */
+    public function setColumnIndex(string $column): self
+    {
+        // Uppercase coordinate
+        $column = strtoupper($column);
+        if ($this->table !== null) {
+            $this->table->isColumnInRange($column);
+        }
+
+        $this->columnIndex = $column;
+
+        return $this;
+    }
+
+    /**
+     * Get show Filter Button.
+     */
+    public function getShowFilterButton(): bool
+    {
+        return $this->showFilterButton;
+    }
+
+    /**
+     * Set show Filter Button.
+     */
+    public function setShowFilterButton(bool $showFilterButton): self
+    {
+        $this->showFilterButton = $showFilterButton;
+
+        return $this;
+    }
+
+    /**
+     * Get total Row Label.
+     */
+    public function getTotalsRowLabel(): ?string
+    {
+        return $this->totalsRowLabel;
+    }
+
+    /**
+     * Set total Row Label.
+     */
+    public function setTotalsRowLabel(string $totalsRowLabel): self
+    {
+        $this->totalsRowLabel = $totalsRowLabel;
+
+        return $this;
+    }
+
+    /**
+     * Get total Row Function.
+     */
+    public function getTotalsRowFunction(): ?string
+    {
+        return $this->totalsRowFunction;
+    }
+
+    /**
+     * Set total Row Function.
+     */
+    public function setTotalsRowFunction(string $totalsRowFunction): self
+    {
+        $this->totalsRowFunction = $totalsRowFunction;
+
+        return $this;
+    }
+
+    /**
+     * Get total Row Formula.
+     */
+    public function getTotalsRowFormula(): ?string
+    {
+        return $this->totalsRowFormula;
+    }
+
+    /**
+     * Set total Row Formula.
+     */
+    public function setTotalsRowFormula(string $totalsRowFormula): self
+    {
+        $this->totalsRowFormula = $totalsRowFormula;
+
+        return $this;
+    }
+
+    /**
+     * Get column Formula.
+     */
+    public function getColumnFormula(): ?string
+    {
+        return $this->columnFormula;
+    }
+
+    /**
+     * Set column Formula.
+     */
+    public function setColumnFormula(string $columnFormula): self
+    {
+        $this->columnFormula = $columnFormula;
+
+        return $this;
+    }
+
+    /**
+     * Get this Column's Table.
+     */
+    public function getTable(): ?Table
+    {
+        return $this->table;
+    }
+
+    /**
+     * Set this Column's Table.
+     */
+    public function setTable(?Table $table = null): self
+    {
+        $this->table = $table;
+
+        return $this;
+    }
+
+    public static function updateStructuredReferences(?Worksheet $workSheet, ?string $oldTitle, ?string $newTitle): void
+    {
+        if ($workSheet === null || $oldTitle === null || $oldTitle === '' || $newTitle === null) {
+            return;
+        }
+
+        // Remember that table headings are case-insensitive
+        if (StringHelper::strToLower($oldTitle) !== StringHelper::strToLower($newTitle)) {
+            // We need to check all formula cells that might contain Structured References that refer
+            //    to this column, and update those formulae to reference the new column text
+            $spreadsheet = $workSheet->getParentOrThrow();
+            foreach ($spreadsheet->getWorksheetIterator() as $sheet) {
+                self::updateStructuredReferencesInCells($sheet, $oldTitle, $newTitle);
+            }
+            self::updateStructuredReferencesInNamedFormulae($spreadsheet, $oldTitle, $newTitle);
+        }
+    }
+
+    private static function updateStructuredReferencesInCells(Worksheet $worksheet, string $oldTitle, string $newTitle): void
+    {
+        $pattern = '/\[(@?)' . preg_quote($oldTitle, '/') . '\]/mui';
+
+        foreach ($worksheet->getCoordinates(false) as $coordinate) {
+            $cell = $worksheet->getCell($coordinate);
+            if ($cell->getDataType() === DataType::TYPE_FORMULA) {
+                $formula = $cell->getValue();
+                if (preg_match($pattern, $formula) === 1) {
+                    $formula = preg_replace($pattern, "[$1{$newTitle}]", $formula);
+                    $cell->setValueExplicit($formula, DataType::TYPE_FORMULA);
+                }
+            }
+        }
+    }
+
+    private static function updateStructuredReferencesInNamedFormulae(Spreadsheet $spreadsheet, string $oldTitle, string $newTitle): void
+    {
+        $pattern = '/\[(@?)' . preg_quote($oldTitle, '/') . '\]/mui';
+
+        foreach ($spreadsheet->getNamedFormulae() as $namedFormula) {
+            $formula = $namedFormula->getValue();
+            if (preg_match($pattern, $formula) === 1) {
+                $formula = preg_replace($pattern, "[$1{$newTitle}]", $formula);
+                $namedFormula->setValue($formula); // @phpstan-ignore-line
+            }
+        }
+    }
+}