#11885 Implemented edit, delete, and search endpoints for task templates and fixed stageId on add

Hafsa-Naeem · Hafsa-Naeem · commit 8b2614a955f9 · 2025-10-23T14:55:25.000+05:00
diff --git a/api/v1/editTaskTemplates/PKPEditTaskTemplateController.php b/api/v1/editTaskTemplates/PKPEditTaskTemplateController.php
@@ -29,6 +29,7 @@
 use PKP\security\authorization\ContextAccessPolicy;
 use PKP\security\Role;
 use PKP\editorialTask\Template;
+use PKP\API\v1\editTaskTemplates\formRequests\UpdateTaskTemplate;
 
 class PKPEditTaskTemplateController extends PKPBaseController
 {
@@ -59,6 +60,8 @@ public function getGroupRoutes(): void
         ])->group(function () {
             Route::post('', $this->add(...));
             Route::get('', $this->getMany(...));
+            Route::put('{templateId}', $this->update(...))->whereNumber('templateId');
+            Route::delete('{templateId}', $this->delete(...))->whereNumber('templateId');
         });
     }
 
@@ -91,6 +94,7 @@ public function add(AddTaskTemplate $illuminateRequest): JsonResponse
                 'context_id' => $context->getId(),
                 'include' => $validated['include'] ?? false,
                 'email_template_key' => $validated['emailTemplateKey'] ?? null,
+                'type' => (int) $validated['type'],
             ]);
 
             $tpl->userGroups()->sync($validated['userGroupIds']);
