PluginProbe
Packeta / 2.1
Packeta v2.1
2.3.2 2.3.1 trunk 1.2.2 1.2.3 1.2.4 1.2.5 1.2.6 1.3.0 1.3.1 1.3.2 1.4 1.4.1 1.4.2 1.4.3 1.5.0 1.5.1 1.5.2 1.5.3 1.5.4 1.6.0 1.6.1 1.6.2 1.6.3 1.6.4 All 56 releases
← All changes | src/Packetery/Module/Order/Repository.php +500 -228 1.3.12.1 View file →
@@ -8,14 +8,22 @@
8 8 declare( strict_types=1 );
9 9
10 10 namespace Packetery\Module\Order;
11 11
12 +use DateTimeImmutable;
13 +use Exception;
14 +use Packetery\Core\CoreHelper;
15 +use Packetery\Core\Entity;
12 16 use Packetery\Core\Entity\Order;
13 17 use Packetery\Core\Entity\PickupPoint;
14 -use Packetery\Core\Entity\Size;
15 -use Packetery\Core\Entity\Address;
16 18 use Packetery\Module\Carrier;
17 -use Packetery\Module\ShippingMethod;
19 +use Packetery\Module\Carrier\PacketaPickupPointsConfig;
20 +use Packetery\Module\CustomsDeclaration;
21 +use Packetery\Module\Exception\InvalidCarrierException;
22 +use Packetery\Module\ModuleHelper;
23 +use Packetery\Module\Shipping\ShippingProvider;
24 +use Packetery\Module\WpdbAdapter;
25 +use WC_Order;
18 26 use WP_Post;
19 27
20 28 /**
21 29 * Class Repository.
@@ -24,13 +32,13 @@
24 32 */
25 33 class Repository {
26 34
27 35 /**
28 - * Wpdb.
36 + * WpdbAdapter.
29 37 *
30 - * @var \wpdb
38 + * @var WpdbAdapter
31 39 */
32 - private $wpdb;
40 + private $wpdbAdapter;
33 41
34 42 /**
35 43 * Order factory.
36 44 *
@@ -38,57 +46,140 @@
38 46 */
39 47 private $builder;
40 48
41 49 /**
50 + * CoreHelper.
51 + *
52 + * @var CoreHelper
53 + */
54 + private $coreHelper;
55 +
56 + /**
57 + * Internal pickup points config.
58 + *
59 + * @var PacketaPickupPointsConfig
60 + */
61 + private $pickupPointsConfig;
62 +
63 + /**
64 + * Carrier repository.
65 + *
66 + * @var Carrier\EntityRepository
67 + */
68 + private $carrierRepository;
69 +
70 + /**
71 + * Customs declaration repository.
72 + *
73 + * @var CustomsDeclaration\Repository
74 + */
75 + private $customsDeclarationRepository;
76 +
77 + /**
42 78 * Repository constructor.
43 79 *
44 - * @param \wpdb $wpdb Wpdb.
45 - * @param Builder $orderFactory Order factory.
80 + * @param WpdbAdapter $wpdbAdapter WpdbAdapter.
81 + * @param Builder $orderFactory Order factory.
82 + * @param CoreHelper $coreHelper CoreHelper.
83 + * @param PacketaPickupPointsConfig $pickupPointsConfig Internal pickup points config.
84 + * @param Carrier\EntityRepository $carrierRepository Carrier repository.
85 + * @param CustomsDeclaration\Repository $customsDeclarationRepository Customs declaration repository.
46 86 */
47 - public function __construct( \wpdb $wpdb, Builder $orderFactory ) {
48 - $this->wpdb = $wpdb;
49 - $this->builder = $orderFactory;
87 + public function __construct(
88 + WpdbAdapter $wpdbAdapter,
89 + Builder $orderFactory,
90 + CoreHelper $coreHelper,
91 + PacketaPickupPointsConfig $pickupPointsConfig,
92 + Carrier\EntityRepository $carrierRepository,
93 + CustomsDeclaration\Repository $customsDeclarationRepository
94 + ) {
95 + $this->wpdbAdapter = $wpdbAdapter;
96 + $this->builder = $orderFactory;
97 + $this->coreHelper = $coreHelper;
98 + $this->pickupPointsConfig = $pickupPointsConfig;
99 + $this->carrierRepository = $carrierRepository;
100 + $this->customsDeclarationRepository = $customsDeclarationRepository;
50 101 }
51 102
52 103 /**
53 - * Extends WP_Query to include custom table.
104 + * Applies custom order status filter.
54 105 *
55 - * @link https://wordpress.stackexchange.com/questions/50305/how-to-extend-wp-query-to-include-custom-table-in-query
106 + * @param array<string, string|null> $clauses Query clauses.
107 + * @param \WP_Query|null $queryObject WP Query.
108 + * @param array<string, string|null> $paramValues Param values.
56 109 *
57 - * @param array $clauses Clauses.
58 - * @param \WP_Query $queryObject WP_Query.
59 - * @param array $paramValues Param values.
110 + * @return void
111 + */
112 + private function applyCustomFilters( array &$clauses, ?\WP_Query $queryObject, array $paramValues ): void {
113 + /**
114 + * Filters order statuses to exclude in Packeta order list filtering.
115 + *
116 + * @since 1.4
117 + *
118 + * @param array $orderStatusesToExclude Order statuses to exclude.
119 + * @param \WP_Query|null $queryObject WP Query.
120 + * @param array $paramValues Param values.
121 + */
122 + $orderStatusesToExclude = (array) apply_filters( 'packetery_exclude_orders_with_status', [], $queryObject, $paramValues );
123 + if ( count( $orderStatusesToExclude ) === 0 ) {
124 + return;
125 + }
126 +
127 + if ( ModuleHelper::isHposEnabled() ) {
128 + $clauses['where'] .= sprintf( ' AND `%s`.`status` NOT IN (%s)', $this->wpdbAdapter->wcOrders, $this->wpdbAdapter->prepareInClause( $orderStatusesToExclude ) );
129 + } else {
130 + $clauses['where'] .= sprintf( ' AND `%s`.`post_status` NOT IN (%s)', $this->wpdbAdapter->posts, $this->wpdbAdapter->prepareInClause( $orderStatusesToExclude ) );
131 + }
132 + }
133 +
134 + /**
135 + * Extends SQL query clauses.
60 136 *
61 - * @return array
137 + * @param array<string, string> $clauses Clauses.
138 + * @param \WP_Query|null $queryObject Query object.
139 + * @param array<string, string|null> $paramValues Param values.
140 + *
141 + * @return array<string, string>
62 142 */
63 - public function processPostClauses( array $clauses, \WP_Query $queryObject, array $paramValues ): array {
64 - if ( isset( $queryObject->query['post_type'] ) &&
65 - (
66 - 'shop_order' === $queryObject->query['post_type'] ||
67 - ( is_array( $queryObject->query['post_type'] ) && in_array( 'shop_order', $queryObject->query['post_type'], true ) )
68 - )
69 - ) {
70 - // TODO: Introduce variable.
71 - $clauses['join'] .= ' LEFT JOIN `' . $this->wpdb->packetery_order . '` ON `' . $this->wpdb->packetery_order . '`.`id` = `' . $this->wpdb->posts . '`.`id`';
143 + public function processClauses( array $clauses, ?\WP_Query $queryObject, array $paramValues ): array {
144 + if ( ModuleHelper::isHposEnabled() ) {
145 + $clauses['join'] .= ' LEFT JOIN `' . $this->wpdbAdapter->packeteryOrder . '` ON `' . $this->wpdbAdapter->packeteryOrder . '`.`id` = `' . $this->wpdbAdapter->wcOrders . '`.`id`';
146 + } else {
147 + $clauses['join'] .= ' LEFT JOIN `' . $this->wpdbAdapter->packeteryOrder . '` ON `' . $this->wpdbAdapter->packeteryOrder . '`.`id` = `' . $this->wpdbAdapter->posts . '`.`id`';
148 + }
72 149
73 - if ( $paramValues['packetery_carrier_id'] ) {
74 - $clauses['where'] .= ' AND `' . $this->wpdb->packetery_order . '`.`carrier_id` = "' . $this->wpdb->_real_escape( $paramValues['packetery_carrier_id'] ) . '"';
150 + if ( isset( $paramValues['packetery_carrier_id'] ) && $paramValues['packetery_carrier_id'] !== '' ) {
151 + $clauses['where'] .= ' AND `' . $this->wpdbAdapter->packeteryOrder . '`.`carrier_id` = "' . esc_sql( $paramValues['packetery_carrier_id'] ) . '"';
152 + $this->applyCustomFilters( $clauses, $queryObject, $paramValues );
153 + }
154 + if ( isset( $paramValues['packetery_to_submit'] ) && $paramValues['packetery_to_submit'] !== '' ) {
155 + $clauses['where'] .= ' AND `' . $this->wpdbAdapter->packeteryOrder . '`.`carrier_id` IS NOT NULL ';
156 + $clauses['where'] .= ' AND `' . $this->wpdbAdapter->packeteryOrder . '`.`is_exported` = false ';
157 + $this->applyCustomFilters( $clauses, $queryObject, $paramValues );
158 + }
159 + if ( isset( $paramValues['packetery_to_print'] ) && $paramValues['packetery_to_print'] !== '' ) {
160 + $clauses['where'] .= ' AND `' . $this->wpdbAdapter->packeteryOrder . '`.`packet_id` IS NOT NULL ';
161 + $clauses['where'] .= ' AND `' . $this->wpdbAdapter->packeteryOrder . '`.`is_label_printed` = false ';
162 + $this->applyCustomFilters( $clauses, $queryObject, $paramValues );
163 + }
164 + if ( isset( $paramValues['packetery_order_type'] ) && $paramValues['packetery_order_type'] !== '' ) {
165 + if ( $paramValues['packetery_order_type'] === Entity\Carrier::INTERNAL_PICKUP_POINTS_ID ) {
166 + $comparison = 'IN';
167 + } else {
168 + $comparison = 'NOT IN';
75 169 }
76 - if ( $paramValues['packetery_to_submit'] ) {
77 - $clauses['where'] .= ' AND `' . $this->wpdb->packetery_order . '`.`carrier_id` IS NOT NULL ';
78 - $clauses['where'] .= ' AND `' . $this->wpdb->packetery_order . '`.`is_exported` = false ';
170 + $internalCarriers = array_keys( $this->carrierRepository->getNonFeedCarriers() );
171 + $internalCarriers[] = Entity\Carrier::INTERNAL_PICKUP_POINTS_ID;
172 + $clauses['where'] .= ' AND `' . $this->wpdbAdapter->packeteryOrder . '`.`carrier_id` ' . $comparison . ' (' . $this->wpdbAdapter->prepareInClause( $internalCarriers ) . ')';
173 + $this->applyCustomFilters( $clauses, $queryObject, $paramValues );
174 + }
175 + if ( isset( $paramValues['orderby'] ) && $paramValues['orderby'] === 'packetery_packet_stored_until' ) {
176 + if ( $paramValues['order'] === 'asc' ) {
177 + $clauses['orderby'] = '`' . $this->wpdbAdapter->packeteryOrder . '`.`stored_until` ASC';
79 178 }
80 - if ( $paramValues['packetery_to_print'] ) {
81 - $clauses['where'] .= ' AND `' . $this->wpdb->packetery_order . '`.`packet_id` IS NOT NULL ';
82 - $clauses['where'] .= ' AND `' . $this->wpdb->packetery_order . '`.`is_label_printed` = false ';
179 + if ( $paramValues['order'] === 'desc' ) {
180 + $clauses['orderby'] = '`' . $this->wpdbAdapter->packeteryOrder . '`.`stored_until` DESC';
83 181 }
84 - if ( $paramValues['packetery_order_type'] ) {
85 - if ( Carrier\Repository::INTERNAL_PICKUP_POINTS_ID === $paramValues['packetery_order_type'] ) {
86 - $clauses['where'] .= ' AND `' . $this->wpdb->packetery_order . '`.`carrier_id` = "' . $this->wpdb->_real_escape( Carrier\Repository::INTERNAL_PICKUP_POINTS_ID ) . '"';
87 - } else {
88 - $clauses['where'] .= ' AND `' . $this->wpdb->packetery_order . '`.`carrier_id` != "' . $this->wpdb->_real_escape( Carrier\Repository::INTERNAL_PICKUP_POINTS_ID ) . '"';
89 - }
90 - }
91 182 }
92 183
93 184 return $clauses;
94 185 }
@@ -97,163 +188,152 @@
97 188 * Create table to store orders.
98 189 *
99 190 * @return bool
100 191 */
101 - public function createTable(): bool {
102 - $wpdb = $this->wpdb;
192 + public function createOrAlterTable(): bool {
193 + $createTableQuery = 'CREATE TABLE ' . $this->wpdbAdapter->packeteryOrder . ' (
194 + `id` bigint(20) unsigned NOT NULL,
195 + `carrier_id` varchar(15) NOT NULL,
196 + `is_exported` tinyint(1) NOT NULL,
197 + `packet_id` varchar(15) NULL,
198 + `packet_claim_id` varchar(15) NULL,
199 + `packet_claim_password` varchar(10) NULL,
200 + `is_label_printed` tinyint(1) NOT NULL,
201 + `point_id` varchar(50) NULL,
202 + `point_name` varchar(150) NULL,
203 + `point_url` varchar(255) NULL,
204 + `point_street` varchar(120) NULL,
205 + `point_zip` varchar(10) NULL,
206 + `point_city` varchar(70) NULL,
207 + `address_validated` tinyint(1) NOT NULL,
208 + `delivery_address` text NULL,
209 + `weight` float NULL,
210 + `length` float NULL,
211 + `width` float NULL,
212 + `height` float NULL,
213 + `adult_content` tinyint(1) NULL,
214 + `value` double NULL,
215 + `cod` double NULL,
216 + `api_error_message` text NULL,
217 + `api_error_date` datetime NULL,
218 + `carrier_number` varchar(50) NULL,
219 + `packet_status` varchar(30) NULL,
220 + `stored_until` date NULL,
221 + `deliver_on` date NULL,
222 + `car_delivery_id` varchar(15) NULL,
223 + PRIMARY KEY (`id`)
224 + ) ' . $this->wpdbAdapter->get_charset_collate();
103 225
104 - return $wpdb->query(
105 - 'CREATE TABLE IF NOT EXISTS `' . $wpdb->packetery_order . '` (
106 - `id` bigint(20) unsigned NOT NULL,
107 - `carrier_id` varchar(255) NOT NULL,
108 - `is_exported` boolean NOT NULL,
109 - `packet_id` varchar(255) NULL,
110 - `is_label_printed` boolean NOT NULL,
111 - `point_id` varchar(255) NULL,
112 - `point_name` varchar(255) NULL,
113 - `point_url` varchar(255) NULL,
114 - `point_street` varchar(255) NULL,
115 - `point_zip` varchar(255) NULL,
116 - `point_city` varchar(255) NULL,
117 - `address_validated` boolean NOT NULL,
118 - `delivery_address` TEXT NULL,
119 - `weight` float NULL,
120 - `length` float NULL,
121 - `width` float NULL,
122 - `height` float NULL,
123 - `carrier_number` varchar(255) NULL,
124 - `packet_status` varchar(255) NULL,
125 - PRIMARY KEY (`id`)
126 - ) ' . $wpdb->get_charset_collate()
127 - );
226 + return $this->wpdbAdapter->dbDelta( $createTableQuery, $this->wpdbAdapter->packeteryOrder );
128 227 }
129 228
130 229 /**
131 - * Drop table used to store orders.
230 + * @throws InvalidCarrierException InvalidCarrierException.
132 231 */
133 - public function drop(): void {
134 - $wpdb = $this->wpdb;
135 - $wpdb->query( 'DROP TABLE IF EXISTS `' . $wpdb->packetery_order . '`' );
232 + public function getById( int $id ): ?Order {
233 + $wcOrder = $this->getWcOrderById( $id );
234 + if ( $wcOrder === null ) {
235 + return null;
236 + }
237 +
238 + return $this->getByWcOrder( $wcOrder );
136 239 }
137 240
138 241 /**
139 - * Gets order data.
140 - *
141 - * @param int $id Order id.
142 - *
143 - * @return Order|null
242 + * Ignores InvalidCarrierException.
144 243 */
145 - public function getById( int $id ): ?Order {
146 - $wcOrder = wc_get_order( $id );
147 - if ( ! $wcOrder instanceof \WC_Order ) {
244 + public function getByIdWithValidCarrier( int $id ): ?Order {
245 + $wcOrder = $this->getWcOrderById( $id );
246 + if ( $wcOrder === null ) {
148 247 return null;
149 248 }
150 249
151 - return $this->getByWcOrder( $wcOrder );
250 + return $this->getByWcOrderWithValidCarrier( $wcOrder );
152 251 }
153 252
154 253 /**
155 - * Gets order by wc order.
254 + * Returns Packeta order, or null.
156 255 *
157 - * @param \WC_Order $wcOrder WC Order.
256 + * @param int $id Order ID.
158 257 *
159 258 * @return Order|null
160 259 */
161 - public function getByWcOrder( \WC_Order $wcOrder ): ?Order {
162 - if ( ! $wcOrder->has_shipping_method( ShippingMethod::PACKETERY_METHOD_ID ) ) {
260 + public function findById( int $id ): ?Order {
261 + $wcOrder = $this->getWcOrderById( $id );
262 + if ( $wcOrder === null ) {
163 263 return null;
164 264 }
165 265
166 - $wpdb = $this->wpdb;
266 + $result = $this->getDataById( $wcOrder->get_id() );
267 + if ( $result === null ) {
268 + return null;
269 + }
167 270
168 - $result = $wpdb->get_row(
169 - $wpdb->prepare(
170 - '
171 - SELECT o.* FROM `' . $wpdb->packetery_order . '` o
172 - JOIN `' . $wpdb->posts . '` as wp_p ON wp_p.ID = o.id
173 - WHERE o.`id` = %d',
174 - $wcOrder->get_id()
175 - )
176 - );
177 -
178 - if ( ! $result ) {
271 + try {
272 + return $this->builder->build( $wcOrder, $result );
273 + } catch ( InvalidCarrierException $invalidCarrierException ) {
179 274 return null;
180 275 }
181 -
182 - $partialOrder = $this->createPartialOrder( $result );
183 - return $this->builder->finalize( $wcOrder, $partialOrder );
184 276 }
185 277
186 278 /**
187 - * Creates partial order.
279 + * Gets Packeta order data by id.
188 280 *
189 - * @param \stdClass $result DB result.
281 + * @param int $id Order id.
190 282 *
191 - * @return Order
283 + * @return object|null
192 284 */
193 - private function createPartialOrder( \stdClass $result ): Order {
194 - $partialOrder = new Order(
195 - $result->id,
196 - $result->carrier_id
285 + public function getDataById( int $id ): ?object {
286 + return $this->wpdbAdapter->get_row(
287 + $this->wpdbAdapter->prepare(
288 + '
289 + SELECT `o`.* FROM `' . $this->wpdbAdapter->packeteryOrder . '` `o`
290 + ' . $this->getWcOrderJoinClause() . '
291 + WHERE `o`.`id` = %d',
292 + $id
293 + )
197 294 );
295 + }
198 296
199 - $orderWeight = $this->parseFloat( $result->weight );
200 - if ( null !== $orderWeight ) {
201 - $partialOrder->setWeight( $orderWeight );
297 + private function getDataByWcOrder( WC_Order $wcOrder ): ?object {
298 + if ( ! ShippingProvider::wcOrderHasOurMethod( $wcOrder ) ) {
299 + return null;
202 300 }
203 - $partialOrder->setPacketId( $result->packet_id );
204 - $partialOrder->setSize( new Size( $this->parseFloat( $result->length ), $this->parseFloat( $result->width ), $this->parseFloat( $result->height ) ) );
205 - $partialOrder->setIsExported( (bool) $result->is_exported );
206 - $partialOrder->setIsLabelPrinted( (bool) $result->is_label_printed );
207 - $partialOrder->setCarrierNumber( $result->carrier_number );
208 - $partialOrder->setPacketStatus( $result->packet_status );
209 - $partialOrder->setAddressValidated( (bool) $result->address_validated );
210 301
211 - if ( $result->delivery_address ) {
212 - $deliveryAddressDecoded = json_decode( $result->delivery_address, false );
213 - $deliveryAddress = new Address(
214 - $deliveryAddressDecoded->street,
215 - $deliveryAddressDecoded->city,
216 - $deliveryAddressDecoded->zip
217 - );
218 -
219 - $deliveryAddress->setHouseNumber( $deliveryAddressDecoded->houseNumber );
220 - $deliveryAddress->setLongitude( $deliveryAddressDecoded->longitude );
221 - $deliveryAddress->setLatitude( $deliveryAddressDecoded->latitude );
222 - $deliveryAddress->setCounty( $deliveryAddressDecoded->county );
223 -
224 - $partialOrder->setDeliveryAddress( $deliveryAddress );
302 + $packeteryOrderData = $this->getDataById( $wcOrder->get_id() );
303 + if ( ! is_object( $packeteryOrderData ) ) {
304 + return null;
225 305 }
226 306
227 - if ( null !== $result->point_id ) {
228 - $pickUpPoint = new PickupPoint(
229 - $result->point_id,
230 - $result->point_name,
231 - $result->point_city,
232 - $result->point_zip,
233 - $result->point_street,
234 - $result->point_url
235 - );
307 + return $packeteryOrderData;
308 + }
236 309
237 - $partialOrder->setPickupPoint( $pickUpPoint );
310 + /**
311 + * @throws InvalidCarrierException
312 + */
313 + public function getByWcOrder( WC_Order $wcOrder ): ?Order {
314 + $packeteryOrderData = $this->getDataByWcOrder( $wcOrder );
315 + if ( $packeteryOrderData === null ) {
316 + return null;
238 317 }
239 318
240 - return $partialOrder;
319 + return $this->builder->build( $wcOrder, $packeteryOrderData );
241 320 }
242 321
243 322 /**
244 - * Parses string value as float.
245 - *
246 - * @param string|float|null $value Value.
247 - *
248 - * @return float|null
323 + * Ignores InvalidCarrierException.
249 324 */
250 - private function parseFloat( $value ): ?float {
251 - if ( null === $value || '' === $value ) {
325 + public function getByWcOrderWithValidCarrier( WC_Order $wcOrder ): ?Order {
326 + $packeteryOrderData = $this->getDataByWcOrder( $wcOrder );
327 + if ( $packeteryOrderData === null ) {
252 328 return null;
253 329 }
254 330
255 - return (float) $value;
331 + try {
332 + return $this->builder->build( $wcOrder, $packeteryOrderData );
333 + } catch ( InvalidCarrierException $invalidCarrierException ) {
334 + return null;
335 + }
256 336 }
257 337
258 338 /**
259 339 * Transforms order to DB array.
@@ -259,41 +339,56 @@
259 339 * Transforms order to DB array.
260 340 *
261 341 * @param Order $order Order.
262 342 *
263 - * @return array
343 + * @return array<string, bool|float|int|string|null>
264 344 */
265 345 private function orderToDbArray( Order $order ): array {
266 346 $point = $order->getPickupPoint();
267 - if ( null === $point ) {
347 + if ( $point === null ) {
268 348 $point = new PickupPoint();
269 349 }
270 350
271 351 $deliveryAddress = null;
272 - if ( $order->isAddressValidated() && $order->getDeliveryAddress() ) {
352 + if ( $order->isAddressValidated() && $order->getDeliveryAddress() !== null ) {
273 353 $deliveryAddress = wp_json_encode( $order->getDeliveryAddress()->export() );
274 354 }
275 355
356 + $apiErrorDateTime = $order->getLastApiErrorDateTime();
357 + if ( $apiErrorDateTime !== null ) {
358 + $apiErrorDateTime = $apiErrorDateTime->format( CoreHelper::MYSQL_DATETIME_FORMAT );
359 + }
360 +
276 361 $data = [
277 - 'id' => (int) $order->getNumber(),
278 - 'carrier_id' => $order->getCarrierId(),
279 - 'is_exported' => (int) $order->isExported(),
280 - 'packet_id' => $order->getPacketId(),
281 - 'packet_status' => $order->getPacketStatus(),
282 - 'is_label_printed' => (int) $order->isLabelPrinted(),
283 - 'carrier_number' => $order->getCarrierNumber(),
284 - 'weight' => $order->getWeight(),
285 - 'point_id' => $point->getId(),
286 - 'point_name' => $point->getName(),
287 - 'point_url' => $point->getUrl(),
288 - 'point_street' => $point->getStreet(),
289 - 'point_zip' => $point->getZip(),
290 - 'point_city' => $point->getCity(),
291 - 'address_validated' => (int) $order->isAddressValidated(),
292 - 'delivery_address' => $deliveryAddress,
293 - 'length' => $order->getLength(),
294 - 'width' => $order->getWidth(),
295 - 'height' => $order->getHeight(),
362 + 'id' => (int) $order->getNumber(),
363 + 'carrier_id' => $order->getCarrier()->getId(),
364 + 'is_exported' => (int) $order->isExported(),
365 + 'packet_id' => $order->getPacketId(),
366 + 'packet_claim_id' => $order->getPacketClaimId(),
367 + 'packet_claim_password' => $order->getPacketClaimPassword(),
368 + 'packet_status' => $order->getPacketStatus(),
369 + 'stored_until' => $this->coreHelper->getStringFromDateTime( $order->getStoredUntil(), CoreHelper::DATEPICKER_FORMAT ),
370 + 'is_label_printed' => (int) $order->isLabelPrinted(),
371 + 'carrier_number' => $order->getCarrierNumber(),
372 + 'weight' => $order->getWeight(),
373 + 'car_delivery_id' => $order->getCarDeliveryId(),
374 + 'point_id' => $point->getId(),
375 + 'point_name' => $point->getName(),
376 + 'point_url' => $point->getUrl(),
377 + 'point_street' => $point->getStreet(),
378 + 'point_zip' => $point->getZip(),
379 + 'point_city' => $point->getCity(),
380 + 'address_validated' => (int) $order->isAddressValidated(),
381 + 'delivery_address' => $deliveryAddress,
382 + 'length' => $order->getLength(),
383 + 'width' => $order->getWidth(),
384 + 'height' => $order->getHeight(),
385 + 'adult_content' => $order->containsAdultContent(),
386 + 'cod' => $order->getManualCod(),
387 + 'value' => $order->getManualValue(),
388 + 'api_error_message' => $order->getLastApiErrorMessage(),
389 + 'api_error_date' => $apiErrorDateTime,
390 + 'deliver_on' => $this->coreHelper->getStringFromDateTime( $order->getDeliverOn(), CoreHelper::DATEPICKER_FORMAT ),
296 391 ];
297 392
298 393 return $data;
299 394 }
@@ -305,37 +400,101 @@
305 400 *
306 401 * @return void
307 402 */
308 403 public function save( Order $order ): void {
309 - $this->wpdb->_insert_replace_helper( $this->wpdb->packetery_order, $this->orderToDbArray( $order ), null, 'REPLACE' );
404 + $this->saveData( $this->orderToDbArray( $order ) );
310 405 }
311 406
312 407 /**
408 + * Saves order data.
409 + *
410 + * @param array<string, int|string|null|DateTimeImmutable> $orderData Order data.
411 + *
412 + * @return void
413 + */
414 + public function saveData( array $orderData ): void {
415 + $this->onBeforeDataInsertion( $orderData );
416 + $this->wpdbAdapter->insertReplaceHelper( $this->wpdbAdapter->packeteryOrder, $orderData, null, 'REPLACE' );
417 + }
418 +
419 + /**
420 + * Calls logic before order data replace/insert.
421 + *
422 + * @param array<string, string|null|DateTimeImmutable> $orderData Order data.
423 + * @return void
424 + */
425 + private function onBeforeDataInsertion( array $orderData ): void {
426 + $pointId = $orderData['point_id'] ?? null;
427 + $carrierId = $orderData['carrier_id'] ?? null;
428 + /**
429 + * Tells if Packeta debug logs are enabled.
430 + *
431 + * @since 1.7.2
432 + */
433 + $isLoggingActive = (bool) apply_filters( 'packeta_enable_debug_logs', false );
434 +
435 + if ( ( $pointId !== null && $pointId !== '' ) || ! $isLoggingActive || ! $this->pickupPointsConfig->isInternalPickupPointCarrier( $carrierId ) ) {
436 + return;
437 + }
438 +
439 + $wcLogger = wc_get_logger();
440 + $dataToLog = [
441 + 'order' => $orderData,
442 + 'trace' => array_map(
443 + static function ( array $item ): array {
444 + return [
445 + 'file' => sprintf( '%s(%s)', $item['file'], $item['line'] ),
446 + 'method' => sprintf( '%s%s%s(...)', $item['class'] ?? '', $item['type'] ?? '', $item['function'] ),
447 + ];
448 + },
449 + ( new Exception() )->getTrace()
450 + ),
451 + ];
452 + $wcLogger->warning(
453 + sprintf(
454 + 'Required value for the pickup point order is not set: %s',
455 + wp_json_encode( $dataToLog, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE )
456 + ),
457 + [ 'source' => 'packeta' ]
458 + );
459 + }
460 +
461 + /**
313 462 * Loads order entities by list of ids.
314 463 *
315 - * @param array $orderIds Order ids.
464 + * @param string[] $orderIds Order ids.
316 465 *
317 466 * @return Order[]
318 467 */
319 468 public function getByIds( array $orderIds ): array {
469 + if ( count( $orderIds ) === 0 ) {
470 + return [];
471 + }
472 +
473 + $wpdbAdapter = $this->wpdbAdapter;
474 + $ordersIdsPlaceholder = implode( ', ', array_fill( 0, count( $orderIds ), '%d' ) );
475 + $packeteryOrdersResult = $wpdbAdapter->get_results(
476 + $wpdbAdapter->prepare(
477 + 'SELECT * FROM `' . $wpdbAdapter->packeteryOrder . '`
478 + WHERE `id` IN (' . $ordersIdsPlaceholder . ')',
479 + $orderIds
480 + ),
481 + OBJECT_K
482 + );
483 +
320 484 $orderEntities = [];
321 - $posts = get_posts(
322 - [
323 - 'post_type' => 'shop_order',
324 - 'post__in' => $orderIds,
325 - 'post_status' => [ 'any', 'trash' ],
326 - 'nopaging' => true,
327 - ]
328 - );
329 - foreach ( $posts as $post ) {
330 - $wcOrder = wc_get_order( $post );
331 - // In case WC_Order does not exist, result set is limited to existing records.
332 - if ( ! $wcOrder ) {
485 + foreach ( $orderIds as $orderId ) {
486 + if ( ! isset( $packeteryOrdersResult[ $orderId ] ) ) {
333 487 continue;
334 488 }
335 - $order = $this->getByWcOrder( $wcOrder );
336 - if ( $order ) {
337 - $orderEntities[ $order->getNumber() ] = $order;
489 +
490 + $wcOrder = $this->getWcOrderById( (int) $orderId );
491 + assert( $wcOrder !== null, 'WC order has to be present' );
492 +
493 + try {
494 + $orderEntities[ $orderId ] = $this->builder->build( $wcOrder, $packeteryOrdersResult[ $orderId ] );
495 + } catch ( InvalidCarrierException $exception ) {
496 + continue;
338 497 }
339 498 }
340 499
341 500 return $orderEntities;
@@ -343,35 +502,77 @@
343 502
344 503 /**
345 504 * Finds orders.
346 505 *
347 - * @param int $limit Number of records.
506 + * @param string[] $allowedPacketStatuses Allowed packet statuses.
507 + * @param string[] $allowedOrderStatuses Allowed order statuses.
508 + * @param int $maxDays Max number of days of single packet sync.
509 + * @param int $limit Number of records.
348 510 *
349 - * @return iterable|Order[]
511 + * @return \Generator<int>
512 + * @throws Exception Exception.
350 513 */
351 - public function findStatusSyncingOrders( int $limit ): iterable {
352 - $wpdb = $this->wpdb;
514 + public function findStatusSyncingOrderIds( array $allowedPacketStatuses, array $allowedOrderStatuses, int $maxDays, int $limit ): \Generator {
515 + $dateLimit = CoreHelper::now()->modify( '- ' . $maxDays . ' days' )->format( 'Y-m-d H:i:s' );
353 516
354 - $rows = $wpdb->get_results(
355 - $wpdb->prepare(
356 - '
357 - SELECT o.* FROM `' . $wpdb->packetery_order . '` o
358 - JOIN `' . $wpdb->posts . '` wp_p ON wp_p.`ID` = o.`id`
359 - WHERE ( o.`packet_status` IS NULL OR o.`packet_status` NOT IN ("delivered", "returned", "cancelled") ) AND o.`packet_id` IS NOT NULL
360 - ORDER BY wp_p.`post_date`
517 + $andWhere = [ '`o`.`packet_id` IS NOT NULL' ];
518 + $hposEnabled = ModuleHelper::isHposEnabled();
519 +
520 + if ( $hposEnabled ) {
521 + $andWhere[] = $this->wpdbAdapter->prepare( '`wc_o`.`date_created_gmt` >= %s', $dateLimit );
522 + } else {
523 + $andWhere[] = $this->wpdbAdapter->prepare( '`wp_p`.`post_date_gmt` >= %s', $dateLimit );
524 + }
525 +
526 + $orPacketStatus = [];
527 + $orPacketStatus[] = '`o`.`packet_status` IS NULL';
528 +
529 + if ( count( $allowedPacketStatuses ) > 0 ) {
530 + $orPacketStatus[] = '`o`.`packet_status` IN (' . $this->wpdbAdapter->prepareInClause( $allowedPacketStatuses ) . ')';
531 + }
532 +
533 + if ( count( $orPacketStatus ) > 0 ) {
534 + $andWhere[] = '(' . implode( ' OR ', $orPacketStatus ) . ')';
535 + }
536 +
537 + if ( count( $allowedOrderStatuses ) > 0 && $hposEnabled ) {
538 + $andWhere[] = '`wc_o`.`status` IN (' . $this->wpdbAdapter->prepareInClause( $allowedOrderStatuses ) . ')';
539 + } elseif ( count( $allowedOrderStatuses ) > 0 && $hposEnabled === false ) {
540 + $andWhere[] = '`wp_p`.`post_status` IN (' . $this->wpdbAdapter->prepareInClause( $allowedOrderStatuses ) . ')';
541 + } else {
542 + $andWhere[] = '1 = 0';
543 + }
544 +
545 + $where = '';
546 + if ( count( $andWhere ) > 0 ) {
547 + $where = ' WHERE ' . implode( ' AND ', $andWhere );
548 + }
549 +
550 + if ( $hposEnabled ) {
551 + $orderBy = ' ORDER BY `wc_o`.`date_created_gmt` ';
552 + } else {
553 + $orderBy = ' ORDER BY `wp_p`.`post_date_gmt` ';
554 + }
555 +
556 + $sql = $this->wpdbAdapter->prepare(
557 + '
558 + SELECT `o`.`id` FROM `' . $this->wpdbAdapter->packeteryOrder . '` `o`
559 + ' . $this->getWcOrderJoinClause() . '
560 + ' . $where . '
561 + ' . $orderBy . '
361 562 LIMIT %d',
362 - $limit
363 - )
563 + $limit
364 564 );
365 565
566 + $rows = $this->wpdbAdapter->get_results( $sql );
567 +
366 568 foreach ( $rows as $row ) {
367 - $wcOrder = wc_get_order( $row->id );
368 - if ( false === $wcOrder || ! $wcOrder->has_shipping_method( ShippingMethod::PACKETERY_METHOD_ID ) ) {
569 + $wcOrder = $this->getWcOrderById( (int) $row->id );
570 + if ( $wcOrder === null || ! ShippingProvider::wcOrderHasOurMethod( $wcOrder ) ) {
369 571 continue;
370 572 }
371 573
372 - $partial = $this->createPartialOrder( $row );
373 - yield $this->builder->finalize( $wcOrder, $partial );
574 + yield (int) $row->id;
374 575 }
375 576 }
376 577
377 578 /**
@@ -379,15 +580,9 @@
379 580 *
380 581 * @return int
381 582 */
382 583 public function countOrdersToSubmit(): int {
383 - $wpdb = $this->wpdb;
384 -
385 - return (int) $wpdb->get_var(
386 - 'SELECT COUNT(DISTINCT o.id) FROM `' . $wpdb->packetery_order . '` o
387 - JOIN `' . $wpdb->posts . '` wp_p ON wp_p.`ID` = o.`id`
388 - WHERE o.`carrier_id` IS NOT NULL AND o.`is_exported` = false'
389 - );
584 + return $this->countOrders( [ 'packetery_to_submit' => '1' ] );
390 585 }
391 586
392 587 /**
393 588 * Counts order to be printed.
@@ -394,43 +589,104 @@
394 589 *
395 590 * @return int
396 591 */
397 592 public function countOrdersToPrint(): int {
398 - $wpdb = $this->wpdb;
593 + return $this->countOrders( [ 'packetery_to_print' => '1' ] );
594 + }
399 595
400 - return (int) $wpdb->get_var(
401 - 'SELECT COUNT(DISTINCT o.id) FROM `' . $wpdb->packetery_order . '` o
402 - JOIN `' . $wpdb->posts . '` wp_p ON wp_p.`ID` = o.`id`
403 - WHERE o.`packet_id` IS NOT NULL AND o.`is_label_printed` = false'
596 + /**
597 + * Counts orders by given params.
598 + *
599 + * @param array<string, string> $params Params.
600 + *
601 + * @return int
602 + */
603 + private function countOrders( array $params ): int {
604 + $clauses = [ 'join' => '' ];
605 +
606 + if ( ModuleHelper::isHposEnabled() ) {
607 + $clauses['select'] = ' SELECT COUNT(DISTINCT `' . $this->wpdbAdapter->wcOrders . '`.`id`) ';
608 + $clauses['from'] = ' FROM `' . $this->wpdbAdapter->wcOrders . '` ';
609 + } else {
610 + $clauses['select'] = ' SELECT COUNT(DISTINCT `' . $this->wpdbAdapter->posts . '`.`ID`) ';
611 + $clauses['from'] = ' FROM `' . $this->wpdbAdapter->posts . '` ';
612 + }
613 +
614 + $clauses['where'] = ' WHERE `' . $this->wpdbAdapter->packeteryOrder . '`.`id` IS NOT NULL ';
615 + $clauses = $this->processClauses( $clauses, null, $params );
616 +
617 + return (int) $this->wpdbAdapter->get_var(
618 + $clauses['select'] .
619 + $clauses['from'] .
620 + $clauses['join'] .
621 + $clauses['where']
404 622 );
405 623 }
406 624
407 625 /**
626 + * Gets WC Order join clause.
627 + *
628 + * @return string
629 + */
630 + public function getWcOrderJoinClause(): string {
631 + $packeteryTableAlias = 'o';
632 +
633 + if ( ModuleHelper::isHposEnabled() ) {
634 + $sourceTableAlias = 'wc_o';
635 +
636 + return sprintf(
637 + 'JOIN `%s` `%s` ON `%s`.`id` = `%s`.`id`',
638 + $this->wpdbAdapter->wcOrders,
639 + $sourceTableAlias,
640 + $sourceTableAlias,
641 + $packeteryTableAlias
642 + );
643 + }
644 +
645 + $sourceTableAlias = 'wp_p';
646 +
647 + return sprintf(
648 + 'JOIN `%s` `%s` ON `%s`.`ID` = `%s`.`id`',
649 + $this->wpdbAdapter->posts,
650 + $sourceTableAlias,
651 + $sourceTableAlias,
652 + $packeteryTableAlias
653 + );
654 + }
655 +
656 + /**
408 657 * Deletes all custom table records linked to permanently deleted orders.
409 658 *
410 659 * @return void
411 660 */
412 661 public function deleteOrphans(): void {
413 - $wpdb = $this->wpdb;
662 + if ( ModuleHelper::isHposEnabled() ) {
663 + $this->wpdbAdapter->query(
664 + 'DELETE `' . $this->wpdbAdapter->packeteryOrder . '` FROM `' . $this->wpdbAdapter->packeteryOrder . '`
665 + LEFT JOIN `' . $this->wpdbAdapter->wcOrders . '` ON `' . $this->wpdbAdapter->wcOrders . '`.`id` = `' . $this->wpdbAdapter->packeteryOrder . '`.`id`
666 + WHERE `' . $this->wpdbAdapter->wcOrders . '`.`id` IS NULL'
667 + );
414 668
415 - $wpdb->query(
416 - 'DELETE `' . $wpdb->packetery_order . '` FROM `' . $wpdb->packetery_order . '`
417 - LEFT JOIN `' . $wpdb->posts . '` ON `' . $wpdb->posts . '`.`ID` = `' . $wpdb->packetery_order . '`.`id`
418 - WHERE `' . $wpdb->posts . '`.`ID` IS NULL'
669 + return;
670 + }
671 +
672 + $this->wpdbAdapter->query(
673 + 'DELETE `' . $this->wpdbAdapter->packeteryOrder . '` FROM `' . $this->wpdbAdapter->packeteryOrder . '`
674 + LEFT JOIN `' . $this->wpdbAdapter->posts . '` ON `' . $this->wpdbAdapter->posts . '`.`ID` = `' . $this->wpdbAdapter->packeteryOrder . '`.`id`
675 + WHERE `' . $this->wpdbAdapter->posts . '`.`ID` IS NULL'
419 676 );
420 677 }
421 678
422 679 /**
423 - * Deletes data from custom table.
680 + * Deletes order data including customs declaration and its items from custom tables.
424 681 *
425 682 * @param int $orderId Order id.
426 683 *
427 684 * @return void
428 685 */
429 - private function delete( int $orderId ): void {
430 - $wpdb = $this->wpdb;
431 -
432 - $wpdb->delete( $wpdb->packetery_order, [ 'id' => $orderId ], '%d' );
686 + public function delete( int $orderId ): void {
687 + $this->customsDeclarationRepository->delete( (string) $orderId );
688 + $this->wpdbAdapter->delete( $this->wpdbAdapter->packeteryOrder, [ 'id' => $orderId ], '%d' );
433 689 }
434 690
435 691 /**
436 692 * Fires after post deletion.
@@ -440,10 +696,26 @@
440 696 *
441 697 * @return void
442 698 */
443 699 public function deletedPostHook( int $postId, WP_Post $post ): void {
444 - if ( 'shop_order' === $post->post_type ) {
700 + // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
701 + if ( $post->post_type === 'shop_order' ) {
445 702 $this->delete( $postId );
446 703 }
447 704 }
448 705
706 + /**
707 + * Gets WC_Order object.
708 + *
709 + * @param int $id Order id.
710 + *
711 + * @return WC_Order|null
712 + */
713 + public function getWcOrderById( int $id ): ?WC_Order {
714 + $result = wc_get_order( $id );
715 + if ( $result instanceof WC_Order ) {
716 + return $result;
717 + }
718 +
719 + return null;
720 + }
449 721 }