'item-table' ]; /** @var array The columns to render */ protected $columns; /** @var iterable The datasource */ protected $data; /** @var string The sort rules */ protected $sort; protected $tag = 'table'; /** * Create a new item table * * @param iterable $data Datasource of the table * @param array $columns The columns to render, keys are labels */ public function __construct(iterable $data, array $columns) { $this->data = $data; $this->columns = array_flip($columns); $this->addAttributes($this->baseAttributes); $this->init(); } /** * Initialize the item table * * If you want to adjust the item table after construction, override this method. */ protected function init() { } /** * Get the columns being rendered * * @return array */ public function getColumns(): array { return $this->columns; } /** * Set sort rules (as returned by {@see SortControl::getSort()}) * * @param ?string $sort * * @return $this */ public function setSort(?string $sort): self { $this->sort = $sort; return $this; } abstract protected function getItemClass(): string; abstract protected function getVisualColumn(): string; abstract protected function getVisualLabel(); protected function assembleColumnHeader(BaseHtmlElement $header, string $name, $label): void { $sortRules = []; if ($this->sort !== null) { $sortRules = SortUtil::createOrderBy($this->sort); } $active = false; $sortDirection = null; foreach ($sortRules as $rule) { if ($rule[0] === $name) { $sortDirection = $rule[1]; $active = true; break; } } if ($sortDirection === 'desc') { $value = "$name asc"; } else { $value = "$name desc"; } $icon = 'sort'; if ($active) { $icon = $sortDirection === 'desc' ? 'sort-up' : 'sort-down'; } $form = new Form(); $form->setAttribute('method', 'GET'); $button = $form->createElement('button', 'sort', [ 'value' => $value, 'type' => 'submit', 'title' => is_string($label) ? $label : null, 'class' => $active ? 'active' : null ]); $button->addHtml( Html::tag( 'span', null, // With   to have the height sized the same as the others $label ?? HtmlString::create(' ') ), new Icon($icon) ); $form->addElement($button); $header->add($form); } protected function assemble() { $itemClass = $this->getItemClass(); $headerRow = new HtmlElement('tr'); $visualCell = new HtmlElement('th', Attributes::create(['class' => 'has-visual'])); $this->assembleColumnHeader($visualCell, $this->getVisualColumn(), $this->getVisualLabel()); $headerRow->addHtml($visualCell); foreach ($this->columns as $name => $label) { $headerCell = new HtmlElement('th'); $this->assembleColumnHeader($headerCell, $name, is_int($label) ? $name : $label); $headerRow->addHtml($headerCell); } $this->addHtml(new HtmlElement('thead', null, $headerRow)); $body = new HtmlElement('tbody', Attributes::create(['data-base-target' => '_next'])); foreach ($this->data as $item) { $body->addHtml(new $itemClass($item, $this)); } if ($body->isEmpty()) { $body->addHtml(new HtmlElement( 'tr', null, new HtmlElement( 'td', Attributes::create(['colspan' => count($this->columns)]), new EmptyState(t('No items found.')) ) )); } $this->addHtml($body); } /** * Enrich the given list of column names with appropriate labels * * @param Query $query * @param array $columns * * @return array */ public static function applyColumnMetaData(Query $query, array $columns): array { $newColumns = []; foreach ($columns as $columnPath) { $label = $query->getResolver()->getColumnDefinition($columnPath)->getLabel(); $newColumns[$label ?? $columnPath] = $columnPath; } return $newColumns; } }