Merge pull request #41 from oneflow/feat/carrier-fields

feat: carrier fields to shipment

Author: KirylMalenchyk

samples/single-item.php

@@ -27,6 +27,10 @@
 $shipment = $orderData->newShipment();
 $shipment->setShipTo("NAME","COMPANY-NAME", "ADDRESS1","ADDRESS2","ADDRESS3","TOWN/CITY","STATE","POSTCODE/ZIP","ISO-COUNTRY-CODE","COUNTRY-NAME", "PHONE", "EMAIL");
 $shipment->setCarrier("CARRIER-CODE","CARRIER-SERVICE");
+$shipment->setCarrierFields([
+	'carrierField1' => 'carrierValue1',
+	'carrierField2' => 'carrierValue2'
+]);
 
 //CREATE AN ITEM
 $item = $orderData->newSKUItem("YOUR-SKU-CODE", "YOUR-ITEM-ID", QUANTITY);

src/order/orderData/shipment/shipment.php

@@ -32,6 +32,7 @@ public function init()      {
 		$this->__addProperty("dispatchAlert");
 		$this->__addProperty("canShipEarly");
 		$this->__addProperty("shipByDate");
+		$this->__addArray("carrierFields", null);
 	}
 
 	/**
@@ -215,6 +216,17 @@ public function setShipByDate($shipByDate)
 	{
 		$this->shipByDate = $shipByDate;
 	}
+
+	/**
+	 * setCarrierFields function.
+	 *
+	 * @access public
+	 * @param mixed $carrierFields
+	 * @return void
+	 */
+	public function setCarrierFields($carrierFields)	{
+		$this->carrierFields = $carrierFields;
+	}
 }
 
 ?>

tests/order/orderTest.php

@@ -100,6 +100,10 @@ public function testCanBuildASingleItemOrder()
 		$shipment->setSlaDays(5);
 		$shipment->setCanShipEarly(false);
 		$shipment->setShipByDate('2019-04-01');
+		$shipment->setCarrierFields([
+			'carrierField1' => 'carrierValue1',
+			'carrierField2' => 'carrierValue2'
+		]);
 
 
 		$item->setShipment($shipment);
@@ -236,5 +240,9 @@ public function testCanBuildASingleItemOrder()
 		$this->assertEquals('application/pdf', $outputAttachment->contentType);
 		$this->assertEquals(false, $outputAttachment->fetch);
 
+		$this->assertObjectHasAttribute('carrierFields', $outputShipment);
+		$this->assertEquals('carrierValue1', $outputShipment->carrierFields->carrierField1);
+		$this->assertEquals('carrierValue2', $outputShipment->carrierFields->carrierField2);
+
 	}
 }