Merge pull request ILIAS-eLearning#11177 from surlabs/ilias11_LTI_table_sorting

[LTI] fix: Implement table sorting in UI tables

Author: Saaweel

components/ILIAS/LTIConsumer/classes/class.ilLTIConsumerGradeSynchronizationTableGUI.php

@@ -66,7 +66,8 @@ public function getRows(
         mixed $filter_data,
         mixed $additional_parameters
     ): Generator {
-        foreach ($this->records as $record) {
+        $records = $this->applyOrdering($this->records, $order);
+        foreach ($records as $record) {
             $record['lti_timestamp'] = new DateTimeImmutable($record['lti_timestamp']);
             $record['score_given'] = $record['score_given'] . ' / ' . $record['score_maximum'];
             $record['activity_progress'] = $this->lng->txt('grade_activity_progress_' . strtolower($record['activity_progress']));
@@ -90,6 +91,34 @@ public function setRecords(array $records): void
         $this->records = $records;
     }
 
+    protected function applyOrdering(array $records, Order $order): array
+    {
+        [$order_field, $order_direction] = $order->join(
+            [],
+            fn($ret, $key, $value) => [$key, $value]
+        );
+
+        usort($records, static function (array $left, array $right) use ($order_field): int {
+            $left_val = $left[$order_field] ?? '';
+            $right_val = $right[$order_field] ?? '';
+
+            if ($left_val instanceof DateTimeImmutable) {
+                $left_val = $left_val->getTimestamp();
+            }
+            if ($right_val instanceof DateTimeImmutable) {
+                $right_val = $right_val->getTimestamp();
+            }
+
+            return $left_val <=> $right_val;
+        });
+
+        if ($order_direction === Order::DESC) {
+            $records = array_reverse($records);
+        }
+
+        return $records;
+    }
+
     public function getHTML(): string
     {
         $table = $this->ui_factory->table()

components/ILIAS/LTIConsumer/classes/class.ilLTIConsumerProviderTableGUI.php

@@ -104,7 +104,8 @@ public function getRows(
         mixed $filter_data,
         mixed $additional_parameters
     ): Generator {
-        foreach ($this->records as $record) {
+        $records = $this->applyOrdering($this->records, $order);
+        foreach ($records as $record) {
             $record["icon"] = $record["icon"] ?? "lti";
             $record["icon"] = $this->ui_factory->symbol()->icon()->standard($record["icon"], $record["icon"], IconAlias::SMALL);
 
@@ -143,6 +144,26 @@ public function setData(array $data): void
         $this->records = $data;
     }
 
+    protected function applyOrdering(array $records, Order $order): array
+    {
+        [$order_field, $order_direction] = $order->join(
+            [],
+            fn($ret, $key, $value) => [$key, $value]
+        );
+
+        usort($records, static function (array $left, array $right) use ($order_field): int {
+            $left_val = $left[$order_field] ?? '';
+            $right_val = $right[$order_field] ?? '';
+            return ilStr::strCmp($left_val, $right_val);
+        });
+
+        if ($order_direction === Order::DESC) {
+            $records = array_reverse($records);
+        }
+
+        return $records;
+    }
+
     /**
      * @throws ilCtrlException
      */

components/ILIAS/LTIConsumer/classes/class.ilLTIConsumerProviderUsageTableGUI.php

@@ -67,7 +67,8 @@ public function getRows(
         /** @var Services $static_url */
         $static_url = $DIC["static_url"];
 
-        foreach ($this->records as $record) {
+        $records = $this->applyOrdering($this->records, $order);
+        foreach ($records as $record) {
             $record['icon'] = $record['icon'] ?? "lti";
             $record['icon'] = $this->ui_factory->symbol()->icon()->standard($record['icon'], $record['icon'], Icon::SMALL);
 
@@ -98,6 +99,26 @@ public function setData(array $data): void
         $this->records = $data;
     }
 
+    protected function applyOrdering(array $records, Order $order): array
+    {
+        [$order_field, $order_direction] = $order->join(
+            [],
+            fn($ret, $key, $value) => [$key, $value]
+        );
+
+        usort($records, static function (array $left, array $right) use ($order_field): int {
+            $left_val = $left[$order_field] ?? '';
+            $right_val = $right[$order_field] ?? '';
+            return ilStr::strCmp($left_val, $right_val);
+        });
+
+        if ($order_direction === Order::DESC) {
+            $records = array_reverse($records);
+        }
+
+        return $records;
+    }
+
     public function getHTML(): string
     {
         $table = $this->ui_factory->table()

components/ILIAS/LTIProvider/classes/Consumer/class.ilObjectConsumerTableGUI.php

@@ -176,7 +176,8 @@ public function getRows(
         mixed $filter_data,
         mixed $additional_parameters
     ): Generator {
-        foreach ($this->records as $record) {
+        $records = $this->applyOrdering($this->records, $order);
+        foreach ($records as $record) {
             $record["active"] = $this->ui_factory->symbol()->icon()->custom(
                 $record["active"] ?
                     'assets/images/standard/icon_ok.svg' :
@@ -235,4 +236,24 @@ public function setEditable(bool $a_editable): void
     {
         $this->editable = $a_editable;
     }
+
+    protected function applyOrdering(array $records, Order $order): array
+    {
+        [$order_field, $order_direction] = $order->join(
+            [],
+            fn($ret, $key, $value) => [$key, $value]
+        );
+
+        usort($records, static function (array $left, array $right) use ($order_field): int {
+            $left_val = $left[$order_field] ?? '';
+            $right_val = $right[$order_field] ?? '';
+            return ilStr::strCmp($left_val, $right_val);
+        });
+
+        if ($order_direction === Order::DESC) {
+            $records = array_reverse($records);
+        }
+
+        return $records;
+    }
 }

components/ILIAS/LTIProvider/classes/InternalProvider/class.ilLTIProviderReleasedObjectsTableGUI.php

@@ -118,7 +118,8 @@ public function getRows(
         /** @var Services $static_url */
         $static_url = $DIC["static_url"];
 
-        foreach ($this->records as $record) {
+        $records = $this->applyOrdering($this->records, $order);
+        foreach ($records as $record) {
             $link = (string) $static_url->builder()->build(
                 $record['type'],
                 new ReferenceId($record['ref_id'])
@@ -158,4 +159,24 @@ public function getId(): string
     {
         return $this->id;
     }
+
+    protected function applyOrdering(array $records, Order $order): array
+    {
+        [$order_field, $order_direction] = $order->join(
+            [],
+            fn($ret, $key, $value) => [$key, $value]
+        );
+
+        usort($records, static function (array $left, array $right) use ($order_field): int {
+            $left_val = $left[$order_field] ?? '';
+            $right_val = $right[$order_field] ?? '';
+            return ilStr::strCmp($left_val, $right_val);
+        });
+
+        if ($order_direction === Order::DESC) {
+            $records = array_reverse($records);
+        }
+
+        return $records;
+    }
 }