refactor invitation page handler

Author: ipula

classes/invitation/core/Invitation.php

@@ -71,6 +71,13 @@ abstract public static function getType(): string;
      */
     abstract public function getInvitationActionRedirectController(): ?InvitationActionRedirectController;
 
+    /**
+     * Defines the controller that is responsible for the handle of the create/edit
+     * invitation views
+     * @return InvitationUIActionRedirectController|null
+     */
+    abstract public function getInvitationUIActionRedirectController(): ?InvitationUIActionRedirectController;
+
     /**
      * Get a specific payload instance for the child class.
      */

classes/invitation/core/InvitationUIActionRedirectController.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * @file classes/invitation/core/InvitationUIActionRedirectController.php
+ *
+ * Copyright (c) 2025 Simon Fraser University
+ * Copyright (c) 2025 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class InvitationUIActionRedirectController
+ *
+ * @brief Declares the create/edit url handlers.
+ */
+
+namespace PKP\invitation\core;
+
+use APP\core\Request;
+use Illuminate\Routing\Controller;
+
+abstract class InvitationUIActionRedirectController extends Controller
+{
+    /** @var TInvitation */
+    protected Invitation $invitation;
+
+    public function __construct(Invitation $invitation)
+    {
+        $this->invitation = $invitation;
+    }
+    abstract public function createHandle(Request $request, $userId = null): void;
+    abstract public function editHandle(Request $request): void;
+}

classes/invitation/invitations/changeProfileEmail/ChangeProfileEmailInvite.php

@@ -25,6 +25,7 @@
 use PKP\invitation\core\enums\ValidationContext;
 use PKP\invitation\core\Invitation;
 use PKP\invitation\core\InvitationActionRedirectController;
+use PKP\invitation\core\InvitationUIActionRedirectController;
 use PKP\invitation\core\traits\HasMailable;
 use PKP\invitation\core\traits\ShouldValidate;
 use PKP\invitation\invitations\changeProfileEmail\handlers\ChangeProfileEmailInviteRedirectController;
@@ -138,10 +139,15 @@ public function getInvitationActionRedirectController(): ?InvitationActionRedire
         return new ChangeProfileEmailInviteRedirectController($this);
     }
 
+    public function getInvitationUIActionRedirectController(): ?InvitationUIActionRedirectController
+    {
+        return null;
+    }
+
     /**
      * @inheritDoc
      */
