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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Model\Order;
use Magento\Framework\Api\SearchCriteria\CollectionProcessorInterface;
use Magento\Sales\Model\ResourceModel\Metadata;
use Magento\Sales\Api\Data\ShipmentSearchResultInterfaceFactory as SearchResultFactory;
use Magento\Framework\Exception\CouldNotDeleteException;
use Magento\Framework\Exception\CouldNotSaveException;
use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Framework\Exception\InputException;
/**
* Repository class for @see \Magento\Sales\Api\Data\ShipmentInterface
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class ShipmentRepository implements \Magento\Sales\Api\ShipmentRepositoryInterface
{
/**
* @var Metadata
*/
protected $metadata;
/**
* @var SearchResultFactory
*/
protected $searchResultFactory = null;
/**
* @var \Magento\Sales\Api\Data\ShipmentInterface[]
*/
protected $registry = [];
/**
* @var \Magento\Framework\Api\SearchCriteria\CollectionProcessorInterface
*/
private $collectionProcessor;
/**
* @param Metadata $metadata
* @param SearchResultFactory $searchResultFactory
* @param CollectionProcessorInterface $collectionProcessor
*/
public function __construct(
Metadata $metadata,
SearchResultFactory $searchResultFactory,
CollectionProcessorInterface $collectionProcessor = null
) {
$this->metadata = $metadata;
$this->searchResultFactory = $searchResultFactory;
$this->collectionProcessor = $collectionProcessor ?: $this->getCollectionProcessor();
}
/**
* Loads a specified shipment.
*
* @param int $id
* @return \Magento\Sales\Api\Data\ShipmentInterface
* @throws \Magento\Framework\Exception\InputException
* @throws \Magento\Framework\Exception\NoSuchEntityException
*/
public function get($id)
{
if (!$id) {
throw new InputException(__('An ID is needed. Set the ID and try again.'));
}
if (!isset($this->registry[$id])) {
/** @var \Magento\Sales\Api\Data\ShipmentInterface $entity */
$entity = $this->metadata->getNewInstance()->load($id);
if (!$entity->getEntityId()) {
throw new NoSuchEntityException(
__("The entity that was requested doesn't exist. Verify the entity and try again.")
);
}
$this->registry[$id] = $entity;
}
return $this->registry[$id];
}
/**
* Find shipments by criteria.
*
* @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
* @return \Magento\Sales\Api\Data\ShipmentInterface[]
*/
public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria)
{
/** @var \Magento\Sales\Model\ResourceModel\Order\Shipment\Collection $searchResult */
$searchResult = $this->searchResultFactory->create();
$this->collectionProcessor->process($searchCriteria, $searchResult);
$searchResult->setSearchCriteria($searchCriteria);
return $searchResult;
}
/**
* Deletes a specified shipment.
*
* @param \Magento\Sales\Api\Data\ShipmentInterface $entity
* @return bool
* @throws CouldNotDeleteException
*/
public function delete(\Magento\Sales\Api\Data\ShipmentInterface $entity)
{
try {
$this->metadata->getMapper()->delete($entity);
unset($this->registry[$entity->getEntityId()]);
} catch (\Exception $e) {
throw new CouldNotDeleteException(__("The shipment couldn't be deleted."), $e);
}
return true;
}
/**
* Deletes shipment by Id.
*
* @param int $id
* @return bool
*/
public function deleteById($id)
{
$entity = $this->get($id);
return $this->delete($entity);
}
/**
* Performs persist operations for a specified shipment.
*
* @param \Magento\Sales\Api\Data\ShipmentInterface $entity
* @return \Magento\Sales\Api\Data\ShipmentInterface
* @throws CouldNotSaveException
*/
public function save(\Magento\Sales\Api\Data\ShipmentInterface $entity)
{
try {
$this->metadata->getMapper()->save($entity);
$this->registry[$entity->getEntityId()] = $entity;
} catch (\Exception $e) {
throw new CouldNotSaveException(__("The shipment couldn't be saved."), $e);
}
return $this->registry[$entity->getEntityId()];
}
/**
* Creates new shipment instance.
*
* @return \Magento\Sales\Api\Data\ShipmentInterface
*/
public function create()
{
return $this->metadata->getNewInstance();
}
/**
* Retrieve collection processor
*
* @deprecated 101.0.0
* @return CollectionProcessorInterface
*/
private function getCollectionProcessor()
{
if (!$this->collectionProcessor) {
$this->collectionProcessor = \Magento\Framework\App\ObjectManager::getInstance()->get(
\Magento\Framework\Api\SearchCriteria\CollectionProcessorInterface::class
);
}
return $this->collectionProcessor;
}
}