Merge pull request #415 from Zasilkovna/PES-3058-email-alerts

PES-3058: e-mail alerts

Author: zemekoule

packetery/CHANGE_LOG.txt

@@ -1,3 +1,6 @@
+
+v3.4
+       - Added: Information about the selected pickup point to emails for e-shop owner.
        - Updated: Loading the widget javascript library only on the checkout page.
        - Updated: Multiple issues form PrestaShop validator resolved.
        - Updated: Added company to shipment submission via API.

packetery/libs/Hooks/SendMailAlterTemplateVars.php

@@ -0,0 +1,99 @@
+<?php
+/**
+ * @author    Packeta s.r.o. <e-commerce.support@packeta.com>
+ * @copyright 2015-2026 Packeta s.r.o.
+ * @license   http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
+ */
+
+namespace Packetery\Hooks;
+
+if (!defined('_PS_VERSION_')) {
+    exit;
+}
+
+use Packetery\Exceptions\DatabaseException;
+use Packetery\Order\OrderRepository;
+
+class SendMailAlterTemplateVars
+{
+    /** @var OrderRepository */
+    private $orderRepository;
+
+    public function __construct(
+        OrderRepository $orderRepository
+    ) {
+        $this->orderRepository = $orderRepository;
+    }
+
+    /**
+     * Alters variables of order e-mails, append carrier with additional data
+     * inspiration: https://github.com/PrestaShop/ps_legalcompliance/blob/dev/ps_legalcompliance.php
+     *
+     * @throws DatabaseException
+     */
+    public function execute(array &$params): void
+    {
+        if (
+            $this->isOrderPage($params) === false
+            || $this->hasCarrier($params) === false
+            || $this->hasOrderOrCart($params) === false
+        ) {
+            return;
+        }
+
+        $orderData = $this->getOrderData($params);
+        if ($orderData !== null) {
+            $additionalCarrierData = $this->getAdditionalCarrierInfo($orderData);
+            $params['template_vars']['{carrier}'] .= $additionalCarrierData;
+        }
+    }
+
+    private function isOrderPage(array $params): bool
+    {
+        return isset($params['template']) && str_contains((string) $params['template'], 'order');
+    }
+
+    private function hasCarrier(array $params): bool
+    {
+        return isset($params['template_vars']['{carrier}']) && is_string($params['template_vars']['{carrier}']);
+    }
+
+    private function hasOrderOrCart(array $params): bool
+    {
+        return isset($params['template_vars']['{id_order}']) || $this->hasCart($params);
+    }
+
+    private function hasCart(array $params): bool
+    {
+        return isset($params['cart']) && $params['cart'] instanceof \Cart;
+    }
+
+    /**
+     * @throws DatabaseException
+     */
+    private function getOrderData(array $params): ?array
+    {
+        $orderData = null;
+        if (isset($params['template_vars']['{id_order}'])) {
+            $orderData = $this->orderRepository->getById((int) $params['template_vars']['{id_order}']);
+        } elseif (isset($params['cart']->id)) {
+            $orderData = $this->orderRepository->getByCart((int) $params['cart']->id);
+        }
+
+        if (!is_array($orderData)) {
+            return null;
+        }
+
+        return $orderData;
+    }
+
+    private function getAdditionalCarrierInfo(array $orderData): string
+    {
+        $carrierText = ' - ' . htmlspecialchars($orderData['name_branch'] ?? '', ENT_QUOTES);
+        if (isset($orderData['is_carrier']) && (bool) $orderData['is_carrier'] === false) {
+            $carrierText .= sprintf(' (%s)', (int) ($orderData['id_branch'] ?? ''));
+        }
+
+        return $carrierText;
+    }
+}

packetery/packetery.php

@@ -1383,27 +1383,9 @@ public function hookDisplayOrderDetail($params)
      */
     public function hookSendMailAlterTemplateVars(&$params)
     {
-        if (
-            !isset(
-                $params['template'],
-                $params['template_vars']['{id_order}'],
-                $params['template_vars']['{carrier}']
-            )
-            || strpos((string) $params['template'], 'order') === false
-        ) {
-            return;
-        }
-
-        $orderRepository = $this->diContainer->get(Packetery\Order\OrderRepository::class);
-        $orderData = $orderRepository->getById((int) $params['template_vars']['{id_order}']);
-        if (!$orderData) {
-            return;
-        }
-
-        $params['template_vars']['{carrier}'] .= ' - ' . $orderData['name_branch'];
-        if ((bool) $orderData['is_carrier'] === false) {
-            $params['template_vars']['{carrier}'] .= sprintf(' (%s)', $orderData['id_branch']);
-        }
+        /** @var Packetery\Hooks\SendMailAlterTemplateVars $sendMailAlterTemplateVars */
+        $sendMailAlterTemplateVars = $this->diContainer->get(Packetery\Hooks\SendMailAlterTemplateVars::class);
+        $sendMailAlterTemplateVars->execute($params);
     }
 
     /**