Language Management table in Multilingualism Metadata to Kitchen Sink

components/ILIAS/AdvancedMetaData/classes/Record/Multilingualism/DataRetrieval.php

@@ -0,0 +1,138 @@
+<?php
+
+/**
+ * This file is part of ILIAS, a powerful learning management system
+ * published by ILIAS open source e-Learning e.V.
+ *
+ * ILIAS is licensed with the GPL-3.0,
+ * see https://www.gnu.org/licenses/gpl-3.0.en.html
+ * You should have received a copy of said license along with the
+ * source code, too.
+ *
+ * If this is not the case or you just want to try ILIAS, you'll find
+ * us at:
+ * https://www.ilias.de
+ * https://github.com/ILIAS-eLearning
+ *
+ *********************************************************************/
+
+declare(strict_types=1);
+
+namespace ILIAS\AdvancedMetaData\Record\Multilingualism;
+
+use ILIAS\UI\Component\Table\DataRowBuilder;
+use ILIAS\Data\Range;
+use ILIAS\Data\Order;
+use Generator;
+use ilAdvancedMDRecord;
+use ilAdvancedMDRecordTranslations;
+use ilLanguage;
+use ilObject;
+use ILIAS\UI\Component\Table\DataRetrieval as BaseDataRetrieval;
+
+class DataRetrieval implements BaseDataRetrieval
+{
+    protected ilAdvancedMDRecord $record;
+    protected ilLanguage $lng;
+    protected ilAdvancedMDRecordTranslations $record_translations;
+
+    /** @var string[] */
+    protected array $all_ids_cache;
+
+    public function __construct(
+        ilAdvancedMDRecord $record,
+        ilLanguage $lng,
+        ilAdvancedMDRecordTranslations $record_translations
+    ) {
+        $this->record = $record;
+        $this->lng = $lng;
+        $this->record_translations = $record_translations;
+    }
+
+
+    public function getRows(
+        DataRowBuilder $row_builder,
+        array $visible_column_ids,
+        Range $range,
+        Order $order,
+        mixed $additional_viewcontrol_data,
+        mixed $filter_data,
+        mixed $additional_parameters
+    ): Generator {
+        $data = $this->getRawData();
+
+        $order_field = array_keys($order->get())[0] ?? TableBuilder::COL_LANGUAGE;
+        $order_direction = $order->get()[$order_field] ?? Order::ASC;
+
+        uasort($data, static function ($a, $b) use ($order_field) {
+            return strnatcasecmp((string) $a[$order_field], (string) $b[$order_field]);
+        });
+
+        if ($order_direction === Order::DESC) {
+            $data = array_reverse($data, true);
+        }
+
+        $data = array_slice($data, $range->getStart(), $range->getLength() ?? 50, true);
+
+        foreach ($data as $lang_code => $row) {
+            $data_row = $row_builder->buildDataRow($lang_code, $row);
+
+            $data_row = $data_row->withDisabledAction(
+                TableBuilder::ACTION_ACTIVATE,
+                $row[TableBuilder::COL_ACTIVE]
+            );
+
+            $data_row = $data_row->withDisabledAction(
+                TableBuilder::ACTION_DEACTIVATE,
+                !$row[TableBuilder::COL_ACTIVE] || $row[TableBuilder::COL_DEFAULT]
+            );
+
+            $data_row = $data_row->withDisabledAction(
+                TableBuilder::ACTION_SET_DEFAULT,
+                !$row[TableBuilder::COL_ACTIVE] || $row[TableBuilder::COL_DEFAULT]
+            );
+
+            yield $data_row;
+        }
+    }
+
+    public function getTotalRowCount(
+        mixed $additional_viewcontrol_data,
+        mixed $filter_data,
+        mixed $additional_parameters
+    ): ?int {
+        return count($this->getAllIDs());
+    }
+
+    public function getAllIDs(): array
+    {
+        if (!isset($this->all_ids_cache)) {
+            $languages = ilObject::_getObjectsByType('lng');
+            $parsed_languages = [];
+            foreach ($languages as $language) {
+                $lang = $language['title'];
+                $parsed_languages[] = $lang;
+            }
+            $this->all_ids_cache = $parsed_languages;
+        }
+        return $this->all_ids_cache;
+    }
+
+    protected function getRawData(): array
+    {
+        $all_languages = $this->getAllIDs();
+        $installed_languages = ilLanguage::_getInstalledLanguages();
+        $default_language = $this->record->getDefaultLanguage();
+
+        $data = [];
+        foreach ($all_languages as $lang_code) {
+            $data[$lang_code] = [
+                TableBuilder::COL_LANGUAGE => $this->lng->txt('meta_l_' . $lang_code),
+                TableBuilder::COL_DEFAULT => ($lang_code === $default_language),
+                TableBuilder::COL_ACTIVE => $this->record_translations->isConfigured($lang_code),
+                TableBuilder::COL_INSTALLED => in_array($lang_code, $installed_languages)
+            ];
+        }
+        return $data;
+    }
+}

