Merge pull request #1186 from plentymarkets/feat/multi_tracking_urls

copy of #1182, make sure that new function uses its own variable
plentymarkets · Mar 5, 2024 · 6d33746 · 6d33746
2 parents ac211be + 0463da9
commit 6d33746
Show file tree

Hide file tree

Showing 5 changed files with 74 additions and 14 deletions.
diff --git a/src/Extensions/Constants/ShopUrls.php b/src/Extensions/Constants/ShopUrls.php
@@ -334,7 +334,7 @@ public function orderDocumentPreview($documentId, $orderId, $orderAccessKey = nu
      * Get tracking URL for a specific order id.
      *
      * @param string|int $orderId Id of the order to get the tracking URL for.
-     * @return string
+     * @return array
      */
     public function tracking($orderId)
     {
@@ -343,17 +343,17 @@ public function tracking($orderId)
             "tracking.{$orderId}",
             function () use ($orderId, $lang) {
                 $authHelper = pluginApp(AuthHelper::class);
-                $trackingURL = $authHelper->processUnguarded(
+                $trackingURLs = $authHelper->processUnguarded(
                     function () use ($orderId, $lang) {
                         $orderRepository = pluginApp(OrderRepositoryContract::class);
                         $orderTrackingService = pluginApp(OrderTrackingService::class);
 
                         $order = $orderRepository->findOrderById($orderId);
-                        return $orderTrackingService->getTrackingURL($order, $lang);
+                        return $orderTrackingService->getTrackingURLs($order, $lang);
                     }
                 );
 
-                return $trackingURL;
+                return $trackingURLs;
             }
         );
     }

diff --git a/src/Models/LocalizedOrder.php b/src/Models/LocalizedOrder.php
@@ -78,6 +78,8 @@ class LocalizedOrder extends ModelWrapper
     public $shippingProfileId = 0;
     /** @var string $trackingURL Tracking URL for the order from shipping provider. */
     public $trackingURL = "";
+    /** @var string $trackingURLs List of tracking URLs for the order from shipping provider. */
+    public $trackingURLs = "";
     /** @var string $paymentMethodName Name of the payment method. */
     public $paymentMethodName = "";
     /** @var string $paymentMethodIcon URL of payment method icon image. */
@@ -169,6 +171,8 @@ public static function wrap($order, ...$data)
             /** @var OrderTrackingService $orderTrackingService */
             $orderTrackingService = pluginApp(OrderTrackingService::class);
             $instance->trackingURL = $orderTrackingService->getTrackingURL($order, $lang);
+            $instance->trackingURLs = $orderTrackingService->getTrackingURLs($order, $lang);
+
         } catch (\Exception $e) {
         }
 

diff --git a/src/Services/Order/Factories/OrderResultFactory.php b/src/Services/Order/Factories/OrderResultFactory.php
@@ -77,6 +77,7 @@ class OrderResultFactory
         'shippingProfileName'          => null,
         'shippingProfileId'            => 0,
         'trackingURL'                  => '',
+        'trackingURLs'                 => [],
         'paymentMethodName'            => null,
         'paymentMethodIcon'            => null,
         'paymentStatus'                => 'unpaid',

diff --git a/src/Services/OrderService.php b/src/Services/OrderService.php
@@ -438,6 +438,7 @@ public function getOrdersCompact(int $page = 1, int $items = 50)
                         'creationDate' => $creationDate,
                         'shippingDate' => $shippingDate,
                         'trackingURL' => $orderTrackingService->getTrackingURL($order, $lang),
+                        'trackingURLs' => $orderTrackingService->getTrackingURLs($order, $lang),
                         'confirmationURL' => $shopUrls->orderConfirmation($order->id)
                     ];
                 }

diff --git a/src/Services/OrderTrackingService.php b/src/Services/OrderTrackingService.php
@@ -55,20 +55,52 @@ public function getTrackingURL(Order $order, $lang)
                 $orderRepo = pluginApp(OrderRepositoryContract::class);
                 $packageNumber = implode(',', $orderRepo->getPackageNumbers($order->id));
 
-                if (strlen($packageNumber)) {
-                    $trackingURL = $parcelService->trackingUrl;
+                $trackingURL = $this->buildTrackingUrl($order, $parcelService->trackingUrl, $packageNumber, $lang);
+            }
+        } catch (\Exception $e) {
+            $this->getLogger(__CLASS__)->error("IO::Debug.OrderTrackingService_getTrackingURL", [
+                'code' => $e->getCode(),
+                'message' => $e->getMessage()
+            ]);
+        }
 
+        return $trackingURL;
+    }
+
+    /**
+     * Get list of tracking URLs for a specific order
+     * @param Order $order The order to get the tracking URL for
+     * @param string $lang The desired language of the tracking URL (ISO-639-1)
+     * @return array
+     */
+    public function getTrackingURLs(Order $order, $lang): array
+    {
+        $trackingURLs = [];
+
+        try {
+            $shippingProfile = $this->parcelServicePresetRepo->getPresetById($order->shippingProfileId);
+            $parcelService = $shippingProfile->parcelService;
+            if ($parcelService instanceof ParcelService) {
+                /** @var OrderRepositoryContract $orderRepo */
+                $orderRepo = pluginApp(OrderRepositoryContract::class);
+                $packageNumbers = $orderRepo->getPackageNumbers($order->id);
 
-                    $zip = $order->deliveryAddress->postalCode;
+                $splitUrls = $parcelService->toArray()['splitTrackingUrl'] ?? false; // Direct property access doesn't work for some reason
+                $delimiter = $parcelService->toArray()['splitDelimiter'] ?? null; // Direct property access doesn't work for some reason
+                if (!$delimiter) {
+                    $delimiter = ',';
+                }
 
-                    if (strlen($trackingURL)) {
+                $trackingURL = $parcelService->trackingUrl;
 
-                        $trackingURL = str_replace(
-                            ['[PaketNr]', '$PaketNr', '[PLZ]', '$PLZ', '[Lang]', '$Lang'],
-                            [urlencode($packageNumber), urlencode($packageNumber), urlencode($zip), urlencode($zip), $lang, $lang],
-                            $trackingURL
-                        );
+                if ($splitUrls) {
+                    foreach ($packageNumbers as $packageNo) {
+                        $trackingURLs[] = $this->buildTrackingUrl($order, $trackingURL, $packageNo, $lang);
                     }
+                } else {
+                    $packageNumber = implode($delimiter, $packageNumbers);
+
+                    $trackingURLs[] = $this->buildTrackingUrl($order, $trackingURL, $packageNumber, $lang);
                 }
             }
         } catch (\Exception $e) {
@@ -78,6 +110,28 @@ public function getTrackingURL(Order $order, $lang)
             ]);
         }
 
-        return $trackingURL;
+        return $trackingURLs;
+    }
+
+    /**
+     * @param Order $order
+     * @param string $trackingURL
+     * @param string $packageNumber
+     * @param string $lang
+     * @return string
+     */
+    private function buildTrackingUrl(Order $order, string $trackingURL, string $packageNumber, string $lang): string
+    {
+        $zip = $order->deliveryAddress->postalCode;
+
+        if (!strlen($trackingURL) || !strlen($packageNumber)) {
+            return '';
+        }
+
+        return str_replace(
+            ['[PaketNr]', '$PaketNr', '[PLZ]', '$PLZ', '[Lang]', '$Lang'],
+            [urlencode($packageNumber), urlencode($packageNumber), urlencode($zip), urlencode($zip), $lang, $lang],
+            $trackingURL
+        );
     }
 }