#11833 Rename to getMany, drop validation, use scope, return collection

Author: Hafsa-Naeem

api/v1/editTaskTemplates/PKPEditTaskTemplateController.php

@@ -21,12 +21,11 @@
 use Illuminate\Support\Facades\Route;
 use PKP\core\PKPBaseController;
 use PKP\core\PKPRequest;
+use Illuminate\Http\Request;
 use PKP\security\authorization\CanAccessSettingsPolicy;
 use PKP\security\authorization\ContextAccessPolicy;
 use PKP\security\Role;
-use APP\facades\Repo;
 use PKP\editorialTask\Template;
-use PKP\API\v1\editTaskTemplates\formRequests\ListTaskTemplates;
 use PKP\API\v1\editTaskTemplates\resources\EditTaskTemplateResource;
 
 class PKPEditTaskTemplateController extends PKPBaseController
@@ -56,40 +55,38 @@ public function getGroupRoutes(): void
                 Role::ROLE_ID_SITE_ADMIN,
             ]),
         ])->group(function () {
-            Route::get('', $this->index(...));
+            Route::get('', $this->getMany(...));
         });
     }
 
     /**
      * GET /api/v1/editTaskTemplates
      */
-    public function index(ListTaskTemplates $illuminateRequest): JsonResponse
+    public function getMany(Request $request): JsonResponse
     {
         $context = $this->getRequest()->getContext();
-        $validated = $illuminateRequest->validated();
 
         $q = Template::query()
-            ->where('context_id', $context->getId())
+            ->byContextId((int) $context->getId())
             ->with('userGroups');
 
-        if (isset($validated['stageId'])) {
-            $q->where('stage_id', (int) $validated['stageId']);
+        if ($request->filled('stageId')) {
+            $q->where('stage_id', (int) $request->query('stageId'));
         }
 
-        if (array_key_exists('include', $validated) && $validated['include'] !== null) {
-            $q->where('include', (bool) $validated['include']);
+        if ($request->has('include')) {
+            $include = filter_var($request->query('include'), FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
+            if ($include !== null) {
+                $q->where('include', $include);
+            }
         }
 
-        if (!empty($validated['emailTemplateKey'])) {
-            $et = Repo::emailTemplate()->getByKey($context->getId(), $validated['emailTemplateKey']);
-            $q->where('email_template_id', $et?->getId() ?? 0);
+        if ($request->filled('emailTemplateKey')) {
+            $q->where('email_template_key', trim((string) $request->query('emailTemplateKey')));
         }
-
-        $items = $q->orderByPkDesc()->get()
-            ->map(fn ($tpl) => (new EditTaskTemplateResource($tpl))->toArray($illuminateRequest))
-            ->values()
-            ->all();
-
-        return response()->json(['items' => $items], Response::HTTP_OK);
-    }
+        $collection = $q->orderByPkDesc()->get();
+        return EditTaskTemplateResource::collection($collection)
+            ->response()
+            ->setStatusCode(Response::HTTP_OK);
+     }
 }

api/v1/editTaskTemplates/formRequests/ListTaskTemplates.php

@@ -0,0 +1,48 @@
+<?php
+
+/**
+ * @file api/v1/editTaskTemplates/resources/EditTaskTemplateResource.php
+ *
+ * Copyright (c) 2014-2025 Simon Fraser University
+ * Copyright (c) 2003-2025 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class EditTaskTemplateResource
+ *
+ * @brief Transforms an editorial task template into an API response format.
+ *
+ */
+
+namespace PKP\API\v1\editTaskTemplates\resources;
+
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class EditTaskTemplateResource extends JsonResource
+{
+    public function toArray(Request $request)
+    {
+
+        return [
+            'id' => (int) $this->id,
+            'stageId' => (int) $this->stage_id,
+            'title' => $this->title,
+            'include' => (bool) $this->include,
+            'emailTemplateKey' => $this->email_template_key ?? null,
+            'userGroupIds' => $this->whenLoaded(
+                'userGroups',
+                fn () => $this->userGroups->pluck('user_group_id')->values()->all()
+            ),
+            'userGroups' => $this->whenLoaded(
+                'userGroups',
+                fn () => $this->userGroups
+                    ->map(fn ($ug) => [
+                        'id' => (int) $ug->user_group_id,
+                        'name' => method_exists($ug, 'getLocalizedName') ? $ug->getLocalizedName() : null,
+                    ])
+                    ->values()
+                    ->all()
+            ),
+        ];
+    }
+}

api/v1/editTaskTemplates/resources/EditTaskTemplateResource.php

@@ -113,6 +113,14 @@ public function userGroups(): BelongsToMany
         );
     }
 
+    /**
+     * Scope: filter by context_id
+     */
+    public function scopeByContextId($query, int $contextId)
+    {
+        return $query->where('context_id', $contextId);
+    }
+
     /**
      * Query scope order by the model's primary key in descending order
      */