Add country flag table column decorator (#1958)

Co-authored-by: Michael Voříšek <[email protected]>

Author: DarkSide666

demos/collection/grid.php

@@ -27,6 +27,13 @@
 
 $grid->setModel($model);
 
+// add country flag column
+$grid->addColumn('flag', [
+    Table\Column\CountryFlag::class,
+    'codeField' => $model->fieldName()->iso,
+    'nameField' => $model->fieldName()->name,
+]);
+
 // Adding Quicksearch on Name field using auto query.
 $grid->addQuickSearch([$model->fieldName()->name], true);
 

src/Table.php

@@ -482,7 +482,7 @@ public function renderRow(): void
                 if (!is_array($columns)) {
                     $columns = [$columns];
                 }
-                $field = !is_int($name) && $this->model->hasField($name) ? $this->model->getField($name) : null;
+                $field = is_int($name) ? null : $this->model->getField($name);
                 foreach ($columns as $column) {
                     $html_tags = array_merge($column->getHtmlTags($this->model, $field), $html_tags);
                 }

src/Table/Column/CountryFlag.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atk4\Ui\Table\Column;
+
+use Atk4\Data\Field;
+use Atk4\Data\Model;
+use Atk4\Ui\Table;
+
+class CountryFlag extends Table\Column
+{
+    /** Name of country code model field (in ISO 3166-1 alpha-2 format) */
+    public string $codeField;
+
+    /** Optional name of model field which contains full country name. */
+    public ?string $nameField = null;
+
+    public function getHtmlTags(Model $row, ?Field $field): array
+    {
+        $countryCode = $row->get($this->codeField);
+        $countryName = $this->nameField ? $row->get($this->nameField) : null;
+
+        return [
+            $field->shortName => $countryCode === null
+                ? ''
+                : $this->getApp()->getTag('i', [
+                    'class' => strtolower($countryCode) . ' flag',
+                    'title' => strtoupper($countryCode) . ($countryName === null ? '' : ' - ' . $countryName),
+                ]),
+        ];
+    }
+}