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