Implementing an endpoint that updates archived status of a group.

Author: krulis-martin

app/helpers/Recodex/RecodexApiHelper.php

@@ -503,4 +503,18 @@ public function createTermGroup(string $instanceId, string $parentGroupId, strin
 
         return null;
     }
+
+    /**
+     * Set or unset archived flag of a group.
+     * @param string $groupId ReCodEx ID of a group which is being updated
+     * @param bool $archived true to set archived flag, false to unset
+     */
+    public function setGroupArchivedFlag(string $groupId, bool $archived): void
+    {
+        Debugger::log(
+            "ReCodEx::setGroupArchivedFlag('$groupId', " . ($archived ? 'true' : 'false') . ")",
+            Debugger::INFO
+        );
+        $this->post("groups/$groupId/archived", [], ['value' => $archived]);
+    }
 }

app/presenters/GroupsPresenter.php

@@ -5,6 +5,7 @@
 use App\Exceptions\BadRequestException;
 use App\Exceptions\ForbiddenRequestException;
 use App\Exceptions\NotFoundException;
+use App\Exceptions\RecodexApiException;
 use App\Helpers\RecodexGroup;
 use App\Model\Entity\SisScheduleEvent;
 use App\Model\Repository\SisScheduleEvents;
@@ -401,4 +402,35 @@ public function actionRemoveAttribute(string $id)
         $this->recodexApi->removeAttribute($id, $key, $value);
         $this->sendSuccessResponse("OK");
     }
+
+    public function checkSetArchived()
+    {
+        if (!$this->groupAcl->canSetArchived()) {
+            throw new ForbiddenRequestException("You do not have permissions to set archived flag.");
+        }
+    }
+
+    /**
+     * Proxy to ReCodEx that sets or unsets the 'archived' flag of a group.
+     * @POST
+     * @Param(type="query", name="id", validation="string:1..",
+     *       description="ReCodEx ID of a group for which the archived flag will be set or unset.")
+     * @Param(type="post", name="value", validation="bool",
+     *       description="Boolean value indicating whether the group should be archived or not.")
+     */
+    public function actionSetArchived(string $id)
+    {
+        $archived = $this->getRequest()->getPost('value');
+        if (!is_bool($archived)) {
+            throw new BadRequestException("Missing or invalid 'value' parameter (expected boolean).");
+        }
+
+        try {
+            $this->recodexApi->setGroupArchivedFlag($id, $archived);
+        } catch (RecodexApiException $e) {
+            throw new BadRequestException("Failed to set archived flag for group $id: " . $e->getMessage());
+        }
+
+        $this->sendSuccessResponse("OK");
+    }
 }

app/router/RouterFactory.php

@@ -83,6 +83,7 @@ private static function createGroupsRoutes(string $prefix): RouteList
         $router[] = new PostRoute("$prefix/<id>/add-attribute", "Groups:addAttribute");
         $router[] = new PostRoute("$prefix/<id>/remove-attribute", "Groups:removeAttribute");
         $router[] = new PostRoute("$prefix/<parentId>/create-term/<term>", "Groups:createTerm");
+        $router[] = new PostRoute("$prefix/<id>/archived", "Groups:setArchived");
         return $router;
     }
 }

app/security/ACL/IGroupPermissions.php

@@ -13,4 +13,6 @@ public function canViewTeacher(): bool;
     public function canEditRawAttributes(): bool;
 
     public function canCreateTermGroup(): bool;
+
+    public function canSetArchived(): bool;
 }