-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
ShipmentDocumentFactory.php
121 lines (113 loc) · 3.53 KB
/
ShipmentDocumentFactory.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<?php
/**
* Copyright © 2013-2017 Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Model\Order;
use Magento\Sales\Api\Data\ShipmentInterface;
use Magento\Sales\Api\Data\ShipmentItemCreationInterface;
use Magento\Sales\Api\Data\ShipmentPackageCreationInterface;
use Magento\Sales\Api\Data\ShipmentTrackCreationInterface;
use Magento\Sales\Api\Data\ShipmentTrackInterface;
use Magento\Sales\Model\Order\Shipment\TrackFactory;
use Magento\Sales\Api\Data\OrderInterface;
use Magento\Sales\Api\Data\ShipmentCommentCreationInterface;
use Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface;
/**
* Class ShipmentDocumentFactory
*
* @api
*/
class ShipmentDocumentFactory
{
/**
* @var ShipmentFactory
*/
private $shipmentFactory;
/**
* @var TrackFactory
*/
private $trackFactory;
/**
* ShipmentDocumentFactory constructor.
*
* @param ShipmentFactory $shipmentFactory
* @param TrackFactory $trackFactory
*/
public function __construct(
ShipmentFactory $shipmentFactory,
TrackFactory $trackFactory
) {
$this->shipmentFactory = $shipmentFactory;
$this->trackFactory = $trackFactory;
}
/**
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*
* @param OrderInterface $order
* @param ShipmentItemCreationInterface[] $items
* @param ShipmentTrackCreationInterface[] $tracks
* @param ShipmentCommentCreationInterface|null $comment
* @param bool $appendComment
* @param ShipmentPackageCreationInterface[] $packages
* @param ShipmentCreationArgumentsInterface|null $arguments
* @return ShipmentInterface
*/
public function create(
OrderInterface $order,
array $items = [],
array $tracks = [],
ShipmentCommentCreationInterface $comment = null,
$appendComment = false,
array $packages = [],
ShipmentCreationArgumentsInterface $arguments = null
) {
$shipmentItems = $this->itemsToArray($items);
/** @var Shipment $shipment */
$shipment = $this->shipmentFactory->create(
$order,
$shipmentItems
);
$this->prepareTracks($shipment, $tracks);
if ($comment) {
$shipment->addComment(
$comment->getComment(),
$appendComment,
$comment->getIsVisibleOnFront()
);
}
return $shipment;
}
/**
* Adds tracks to the shipment.
*
* @param ShipmentInterface $shipment
* @param ShipmentTrackCreationInterface[] $tracks
* @return ShipmentInterface
*/
private function prepareTracks(\Magento\Sales\Api\Data\ShipmentInterface $shipment, array $tracks)
{
foreach ($tracks as $track) {
$data = [];
$data[ShipmentTrackInterface::CARRIER_CODE] = $track->getCarrierCode();
$data[ShipmentTrackInterface::TITLE] = $track->getTitle();
$data[ShipmentTrackInterface::TRACK_NUMBER] = $track->getTrackNumber();
$shipment->addTrack($this->trackFactory->create(['data' => $data]));
}
return $shipment;
}
/**
* Convert items to array
*
* @param ShipmentItemCreationInterface[] $items
* @return array
*/
private function itemsToArray(array $items = [])
{
$shipmentItems = [];
foreach ($items as $item) {
$shipmentItems[$item->getOrderItemId()] = $item->getQty();
}
return $shipmentItems;
}
}