first commit

lib/pkp/classes/mail/mailables/DecisionNotifyOtherAuthors.php

@@ -0,0 +1,95 @@
+<?php
+
+/**
+ * @file classes/mail/mailables/DecisionNotifyOtherAuthors.php
+ *
+ * Copyright (c) 2014-2022 Simon Fraser University
+ * Copyright (c) 2000-2022 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class DecisionNotifyOtherAuthors
+ *
+ * @brief Email sent to other authors of a submission when an editorial decision
+ *   is made. These are authors with metadata records on the publication who are
+ *   not assigned as participants to the submission workflow.
+ */
+
+namespace PKP\mail\mailables;
+
+use APP\submission\Submission;
+use PKP\context\Context;
+use PKP\facades\Locale;
+use PKP\mail\Mailable;
+use PKP\mail\traits\Configurable;
+use PKP\mail\traits\Sender;
+use PKP\security\Role;
+use PKP\user\User;
+
+class DecisionNotifyOtherAuthors extends Mailable
+{
+    use Configurable;
+    use Sender;
+
+    /** @var string An email variable that contains the message that was sent to the submitting author */
+    public const MESSAGE_TO_SUBMITTING_AUTHOR = 'messageToSubmittingAuthor';
+    public const SUBMITTING_AUTHOR_NAME = 'submittingAuthorName';
+
+    protected static ?string $name = 'mailable.decision.notifyOtherAuthors.name';
+    protected static ?string $description = 'mailable.decision.notifyOtherAuthors.description';
+    protected static ?string $emailTemplateKey = 'EDITOR_DECISION_NOTIFY_OTHER_AUTHORS';
+    protected static array $groupIds = [
+        self::GROUP_SUBMISSION,
+        self::GROUP_REVIEW,
+        self::GROUP_COPYEDITING,
+        self::GROUP_PRODUCTION,
+    ];
+    protected static array $fromRoleIds = [Role::ROLE_ID_SUB_EDITOR];
+    protected static array $toRoleIds = [Role::ROLE_ID_AUTHOR];
+
+    /** @var User[] */
+    protected array $assignedAuthors;
+
+    public function __construct(Context $context, Submission $submission, array $assignedAuthors)
+    {
+        parent::__construct([$context, $submission]);
+
+        $this->assignedAuthors = $assignedAuthors;
+    }
+
+    public static function getDataDescriptions(): array
+    {
+        $variables = parent::getDataDescriptions();
+        $variables[self::MESSAGE_TO_SUBMITTING_AUTHOR] = __('mailable.decision.notifyOtherAuthors.variable.message.description');
+        $variables[self::SUBMITTING_AUTHOR_NAME] = __('emailTemplate.variable.submission.submittingAuthorName');
+        return $variables;
+    }
+
+    /**
+     * Set submitting author name email template variable
+     */
+    public function setData(?string $locale = null): void
+    {
+        parent::setData($locale);
+
+        if (is_null($locale)) {
+            $locale = Locale::getLocale();
+        }
+
+        $this->viewData[self::SUBMITTING_AUTHOR_NAME] = $this->getSubmittingAuthorName($locale);
+    }
+
+    /**
+     * The name(s) of authors assigned as participants to the
+     * submission workflow.
+     *
+     * Usually this is the submitting author.
+     */
+    protected function getSubmittingAuthorName(string $locale): string
+    {
+        $authorNames = [];
+        foreach ($this->assignedAuthors as $user) {
+            $authorNames[] = $user->getFullName(true, false, $locale);
+        }
+        return join(__('common.commaListSeparator'), $authorNames);
+    }
+}