Unit Tests

Author: MarkBaker

src/PhpSpreadsheet/Worksheet/Worksheet.php

@@ -2236,13 +2236,23 @@ public function getTableNames(): array
         return $tableNames;
     }
 
+    /**
+     * @param string $name the table name to search
+     *
+     * @return null|Table The table from the tables collection, or null if not found
+     */
     public function getTableByName(string $name): ?Table
     {
         $tableIndex = $this->getTableIndexByName($name);
 
         return ($tableIndex === null) ? null : $this->tableCollection[$tableIndex];
     }
 
+    /**
+     * @param string $name the table name to search
+     *
+     * @return null|int The index of the located table in the tables collection, or null if not found
+     */
     protected function getTableIndexByName(string $name): ?int
     {
         $name = Shared\StringHelper::strToUpper($name);

tests/PhpSpreadsheetTests/Worksheet/WorksheetTest.php

@@ -4,8 +4,10 @@
 
 use Exception;
 use PhpOffice\PhpSpreadsheet\Cell\DataType;
+use PhpOffice\PhpSpreadsheet\Reader\Xlsx;
 use PhpOffice\PhpSpreadsheet\Spreadsheet;
 use PhpOffice\PhpSpreadsheet\Worksheet\CellIterator;
+use PhpOffice\PhpSpreadsheet\Worksheet\Table;
 use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
 use PHPUnit\Framework\TestCase;
 
@@ -506,4 +508,27 @@ public function emptyColumnProvider(): array
             ['I', true],
         ];
     }
+
+    public function testGetTableNames(): void
+    {
+        $reader = new Xlsx();
+        $spreadsheet = $reader->load('tests/data/Worksheet/Table/TableFormulae.xlsx');
+        $worksheet = $spreadsheet->getActiveSheet();
+
+        $tables = $worksheet->getTableNames();
+        self::assertSame(['DeptSales'], $tables);
+    }
+
+    public function testGetTableByName(): void
+    {
+        $reader = new Xlsx();
+        $spreadsheet = $reader->load('tests/data/Worksheet/Table/TableFormulae.xlsx');
+        $worksheet = $spreadsheet->getActiveSheet();
+
+        $table = $worksheet->getTableByName('Non-existent Table');
+        self::assertNull($table);
+
+        $table = $worksheet->getTableByName('DeptSales');
+        self::assertInstanceOf(Table::class, $table);
+    }
 }