#11303 allow locale to be set on mailables

Author: touhidurabir

classes/mail/Mailable.php

@@ -91,6 +91,9 @@ class Mailable extends IlluminateMailable
     public const ATTACHMENT_SUBMISSION_FILE = 'submissionFileId';
     public const ATTACHMENT_LIBRARY_FILE = 'libraryFileId';
 
+    /** @var string|null The specific locale to send the mail of this Mailable */
+    protected ?string $mailableLocale = null;
+
     /** @var string|null Locale key for the name of this Mailable */
     protected static ?string $name = null;
 
@@ -121,9 +124,6 @@ class Mailable extends IlluminateMailable
     /** @var string embedded footer of the email */
     protected string $footer;
 
-    /** @var bool define if email data has been set */
-    protected bool $isDataSet = false;
-
     public function __construct(array $variables = [])
     {
         if (!empty($variables)) {
@@ -229,7 +229,7 @@ public function getData(?string $locale = null): array
     public function setData(?string $locale = null): void
     {
         if (is_null($locale)) {
-            $locale = Locale::getLocale();
+            $locale = $this->getLocale() ?? Locale::getLocale();
         }
         foreach ($this->variables as $variable) {
             $this->viewData = array_merge(
@@ -239,16 +239,24 @@ public function setData(?string $locale = null): void
         }
 
         $this->addFooter($locale); // set the locale for the email footer
+    }
+
+    /**
+     * Set the mailable locale
+     */
+    public function setLocale(string $locale): static
+    {
+        $this->mailableLocale = $locale;
 
-        $this->isDataSet = true;
+        return $this;
     }
 
     /**
-     * return if the data for this email has been set
+     * Get the mailable locale
      */
-    public function hasDataSet(): bool
+    public function getLocale(): ?string
     {
-        return $this->isDataSet;
+        return $this->mailableLocale;
     }
 
     /**

classes/mail/Mailer.php

@@ -115,9 +115,7 @@ public function send($view, array $data = [], $callback = null)
     {
         if (is_a($view, Mailable::class)) {
             /** @var Mailable $view */
-            if (!$view->hasDataSet()) {
-                $view->setData();
-            }
+            $view->setData($view->getLocale());
         }
 
         // Application is set to sandbox mode and will sent any emails to log

classes/mail/mailables/AnnouncementNotify.php

@@ -73,7 +73,7 @@ public function setData(?string $locale = null): void
     {
         parent::setData($locale);
         if (is_null($locale)) {
-            $locale = Locale::getLocale();
+            $locale = $this->getLocale() ?? Locale::getLocale();
         }
 
         $request = Application::get()->getRequest();

classes/task/ReviewReminder.php

@@ -68,7 +68,7 @@ public function sendReminder(
             ->from($context->getData('contactEmail'), $context->getData('contactName'))
             ->recipients([$reviewer]);
 
-        $mailable->setData($primaryLocale);
+        $mailable->setLocale($primaryLocale);
 
         $application = Application::get();
         $request = $application->getRequest();

controllers/grid/users/reviewer/form/ReviewerForm.php

@@ -460,7 +460,8 @@ protected function getMailable(): ReviewRequest
         ]);
 
         // Remove template variables that haven't been set yet during form initialization
-        $mailable->setData(Locale::getLocale());
+        $locale = Locale::getLocale();
+        $mailable->setLocale($locale)->setData($locale);
         unset($mailable->viewData[ReviewAssignmentEmailVariable::REVIEW_DUE_DATE]);
         unset($mailable->viewData[ReviewAssignmentEmailVariable::RESPONSE_DUE_DATE]);
         unset($mailable->viewData[ReviewAssignmentEmailVariable::REVIEW_ASSIGNMENT_URL]);

controllers/grid/users/reviewer/form/ThankReviewerForm.php

@@ -125,7 +125,7 @@ public function execute(...$functionArgs)
 
         Hook::call('ThankReviewerForm::thankReviewer', [$submission, $reviewAssignment, $mailable]);
         if (!$this->getData('skipEmail')) {
-            $mailable->setData(Locale::getLocale());
+            $mailable->setLocale(Locale::getLocale());
             try {
                 Mail::send($mailable);
                 $submissionEmailLogDao = DAORegistry::getDAO('SubmissionEmailLogDAO'); /** @var SubmissionEmailLogDAO $submissionEmailLogDao */

jobs/notifications/NewAnnouncementNotifyUsers.php

@@ -88,7 +88,7 @@ public function handle()
             $mailable = $this->createMailable($context, $recipient, $announcement, $template)
                 ->allowUnsubscribe($notification);
 
-            $mailable->setData($this->locale);
+            $mailable->setLocale($this->locale);
             Mail::send($mailable);
         }
     }

jobs/notifications/StatisticsReportMail.php

@@ -96,7 +96,7 @@ public function handle()
             $mailable->from($context->getContactEmail(), $context->getContactName());
             $mailable->subject($template->getLocalizedData('subject', $locale));
             $mailable->body($template->getLocalizedData('body', $locale));
-            $mailable->setData($locale);
+            $mailable->setLocale($locale);
             $mailable->attach($filePath, ['as' => 'editorial-report.csv']);
             $mailable->allowUnsubscribe($notification);