first commit

lib/pkp/classes/mail/variables/QueuedPaymentEmailVariable.php

@@ -0,0 +1,83 @@
+<?php
+
+/**
+ * @file classes/mail/variables/QueuedPaymentEmailVariable.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 QueuedPaymentEmailVariable
+ *
+ * @ingroup mail_variables
+ *
+ * @brief Represents email template variables that are associated with payments
+ */
+
+namespace PKP\mail\variables;
+
+use APP\core\Application;
+use PKP\mail\Mailable;
+use PKP\payment\QueuedPayment;
+
+class QueuedPaymentEmailVariable extends Variable
+{
+    public const PAYMENT_NAME = 'paymentName';
+    public const PAYMENT_AMOUNT = 'paymentAmount';
+    public const PAYMENT_CURRENCY_CODE = 'paymentCurrencyCode';
+
+    protected QueuedPayment $queuedPayment;
+
+    public function __construct(QueuedPayment $queuedPayment, Mailable $mailable)
+    {
+        parent::__construct($mailable);
+
+        $this->queuedPayment = $queuedPayment;
+    }
+
+    /**
+     * @copydoc Validation::descriptions()
+     */
+    public static function descriptions(): array
+    {
+        return
+        [
+            self::PAYMENT_NAME => __('emailTemplate.variable.queuedPayment.itemName'),
+            self::PAYMENT_AMOUNT => __('emailTemplate.variable.queuedPayment.itemCost'),
+            self::PAYMENT_CURRENCY_CODE => __('emailTemplate.variable.queuedPayment.itemCurrencyCode'),
+        ];
+    }
+
+    /**
+     * @copydoc Validation::values()
+     */
+    public function values(string $locale): array
+    {
+        return
+        [
+            self::PAYMENT_NAME => htmlspecialchars($this->getItemName()),
+            self::PAYMENT_AMOUNT => (string) $this->getItemCost(),
+            self::PAYMENT_CURRENCY_CODE => (string) $this->getItemCurrencyCode(),
+        ];
+    }
+
+    protected function getItemName(): string
+    {
+        $context = $this->getContext();
+        $paymentManager = Application::getPaymentManager($context);
+        return $paymentManager->getPaymentName($this->queuedPayment);
+    }
+
+    /**
+     * @return float|int|string|null
+     */
+    protected function getItemCost()
+    {
+        return $this->queuedPayment->getAmount();
+    }
+
+    protected function getItemCurrencyCode(): ?string
+    {
+        return $this->queuedPayment->getCurrencyCode();
+    }
+}