refactor: xml namespaces are stored in php constants

Antidot-be · Oct 13, 2024 · 639557a · 639557a
1 parent f80989d
commit 639557a
Show file tree

Hide file tree

Showing 29 changed files with 146 additions and 389 deletions.
diff --git a/src/Bpost.php b/src/Bpost.php
@@ -43,6 +43,15 @@ class Bpost
     const LABEL_FORMAT_A4 = 'A4';
     const LABEL_FORMAT_A6 = 'A6';
 
+    const NS_V3_GLOBAL = 'http://schema.post.be/shm/deepintegration/v3/';
+    const NS_V3_COMMON = 'http://schema.post.be/shm/deepintegration/v3/common';
+    const NS_V3_NATIONAL = 'http://schema.post.be/shm/deepintegration/v3/national';
+    const NS_V3_INTERNATIONAL = 'http://schema.post.be/shm/deepintegration/v3/international';
+    const NS_V5_GLOBAL = 'http://schema.post.be/shm/deepintegration/v5/';
+    const NS_V5_COMMON = 'http://schema.post.be/shm/deepintegration/v5/common';
+    const NS_V5_NATIONAL = 'http://schema.post.be/shm/deepintegration/v5/national';
+    const NS_V5_INTERNATIONAL = 'http://schema.post.be/shm/deepintegration/v5/international';
+
     // URL for the api
     const API_URL = 'https://shm-rest.bpost.cloud/services/shm';
 

diff --git a/src/Bpost/HttpRequestBuilder/CreateLabelInBulkForOrdersBuilder.php b/src/Bpost/HttpRequestBuilder/CreateLabelInBulkForOrdersBuilder.php
@@ -2,6 +2,7 @@
 
 namespace Bpost\BpostApiClient\Bpost\HttpRequestBuilder;
 
+use Bpost\BpostApiClient\Bpost;
 use Bpost\BpostApiClient\Common\ValidatedValue\LabelFormat;
 use DOMDocument;
 use DOMException;
@@ -57,7 +58,7 @@ public function getXml()
         $document->formatOutput = true;
 
         $batchLabels = $document->createElement('batchLabels');
