first commit

classes/mail/mailables/SubscriptionRenewInstitutional.php

@@ -0,0 +1,74 @@
+<?php
+
+/**
+ * @file classes/mail/mailables/SubscriptionRenewInstitutional.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 SubscriptionRenewInstitutional
+ *
+ * @brief Email sent automatically to notify a subscription manager about subscription renewal
+ */
+
+namespace APP\mail\mailables;
+
+use APP\journal\Journal;
+use APP\mail\traits\SubscriptionInstitutional;
+use APP\mail\traits\SubscriptionTypeVariables;
+use APP\mail\variables\SubscriptionEmailVariable;
+use APP\subscription\InstitutionalSubscription;
+use APP\subscription\Subscription;
+use APP\subscription\SubscriptionType;
+use PKP\institution\Institution;
+use PKP\mail\Mailable;
+use PKP\mail\traits\Configurable;
+use PKP\mail\traits\Sender;
+use PKP\security\Role;
+
+class SubscriptionRenewInstitutional extends Mailable
+{
+    use Configurable;
+    use Sender;
+    use SubscriptionInstitutional;
+    use SubscriptionTypeVariables;
+
+    protected static ?string $name = 'mailable.subscriptionRenewInstitutional.name';
+    protected static ?string $description = 'mailable.subscriptionRenewInstitutional.description';
+    protected static ?string $emailTemplateKey = 'SUBSCRIPTION_RENEW_INSTL';
+    protected static array $groupIds = [self::GROUP_OTHER];
+    protected static array $fromRoleIds = [Role::ROLE_ID_READER];
+    protected static array $toRoleIds = [Role::ROLE_ID_SUBSCRIPTION_MANAGER];
+
+    public function __construct(
+        Journal $context,
+        InstitutionalSubscription $subscription,
+        SubscriptionType $subscriptionType,
+        Institution $institution,
+    ) {
+        parent::__construct(func_get_args());
+        $this->setupInstitutionalVariables($subscription, $institution);
+        $this->setupSubscriptionTypeVariables($subscriptionType, $context);
+    }
+
+    /**
+     * Setup subscription related variables
+     */
+    protected static function templateVariablesMap(): array
+    {
+        $map = parent::templateVariablesMap();
+        $map[Subscription::class] = SubscriptionEmailVariable::class;
+        return $map;
+    }
+
+    /**
+     * Description for institution related template variables
+     */
+    public static function getDataDescriptions(): array
+    {
+        $variables = parent::getDataDescriptions();
+        $variables = static::addInstitutionalVariablesDescription($variables);
+        return static::addSubscriptionTypeVariablesDescription($variables);
+    }
+}