#11885 Refactor edit task templates API and validation rules

Hafsa-Naeem · Hafsa-Naeem · commit 6b7fc8b6cc32 · 2025-10-28T14:11:49.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\CanAccessSettingsPolicy;
 use PKP\security\authorization\ContextAccessPolicy;
 use PKP\security\Role;
+use PKP\editorialTask\enums\EditorialTaskType;
 use PKP\API\v1\editTaskTemplates\formRequests\UpdateTaskTemplate;
 
 class PKPEditTaskTemplateController extends PKPBaseController
@@ -144,7 +145,7 @@ public function getMany(Request $request): JsonResponse
                 case 'type':
                     if (is_numeric($val)) {
                         $type = (int) $val;
-                        if ($type === Template::TYPE_DISCUSSION || $type === Template::TYPE_TASK) {
+                        if (in_array($type, [EditorialTaskType::DISCUSSION->value, EditorialTaskType::TASK->value], true)) {
                             $collector->filterByType($type);
                         }
                     }
@@ -186,22 +187,33 @@ public function update(UpdateTaskTemplate $request): JsonResponse
         $id = (int) $request->route('templateId');
 
         $template = Template::query()
-            ->where('context_id', $contextId)
-            ->findOrFail($id);
+            ->byContextId($contextId)
+            ->find($id);
+    
+        if (!$template) {
+            return response()->json([
+                'error' => __('api.404.resourceNotFound'),
+            ], Response::HTTP_NOT_FOUND);
+        }
 
         $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);
-            }
+            $updates = collect($data)
+                ->only(['stageId', 'title', 'include', 'type', 'description', 'dueInterval'])
+                ->mapWithKeys(function ($v, $k) {
+                    return match ($k) {
+                        'stageId' => ['stageId' => (int) $v],
+                        'include' => ['include' => (bool) $v],
+                        'type' => ['type' => (int) $v],
+                        'dueInterval' => ['dueInterval' => $v],
+                        default => [$k => $v], // 'title', 'description'
+                    };
+                })
+                ->all();
+
+            $template->update($updates);
+
             if (array_key_exists('userGroupIds', $data)) {
                 $template->userGroups()->sync($data['userGroupIds']);
             }
@@ -222,7 +234,7 @@ public function delete(Request $illuminateRequest): JsonResponse
         $id = (int) $illuminateRequest->route('templateId');
 
         $template = Template::query()
-            ->where('context_id', $contextId)
+            ->byContextId($contextId)
             ->find($id);
 
         if (!$template) {
diff --git a/api/v1/editTaskTemplates/formRequests/AddTaskTemplate.php b/api/v1/editTaskTemplates/formRequests/AddTaskTemplate.php
@@ -34,10 +34,8 @@ public function rules(): array
 
         // 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
-        )));
+        $stageIds = array_values(array_unique(array_map('intval', array_values((array) $stages))));
+
 
         return [
             'type' => ['required', Rule::in(array_column(EditorialTaskType::cases(), 'value'))],
@@ -46,7 +44,6 @@ public function rules(): array
             'include' => ['boolean'],
             'dueInterval' => ['sometimes', 'nullable', 'string', Rule::in(array_column(EditorialTaskDueInterval::cases(), 'value'))],
             'description' => ['sometimes', 'nullable', 'string'],
-            'type' => ['required','integer','in:1,2'],
             'userGroupIds' => ['required', 'array', 'min:1'],
             'userGroupIds.*' => [
                 'integer',
diff --git a/api/v1/editTaskTemplates/formRequests/UpdateTaskTemplate.php b/api/v1/editTaskTemplates/formRequests/UpdateTaskTemplate.php
@@ -5,6 +5,8 @@
 use APP\core\Application;
 use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Validation\Rule;
+use PKP\editorialTask\enums\EditorialTaskDueInterval;
+use PKP\editorialTask\enums\EditorialTaskType;
 
 class UpdateTaskTemplate extends FormRequest
 {
@@ -19,27 +21,18 @@ public function rules(): array
 
         // 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();
+        $stageIds = array_values(array_unique(array_map('intval', array_values((array) $stages))));
 
         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'],
+            'description' => ['sometimes', 'nullable', 'string'],
+            'dueInterval' => ['sometimes', 'nullable', 'string',
+                Rule::in(array_column(EditorialTaskDueInterval::cases(), 'value'))
+            ],
+            'type' => ['sometimes', Rule::in(array_column(EditorialTaskType::cases(), 'value'))],
 
             'userGroupIds' => ['sometimes', 'array', 'min:1'],
             'userGroupIds.*' => [
@@ -75,11 +68,4 @@ protected function prepareForValidation(): void
         ]);
     }
 
-    protected function passedValidation(): void
-    {
-        if ($this->has('emailTemplateKey')) {
-            $key = $this->input('emailTemplateKey');
-            $this->merge(['emailTemplateKey' => is_string($key) ? trim($key) : $key]);
-        }
-    }
 }