-    public function getValidationRules(ValidationContext $validationContext = ValidationContext::VALIDATION_CONTEXT_DEFAULT): array 
+    public function getValidationRules(ValidationContext $validationContext = ValidationContext::VALIDATION_CONTEXT_DEFAULT): array
     {
         return [
             'newEmail' => 'required|email',
@@ -151,7 +157,7 @@ public function getValidationRules(ValidationContext $validationContext = Valida
     /**
      * @inheritDoc
      */
-    public function getValidationMessages(ValidationContext $validationContext = ValidationContext::VALIDATION_CONTEXT_DEFAULT): array 
+    public function getValidationMessages(ValidationContext $validationContext = ValidationContext::VALIDATION_CONTEXT_DEFAULT): array
     {
         return [];
     }

classes/invitation/invitations/registrationAccess/RegistrationAccessInvite.php

@@ -25,6 +25,7 @@
 use PKP\invitation\core\enums\InvitationStatus;
 use PKP\invitation\core\Invitation;
 use PKP\invitation\core\InvitationActionRedirectController;
+use PKP\invitation\core\InvitationUIActionRedirectController;
 use PKP\invitation\invitations\registrationAccess\handlers\RegistrationAccessInviteRedirectController;
 use PKP\user\User;
 
@@ -101,4 +102,9 @@ public function getInvitationActionRedirectController(): ?InvitationActionRedire
     {
         return new RegistrationAccessInviteRedirectController($this);
     }
+
+    public function getInvitationUIActionRedirectController(): ?InvitationUIActionRedirectController
+    {
+        return null;
+    }
 }

classes/invitation/invitations/reviewerAccess/ReviewerAccessInvite.php

@@ -25,6 +25,7 @@
 use PKP\invitation\core\enums\ValidationContext;
 use PKP\invitation\core\Invitation;
 use PKP\invitation\core\InvitationActionRedirectController;
+use PKP\invitation\core\InvitationUIActionRedirectController;
 use PKP\invitation\core\traits\ShouldValidate;
 use PKP\invitation\invitations\reviewerAccess\handlers\ReviewerAccessInviteRedirectController;
 use PKP\invitation\invitations\reviewerAccess\payload\ReviewerAccessInvitePayload;
@@ -148,10 +149,15 @@ public function getInvitationActionRedirectController(): ?InvitationActionRedire
         return new ReviewerAccessInviteRedirectController($this);
     }
 
+    public function getInvitationUIActionRedirectController(): ?InvitationUIActionRedirectController
+    {
+        return null;
+    }
+
     /**
      * @inheritDoc
      */
-    public function getValidationRules(ValidationContext $validationContext = ValidationContext::VALIDATION_CONTEXT_DEFAULT): array 
+    public function getValidationRules(ValidationContext $validationContext = ValidationContext::VALIDATION_CONTEXT_DEFAULT): array
     {
         return [
             'reviewAssignmentId' => [
@@ -161,7 +167,7 @@ function ($attribute, $value, $fail) {
                     $reviewAssignment = Repo::reviewAssignment()->get($value);
 
                     if (!$reviewAssignment) {
-                        $fail(__('invitation.reviewerAccess.validation.error.reviewAssignmentId.notExisting', 
+                        $fail(__('invitation.reviewerAccess.validation.error.reviewAssignmentId.notExisting',
                             [
                                 'reviewAssignmentId' => $value
                             ])

classes/invitation/invitations/userRoleAssignment/UserRoleAssignmentInvite.php

@@ -23,12 +23,14 @@
 use PKP\invitation\core\enums\ValidationContext;
 use PKP\invitation\core\Invitation;
 use PKP\invitation\core\InvitationActionRedirectController;
+use PKP\invitation\core\InvitationUIActionRedirectController;
 use PKP\invitation\core\ReceiveInvitationController;
 use PKP\invitation\core\traits\HasMailable;
 use PKP\invitation\core\traits\ShouldValidate;
 use PKP\invitation\invitations\userRoleAssignment\handlers\api\UserRoleAssignmentCreateController;
 use PKP\invitation\invitations\userRoleAssignment\handlers\api\UserRoleAssignmentReceiveController;
 use PKP\invitation\invitations\userRoleAssignment\handlers\UserRoleAssignmentInviteRedirectController;
+use PKP\invitation\invitations\userRoleAssignment\handlers\UserRoleAssignmentInviteUIController;
 use PKP\invitation\invitations\userRoleAssignment\payload\UserRoleAssignmentInvitePayload;
 use PKP\invitation\invitations\userRoleAssignment\rules\EmailMustNotExistRule;
 use PKP\invitation\invitations\userRoleAssignment\rules\NoUserGroupChangesRule;
@@ -116,7 +118,7 @@ public function getMailable(): Mailable
         return $this->mailable;
     }
 
-    public function getMailableReceiver(?string $locale = null): Identity 
+    public function getMailableReceiver(?string $locale = null): Identity
     {
         $locale = $this->getUsedLocale($locale);
 
@@ -138,18 +140,23 @@ public function getInvitationActionRedirectController(): ?InvitationActionRedire
         return new UserRoleAssignmentInviteRedirectController($this);
     }
 
+    public function getInvitationUIActionRedirectController(): ?InvitationUIActionRedirectController
+    {
+        return new UserRoleAssignmentInviteUIController($this);
+    }
+
     /**
      * @inheritDoc
      */
-    public function getCreateInvitationController(Invitation $invitation): CreateInvitationController 
+    public function getCreateInvitationController(Invitation $invitation): CreateInvitationController
     {
         return new UserRoleAssignmentCreateController($invitation);
     }
-    
+
     /**
      * @inheritDoc
      */
-    public function getReceiveInvitationController(Invitation $invitation): ReceiveInvitationController 
+    public function getReceiveInvitationController(Invitation $invitation): ReceiveInvitationController
     {
         return new UserRoleAssignmentReceiveController($invitation);
     }
@@ -175,7 +182,7 @@ public function getValidationRules(ValidationContext $validationContext = Valida
         }
 
         $validationRules = array_merge(
-            $invitationValidationRules, 
+            $invitationValidationRules,
             $this->getPayload()->getValidationRules($this, $validationContext)
         );
 
@@ -190,7 +197,7 @@ public function getValidationMessages(ValidationContext $validationContext = Val
         $invitationValidationMessages = [];
 
         $invitationValidationMessages = array_merge(
-            $invitationValidationMessages, 
+            $invitationValidationMessages,
             $this->getPayload()->getValidationMessages($validationContext)
         );