custom/plugins/ProcLiveOrderHistory/src/Subscriber/LiveOrderHistorySubscriber.php line 112

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Proc\ProcLiveOrderHistory\Subscriber;
  5. use Proc\ProcFoundation\Helper\ErrorHandler;
  6. use Proc\ProcFoundation\Helper\RequestHandler;
  7. use Proc\ProcFoundation\Service\ProcFoundationService;
  8. use Proc\ProcLiveOrderHistory\Helper\OrderHistoryStruct;
  9. use Proc\ProcLiveOrderHistory\Helper\BuildRequestHelper;
  11. use Shopware\Storefront\Page\Account\Order\AccountOrderPageLoadedEvent;
  12. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  13. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  17. use DateTime;
  18. use Exception;
  20. /**
  21.  * Class LiveOrderHistorySubscriber
  22.  * @package Proc\ProcLiveOrderHistory\Subscriber
  23.  */
  24. class LiveOrderHistorySubscriber implements EventSubscriberInterface
  25. {
  26.     private const PATH_HEADLIST = '/iman/order-history-headlist';
  27.     private const PATH_DETAILS = '/iman/order-history-details';
  28.     /**
  29.      * @todo
  30.      * Richtig muss es '/iman/order-history-document' heißen. Dies muss aber noch im iMan angepasst werden.
  31.      */
  32.     private const PATH_DOCUMENTS = '/iman/order-history-documents';
  33. //     private const PATH_DOCUMENTS = '/iman/order-history-document';
  35.     /**
  36.      * @var RequestHandler
  37.      */
  38.     private $requestHandler;
  40.     /**
  41.      * @var ErrorHandler
  42.      */
  43.     private $errorHandler;
  45.     /**
  46.      * @var string
  47.      */
  48.     private $host,
  49.             $port,
  50.             $customerNumber,
  51.             $fromDate,
  52.             $toDate;
  54.     private $error = null;
  56.     /**
  57.      * @var ProcFoundationService
  58.      */
  59.     private $foundationService;
  61.     /**
  62.      * @var AccountOrderPageLoadedEvent
  63.      */
  64.     private $event;
  66.     /**
  67.      * @var int
  68.      */
  69.     private $elementsPerPage,
  70.             $page;
  72.     /**
  73.      * @var EntityRepositoryInterface
  74.      */
  75.     private $productRepository;
  78.     /**
  79.      * @var Context
  80.      */
  81.     private $context;
  83.     /**
  84.      * @inheritDoc
  85.      */
  86.     public static function getSubscribedEvents()
  87.     {
  88.         return [
  89.             AccountOrderPageLoadedEvent::class => ['onAccountOrderPageLoaded' ,1]
  90.         ];
  91.     }
  94.     /**
  95.      * LiveOrderHistorySubscriber constructor.
  96.      * @param ProcFoundationService $foundationService
  97.      * @param RequestHandler $requestHandler
  98.      * @param ErrorHandler $errorHandler
  99.      * @throws Exception
  100.      */
  101.     public function __construct(ProcFoundationService $foundationService, RequestHandler $requestHandler, ErrorHandler $errorHandler, EntityRepositoryInterface  $productRepository)
  102.     {
  103.         $this->foundationService = $foundationService;
  104.         $this->requestHandler = $requestHandler;
  105.         $this->errorHandler = $errorHandler;
  106.         $this->productRepository = $productRepository;
  107.     }
  109.     /**
  110.      * @param AccountOrderPageLoadedEvent $event
  111.      */
  112.     public function onAccountOrderPageLoaded(AccountOrderPageLoadedEvent $event)
  113.     {
  114.         $this->event = $event;
  115.         /**
  116.          * Prüfung ob Benutzer angemeldet ist, sonst keine Live-Abfrage.
  117.          */
  118.         if (!($this->checkLogin()) || !($this->checkConfig()))
  119.         {
  120.             $orderNotComplete['fromDate'] = (new DateTime())->format('Y-m-d');
  121.             $orderNotComplete['toDate'] = (new DateTime())->format('Y-m-d');
  122.             $orderNotComplete['numElements'] = 0;
  123.             $orderNotComplete['order-history-list'] = '';
  125.             $orderNotCompleteStruct = new OrderHistoryStruct();
  126.             $orderNotCompleteStruct->setOrderHistory($orderNotComplete);
  127.             $this->event->getPage()->addExtension('order_history', $orderNotCompleteStruct);
  128.             return;
  129.         }
  131.         $this->handleOrderHistory();
  132.     }
  134.     private function checkLogin()
  135.     {   
  136.         $this->customerNumber = $this->foundationService->checkLogin($this->event->getSalesChannelContext(), (string)get_class($this));
  137.         $this->context = $this->event->getSalesChannelContext()->getContext();
  139.         if (!($this->customerNumber)) return false;
  140.         return true;
  141.     }
  143.     /**
  144.      * Hauptfunktion welche das einlesen der OrderHistory primär steuert.
  145.      * Die OrderHistory wird anhand vorhandener Daten eingelesen. Wird kein Datum ermittelt werden alle Order von 1.1.2021 bis zum aktuellen Datum vom iMan geholt.
  146.      * Standard Anzahl der Elemente pro Seite ist bei 10, kann aber über das Menü der OrderHistory auch anders ausgewählt werden.
  147.      */
  148.     public function handleOrderHistory()
  149.     {
  151.         $request = $this->event->getRequest();
  152.       
  153.         if ($request->getQueryString() == '') {
  154.             $orderNotComplete['fromDate'] = (new DateTime())->modify('-1 month')->format('Y-m-d');
  155.             $orderNotComplete['toDate'] = (new DateTime())->format('Y-m-d');
  156.             $orderNotComplete['numElements'] = 10;
  157.             $orderNotComplete['order-history-list'] = '';
  159.         }
  161.         $fromDate           = $request->get('fromDate') ?? (new DateTime())->modify('-1 month')->format('Y-m-d');;
  162.         $toDate             = $request->get('toDate') ?? (new DateTime())->format('Y-m-d');;
  163.         $this->elementsPerPage    = $request->get('numElements') ? (int)$request->get('numElements') : null ?? 10;
  164.         $this->page               = $request->get('page') ? (int)$request->get('page') : null ?? 1;
  166.         $orderHistory = $this->getOrderHistory($fromDate, $toDate);
  168.         if ($orderHistory['head']['status'] === 'NOK') {
  169.             $this->error = $this->errorHandler->error($this->errorHandler::SAP_RESPONSE_ERROR, get_class($this), 'SAP Status Fehler.' . print_r($orderHistory, true));
  170.             $this->errorHandler->writeErrorLog($this->error);
  171.             $orderNotComplete['fromDate'] = $request->get('fromDate');
  172.             $orderNotComplete['toDate'] = $request->get('toDate');
  173.             $orderNotComplete['numElements'] = 0;
  174.             $orderNotComplete['order-history-list'] = '';
  175.             $orderComplete['currentPage'] = $this->page;
  177.             $orderNotCompleteStruct = new OrderHistoryStruct();
  178.             $orderNotCompleteStruct->setOrderHistory($orderNotComplete);
  179.             $this->event->getPage()->addExtension('order_history', $orderNotCompleteStruct);
  180.         } else {
  182.             $orderHistory = $this->formatOrderHistory($orderHistory);
  183.             $pageOrders = $this->getOrdersPerPage($orderHistory);
  184.             $orderComplete = $this->getOrderDetails($pageOrders);
  186.             // $numElements = count($orderComplete['order-history-list']['order']);
  187.             $numElements = $this->elementsPerPage;
  188.             $orderComplete['numElements'] = $numElements;
  190.             if (null !== $qs = $this->event->getRequest()->getQueryString()) {
  191.                 $qs = '?'.$qs;
  192.             }
  193.             $orderComplete['baseUri'] = $this->event->getSalesChannelContext()->getSalesChannel()->getDomains()->first()->getUrl() .$this->event->getRequest()->getPathInfo().$qs;
  194.             $orderComplete['fromDate'] = $this->fromDate;
  195.             $orderComplete['toDate'] = $this->toDate;
  196.             $orderComplete['currentPage'] = $this->page;
  199.             $orderCompleteStruct = new OrderHistoryStruct();
  200.             $orderCompleteStruct->setOrderHistory($orderComplete);
  201.             $this->event->getPage()->addExtension('order_history', $orderCompleteStruct);
  202.         }
  203.     }
  205.     /**
  206.      * Nimm die Liste der OrderHistory-Elemente für die Zeit von-bis, wie beim Aufruf der getOrderHistory definiert
  207.      * schneidet" die Elemente für die gewünschte Seite aus und gibt das gekürzte Array zurück.
  208.      * @param $orderHistory
  209.      * @return array
  210.      */
  211.     protected function getOrdersPerPage($orderHistory) : array
  212.     {
  213.         $numElements = count($orderHistory['order-history-list']['order']);
  215.         if ($this->page === '' || $this->elementsPerPage === '' || $this->elementsPerPage === null) {
  216.             $this->page = 1;
  217.             $this->elementsPerPage = 10;
  218.         }
  220.         if ($numElements <= $this->elementsPerPage) {
  221.             return $orderHistory;
  222.         }
  224.         $start = ($this->page - 1) * $this->elementsPerPage;
  225.         $end = ($this->page * $this->elementsPerPage) - 1;
  227.         $resultArray['head'] = $orderHistory['head'];
  228.         $resultArray['order-history-list']['order'] = array_slice($orderHistory['order-history-list']['order'], $start, $this->elementsPerPage);
  229.         $resultArray['numPages'] = (int)ceil($numElements / $this->elementsPerPage);
  230.         $resultArray['currentPage'] = $this->page;
  232.         return $resultArray;
  233.     }
  235.     /**
  236.      * Liest die OrderHistory aus und die hinterlegten Dokumente
  237.      * füllte das Basis-Array mit diesen Daten und gibt das angereicherte Array zurück.
  238.      * @param array $iterationArray
  239.      * @param int $shopInstance
  240.      * @param string $language
  241.      * @return array
  242.      */
  243.     protected function getOrderDetails(array $iterationArray, int $shopInstance = 1, string $language = 'DE') : array
  244.     {
  245.         foreach ($iterationArray['order-history-list']['order'] as $key => $orderElement)
  246.         {
  248.             $params = [
  249.                 'shop-instance' => $shopInstance,
  250.                 'sap-order-id'  => $orderElement['sap-order-id'],
  251.                 'language'      => $language
  252.             ];
  254.             $buildRequestHelper = new BuildRequestHelper($params, 'details', $this->errorHandler);
  256.             /**
  257.              * @var string $request
  258.              */
  259.             $request = $this->requestHandler->buildRequest($buildRequestHelper, (string)get_class($this));
  261.             if ($request !== '') {
  262.                 /**
  263.                  * @var string $detailResult
  264.                  */
  265.                 $detailResult = $this->requestHandler->sendRequest($this->host, $this->port, self::PATH_DETAILS, $request);
  266.             } else {
  267.                 $this->error = $this->errorHandler->error($this->errorHandler::UNKNOWN_REQUEST, get_class($this), 'Fehler im Aufbau des Request');
  268.                 $this->errorHandler->writeErrorLog($this->error);
  269.                 continue;
  270.             }
  272.             $detailArray = RequestHandler::parseResult($detailResult);
  274.             if ($detailArray['head']['status'] === 'NOK' || count($detailArray) === 0) {
  275.                 continue;
  276.             }
  278.             /**
  279.              * Holen der Dokumente zu den einzelnen Orders
  280.              * @todo Deaktiviert, da SAP noch keine Dokumente liefern kann. Muss noch getestet werden, sobald SAP Dokumente liefern kan.
  281.              */
  282.             if (array_key_exists('sap-order-id', $detailArray['document-list']['document'])) {
  283.                 $detailIterationArray['head'] = $detailArray['head'];
  284.                 $detailIterationArray['document-list']['document'][0] = $detailArray['document-list']['document'];
  285.             } else {
  286.                 $detailIterationArray = $detailArray;
  287.             }
  288.             /**
  289.              * @todo Die Foreach war für  um nur Rechunungen heraus zu filtern. Hier sollte es konfigurierbar gemacht werden.
  290.              */
  291.             foreach ($detailIterationArray['document-list']['document'] as $key2 => $documentElement)
  292.             {
  293.                 if (($documentElement['document-type-code'] != 'M') && ($documentElement['document-type-code'] != 'C'))
  294.                 {
  295.                     unset($detailIterationArray['document-list']['document'][$key2]);
  296.                 }
  297.             }
  299. //             $detailCompleteArray = $this->getOrderDocuments($detailIterationArray);
  301.             $iterationArray['order-history-list']['order'][$key]['document-list'] = $detailIterationArray['document-list'];
  303.             $iterationArray['order-history-list']['order'][$key]['head'] = $detailArray['head'];
  305.             if ($iterationArray['order-history-list']['order'][$key]['customer-order-id'] === []) {
  306.                 $iterationArray['order-history-list']['order'][$key]['customer-order-id'] = 'keine Kunden-Bestellnummer';
  307.             }
  309.             $totalAmount = 0;
  311.             //check if an array of $detailArray['articles']['article'] is assocciative
  312.             if(array_key_exists('number', $detailArray['articles']['article'])) {
  313.                 //means that the order have only one article
  314.                 $additionaDataFromSW = $this->fetchProductByReferenceNumber($detailArray['articles']['article']['number'], $detailArray['articles']['article']['short-text']);
  316.                 if($additionaDataFromSW ) {
  317.                     $detailArray['articles']['article'] = array_merge( $detailArray['articles']['article'],$additionaDataFromSW);
  318.                 }
  320.                 $iterationArray['order-history-list']['order'][$key]['articles'][] = $detailArray['articles']['article'];
  322.                 $iterationArray['order-history-list']['order'][$key]['totalAmount'] = $detailArray['articles']['article']['net-position-sum'];
  324.             } else {
  325.                 foreach($detailArray['articles']['article'] as $lineItemKey => $lineItem) {
  326.                     $additionaDataFromSW = $this->fetchProductByReferenceNumber($lineItem['number'], $lineItem['short-text']);
  328.                     if($additionaDataFromSW ) {
  329.                         $detailArray['articles']['article'][$lineItemKey] = array_merge( $lineItem, $additionaDataFromSW);
  330.                     }
  332.                     $totalAmount += $lineItem['net-position-sum'];
  334.                 }
  336.                 $iterationArray['order-history-list']['order'][$key]['articles'] = $detailArray['articles']['article'];
  337.                 $iterationArray['order-history-list']['order'][$key]['totalAmount'] = $totalAmount;
  339.             }
  341.             // @fts - Add discounts to array
  342.             $iterationArray['order-history-list']['order'][$key]['discounts'] = $detailArray['discounts'] ?? [];
  343.         }
  345.         return $iterationArray;
  346.     }
  348.     /**
  349.      * Liest die OrderDetails aus und die hinterlegten Dokumente
  350.      * füllte das Details-Array mit den Dokumenten und gibt das angereicherte Array zurück.
  351.      * @param array $detailsArray
  352.      * @param int$shopInstance
  353.      * @return array
  354.      * @todo In Controller auslagern, um die document.php im Plugin zu halten
  355.      */
  356.     public function getOrderDocuments(array $detailsArray, int $shopInstance = 1)
  357.     {
  358.         foreach ($detailsArray['document-list']['document'] as $key => $documentElement)
  359.         {
  360.             /**
  361.              * @todo
  362.              * Hier muss noch wegen der Dokumententypen angepasst werden.
  363.              */
  364. //             if ($documentElement['document-type-code'] == 'M') {
  365.             if (true) {
  366.                 $params = [
  367.                     'shop-instance' => $shopInstance,
  368.                     'customer' => $this->customerNumber,
  369.                     'document-number' => $documentElement['document-number'],
  370.                     'document-type-code' => $documentElement['document-type-code']
  371.                 ];
  373.                 $buildRequestHelper = new BuildRequestHelper($params, 'documents', $this->errorHandler);
  375.                 /**
  376.                  * @var string $request
  377.                  */
  378.                 $request = $this->requestHandler->buildRequest($buildRequestHelper, (string)get_class($this));
  380.                 if ($request !== '') {
  381.                     /**
  382.                      * @var string $documentResult
  383.                      */
  384.                     $documentResult = $this->requestHandler->sendRequest($this->host, $this->port, self::PATH_DOCUMENTS, $request);
  385.                 } else {
  386.                     $this->error = $this->errorHandler->error($this->errorHandler::UNKNOWN_REQUEST, get_class($this), 'Fehler im Aufbau des Request');
  387.                     $this->errorHandler->writeErrorLog($this->error);
  388.                     continue;
  389.                 }
  391.                 $documentArray = RequestHandler::parseResult($documentResult);
  393.                 if ($documentArray['head']['status'] === 'NOK' || count($documentArray) === 0) {
  394.                     continue;
  395.                 }
  397.                 if (array_key_exists('data', $documentArray['head'])) {
  398.                     $documentIterationArray['data'] = $documentArray['head']['data'];
  399.                 } else {
  400.                     $documentIterationArray['data'] = $documentArray['head']['status'];
  401.                 }
  403.                 $detailsArray['document-list']['document'][$key]['document-data'] = $documentIterationArray['data'];
  404.             /**
  405.              * @todo Hier werden alle nicht Rechnungen entfernt. Muss raus genommen werden, wenn andere Dokumente gehen
  406.              */
  407.             } else {
  408.                 unset($detailsArray['document-list']['document'][$key]);
  409.             }
  410.         }
  412.         return $detailsArray;
  413.     }
  416.     /**
  417.      * Bereitet mit dem Requesthandler die Request auf und holt die Daten vom iMan
  418.      *
  419.      * @param string|null $fromDate
  420.      * @param string|null $toDate
  421.      * @param int $shopInstance
  422.      * @param string $language
  423.      * @return array
  424.      */
  425.     protected function getOrderHistory(string $fromDate = null,
  426.                                        string $toDate = null,
  427.                                        int $shopInstance = 1,
  428.                                        string $language = 'DE') : array
  429.     {
  431.         if ($fromDate !== null && $toDate !== null) {
  432.             $this->checkDateRange($fromDate, $toDate);
  433.         }
  435.         if ($fromDate === null) {
  436.             $fromDate = '2021-01-01';
  437.         }
  439.         if ($toDate === null) {
  440.             $toDate = (new DateTime())->format('Y-m-d');
  441.         }
  443.         $this->fromDate = $fromDate;
  444.         $this->toDate = $toDate;
  446.         $params = [
  447.             'shop-instance' => $shopInstance,
  448.             'customer'      => $this->customerNumber,
  449.             'date-from'     => $this->fromDate,
  450.             'date-to'       => $this->toDate,
  451.             'language'      => $language
  452.         ];
  455.         $buildRequestHelper = new BuildRequestHelper($params, 'headlist', $this->errorHandler);
  457.         /**
  458.          * @var string $request
  459.          */
  460.         $request = $this->requestHandler->buildRequest($buildRequestHelper, (string)get_class($this));
  462.         if ($request !== '') {
  463.             /**
  464.              * @var string $result
  465.              */
  466.             $result = $this->requestHandler->sendRequest($this->host, $this->port, self::PATH_HEADLIST, $request);
  467.             $this->error = $this->errorHandler->error($this->errorHandler::UNKNOWN_REQUEST, get_class($this), 'Result: ' . print_r($result, true));
  468.             $this->errorHandler->writeErrorLog($this->error);
  469.         } else {
  470.             /**
  471.              * @todo Fehlerbehandlung
  472.              */
  473.             Return array();
  474.         }
  475.         return $this->requestHandler->parseResult($result);
  476.     }
  478.     /**
  479.      * Prüft die übergebenen Daten auf ihren Wert und bei vertauschte Angabe werden diese ausgewechselt.
  480.      *
  481.      * @param string|null $fromDate
  482.      * @param string|null $toDate
  483.      */
  484.     protected function checkDateRange(string &$fromDate, string &$toDate) : void
  485.     {
  486.         try {
  487.             $startDate = new DateTime($fromDate);
  488.             $endDate = new DateTime($toDate);
  489.         } catch (Exception $e) {
  490.             $this->error = $this->errorHandler->error($this->errorHandler::GENERAL_ERROR, get_class($this), 'Eine Datumsangabe entspricht nicht dem vorgegeben Format. - ' . $e->getCode() . ' - ' . $e->getMessage());
  491.             $this->errorHandler->writeErrorLog($this->error);
  492.             $fromDate = '';
  493.             $toDate = '';
  494.         }
  496.         if ($endDate < $startDate)
  497.         {
  498.             $fromDate   = $endDate->format('Y-m-d');
  499.             $toDate     = $startDate->format('Y-m-d');
  500.         }
  501.     }
  503.     /**
  504.      * Array des Response wird in ein einheitliches Format gebracht zur Vereinfachung der weiteren Handhabung
  505.      * @param array $orderHistory
  506.      * @return array
  507.      */
  508.     protected function formatOrderHistory(array $orderHistory) : array
  509.     {
  510.         if (array_key_exists('sap-order-id', $orderHistory['order-history-list']['order'])) {
  511.             $iterationArray['head'] = $orderHistory['head'];
  512.             $iterationArray['order-history-list']['order'][0] = $orderHistory['order-history-list']['order'];
  513.         } else {
  514.             $iterationArray = $orderHistory;
  515.         }
  516.         if (empty($iterationArray['head']['customer']) || is_array($iterationArray['head']['customer'])) {
  517.             $iterationArray['head']['customer'] = $this->customerNumber;
  518.         }
  520.         return $iterationArray;
  521.     }
  523.     /**
  524.      * @return bool
  525.      */
  526.     private function checkConfig() : bool
  527.     {
  528.         if ($this->foundationService->getConfigStatus()) {
  529.             $this->host = $this->foundationService->getHost();
  530.             $this->port = $this->foundationService->getPort();
  531.             return true;
  532.         }
  533.         $this->error = $this->errorHandler->error($this->errorHandler::CONFIG_NOT_VALID, get_class($this), 'Konnte die Konfiguration nicht ermitteln');
  534.         $this->errorHandler->writeErrorLog($this->error);
  535.         return false;
  536.     }
  539.     public function fetchProductByReferenceNumber(string $referenceNumber, string $orginalName)
  540.     {
  541.         $criteria = new Criteria();
  542.         $criteria->addFilter(new EqualsFilter('product.productNumber', $referenceNumber));
  544.         $product = $this->productRepository->search($criteria, $this->context)->first();
  546.         /** @var ProductEntity $product */
  547.         if (!$product) {
  548.             // throw new NotFoundException("Product with reference number {$referenceNumber} not found.");
  549.             return ['name' => $orginalName];
  550.         }
  552.         $result = [
  553.             'identifier' => $product->getId(),
  554.             'name' => $product->getTranslated()['name']
  555.         ];
  557.         return $result;
  558.     }
  559. }