@@ -118,6 +122,9 @@ public function getMany(Request $request): JsonResponse
             ->with('userGroups');
 
         $queryParams = $this->_processAllowedParams($request->query(), [
+            'search',
+            'title',
+            'type',
             'stageId',
             'include',
             'emailTemplateKey',
@@ -127,6 +134,20 @@ public function getMany(Request $request): JsonResponse
 
         foreach ($queryParams as $param => $val) {
             switch ($param) {
+                case 'search':
+                    $collector->filterBySearch((string) $val);
+                    break;
+                case 'title':
+                    $collector->filterByTitleLike((string) $val);
+                    break;
+                case 'type':
+                    if (is_numeric($val)) {
+                        $type = (int) $val;
+                        if ($type === Template::TYPE_DISCUSSION || $type === Template::TYPE_TASK) {
+                            $collector->filterByType($type);
+                        }
+                    }
+                    break;
                 case 'stageId':
                     $collector->filterByStageId((int) $val);
                     break;
@@ -162,5 +183,67 @@ public function getMany(Request $request): JsonResponse
             ->setStatusCode(Response::HTTP_OK);
     }
 
+    /**
+     * UPDATE /api/v1/editTaskTemplates/{templateId}
+     */
+    public function update(UpdateTaskTemplate $request): JsonResponse
+    {
+        $contextId = (int) $this->getRequest()->getContext()->getId();
+        $id = (int) $request->route('templateId');
+
+        $template = Template::query()
+            ->where('context_id', $contextId)
+            ->findOrFail($id);
+
+        $data = $request->validated();
+
+        DB::transaction(function () use ($template, $data) {
+            $updates = [];
+            if (array_key_exists('stageId', $data)) $updates['stage_id'] = (int) $data['stageId'];
+            if (array_key_exists('title', $data)) $updates['title'] = $data['title'];
+            if (array_key_exists('include', $data)) $updates['include'] = (bool) $data['include'];
+            if (array_key_exists('emailTemplateKey', $data)) $updates['email_template_key'] = $data['emailTemplateKey'];
+            if (array_key_exists('type', $data)) $updates['type'] = (int) $data['type'];
+
+            if ($updates) {
+                $template->update($updates);
+            }
+            if (array_key_exists('userGroupIds', $data)) {
+                $template->userGroups()->sync($data['userGroupIds']);
+            }
+        });
+
+        return response()->json(
+            (new TaskTemplateResource($template->refresh()->load('userGroups')))->toArray($request),
+            Response::HTTP_OK
+        );
+    }
+
+    /**
+     * DELETE /api/v1/editTaskTemplates/{templateId}
+     */
+    public function delete(Request $illuminateRequest): JsonResponse
+    {
+        $contextId = (int) $this->getRequest()->getContext()->getId();
+        $id = (int) $illuminateRequest->route('templateId');
+
+        $template = Template::query()
+            ->where('context_id', $contextId)
+            ->find($id);
+
+        if (!$template) {
+            return response()->json([
+                'error' => __('api.404.resourceNotFound'),
+            ], Response::HTTP_NOT_FOUND);
+        }
+
+        DB::transaction(function () use ($template) {
+            // Pivot/settings rows cascade via FKs defined in migration
+            $template->delete();
+        });
+
+        return response()->json([], Response::HTTP_OK);
+    }
+
 }
 
diff --git a/api/v1/editTaskTemplates/formRequests/AddTaskTemplate.php b/api/v1/editTaskTemplates/formRequests/AddTaskTemplate.php
@@ -30,7 +30,14 @@ public function authorize(): bool
     public function rules(): array
     {
         $contextId = Application::get()->getRequest()->getContext()->getId();
-        $stageIds = array_keys(Application::getApplicationStages());
+
+        // build a list of allowed stage IDs from values
+        $stages = Application::getApplicationStages();
+        $stageIds = array_values(array_unique(array_filter(
+            array_map('intval', array_merge(array_keys((array)$stages), array_values((array)$stages))),
+            fn ($id) => $id > 0
+        )));
+
         $emailKeys = Repo::emailTemplate()
             ->getCollector($contextId)
             ->getMany()
@@ -43,6 +50,7 @@ public function rules(): array
             'title' => ['required', 'string', 'max:255'],
             'include' => ['boolean'],
             'emailTemplateKey' => ['sometimes', 'nullable', 'string', 'max:255', Rule::in($emailKeys)],
+            'type' => ['required','integer','in:1,2'],
             'userGroupIds' => ['required', 'array', 'min:1'],
             'userGroupIds.*' => [
                 'integer',
@@ -56,10 +64,12 @@ public function rules(): array
     protected function prepareForValidation(): void
     {
         $stageId = $this->input('stageId', null);
+        $type = $this->input('type', null);
         $this->merge([
             'include' => filter_var($this->input('include', false), FILTER_VALIDATE_BOOLEAN),
             'userGroupIds' => array_values(array_map('intval', (array) $this->input('userGroupIds', []))),
             'stageId' => is_null($stageId) ? $stageId : (int) $stageId,
+            'type' => is_null($type) ? null : (int) $type,
         ]);
     }
 
diff --git a/api/v1/editTaskTemplates/formRequests/UpdateTaskTemplate.php b/api/v1/editTaskTemplates/formRequests/UpdateTaskTemplate.php
@@ -0,0 +1,85 @@
+<?php
+
+namespace PKP\API\v1\editTaskTemplates\formRequests;
+
+use APP\core\Application;
+use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Validation\Rule;
+
+class UpdateTaskTemplate extends FormRequest
+{
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    public function rules(): array
+    {
+        $contextId = Application::get()->getRequest()->getContext()->getId();
+
+        // Build allowed stage IDs (values)
+        $stages = Application::getApplicationStages();
+        $stageIds = array_values(array_unique(array_filter(
+            array_map('intval', array_merge(array_keys((array)$stages), array_values((array)$stages))),
+            fn ($id) => $id > 0
+        )));
+
+        // Context-scoped email keys
+        $emailKeys = \APP\facades\Repo::emailTemplate()
+            ->getCollector($contextId)
+            ->getMany()
+            ->map(fn ($t) => $t->getData('key'))
+            ->filter()
+            ->values()
+            ->all();
+
+        return [
+            // all fields are optional but if present must validate
+            'stageId' => ['sometimes', 'integer', Rule::in($stageIds)],
+            'title' => ['sometimes', 'string', 'max:255'],
+            'include' => ['sometimes', 'boolean'],
+            'emailTemplateKey' => ['sometimes', 'nullable', 'string', 'max:255', Rule::in($emailKeys)],
+            'type' => ['sometimes','integer','in:1,2'],
+
+            'userGroupIds' => ['sometimes', 'array', 'min:1'],
+            'userGroupIds.*' => [
+                'integer',
+                'distinct',
+                Rule::exists('user_groups', 'user_group_id')
+                    ->where(fn ($q) => $q->where('context_id', $contextId)),
+            ],
+        ];
+    }
+
+    protected function prepareForValidation(): void
+    {
+        $stageId = $this->input('stageId', null);
+        $type = $this->input('type', null);
+
+        $this->merge([
+            'include' => $this->has('include')
+                ? filter_var($this->input('include'), FILTER_VALIDATE_BOOLEAN)
+                : $this->input('include', null),
+
+            'userGroupIds' => $this->has('userGroupIds')
+                ? array_values(array_map('intval', (array) $this->input('userGroupIds', [])))
+                : $this->input('userGroupIds', null),
+
+            'stageId' => $this->has('stageId')
+                ? (is_null($stageId) ? null : (int) $stageId)
+                : $this->input('stageId', null),
+
+            'type' => $this->has('type')
+                ? (is_null($type) ? null : (int) $type)
+                : $this->input('type', null),
+        ]);
+    }
+
+    protected function passedValidation(): void
+    {
+        if ($this->has('emailTemplateKey')) {
+            $key = $this->input('emailTemplateKey');
+            $this->merge(['emailTemplateKey' => is_string($key) ? trim($key) : $key]);
+        }
+    }
+}
diff --git a/api/v1/editTaskTemplates/resources/TaskTemplateResource.php b/api/v1/editTaskTemplates/resources/TaskTemplateResource.php
@@ -29,6 +29,7 @@ public function toArray(Request $request)
             'title' => $this->title,
             'include' => (bool) $this->include,
             'emailTemplateKey' => $this->email_template_key ?? null,
+            'type' => (int) $this->type,
             'userGroups' => $this->whenLoaded(
                 'userGroups',
                 fn () => $this->userGroups
diff --git a/classes/editorialTask/Template.php b/classes/editorialTask/Template.php
@@ -21,6 +21,7 @@
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Support\Facades\DB;
 use PKP\core\traits\ModelWithSettings;
 use PKP\userGroup\UserGroup;
 
@@ -33,13 +34,17 @@ class Template extends Model
 
     public $timestamps = true;
 
+    public const TYPE_DISCUSSION = 1;
+    public const TYPE_TASK = 2;
+
     // columns on edit_task_templates
     protected $fillable = [
         'stage_id',
         'title',
         'context_id',
         'include',
         'email_template_key',
+        'type',
     ];
 
     protected $casts = [
@@ -48,6 +53,7 @@ class Template extends Model
         'include' => 'bool',
         'title' => 'string',
         'email_template_key' => 'string',
+        'type' => 'int',
     ];
 
     /**
@@ -100,11 +106,11 @@ public function emailTemplate(): BelongsTo
         return $this->belongsTo(
             \PKP\emailTemplate\EmailTemplate::class,
             'email_template_key',  // FK on this model
-            'email_key'            // owner key on email_templates
+            'email_key' // owner key on email_templates
         )
         ->where(function ($q) {
             $q->where('context_id', $this->context_id)
-            ->orWhereNull('context_id');
+              ->orWhereNull('context_id');
         })
         ->orderByRaw('CASE WHEN context_id = ? THEN 1 ELSE 0 END DESC', [$this->context_id]);
     }
@@ -138,9 +144,9 @@ public function scopeOrderByPkDesc(Builder $query): Builder
         return $query->orderByDesc($query->getModel()->getKeyName());
     }
 
-        /**
-         * Scope: filter by stage_id
-         */
+    /**
+     * Scope: filter by stage_id
+     */
     public function scopeFilterByStageId(Builder $query, int $stageId): Builder
     {
         return $query->where('stage_id', $stageId);
@@ -162,4 +168,69 @@ public function scopeFilterByEmailTemplateKey(Builder $query, string $key): Buil
         return $query->where('email_template_key', $key);
     }
 
-}
+    /**
+     * Scope: filter by  type
+     */
+    public function scopeFilterByType(Builder $q, int $type): Builder
+    {
+        return $q->where('type', $type);
+    }
+
+    /**
+     * Scope: filter by title LIKE
+     */
+    public function scopeFilterByTitleLike(Builder $query, string $title): Builder
+    {
+        $title = trim($title);
+        if ($title === '') {
+            return $query;
+        }
+        $needle = '%' . str_replace(['%', '_'], ['\\%', '\\_'], mb_strtolower($title)) . '%';
+        return $query->whereRaw('LOWER(title) LIKE ?', [$needle]);
+    }
+
+    /**
+     * free-text/ words search across:
+     * title column
+     * name, description
+     * email_template_key column
+     *
+     */
+    public function scopeFilterBySearch(Builder $query, string $phrase): Builder
+    {
+        $phrase = trim($phrase);
+        if ($phrase === '') {
+            return $query;
+        }
+
+        $tokens = preg_split('/\s+/', $phrase) ?: [];
+        $tokens = array_values(array_filter($tokens, fn ($t) => $t !== ''));
+        if (!$tokens) {
+            return $query;
+        }
+
+        $settingsTable = $this->getSettingsTable(); // 'edit_task_template_settings'
+        $pk = $this->getKeyName(); // 'edit_task_template_id'
+        $selfTable = $this->getTable(); // 'edit_task_templates'
+
+        return $query->where(function (Builder $outer) use ($tokens, $settingsTable, $pk, $selfTable) {
+            foreach ($tokens as $tok) {
+                // escape % and _
+                $like = '%' . str_replace(['%', '_'], ['\\%', '\\_'], mb_strtolower($tok)) . '%';
+
+                $outer->where(function (Builder $q) use ($like, $settingsTable, $pk, $selfTable) {
+                    $q->whereRaw('LOWER(title) LIKE ?', [$like])
+                    ->orWhereRaw('LOWER(email_template_key) LIKE ?', [$like])
+                    ->orWhereExists(function ($sub) use ($like, $settingsTable, $pk, $selfTable) {
+                        $sub->select(DB::raw(1))
+                            ->from($settingsTable . ' as ets')
+                            ->whereColumn("ets.$pk", "$selfTable.$pk")
+                            ->whereIn('ets.setting_name', ['name', 'description'])
+                            ->whereRaw('LOWER(ets.setting_value) LIKE ?', [$like]);
+                    });
+                });
+            }
+        });
+    }
+
+}
diff --git a/classes/migration/install/SubmissionsMigration.php b/classes/migration/install/SubmissionsMigration.php
@@ -315,9 +315,11 @@ public function up(): void
             $table->index(['context_id'], 'edit_task_templates_context_id_idx');
 
             $table->boolean('include')->default(false);
+            $table->unsignedSmallInteger('type')->default(1); // 1 - discussion, 2 - task
             // store key, comes from either email_templates or email_templates_default_data
             $table->string('email_template_key', 255)->nullable();
             $table->index(['context_id', 'email_template_key'], 'edit_task_templates_context_email_key_idx');
+            $table->index(['context_id', 'type', 'stage_id'], 'ett_context_type_stage_idx');
 
             
             $table->timestamps();
diff --git a/classes/migration/upgrade/v3_6_0/I11885_AddTypeToEditTaskTemplates.php b/classes/migration/upgrade/v3_6_0/I11885_AddTypeToEditTaskTemplates.php