components/ILIAS/AdvancedMetaData/classes/Record/Multilingualism/TableBuilder.php

@@ -0,0 +1,105 @@
+<?php
+
+/**
+ * This file is part of ILIAS, a powerful learning management system
+ * published by ILIAS open source e-Learning e.V.
+ *
+ * ILIAS is licensed with the GPL-3.0,
+ * see https://www.gnu.org/licenses/gpl-3.0.en.html
+ * You should have received a copy of said license along with the
+ * source code, too.
+ *
+ * If this is not the case or you just want to try ILIAS, you'll find
+ * us at:
+ * https://www.ilias.de
+ * https://github.com/ILIAS-eLearning
+ *
+ *********************************************************************/
+
+declare(strict_types=1);
+
+namespace ILIAS\AdvancedMetaData\Record\Multilingualism;
+
+use ILIAS\UI\Factory as UIFactory;
+use ILIAS\UI\Component\Table\Data as DataTable;
+use ilLanguage;
+use ILIAS\HTTP\Services as HTTP;
+use ILIAS\UI\URLBuilder;
+use ILIAS\UI\URLBuilderToken;
+
+class TableBuilder
+{
+    public const string COL_LANGUAGE = 'language';
+    public const string COL_DEFAULT = 'default';
+    public const string COL_ACTIVE = 'active';
+    public const string COL_INSTALLED = 'installed';
+
+    public const string ACTION_ACTIVATE = 'activate';
+    public const string ACTION_DEACTIVATE = 'deactivate';
+    public const string ACTION_SET_DEFAULT = 'setDefault';
+
+    public function __construct(
+        protected DataRetrieval $data_retrieval,
+        protected ilLanguage $lng,
+        protected UIFactory $ui_factory,
+        protected HTTP $http
+    ) {
+    }
+
+    public function get(URLBuilder $url_builder, URLBuilderToken $id_token, URLBuilderToken $action_token): DataTable
+    {
+        $columns = [];
+        $columns[self::COL_LANGUAGE] = $this->ui_factory->table()->column()->text(
+            $this->lng->txt('md_adv_record_lng_table_lng')
+        )->withIsSortable(true);
+
+        $icon_ok = $this->ui_factory->symbol()->icon()->custom('assets/images/standard/icon_ok.svg', 'ok');
+        $icon_not_ok = $this->ui_factory->symbol()->icon()->custom('assets/images/standard/icon_not_ok.svg', 'not ok');
+
+        $columns[self::COL_DEFAULT] = $this->ui_factory->table()->column()->boolean(
+            $this->lng->txt('md_adv_record_lng_table_default'),
+            $icon_ok,
+            $icon_not_ok
+        );
+
+        $columns[self::COL_ACTIVE] = $this->ui_factory->table()->column()->boolean(
+            $this->lng->txt('md_adv_record_lng_table_active'),
+            $icon_ok,
+            $icon_not_ok
+        );
+
+        $columns[self::COL_INSTALLED] = $this->ui_factory->table()->column()->boolean(
+            $this->lng->txt('md_adv_record_lng_table_inst'),
+            $icon_ok,
+            $icon_not_ok
+        );
+
+        $actions = [];
+        $actions[self::ACTION_ACTIVATE] = $this->ui_factory->table()->action()->standard(
+            $this->lng->txt('md_adv_record_lng_table_activate'),
+            $url_builder->withParameter($action_token, self::ACTION_ACTIVATE),
+            $id_token
+        );
+
+        $actions[self::ACTION_DEACTIVATE] = $this->ui_factory->table()->action()->standard(
+            $this->lng->txt('md_adv_record_lng_table_deactivate'),
+            $url_builder->withParameter($action_token, self::ACTION_DEACTIVATE),
+            $id_token
+        );
+
+        $actions[self::ACTION_SET_DEFAULT] = $this->ui_factory->table()->action()->single(
+            $this->lng->txt('md_adv_record_lng_table_set_default'),
+            $url_builder->withParameter($action_token, self::ACTION_SET_DEFAULT),
+            $id_token
+        );
+
+        return $this->ui_factory->table()->data(
+            $this->data_retrieval,
+            $this->lng->txt('md_adv_record_lng_table'),
+            $columns
+        )->withActions($actions)
+            ->withRequest($this->http->request())
+            ->withId('advanced_metadata_record_translations_table');
+    }
+
+}