Merge pull request #1044 from Vitaliy-1/i7264_rename_variables

pkp/pkp-lib#7264 Rename email template variables

classes/emailTemplate/DAO.inc.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * @file classes/emailTemplate/DAO.inc.php
+ *
+ * Copyright (c) 2014-2021 Simon Fraser University
+ * Copyright (c) 2000-2021 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class DAO
+ *
+ * @brief Read and write email templates to the database.
+ */
+
+namespace APP\emailTemplate;
+
+class DAO extends \PKP\emailTemplate\DAO
+{
+    /**
+     * Renames app-specific email template variables during installation
+     */
+    protected function variablesToRename(): array
+    {
+        return [
+            'contextName' => 'pressName',
+            'contextUrl' => 'pressUrl',
+        ];
+    }
+}

classes/migration/upgrade/v3_4_0/I7264_UpdateEmailTemplates.inc.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * @file classes/migration/upgrade/v3_4_0/I7264_UpdateEmailTemplates.inc.php
+ *
+ * Copyright (c) 2014-2021 Simon Fraser University
+ * Copyright (c) 2000-2021 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class I7264_UpdateEmailTemplates
+ * @brief Describe upgrade/downgrade operations for DB table email_templates.
+ */
+
+namespace APP\migration\upgrade\v3_4_0;
+
+class I7264_UpdateEmailTemplates extends \PKP\migration\upgrade\v3_4_0\I7264_UpdateEmailTemplates
+{
+    protected function oldNewVariablesMap(): array
+    {
+        $oldNewVariablesMap = parent::oldNewVariablesMap();
+        array_walk_recursive($oldNewVariablesMap, function (&$newVariable, $oldVariable) {
+            if ($newVariable === 'contextName') {
+                $newVariable = 'pressName';
+            } elseif ($newVariable === 'contextUrl') {
+                $newVariable = 'pressUrl';
+            }
+        });
+
+        return $oldNewVariablesMap;
+    }
+}

classes/submission/form/SubmissionSubmitStep4Form.inc.php

@@ -21,6 +21,7 @@
 use APP\mail\MonographMailTemplate;
 use APP\notification\NotificationManager;
 use PKP\log\SubmissionLog;
+use PKP\notification\PKPNotification;
 use PKP\submission\form\PKPSubmissionSubmitStep4Form;
 
 class SubmissionSubmitStep4Form extends PKPSubmissionSubmitStep4Form
@@ -68,20 +69,20 @@ public function execute(...$functionParams)
             $mail->bccAssignedSeriesEditors($this->submissionId, WORKFLOW_STAGE_ID_SUBMISSION);
 
             $mail->assignParams([
-                'authorName' => $user->getFullName(),
-                'authorUsername' => $user->getUsername(),
-                'editorialContactSignature' => $context->getData('contactName') . "\n" . $context->getLocalizedName(),
+                'recipientName' => $user->getFullName(),
+                'recipientUsername' => $user->getUsername(),
+                'signature' => $context->getData('contactName') . "\n" . $context->getLocalizedName(),
                 'submissionUrl' => $router->url($request, null, 'authorDashboard', 'submission', $this->submissionId),
             ]);
 
             if (!$mail->send($request)) {
                 $notificationMgr = new NotificationManager();
-                $notificationMgr->createTrivialNotification($request->getUser()->getId(), NOTIFICATION_TYPE_ERROR, ['contents' => __('email.compose.error')]);
+                $notificationMgr->createTrivialNotification($request->getUser()->getId(), PKPNotification::NOTIFICATION_TYPE_ERROR, ['contents' => __('email.compose.error')]);
             }
 
             $authorMail->assignParams([
                 'submitterName' => $user->getFullName(),
-                'editorialContactSignature' => $context->getData('contactName'),
+                'signature' => $context->getData('contactName'),
             ]);
 
             foreach ($this->emailRecipients as $authorEmailRecipient) {
@@ -92,7 +93,7 @@ public function execute(...$functionParams)
             if (!empty($recipients)) {
                 if (!$authorMail->send($request)) {
                     $notificationMgr = new NotificationManager();
-                    $notificationMgr->createTrivialNotification($request->getUser()->getId(), NOTIFICATION_TYPE_ERROR, ['contents' => __('email.compose.error')]);
+                    $notificationMgr->createTrivialNotification($request->getUser()->getId(), PKPNotification::NOTIFICATION_TYPE_ERROR, ['contents' => __('email.compose.error')]);
                 }
             }
         }

dbscripts/xml/upgrade.xml

@@ -122,6 +122,7 @@
 		<migration class="APP\migration\upgrade\v3_4_0\I6807_SetLastModified" />
 		<migration class="APP\migration\upgrade\v3_4_0\I7132_AddSourceChapterId" />
 		<migration class="PKP\migration\upgrade\v3_4_0\I7167_RemoveDuplicatedUserSettingsAndDeprecatedFields" />
+		<migration class="APP\migration\upgrade\v3_4_0\I7264_UpdateEmailTemplates"/>
 		<data file="dbscripts/xml/upgrade/3.4.0_preupdate_email_templates.xml" />
 		<note file="docs/release-notes/README-3.4.0" />
 	</upgrade>