Merge pull request #4317 from oleibman/crstyle

Get Style for Row or Column

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 
 ### Added
 
+- Methods to get style for row or column. [PR #4317](https://github.com/PHPOffice/PhpSpreadsheet/pull/4317)
 - Method for duplicating worksheet in spreadsheet. [PR #4315](https://github.com/PHPOffice/PhpSpreadsheet/pull/4315)
 
 ### Changed

docs/topics/recipes.md

@@ -926,6 +926,7 @@ loop. This is much faster compared to looping through cells and styling
 them individually.
 
 **Tip** If you are styling entire row(s) or column(s), e.g. getStyle('A:A'), it is recommended to use applyFromArray as described below rather than setting the styles individually as described above.
+Also, starting with release 3.9.0, you should use getRowStyle or getColumnStyle to get the style for an entire row or column.
 
 There is also an alternative manner to set styles. The following code
 sets a cell's style to font bold, alignment right, top border thin and a

src/PhpSpreadsheet/Spreadsheet.php

@@ -1101,6 +1101,11 @@ public function getCellXfByIndex(int $cellStyleIndex): Style
         return $this->cellXfCollection[$cellStyleIndex];
     }
 
+    public function getCellXfByIndexOrNull(?int $cellStyleIndex): ?Style
+    {
+        return ($cellStyleIndex === null) ? null : ($this->cellXfCollection[$cellStyleIndex] ?? null);
+    }
+
     /**
      * Get cellXf by hash code.
      *

src/PhpSpreadsheet/Worksheet/Worksheet.php

@@ -1335,6 +1335,13 @@ public function getRowDimension(int $row): RowDimension
         return $this->rowDimensions[$row];
     }
 
+    public function getRowStyle(int $row): ?Style
+    {
+        return $this->parent?->getCellXfByIndexOrNull(
+            ($this->rowDimensions[$row] ?? null)?->getXfIndex()
+        );
+    }
+
     public function rowDimensionExists(int $row): bool
     {
         return isset($this->rowDimensions[$row]);
@@ -1378,6 +1385,13 @@ public function getColumnDimensionByColumn(int $columnIndex): ColumnDimension
         return $this->getColumnDimension(Coordinate::stringFromColumnIndex($columnIndex));
     }
 
+    public function getColumnStyle(string $column): ?Style
+    {
+        return $this->parent?->getCellXfByIndexOrNull(
+            ($this->columnDimensions[$column] ?? null)?->getXfIndex()
+        );
+    }
+
     /**
      * Get styles.
      *

tests/PhpSpreadsheetTests/Worksheet/ColumnRowStyleTest.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpSpreadsheetTests\Worksheet;
+
+use PhpOffice\PhpSpreadsheet\Spreadsheet;
+use PHPUnit\Framework\TestCase;
+
+class ColumnRowStyleTest extends TestCase
+{
+    public function testColumnStyle(): void
+    {
+        $spreadsheet = new Spreadsheet();
+        $sheet = $spreadsheet->getActiveSheet();
+        $columnStyle = $sheet->getStyle('B:C');
+        $columnStyle->applyFromArray([
+            'font' => ['name' => 'Who knows'],
+        ]);
+        self::assertSame(
+            'Who knows',
+            $sheet->getColumnStyle('B')?->getFont()->getName()
+        );
+        self::assertSame(
+            'Who knows',
+            $sheet->getColumnStyle('C')?->getFont()->getName()
+        );
+        self::assertNull(
+            $sheet->getColumnStyle('A')?->getFont()->getName()
+        );
+        self::assertNull(
+            $sheet->getColumnStyle('D')?->getFont()->getName()
+        );
+
+        $spreadsheet->disconnectWorksheets();
+    }
+
+    public function testRowStyle(): void
+    {
+        $spreadsheet = new Spreadsheet();
+        $sheet = $spreadsheet->getActiveSheet();
+        $rowStyle = $sheet->getStyle('2:3');
+        $rowStyle->applyFromArray([
+            'font' => ['name' => 'Who knows'],
+        ]);
+        self::assertSame(
+            'Who knows',
+            $sheet->getRowStyle(2)?->getFont()->getName()
+        );
+        self::assertSame(
+            'Who knows',
+            $sheet->getRowStyle(3)?->getFont()->getName()
+        );
+        self::assertNull(
+            $sheet->getRowStyle(1)?->getFont()->getName()
+        );
+        self::assertNull(
+            $sheet->getRowStyle(4)?->getFont()->getName()
+        );
+
+        $spreadsheet->disconnectWorksheets();
+    }
+}