diff --git a/classes/editorialTask/Template.php b/classes/editorialTask/Template.php
@@ -38,8 +38,6 @@ class Template extends Model
 
     public $timestamps = true;
 
-    public const TYPE_DISCUSSION = 1;
-    public const TYPE_TASK = 2;
 
     // columns on edit_task_templates
     protected $fillable = [
@@ -143,14 +141,6 @@ public function scopeFilterByInclude(Builder $query, bool $include): Builder
         return $query->where('include', $include);
     }
 
-    /**
-     * Scope: filter by email_template_key
-     */
-    public function scopeFilterByEmailTemplateKey(Builder $query, string $key): Builder
-    {
-        return $query->where('email_template_key', $key);
-    }
-
     /**
      * Creates a new task from a template
      */
@@ -202,8 +192,6 @@ public function scopeFilterByTitleLike(Builder $query, string $title): Builder
      * free-text/ words search across:
      * title column
      * name, description
-     * email_template_key column
-     *
      */
     public function scopeFilterBySearch(Builder $query, string $phrase): Builder
     {
@@ -218,18 +206,18 @@ public function scopeFilterBySearch(Builder $query, string $phrase): Builder
             return $query;
         }
 
-        $settingsTable = $this->getSettingsTable(); // 'edit_task_template_settings'
-        $pk = $this->getKeyName(); // 'edit_task_template_id'
-        $selfTable = $this->getTable(); // 'edit_task_templates'
+        $settingsTable = $this->getSettingsTable();
+        $pk = $this->getKeyName();
+        $selfTable = $this->getTable();
 
         return $query->where(function (Builder $outer) use ($tokens, $settingsTable, $pk, $selfTable) {
             foreach ($tokens as $tok) {
                 // escape % and _
-                $like = '%' . str_replace(['%', '_'], ['\\%', '\\_'], mb_strtolower($tok)) . '%';
+                $like = '%' . str_replace(['%', '_'], ['\\%', '\\_'], mb_strtolower($tok, 'UTF-8')) . '%';
 
                 $outer->where(function (Builder $q) use ($like, $settingsTable, $pk, $selfTable) {
                     $q->whereRaw('LOWER(title) LIKE ?', [$like])
-                    ->orWhereRaw('LOWER(email_template_key) LIKE ?', [$like])
+                    ->orWhereRaw('LOWER(description) LIKE ?', [$like])
                     ->orWhereExists(function ($sub) use ($like, $settingsTable, $pk, $selfTable) {
                         $sub->select(DB::raw(1))
                             ->from($settingsTable . ' as ets')
diff --git a/classes/migration/upgrade/v3_6_0/I11885_AddTypeToEditTaskTemplates.php b/classes/migration/upgrade/v3_6_0/I11885_AddTypeToEditTaskTemplates.php