-        $batchLabels->setAttribute('xmlns', 'http://schema.post.be/shm/deepintegration/v3/');
+        $batchLabels->setAttribute('xmlns', Bpost::NS_V3_GLOBAL);
         foreach ($this->references as $reference) {
             $batchLabels->appendChild(
                 $document->createElement('order', $reference)

diff --git a/src/Bpost/HttpRequestBuilder/ModifyOrderBuilder.php b/src/Bpost/HttpRequestBuilder/ModifyOrderBuilder.php
@@ -2,6 +2,7 @@
 
 namespace Bpost\BpostApiClient\Bpost\HttpRequestBuilder;
 
+use Bpost\BpostApiClient\Bpost;
 use Bpost\BpostApiClient\Bpost\Order\Box;
 use Bpost\BpostApiClient\Exception\BpostLogicException\BpostInvalidValueException;
 use DOMDocument;
@@ -40,7 +41,7 @@ public function getXml()
         $document->formatOutput = true;
 
         $orderUpdate = $document->createElement('orderUpdate');
-        $orderUpdate->setAttribute('xmlns', 'http://schema.post.be/shm/deepintegration/v3/');
+        $orderUpdate->setAttribute('xmlns', Bpost::NS_V3_GLOBAL);
         $orderUpdate->setAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
         $orderUpdate->appendChild(
             $document->createElement('status', $this->status)

diff --git a/src/Bpost/Order.php b/src/Bpost/Order.php
@@ -2,6 +2,7 @@
 
 namespace Bpost\BpostApiClient\Bpost;
 
+use Bpost\BpostApiClient\Bpost;
 use Bpost\BpostApiClient\Bpost\Order\Box;
 use Bpost\BpostApiClient\Bpost\Order\Line;
 use Bpost\BpostApiClient\Exception\BpostNotImplementedException;
@@ -158,30 +159,12 @@ public function toXML(DOMDocument $document, $accountId)
         $order = $document->createElement(
             'tns:order'
         );
-        $order->setAttribute(
-            'xmlns:common',
-            'http://schema.post.be/shm/deepintegration/v5/common'
-        );
-        $order->setAttribute(
-            'xmlns:tns',
-            'http://schema.post.be/shm/deepintegration/v5/'
-        );
-        $order->setAttribute(
-            'xmlns',
-            'http://schema.post.be/shm/deepintegration/v5/national'
-        );
-        $order->setAttribute(
-            'xmlns:international',
-            'http://schema.post.be/shm/deepintegration/v5/international'
-        );
-        $order->setAttribute(
-            'xmlns:xsi',
-            'http://www.w3.org/2001/XMLSchema-instance'
-        );
-        $order->setAttribute(
-            'xsi:schemaLocation',
-            'http://schema.post.be/shm/deepintegration/v5/'
-        );
+        $order->setAttribute('xmlns:common', Bpost::NS_V5_COMMON);
+        $order->setAttribute('xmlns:tns', Bpost::NS_V5_GLOBAL);
+        $order->setAttribute('xmlns', Bpost::NS_V5_NATIONAL);
+        $order->setAttribute('xmlns:international', Bpost::NS_V5_INTERNATIONAL);
+        $order->setAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
+        $order->setAttribute('xsi:schemaLocation', Bpost::NS_V5_GLOBAL);
 
         $document->appendChild($order);
 

diff --git a/src/Bpost/Order/Box.php b/src/Bpost/Order/Box.php
@@ -2,6 +2,7 @@
 
 namespace Bpost\BpostApiClient\Bpost\Order;
 
+use Bpost\BpostApiClient\Bpost;
 use Bpost\BpostApiClient\Common\XmlHelper;
 use Bpost\BpostApiClient\Exception\BpostLogicException\BpostInvalidValueException;
 use Bpost\BpostApiClient\Exception\BpostNotImplementedException;
@@ -232,14 +233,14 @@ public static function createFromXML(SimpleXMLElement $xml)
             $box->setSender(
                 Sender::createFromXML(
                     $xml->sender->children(
-                        'http://schema.post.be/shm/deepintegration/v3/common'
+                        Bpost::NS_V3_COMMON
                     )
                 )
             );
         }
         if (isset($xml->nationalBox)) {
             /** @var SimpleXMLElement $nationalBoxData */
-            $nationalBoxData = $xml->nationalBox->children('http://schema.post.be/shm/deepintegration/v3/national');
+            $nationalBoxData = $xml->nationalBox->children(Bpost::NS_V3_NATIONAL);
 
             // build classname based on the tag name
             $className = '\\Bpost\\BpostApiClient\\Bpost\\Order\\Box\\' . ucfirst($nationalBoxData->getName());
@@ -255,7 +256,7 @@ public static function createFromXML(SimpleXMLElement $xml)
         }
         if (isset($xml->internationalBox)) {
             /** @var SimpleXMLElement $internationalBoxData */
-            $internationalBoxData = $xml->internationalBox->children('http://schema.post.be/shm/deepintegration/v3/international');
+            $internationalBoxData = $xml->internationalBox->children(Bpost::NS_V3_INTERNATIONAL);
 
             // build classname based on the tag name
             $className = '\\Bpost\\BpostApiClient\\Bpost\\Order\\Box\\' . ucfirst($internationalBoxData->getName());

diff --git a/src/Bpost/Order/Box/At247.php b/src/Bpost/Order/Box/At247.php
@@ -2,6 +2,7 @@
 
 namespace Bpost\BpostApiClient\Bpost\Order\Box;
 
+use Bpost\BpostApiClient\Bpost;
 use Bpost\BpostApiClient\Bpost\Order\Box\National\Unregistered;
 use Bpost\BpostApiClient\Bpost\Order\Box\Option\Messaging;
 use Bpost\BpostApiClient\Bpost\Order\ParcelsDepotAddress;
@@ -322,7 +323,7 @@ public static function createFromXML(SimpleXMLElement $xml, National $self = nul
         if (isset($xml->{'at24-7'}->options)) {
             /** @var SimpleXMLElement $optionData */
             foreach ($xml->{'at24-7'}->options as $optionData) {
-                $optionData = $optionData->children('http://schema.post.be/shm/deepintegration/v3/common');
+                $optionData = $optionData->children(Bpost::NS_V3_COMMON);
 
                 if (in_array($optionData->getName(), array(Messaging::MESSAGING_TYPE_INFO_DISTRIBUTED))) {
                     $option = Messaging::createFromXML($optionData);
@@ -365,9 +366,7 @@ public static function createFromXML(SimpleXMLElement $xml, National $self = nul
         }
         if (isset($xml->{'at24-7'}->parcelsDepotAddress)) {
             /** @var SimpleXMLElement $parcelsDepotAddressData */
-            $parcelsDepotAddressData = $xml->{'at24-7'}->parcelsDepotAddress->children(
-                'http://schema.post.be/shm/deepintegration/v3/common'
-            );
+            $parcelsDepotAddressData = $xml->{'at24-7'}->parcelsDepotAddress->children(Bpost::NS_V3_COMMON);
             $at247->setParcelsDepotAddress(
                 ParcelsDepotAddress::createFromXML($parcelsDepotAddressData)
             );

diff --git a/src/Bpost/Order/Box/AtBpost.php b/src/Bpost/Order/Box/AtBpost.php
@@ -2,6 +2,7 @@
 
 namespace Bpost\BpostApiClient\Bpost\Order\Box;
 
+use Bpost\BpostApiClient\Bpost;
 use Bpost\BpostApiClient\Bpost\Order\Box\National\ShopHandlingInstruction;
 use Bpost\BpostApiClient\Bpost\Order\Box\Option\Messaging;
 use Bpost\BpostApiClient\Bpost\Order\PugoAddress;
@@ -281,7 +282,7 @@ public static function createFromXML(SimpleXMLElement $xml, National $self = nul
         if (isset($xml->atBpost->options)) {
             /** @var SimpleXMLElement $optionData */
             foreach ($xml->atBpost->options as $optionData) {
-                $optionData = $optionData->children('http://schema.post.be/shm/deepintegration/v3/common');
+                $optionData = $optionData->children(Bpost::NS_V3_COMMON);
 
                 if (in_array(
                     $optionData->getName(),
@@ -329,7 +330,7 @@ public static function createFromXML(SimpleXMLElement $xml, National $self = nul
         if (isset($xml->atBpost->pugoAddress)) {
             /** @var SimpleXMLElement $pugoAddressData */
             $pugoAddressData = $xml->atBpost->pugoAddress->children(
-                'http://schema.post.be/shm/deepintegration/v3/common'
+                Bpost::NS_V3_COMMON
             );
             $atBpost->setPugoAddress(
                 PugoAddress::createFromXML($pugoAddressData)

diff --git a/src/Bpost/Order/Box/AtHome.php b/src/Bpost/Order/Box/AtHome.php
@@ -2,6 +2,7 @@
 
 namespace Bpost\BpostApiClient\Bpost\Order\Box;
 
+use Bpost\BpostApiClient\Bpost;
 use Bpost\BpostApiClient\Bpost\Order\Receiver;
 use Bpost\BpostApiClient\Bpost\ProductConfiguration\Product;
 use Bpost\BpostApiClient\Common\XmlHelper;
@@ -159,7 +160,7 @@ public static function createFromXML(SimpleXMLElement $xml, National $self = nul
         if (isset($atHomeXml->receiver)) {
             $self->setReceiver(
                 Receiver::createFromXML(
-                    $atHomeXml->receiver->children('http://schema.post.be/shm/deepintegration/v3/common')
+                    $atHomeXml->receiver->children(Bpost::NS_V3_COMMON)
                 )
             );
         }

diff --git a/src/Bpost/Order/Box/AtIntlPugo.php b/src/Bpost/Order/Box/AtIntlPugo.php
@@ -1,6 +1,7 @@
 <?php
 namespace Bpost\BpostApiClient\Bpost\Order\Box;
 
+use Bpost\BpostApiClient\Bpost;
 use Bpost\BpostApiClient\Bpost\Order\Box\National\ShopHandlingInstruction;
 use Bpost\BpostApiClient\Bpost\Order\Box\Option\Messaging;
 use Bpost\BpostApiClient\Bpost\Order\PugoAddress;
@@ -252,7 +253,7 @@ public static function createFromXML(\SimpleXMLElement $xml)
         if (isset($xml->atIntlPugo->options)) {
             /** @var \SimpleXMLElement $optionData */
             foreach ($xml->atIntlPugo->options as $optionData) {
-                $optionData = $optionData->children('http://schema.post.be/shm/deepintegration/v3/common');
+                $optionData = $optionData->children(Bpost::NS_V3_COMMON);
 
                 if (in_array(
                     $optionData->getName(),
@@ -288,7 +289,7 @@ public static function createFromXML(\SimpleXMLElement $xml)
         if (isset($xml->atIntlPugo->receiver) && $xml->atIntlPugo->receiver != '') {
             $self->setReceiver(
                 Receiver::createFromXML(
-                    $xml->atIntlPugo->receiver->children('http://schema.post.be/shm/deepintegration/v3/common')
+                    $xml->atIntlPugo->receiver->children(Bpost::NS_V3_COMMON)
                 )
             );
         }
@@ -304,9 +305,7 @@ public static function createFromXML(\SimpleXMLElement $xml)
         }
         if (isset($xml->atIntlPugo->pugoAddress)) {
             /** @var \SimpleXMLElement $pugoAddressData */
-            $pugoAddressData = $xml->atIntlPugo->pugoAddress->children(
-                'http://schema.post.be/shm/deepintegration/v3/common'
-            );
+            $pugoAddressData = $xml->atIntlPugo->pugoAddress->children(Bpost::NS_V3_COMMON);
             $self->setPugoAddress(
                 PugoAddress::createFromXML($pugoAddressData)
             );

diff --git a/src/Bpost/Order/Box/BpostOnAppointment.php b/src/Bpost/Order/Box/BpostOnAppointment.php
@@ -2,6 +2,7 @@
 
 namespace Bpost\BpostApiClient\Bpost\Order\Box;
 
+use Bpost\BpostApiClient\Bpost;
 use Bpost\BpostApiClient\Bpost\Order\Receiver;
 use Bpost\BpostApiClient\Common\XmlHelper;
 use Bpost\BpostApiClient\Exception\XmlException\BpostXmlInvalidItemException;
@@ -125,7 +126,7 @@ public static function createFromXML(SimpleXMLElement $xml, National $self = nul
         if (isset($bpostOnAppointmentXml->receiver)) {
             $self->setReceiver(
                 Receiver::createFromXML(
-                    $bpostOnAppointmentXml->receiver->children('http://schema.post.be/shm/deepintegration/v3/common')
+                    $bpostOnAppointmentXml->receiver->children(Bpost::NS_V3_COMMON)
                 )
             );
         }

diff --git a/src/Bpost/Order/Box/International.php b/src/Bpost/Order/Box/International.php
@@ -2,6 +2,7 @@
 
 namespace Bpost\BpostApiClient\Bpost\Order\Box;
 
+use Bpost\BpostApiClient\Bpost;
 use Bpost\BpostApiClient\Bpost\Order\Box\CustomsInfo\CustomsInfo;
 use Bpost\BpostApiClient\Bpost\Order\Box\International\ParcelContent;
 use Bpost\BpostApiClient\Bpost\Order\Box\Option\Messaging;
@@ -295,7 +296,7 @@ public static function createFromXML(SimpleXMLElement $xml)
         }
         if (isset($xml->international->options)) {
             /** @var SimpleXMLElement $optionData */
-            $options = $xml->international->options->children('http://schema.post.be/shm/deepintegration/v3/common');
+            $options = $xml->international->options->children(Bpost::NS_V3_COMMON);
             foreach ($options as $optionData) {
                 switch ($optionData->getName()) {
                     case Messaging::MESSAGING_TYPE_INFO_DISTRIBUTED:
@@ -322,9 +323,7 @@ public static function createFromXML(SimpleXMLElement $xml)
             );
         }
         if (isset($xml->international->receiver)) {
-            $receiverData = $xml->international->receiver->children(
-                'http://schema.post.be/shm/deepintegration/v3/common'
-            );
+            $receiverData = $xml->international->receiver->children(Bpost::NS_V3_COMMON);
             $international->setReceiver(
                 Receiver::createFromXML($receiverData)
             );

diff --git a/src/Bpost/Order/Box/National.php b/src/Bpost/Order/Box/National.php
@@ -2,6 +2,7 @@
 
 namespace Bpost\BpostApiClient\Bpost\Order\Box;
 
+use Bpost\BpostApiClient\Bpost;
 use Bpost\BpostApiClient\Bpost\Order\Box\OpeningHour\Day;
 use Bpost\BpostApiClient\Bpost\Order\Box\Option\Messaging;
 use Bpost\BpostApiClient\Bpost\Order\Box\Option\Option;
@@ -234,7 +235,7 @@ public static function createFromXML(SimpleXMLElement $nationalXml, National $se
         if (isset($nationalXml->options) && !empty($nationalXml->options)) {
             /** @var SimpleXMLElement $optionData */
             foreach ($nationalXml->options as $optionData) {
-                $optionData = $optionData->children('http://schema.post.be/shm/deepintegration/v3/common');
+                $optionData = $optionData->children(Bpost::NS_V3_COMMON);
 
                 if (in_array($optionData->getName(), array(
                         Messaging::MESSAGING_TYPE_INFO_DISTRIBUTED,

diff --git a/src/Bpost/Order/Box/Option/Insured.php b/src/Bpost/Order/Box/Option/Insured.php
@@ -2,6 +2,7 @@
 
 namespace Bpost\BpostApiClient\Bpost\Order\Box\Option;
 
+use Bpost\BpostApiClient\Bpost;
 use Bpost\BpostApiClient\Common\XmlHelper;
 use Bpost\BpostApiClient\Exception\BpostLogicException\BpostInvalidValueException;
 use DomDocument;
@@ -137,7 +138,6 @@ public function __construct($type, $value = null)
      * Return the object as an array for usage in the XML
      *
      * @param DomDocument $document
-     * @param string      $prefix
      *
      * @return DomElement
      *

diff --git a/src/Bpost/Order/Box/Option/Messaging.php b/src/Bpost/Order/Box/Option/Messaging.php
@@ -2,6 +2,7 @@
 
 namespace Bpost\BpostApiClient\Bpost\Order\Box\Option;
 
+use Bpost\BpostApiClient\Bpost;
 use Bpost\BpostApiClient\Common\XmlHelper;
 use Bpost\BpostApiClient\Exception\BpostLogicException\BpostInvalidLengthException;
 use Bpost\BpostApiClient\Exception\BpostLogicException\BpostInvalidValueException;
@@ -236,7 +237,7 @@ public static function createFromXML(SimpleXMLElement $xml)
     {
         $messaging = new Messaging($xml->getName(), (string) $xml->attributes()->language);
 
-        $children = $xml->children('http://schema.post.be/shm/deepintegration/v3/common');
+        $children = $xml->children(Bpost::NS_V3_COMMON);
         if ((string) $children->emailAddress !== '') {
             $messaging->setEmailAddress((string) $children->emailAddress);
         }

diff --git a/tests/Bpost/Order/Box/AtHomeTest.php b/tests/Bpost/Order/Box/AtHomeTest.php
@@ -2,6 +2,7 @@
 
 namespace Tests\Bpost\Order\Box;
 
+use Bpost\BpostApiClient\Bpost;
 use Bpost\BpostApiClient\Bpost\Order\Address;
 use Bpost\BpostApiClient\Bpost\Order\Box\AtHome;
 use Bpost\BpostApiClient\Bpost\Order\Receiver;
@@ -36,30 +37,12 @@ private function createDomDocument()
      */
     private function generateDomDocument(DOMDocument $document, DOMElement $element)
     {
-        $element->setAttribute(
-            'xmlns:common',
-            'http://schema.post.be/shm/deepintegration/v5/common'
-        );
-        $element->setAttribute(
-            'xmlns:tns',
-            'http://schema.post.be/shm/deepintegration/v5/'
-        );
-        $element->setAttribute(
-            'xmlns',
-            'http://schema.post.be/shm/deepintegration/v5/national'
-        );
-        $element->setAttribute(
-            'xmlns:international',
-            'http://schema.post.be/shm/deepintegration/v5/international'
-        );
-        $element->setAttribute(
-            'xmlns:xsi',
-            'http://www.w3.org/2001/XMLSchema-instance'
-        );
-        $element->setAttribute(
-            'xsi:schemaLocation',
-            'http://schema.post.be/shm/deepintegration/v5/'
-        );
+        $element->setAttribute('xmlns:common', Bpost::NS_V5_COMMON);
+        $element->setAttribute('xmlns:tns', Bpost::NS_V5_GLOBAL);
+        $element->setAttribute('xmlns', Bpost::NS_V5_NATIONAL);
+        $element->setAttribute('xmlns:international', Bpost::NS_V5_INTERNATIONAL);
+        $element->setAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
+        $element->setAttribute('xsi:schemaLocation', Bpost::NS_V5_GLOBAL);
 
         $document->appendChild($element);