pkp/pkp-lib#1660 Customizable Reviewer Recommendations

api/v1/contexts/index.php

@@ -15,4 +15,12 @@
  * @brief Handle API requests for contexts (journals/presses).
  */
 
+$urlParts = explode('/', trim($_SERVER['PATH_INFO'], '/'));
+
+if (in_array('recommendations', $urlParts)) {
+    return new \PKP\handler\APIHandler(
+        new \PKP\API\v1\reviewers\recommendations\ReviewerRecommendationController()
+    );
+}
+
 return new \PKP\handler\APIHandler(new \PKP\API\v1\contexts\PKPContextController());

classes/migration/install/ReviewerRecommendationsMigration.php

@@ -0,0 +1,42 @@
+<?php
+
+/**
+ * @file classes/migration/install/ReviewerRecommendationsMigration.php
+ *
+ * Copyright (c) 2024 Simon Fraser University
+ * Copyright (c) 2024 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class ReviewerRecommendationsMigration
+ *
+ * @brief Describe database table structures .
+ */
+
+namespace APP\migration\install;
+
+class ReviewerRecommendationsMigration extends \PKP\migration\install\ReviewerRecommendationsMigration
+{
+    /**
+     * @copydoc \PKP\migration\install\ReviewerRecommendationsMigratio::contextTable()
+     */
+    public function contextTable(): string
+    {
+        return 'journals';
+    }
+
+    /**
+     * @copydoc \PKP\migration\install\ReviewerRecommendationsMigratio::settingTable()
+     */
+    public function settingTable(): string
+    {
+        return 'journal_settings';
+    }
+
+    /**
+     * @copydoc \PKP\migration\install\ReviewerRecommendationsMigratio::contextPrimaryKey()
+     */
+    public function contextPrimaryKey(): string
+    {
+        return 'journal_id';
+    }
+}

classes/migration/upgrade/v3_6_0/I1660_ReviewerRecommendations.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * @file classes/migration/upgrade/v3_6_0/I1660_ReviewerRecommendations.php
+ *
+ * Copyright (c) 2024 Simon Fraser University
+ * Copyright (c) 2024 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class I1660_ReviewerRecommendations.php
+ *
+ * @brief Upgrade migration add recommendations
+ *
+ */
+
+namespace APP\migration\upgrade\v3_6_0;
+
+use PKP\submission\reviewer\recommendation\ReviewerRecommendation;
+
+class I1660_ReviewerRecommendations extends \PKP\migration\upgrade\v3_6_0\I1660_ReviewerRecommendations
+{
+    /**
+     * @copydoc \PKP\migration\upgrade\v3_6_0\I1660_ReviewerRecommendations::systemDefineNonRemovableRecommendations()
+     */
+    protected function systemDefineNonRemovableRecommendations(): array
+    {
+        return ReviewerRecommendation::seedableRecommendations();
+    }
+}

dbscripts/xml/install.xml

@@ -42,6 +42,7 @@
 
 	<migration class="APP\migration\install\OJSMigration" />
 
+	<migration class="APP\migration\install\ReviewerRecommendationsMigration" />
 	<migration class="PKP\migration\install\MetadataMigration" />
 	<migration class="PKP\migration\install\AnnouncementsMigration" />
 	<migration class="PKP\migration\install\CategoriesMigration" />

dbscripts/xml/upgrade.xml

@@ -160,6 +160,7 @@
 		<migration class="APP\migration\upgrade\v3_5_0\I10620_EditorialBoardMemberRole"/>
 		<migration class="APP\migration\upgrade\v3_5_0\I9707_WeblateUILocales"/>
 		<note file="docs/release-notes/README-3.5.0" />
+		<migration class="APP\migration\upgrade\v3_6_0\I1660_ReviewerRecommendations"/>
 	</upgrade>
 
 	<!-- update plugin configuration - should be done as the final upgrade task -->

pages/management/SettingsHandler.php

@@ -19,6 +19,7 @@
 use APP\components\forms\context\AccessForm;
 use APP\components\forms\context\ArchivingLockssForm;
 use APP\template\TemplateManager;
+use PKP\API\v1\reviewers\recommendations\resources\ReviewerRecommendationResource;
 use PKP\components\forms\context\PKPContextStatisticsForm;
 use PKP\components\forms\context\PKPDisableSubmissionsForm;
 use PKP\components\forms\context\PKPDoiRegistrationSettingsForm;
