Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 74 |
|
0.00% |
0 / 6 |
CRAP | |
0.00% |
0 / 1 |
| TableRenderer | |
0.00% |
0 / 74 |
|
0.00% |
0 / 6 |
420 | |
0.00% |
0 / 1 |
| __construct | |
0.00% |
0 / 4 |
|
0.00% |
0 / 1 |
2 | |||
| render | |
0.00% |
0 / 20 |
|
0.00% |
0 / 1 |
12 | |||
| prepareColumns | |
0.00% |
0 / 13 |
|
0.00% |
0 / 1 |
12 | |||
| prepareRows | |
0.00% |
0 / 12 |
|
0.00% |
0 / 1 |
30 | |||
| getSortIconClass | |
0.00% |
0 / 4 |
|
0.00% |
0 / 1 |
12 | |||
| buildSortUrl | |
0.00% |
0 / 21 |
|
0.00% |
0 / 1 |
30 | |||
| 1 | <?php |
| 2 | /** |
| 3 | * TableRenderer.php |
| 4 | * |
| 5 | * This file is part of the Codex PHP library, which provides a PHP-based interface for creating |
| 6 | * UI components consistent with the Codex design system. |
| 7 | * |
| 8 | * The `TableRenderer` class leverages the `TemplateParser` and `Sanitizer` utilities to ensure the |
| 9 | * component object is rendered according to Codex design system standards. |
| 10 | * |
| 11 | * @category Renderer |
| 12 | * @package Codex\Renderer |
| 13 | * @since 0.1.0 |
| 14 | * @author Doğu Abaris <abaris@null.net> |
| 15 | * @license https://www.gnu.org/copyleft/gpl.html GPL-2.0-or-later |
| 16 | * @link https://doc.wikimedia.org/codex/main/ Codex Documentation |
| 17 | */ |
| 18 | |
| 19 | namespace Wikimedia\Codex\Renderer; |
| 20 | |
| 21 | use InvalidArgumentException; |
| 22 | use UnexpectedValueException; |
| 23 | use Wikimedia\Codex\Component\Table; |
| 24 | use Wikimedia\Codex\Contract\Renderer\IRenderer; |
| 25 | use Wikimedia\Codex\ParamValidator\ParamDefinitions; |
| 26 | use Wikimedia\Codex\ParamValidator\ParamValidator; |
| 27 | use Wikimedia\Codex\ParamValidator\ParamValidatorCallbacks; |
| 28 | use Wikimedia\Codex\Parser\TemplateParser; |
| 29 | use Wikimedia\Codex\Traits\AttributeResolver; |
| 30 | use Wikimedia\Codex\Utility\Sanitizer; |
| 31 | |
| 32 | /** |
| 33 | * TableRenderer is responsible for rendering the HTML markup |
| 34 | * for a Table component using a Mustache template. |
| 35 | * |
| 36 | * This class uses the `TemplateParser` and `Sanitizer` utilities to manage |
| 37 | * the template rendering process, ensuring that the component object's HTML |
| 38 | * output adheres to the Codex design system's standards. |
| 39 | * |
| 40 | * @category Renderer |
| 41 | * @package Codex\Renderer |
| 42 | * @since 0.1.0 |
| 43 | * @author Doğu Abaris <abaris@null.net> |
| 44 | * @license https://www.gnu.org/copyleft/gpl.html GPL-2.0-or-later |
| 45 | * @link https://doc.wikimedia.org/codex/main/ Codex Documentation |
| 46 | */ |
| 47 | class TableRenderer implements IRenderer { |
| 48 | |
| 49 | /** |
| 50 | * Use the AttributeResolver trait |
| 51 | */ |
| 52 | use AttributeResolver; |
| 53 | |
| 54 | /** |
| 55 | * The sanitizer instance used for content sanitization. |
| 56 | */ |
| 57 | private Sanitizer $sanitizer; |
| 58 | |
| 59 | /** |
| 60 | * The template parser instance. |
| 61 | */ |
| 62 | private TemplateParser $templateParser; |
| 63 | |
| 64 | /** |
| 65 | * The param validator. |
| 66 | */ |
| 67 | protected ParamValidator $paramValidator; |
| 68 | |
| 69 | /** |
| 70 | * The param validator callbacks. |
| 71 | */ |
| 72 | protected ParamValidatorCallbacks $paramValidatorCallbacks; |
| 73 | |
| 74 | /** |
| 75 | * Constructor to initialize the TableRenderer with necessary dependencies. |
| 76 | * |
| 77 | * @since 0.1.0 |
| 78 | * @param Sanitizer $sanitizer The sanitizer instance for cleaning user-provided data and HTML attributes. |
| 79 | * @param TemplateParser $templateParser The template parser instance for rendering Mustache templates. |
| 80 | * @param ParamValidator $paramValidator The parameter validator instance to validate query parameters. |
| 81 | * @param ParamValidatorCallbacks $paramValidatorCallbacks The callbacks instance for fetching validated parameters. |
| 82 | */ |
| 83 | public function __construct( |
| 84 | Sanitizer $sanitizer, |
| 85 | TemplateParser $templateParser, |
| 86 | ParamValidator $paramValidator, |
| 87 | ParamValidatorCallbacks $paramValidatorCallbacks |
| 88 | ) { |
| 89 | $this->sanitizer = $sanitizer; |
| 90 | $this->templateParser = $templateParser; |
| 91 | $this->paramValidator = $paramValidator; |
| 92 | $this->paramValidatorCallbacks = $paramValidatorCallbacks; |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * Renders the HTML for an table component. |
| 97 | * |
| 98 | * Uses the provided Table component to generate HTML markup adhering to the Codex design system. |
| 99 | * |
| 100 | * @since 0.1.0 |
| 101 | * @param Table $component The Table object to render. |
| 102 | * @return string The rendered HTML string for the component. |
| 103 | */ |
| 104 | public function render( $component ): string { |
| 105 | if ( !$component instanceof Table ) { |
| 106 | throw new InvalidArgumentException( "Expected instance of Table, got " . get_class( $component ) ); |
| 107 | } |
| 108 | |
| 109 | $pager = $component->getPager(); |
| 110 | $tableData = [ |
| 111 | 'id' => $this->sanitizer->sanitizeText( $component->getId() ), |
| 112 | 'showVerticalBorders' => $component->getShowVerticalBorders(), |
| 113 | 'useRowHeaders' => $component->getUseRowHeaders(), |
| 114 | 'paginationPosition' => $component->getPaginationPosition(), |
| 115 | 'totalRows' => $component->getTotalRows(), |
| 116 | 'caption' => $this->sanitizer->sanitizeText( $component->getCaption() ), |
| 117 | 'columns' => $this->prepareColumns( $component ), |
| 118 | 'rows' => $this->prepareRows( $component ), |
| 119 | 'hideCaption' => $component->getHideCaption(), |
| 120 | 'headerContent' => $this->sanitizer->sanitizeText( $component->getHeaderContent() ?? '' ), |
| 121 | 'hasData' => (bool)count( $component->getData() ), |
| 122 | 'pager' => $pager ? $pager->getHtml() : '', |
| 123 | 'attributes' => $this->resolve( $this->sanitizer->sanitizeAttributes( $component->getAttributes() ) ), |
| 124 | 'footer' => $this->sanitizer->sanitizeText( $component->getFooter() ?? '' ), |
| 125 | ]; |
| 126 | return $this->templateParser->processTemplate( 'table', $tableData ); |
| 127 | } |
| 128 | |
| 129 | /** |
| 130 | * Prepares the column data for rendering in the Mustache template. |
| 131 | * |
| 132 | * This method takes the columns defined in the Table component and processes them into an array |
| 133 | * format suitable for rendering in the table. It handles sorting options, alignment, and the correct |
| 134 | * icon for the sorting direction. |
| 135 | * |
| 136 | * @since 0.1.0 |
| 137 | * @param Table $table The Table object containing column definitions. |
| 138 | * @return array The processed columns ready for rendering. |
| 139 | */ |
| 140 | private function prepareColumns( Table $table ): array { |
| 141 | $columns = []; |
| 142 | foreach ( $table->getColumns() as $column ) { |
| 143 | $isCurrentSortColumn = $table->getCurrentSortColumn() === $column['id']; |
| 144 | $columns[] = [ |
| 145 | 'id' => $this->sanitizer->sanitizeText( $column['id'] ), |
| 146 | 'label' => $this->sanitizer->sanitizeText( $column['label'] ), |
| 147 | 'align' => isset( $column['align'] ) ? $this->sanitizer->sanitizeText( $column['align'] ) : '', |
| 148 | 'sortable' => !empty( $column['sortable'] ), |
| 149 | 'isCurrentSort' => $isCurrentSortColumn, |
| 150 | 'sortUrl' => $this->buildSortUrl( $table, $column['id'] ), |
| 151 | 'sortIconClass' => $this->getSortIconClass( $table, $isCurrentSortColumn ), |
| 152 | ]; |
| 153 | } |
| 154 | |
| 155 | return $columns; |
| 156 | } |
| 157 | |
| 158 | /** |
| 159 | * Prepares the row data for rendering in the Mustache template. |
| 160 | * |
| 161 | * This method processes the data provided in the Table component and matches it with the defined columns. |
| 162 | * Each row is prepared as an array of columns with their respective cell data and alignment settings. |
| 163 | * |
| 164 | * @since 0.1.0 |
| 165 | * @param Table $table The Table object containing row data. |
| 166 | * @return array The processed rows ready for rendering. |
| 167 | */ |
| 168 | private function prepareRows( Table $table ): array { |
| 169 | $rows = []; |
| 170 | foreach ( $table->getData() as $row ) { |
| 171 | $rowData = []; |
| 172 | foreach ( $table->getColumns() as $column ) { |
| 173 | $cellData = isset( $row[$column['id']] ) ? $this->sanitizer->sanitizeText( $row[$column['id']] ) : ''; |
| 174 | $align = isset( $column['align'] ) ? $this->sanitizer->sanitizeText( $column['align'] ) : ''; |
| 175 | $rowData[] = [ |
| 176 | 'cellData' => $cellData, |
| 177 | 'align' => $align, |
| 178 | ]; |
| 179 | } |
| 180 | $rows[] = [ 'columns' => $rowData ]; |
| 181 | } |
| 182 | |
| 183 | return $rows; |
| 184 | } |
| 185 | |
| 186 | /** |
| 187 | * Determines the appropriate CSS class for the sort icon based on the current sort state. |
| 188 | * |
| 189 | * If the column is the currently sorted column, it returns the correct ascending or descending sort icon class. |
| 190 | * Otherwise, it returns the unsorted icon class. |
| 191 | * |
| 192 | * @since 0.1.0 |
| 193 | * @param Table $table The Table object. |
| 194 | * @param bool $isCurrentSortColumn Whether the column is currently sorted. |
| 195 | * @return string The CSS class for the sort icon. |
| 196 | */ |
| 197 | private function getSortIconClass( Table $table, bool $isCurrentSortColumn ): string { |
| 198 | if ( $isCurrentSortColumn ) { |
| 199 | return $table->getCurrentSortDirection() === Table::SORT_ASCENDING ? 'cdx-table__table__sort-icon--asc' |
| 200 | : 'cdx-table__table__sort-icon--desc'; |
| 201 | } |
| 202 | |
| 203 | return 'cdx-table__table__sort-icon--unsorted'; |
| 204 | } |
| 205 | |
| 206 | /** |
| 207 | * Builds the URL for sorting the table by a specific column. |
| 208 | * |
| 209 | * This method constructs the sort URL by adjusting the query parameters to reflect the new sort column |
| 210 | * and direction (ascending or descending). |
| 211 | * |
| 212 | * @since 0.1.0 |
| 213 | * @param Table $table The Table object. |
| 214 | * @param string $columnId The ID of the column to sort by. |
| 215 | * @return string The generated URL for sorting by the specified column. |
| 216 | */ |
| 217 | private function buildSortUrl( Table $table, string $columnId ): string { |
| 218 | $definitions = ParamDefinitions::getDefinitionsForContext( 'table' ); |
| 219 | |
| 220 | foreach ( $definitions as $param => $rules ) { |
| 221 | try { |
| 222 | $this->paramValidator->validateValue( |
| 223 | $param, |
| 224 | $this->paramValidatorCallbacks->getValue( |
| 225 | $param, |
| 226 | $rules[ParamValidator::PARAM_DEFAULT], |
| 227 | [] |
| 228 | ), |
| 229 | $rules |
| 230 | ); |
| 231 | } catch ( UnexpectedValueException $e ) { |
| 232 | throw new InvalidArgumentException( "Invalid value for parameter '$param': " . $e->getMessage() ); |
| 233 | } |
| 234 | } |
| 235 | |
| 236 | $queryParams = []; |
| 237 | $queryParams['offset'] = $this->paramValidatorCallbacks->getValue( 'offset', '', [] ); |
| 238 | $queryParams['limit'] = $this->paramValidatorCallbacks->getValue( 'limit', 5, [] ); |
| 239 | |
| 240 | $queryParams['sort'] = $columnId; |
| 241 | |
| 242 | $oppositeDirection = $table->oppositeSort( $table->getCurrentSortDirection() ); |
| 243 | $queryParams['asc'] = ( $oppositeDirection === Table::SORT_ASCENDING ) ? 1 : ''; |
| 244 | $queryParams['desc'] = ( $oppositeDirection === Table::SORT_DESCENDING ) ? 1 : ''; |
| 245 | |
| 246 | return '?' . http_build_query( $queryParams ); |
| 247 | } |
| 248 | } |