Merge pull request hoogi91#60 from hoogi91/feature/improve-table-markup

Improve table header markup

Author: hoogi91

Classes/ViewHelpers/Cell/RenderViewHelper.php

@@ -39,6 +39,7 @@ public function initializeArguments(): void
             true
         );
         $this->registerArgument('isHeader', 'bool', 'True to render <th> otherwise it will be <td>', false, false);
+        $this->registerArgument('scope', 'string', 'scope attribute value', false);
     }
 
     /**
@@ -60,8 +61,13 @@ public static function renderStatic(
             $attributes .= $cell->getColspan() > 0 ? ' colspan="' . $cell->getColspan() . '"' : '';
         }
 
+        $isHeader = (bool)($arguments['isHeader'] ?? 0);
+        if ($isHeader === true && isset($arguments['scope'])) {
+            $attributes = ' scope="' . $arguments['scope'] . '"' . ($attributes ?? '');
+        }
+
         return sprintf(
-            (bool)($arguments['isHeader'] ?? 0) === true ? '<th%s>%s</th>' : '<td%s>%s</td>',
+            $isHeader === true ? '<th%s>%s</th>' : '<td%s>%s</td>',
             $attributes ?? '',
             $renderChildrenClosure()
         );

Resources/Private/Partials/Rows.html

@@ -6,7 +6,9 @@
     <f:for each="{rowsData}" as="rowData">
         <tr>
             <f:for each="{rowData}" as="value" iteration="columnIterator">
-                <s:cell.render cell="{value}" isHeader="{columnIterator.isFirst} && {firstColumnIsHeader}">
+                <s:cell.render cell="{value}"
+                               scope="{headerScope}"
+                               isHeader="({columnIterator.isFirst} && {firstColumnIsHeader}) || {forceHeader}">
                     <s:cell.value.formatted cell="{value}"/>
                 </s:cell.render>
             </f:for>

Resources/Private/Partials/Table.html

@@ -6,13 +6,14 @@
                class="table{f:if(condition: '{data.tx_spreadsheets_ignore_styles} && {data.table_class}', then: ' table-{data.table_class}')}">
             <f:if condition="{spreadsheet.headData}">
                 <thead>
-                <f:render partial="Rows" section="Main" arguments="{rowsData: spreadsheet.headData}"/>
+                <f:render partial="Rows" section="Main"
+                          arguments="{rowsData: spreadsheet.headData, forceHeader: 1, headerScope: 'col'}"/>
                 </thead>
             </f:if>
             <f:if condition="{spreadsheet.bodyData}">
                 <tbody>
                 <f:render partial="Rows" section="Main"
-                          arguments="{rowsData: spreadsheet.bodyData, firstColumnIsHeader: spreadsheet.firstColumnIsHeader}"/>
+                          arguments="{rowsData: spreadsheet.bodyData, firstColumnIsHeader: spreadsheet.firstColumnIsHeader, headerScope: 'row'}"/>
                 </tbody>
             </f:if>
             <f:if condition="{spreadsheet.footData}">

Tests/Functional/ViewHelpers/CellRenderViewHelperTest.php

@@ -12,8 +12,12 @@ class CellRenderViewHelperTest extends AbstractViewHelperTestCase
     /**
      * @dataProvider cellProvider
      */
-    public function testRender(string $expectedAttributes, ?array $cellMock, bool $isHeader = false): void
-    {
+    public function testRender(
+        string $expectedAttributes,
+        ?array $cellMock,
+        ?string $scope = null,
+        bool $isHeader = false
+    ): void {
         if ($cellMock !== null) {
             $cellValue = $this->createConfiguredMock(CellDataValueObject::class, $cellMock);
         }
@@ -24,8 +28,8 @@ public function testRender(string $expectedAttributes, ?array $cellMock, bool $i
                 $expectedAttributes !== '' ? ' ' . $expectedAttributes : ''
             ),
             $this->getView(
-                '<test:cell.render cell="{cell}" isHeader="{isHeader}">content</test:cell.render>',
-                ['cell' => $cellValue ?? null, 'isHeader' => $isHeader]
+                '<test:cell.render cell="{cell}" scope="{scope}" isHeader="{isHeader}">content</test:cell.render>',
+                ['cell' => $cellValue ?? null, 'scope' => $scope ?? null, 'isHeader' => $isHeader]
             )->render()
         );
     }
@@ -35,7 +39,33 @@ public function testRender(string $expectedAttributes, ?array $cellMock, bool $i
      */
     public function testRenderAsHeader(string $expectedAttributes, ?array $cellMock): void
     {
-        $this->testRender($expectedAttributes, $cellMock, true);
+        $this->testRender($expectedAttributes, $cellMock, null, true);
+    }
+
+    /**
+     * @dataProvider cellProvider
+     */
+    public function testRenderWithRowScope(string $expectedAttributes, ?array $cellMock): void
+    {
+        $this->testRender($expectedAttributes, $cellMock, 'row');
+    }
+
+    /**
+     * @dataProvider cellProvider
+     */
+    public function testRenderAsHeaderWithRowScope(string $expectedAttributes, ?array $cellMock): void
+    {
+        $expectedAttributes = trim('scope="row" ' . $expectedAttributes);
+        $this->testRender($expectedAttributes, $cellMock, 'row', true);
+    }
+
+    /**
+     * @dataProvider cellProvider
+     */
+    public function testRenderAsHeaderWithColScope(string $expectedAttributes, ?array $cellMock): void
+    {
+        $expectedAttributes = trim('scope="col" ' . $expectedAttributes);
+        $this->testRender($expectedAttributes, $cellMock, 'col', true);
     }
 
     /**