@@ -29,11 +30,14 @@
 use PKP\components\forms\context\PKPReviewGuidanceForm;
 use PKP\components\forms\context\PKPReviewSetupForm;
 use PKP\components\forms\context\PKPSearchIndexingForm;
+use PKP\components\listPanels\ReviewerRecommendationsListPanel;
 use PKP\core\PKPApplication;
+use PKP\core\PKPRequest;
 use PKP\pages\management\ManagementHandler;
 use PKP\plugins\Hook;
 use PKP\plugins\PluginRegistry;
 use PKP\security\Role;
+use PKP\submission\reviewer\recommendation\ReviewerRecommendation;
 
 class SettingsHandler extends ManagementHandler
 {
@@ -77,6 +81,35 @@ public function workflow($args, $request)
         $templateMgr->display('management/workflow.tpl');
     }
 
+    /**
+     * Add support for review related forms in workflow.
+     */
+    protected function addReviewFormWorkflowSupport(PKPRequest $request): void
+    {
+        parent::addReviewFormWorkflowSupport($request);
+
+        $templateManager = TemplateManager::getManager($request);
+        $components = $templateManager->getState('components');
+
+        $context = $request->getContext();
+        $recommendations = ReviewerRecommendation::withContextId($context->getId())->get();
+
+        $reviewerRecommendationsListPanel = new ReviewerRecommendationsListPanel(
+            __('manager.reviewerRecommendations'),
+            $context,
+            $this->getSupportedFormLocales($context),
+            array_values(
+                ReviewerRecommendationResource::collection($recommendations)
+                    ->toArray(app()->get('request'))
+            ),
+            ReviewerRecommendation::withContextId($context->getId())->count()
+        );
+
+        $components[$reviewerRecommendationsListPanel->id] = $reviewerRecommendationsListPanel->getConfig();
+        $templateManager->setState(['components' => $components]);
+        $templateManager->assign('hasCustomizableRecommendation', true);
+    }
+
     /**
      * Add the archive and payments tabs to the distribution settings page
      *

registry/uiLocaleKeysBackend.json

@@ -402,14 +402,9 @@
   "publication.version",
   "publication.version.all",
   "publication.version.confirm",
-  "reviewer.article.decision.accept",
-  "reviewer.article.decision.decline",
-  "reviewer.article.decision.pendingRevisions",
-  "reviewer.article.decision.resubmitElsewhere",
-  "reviewer.article.decision.resubmitHere",
-  "reviewer.article.decision.seeComments",
   "reviewer.article.recommendation",
   "reviewer.competingInterests",
+  "reviewer.recommendation.management.options",
   "reviewer.submission.acceptedOn",
   "reviewer.submission.responseDueDate",
   "reviewer.submission.reviewDueDate",
@@ -494,7 +489,6 @@
   "submission.list.revisionsSubmitted",
   "submission.production",
   "submission.publication",
-  "submission.recommendation",
   "submission.review",
   "submission.stage.externalReviewWithRound",
   "submission.stage.internalReviewWithRound",

templates/reviewer/review/reviewerRecommendations.tpl

@@ -1,13 +1,25 @@
 {**
  * templates/reviewer/review/reviewerRecommendations.tpl
  *
- * Copyright (c) 2014-2021 Simon Fraser University
- * Copyright (c) 2003-2021 John Willinsky
+ * Copyright (c) 2014-2024 Simon Fraser University
+ * Copyright (c) 2003-2024 John Willinsky
  * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
  *
  * Include reviewer recommendations for OJS review assignment responses.
  *}
 
-{fbvFormSection label="reviewer.article.recommendation" description=$description|default:"reviewer.article.selectRecommendation"}
-	{fbvElement type="select" id="recommendation" from=$reviewerRecommendationOptions selected=$reviewAssignment->getRecommendation() size=$fbvStyles.size.MEDIUM required=$required|default:true disabled=$readOnly}
+{fbvFormSection 
+	label="reviewer.article.recommendation"
+	description=$description|default:"reviewer.article.selectRecommendation"
+}
+	{fbvElement 
+		type="select"
+		id="recommendation"
+		from=$reviewerRecommendationOptions
+		selected=$reviewAssignment->getRecommendation()
+		size=$fbvStyles.size.MEDIUM
+		required=$required|default:true
+		disabled=$readOnly
+		translate=false
+	}
 {/fbvFormSection}