spryker /
spryker-core
| Total Complexity | 85 |
| Total Lines | 884 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like SalesRepository often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use SalesRepository, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 43 | class SalesRepository extends AbstractRepository implements SalesRepositoryInterface |
||
| 44 | { |
||
| 45 | /** |
||
| 46 | * @var string |
||
| 47 | */ |
||
| 48 | protected const ID_SALES_ORDER = 'id_sales_order'; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * @var string |
||
| 52 | */ |
||
| 53 | protected const COL_MAX_CREATED_AT = 'max_created_at'; |
||
| 54 | |||
| 55 | /** |
||
| 56 | * @var string |
||
| 57 | */ |
||
| 58 | protected const COL_FK_SALES_ORDER = 'fk_sales_order'; |
||
| 59 | |||
| 60 | /** |
||
| 61 | * @var string |
||
| 62 | */ |
||
| 63 | protected const ALIAS_LATEST_TOTALS = 'latest_totals'; |
||
| 64 | |||
| 65 | /** |
||
| 66 | * @var array<string, string> |
||
| 67 | */ |
||
| 68 | protected const SORT_KEYS_MAP = [ |
||
| 69 | 'createdAt' => SpySalesOrderTableMap::COL_CREATED_AT, |
||
| 70 | 'updatedAt' => SpySalesOrderTableMap::COL_UPDATED_AT, |
||
| 71 | ]; |
||
| 72 | |||
| 73 | /** |
||
| 74 | * @param string $customerReference |
||
| 75 | * @param string $orderReference |
||
| 76 | * |
||
| 77 | * @return int|null |
||
| 78 | */ |
||
| 79 | public function findCustomerOrderIdByOrderReference(string $customerReference, string $orderReference): ?int |
||
| 80 | { |
||
| 81 | /** @var int|null $idSalesOrder */ |
||
| 82 | $idSalesOrder = $this->getFactory() |
||
| 83 | ->createSalesOrderQuery() |
||
| 84 | ->filterByCustomerReference($customerReference) |
||
| 85 | ->filterByOrderReference($orderReference) |
||
| 86 | ->select([static::ID_SALES_ORDER]) |
||
| 87 | ->findOne(); |
||
| 88 | |||
| 89 | return $idSalesOrder; |
||
| 90 | } |
||
| 91 | |||
| 92 | /** |
||
| 93 | * @param int $idOrderAddress |
||
| 94 | * |
||
| 95 | * @return \Generated\Shared\Transfer\AddressTransfer|null |
||
| 96 | */ |
||
| 97 | public function findOrderAddressByIdOrderAddress(int $idOrderAddress): ?AddressTransfer |
||
| 98 | { |
||
| 99 | $addressEntity = $this->getFactory() |
||
| 100 | ->createSalesOrderAddressQuery() |
||
| 101 | ->leftJoinWithCountry() |
||
| 102 | ->filterByIdSalesOrderAddress($idOrderAddress) |
||
| 103 | ->findOne(); |
||
| 104 | |||
| 105 | if ($addressEntity === null) { |
||
| 106 | return null; |
||
| 107 | } |
||
| 108 | |||
| 109 | return $this->hydrateAddressTransferFromEntity($this->createOrderAddressTransfer(), $addressEntity); |
||
| 110 | } |
||
| 111 | |||
| 112 | /** |
||
| 113 | * @module Oms |
||
| 114 | * |
||
| 115 | * @param \Generated\Shared\Transfer\OrderItemFilterTransfer $orderItemFilterTransfer |
||
| 116 | * |
||
| 117 | * @return array<\Generated\Shared\Transfer\ItemTransfer> |
||
| 118 | */ |
||
| 119 | public function getOrderItems(OrderItemFilterTransfer $orderItemFilterTransfer): array |
||
| 120 | { |
||
| 121 | $salesOrderItemQuery = $this->getFactory() |
||
| 122 | ->createSalesOrderItemQuery() |
||
| 123 | ->innerJoinWithOrder() |
||
| 124 | ->leftJoinWithProcess() |
||
| 125 | ->leftJoinWithState(); |
||
| 126 | |||
| 127 | $salesOrderItemQuery = $this->setOrderItemFilters($salesOrderItemQuery, $orderItemFilterTransfer); |
||
| 128 | |||
| 129 | $salesOrderItemQuery = $this->buildQueryFromCriteria( |
||
| 130 | $salesOrderItemQuery, |
||
| 131 | $orderItemFilterTransfer->getFilter(), |
||
| 132 | ); |
||
| 133 | |||
| 134 | $salesOrderItemQuery->setFormatter(ModelCriteria::FORMAT_OBJECT); |
||
| 135 | |||
| 136 | return $this->getFactory() |
||
| 137 | ->createSalesOrderItemMapper() |
||
| 138 | ->mapSalesOrderItemEntityCollectionToOrderItemTransfers($salesOrderItemQuery->find()); |
||
| 139 | } |
||
| 140 | |||
| 141 | /** |
||
| 142 | * @param array<int> $salesOrderIds |
||
| 143 | * |
||
| 144 | * @return array<string> |
||
| 145 | */ |
||
| 146 | public function getCurrencyIsoCodesBySalesOrderIds(array $salesOrderIds): array |
||
| 147 | { |
||
| 148 | if (!$salesOrderIds) { |
||
| 149 | return []; |
||
| 150 | } |
||
| 151 | |||
| 152 | /** @var \Propel\Runtime\Collection\ObjectCollection $currencyIsoCodes */ |
||
| 153 | $currencyIsoCodes = $this->getFactory() |
||
| 154 | ->createSalesOrderQuery() |
||
| 155 | ->filterByIdSalesOrder_In($salesOrderIds) |
||
| 156 | ->select([static::ID_SALES_ORDER, SpySalesOrderTableMap::COL_CURRENCY_ISO_CODE]) |
||
| 157 | ->find(); |
||
| 158 | |||
| 159 | return $currencyIsoCodes->toKeyValue(static::ID_SALES_ORDER, SpySalesOrderTableMap::COL_CURRENCY_ISO_CODE); |
||
| 160 | } |
||
| 161 | |||
| 162 | /** |
||
| 163 | * @param \Generated\Shared\Transfer\OrderListTransfer $orderListTransfer |
||
| 164 | * |
||
| 165 | * @return \Generated\Shared\Transfer\OrderListTransfer |
||
| 166 | */ |
||
| 167 | public function searchOrders(OrderListTransfer $orderListTransfer): OrderListTransfer |
||
| 168 | { |
||
| 169 | $orderListTransfer |
||
| 170 | ->requireFormat(); |
||
| 171 | |||
| 172 | $salesOrderQuery = $this->getFactory() |
||
| 173 | ->createSalesOrderQuery() |
||
| 174 | ->groupByIdSalesOrder() |
||
| 175 | ->setIgnoreCase(true); |
||
| 176 | |||
| 177 | $salesOrderQuery = $this->buildSearchOrdersQuery($salesOrderQuery, $orderListTransfer); |
||
| 178 | |||
| 179 | if ($orderListTransfer->getPagination()) { |
||
| 180 | $salesOrderQuery = $this->preparePagination($salesOrderQuery, $orderListTransfer->getPaginationOrFail()); |
||
| 181 | } |
||
| 182 | |||
| 183 | $orderTransfers = $this->getFactory() |
||
| 184 | ->createSalesOrderMapper() |
||
| 185 | ->mapSalesOrderEntityCollectionToOrderTransfers($salesOrderQuery->find()); |
||
| 186 | |||
| 187 | return $orderListTransfer->setOrders(new ArrayObject($orderTransfers)); |
||
| 188 | } |
||
| 189 | |||
| 190 | /** |
||
| 191 | * @param array<int> $salesOrderIds |
||
| 192 | * |
||
| 193 | * @return array<\Generated\Shared\Transfer\ItemTransfer> |
||
| 194 | */ |
||
| 195 | public function getSalesOrderItemsByOrderIds(array $salesOrderIds): array |
||
| 196 | { |
||
| 197 | $salesOrderItemQuery = $this->getFactory() |
||
| 198 | ->createSalesOrderItemQuery() |
||
| 199 | ->filterByFkSalesOrder_In($salesOrderIds); |
||
| 200 | |||
| 201 | return $this->getFactory() |
||
| 202 | ->createSalesOrderItemMapper() |
||
| 203 | ->mapSalesOrderItemEntityCollectionToOrderItemTransfers($salesOrderItemQuery->find()); |
||
| 204 | } |
||
| 205 | |||
| 206 | /** |
||
| 207 | * @param array<int> $salesOrderIds |
||
| 208 | * |
||
| 209 | * @return array<\Generated\Shared\Transfer\TotalsTransfer> |
||
| 210 | */ |
||
| 211 | public function getMappedSalesOrderTotalsBySalesOrderIds(array $salesOrderIds): array |
||
| 212 | { |
||
| 213 | $salesOrderTotalsSubQuerySql = $this->getLatestSalesOrderTotalsSubQuerySql($salesOrderIds); |
||
| 214 | $salesOrderTotalsQuery = $this->getFactory() |
||
| 215 | ->getSalesOrderTotalsPropelQuery() |
||
| 216 | ->addAlias(static::ALIAS_LATEST_TOTALS, sprintf('(%s)', $salesOrderTotalsSubQuerySql)) |
||
| 217 | ->addJoin( |
||
| 218 | [SpySalesOrderTotalsTableMap::COL_FK_SALES_ORDER, SpySalesOrderTotalsTableMap::COL_CREATED_AT], |
||
| 219 | [sprintf('%s.%s', static::ALIAS_LATEST_TOTALS, static::COL_FK_SALES_ORDER), sprintf('%s.%s', static::ALIAS_LATEST_TOTALS, static::COL_MAX_CREATED_AT)], |
||
| 220 | Criteria::INNER_JOIN, |
||
| 221 | ) |
||
| 222 | ->filterByFkSalesOrder_In($salesOrderIds) |
||
| 223 | ->groupByFkSalesOrder() |
||
| 224 | ->orderByCreatedAt(); |
||
| 225 | |||
| 226 | return $this->getFactory() |
||
| 227 | ->createSalesOrderMapper() |
||
| 228 | ->mapSalesOrderTotalsEntityCollectionToMappedOrderTotalsByIdSalesOrder($salesOrderTotalsQuery->find()); |
||
| 229 | } |
||
| 230 | |||
| 231 | /** |
||
| 232 | * @param array<int> $salesOrderIds |
||
| 233 | * |
||
| 234 | * @return string |
||
| 235 | */ |
||
| 236 | protected function getLatestSalesOrderTotalsSubQuerySql(array $salesOrderIds): string |
||
| 247 | } |
||
| 248 | |||
| 249 | /** |
||
| 250 | * @param \Orm\Zed\Sales\Persistence\SpySalesOrderQuery $salesOrderQuery |
||
| 251 | * @param \Generated\Shared\Transfer\OrderListTransfer $orderListTransfer |
||
| 252 | * |
||
| 253 | * @return \Orm\Zed\Sales\Persistence\SpySalesOrderQuery |
||
| 254 | */ |
||
| 255 | protected function buildSearchOrdersQuery( |
||
| 256 | SpySalesOrderQuery $salesOrderQuery, |
||
| 257 | OrderListTransfer $orderListTransfer |
||
| 258 | ): SpySalesOrderQuery { |
||
| 259 | $salesOrderQuery = $this->getFactory() |
||
| 260 | ->createOrderSearchFilterFieldQueryBuilder() |
||
| 261 | ->addSalesOrderQueryFilters($salesOrderQuery, $orderListTransfer); |
||
| 262 | |||
| 263 | $queryJoinCollectionTransfer = $orderListTransfer->getQueryJoins(); |
||
| 264 | |||
| 265 | if ($queryJoinCollectionTransfer && $queryJoinCollectionTransfer->getQueryJoins()->count()) { |
||
| 266 | $salesOrderQuery = $this->getFactory() |
||
| 267 | ->createOrderSearchQueryJoinQueryBuilder() |
||
| 268 | ->addSalesOrderQueryFilters($salesOrderQuery, $queryJoinCollectionTransfer); |
||
| 269 | } |
||
| 270 | |||
| 271 | if ($this->isSearchByAllFilterFieldSet($orderListTransfer->getFilterFields())) { |
||
| 272 | $salesOrderQuery->where([OrderSearchFilterFieldQueryBuilder::CONDITION_GROUP_ALL]); |
||
| 273 | } |
||
| 274 | |||
| 275 | return $salesOrderQuery; |
||
| 276 | } |
||
| 277 | |||
| 278 | /** |
||
| 279 | * @param \Propel\Runtime\ActiveQuery\ModelCriteria $query |
||
| 280 | * @param \Generated\Shared\Transfer\PaginationTransfer $paginationTransfer |
||
| 281 | * |
||
| 282 | * @return \Propel\Runtime\ActiveQuery\ModelCriteria |
||
| 283 | */ |
||
| 284 | protected function preparePagination( |
||
| 285 | ModelCriteria $query, |
||
| 286 | PaginationTransfer $paginationTransfer |
||
| 287 | ): ModelCriteria { |
||
| 288 | $page = $paginationTransfer |
||
| 289 | ->requirePage() |
||
| 290 | ->getPage(); |
||
| 291 | |||
| 292 | $maxPerPage = $paginationTransfer |
||
| 293 | ->requireMaxPerPage() |
||
| 294 | ->getMaxPerPage(); |
||
| 295 | |||
| 296 | $propelModelPager = $query->paginate($page, $maxPerPage); |
||
| 297 | |||
| 298 | $paginationTransfer->setNbResults($propelModelPager->getNbResults()) |
||
| 299 | ->setFirstIndex($propelModelPager->getFirstIndex()) |
||
| 300 | ->setLastIndex($propelModelPager->getLastIndex()) |
||
| 301 | ->setFirstPage($propelModelPager->getFirstPage()) |
||
| 302 | ->setLastPage($propelModelPager->getLastPage()) |
||
| 303 | ->setNextPage($propelModelPager->getNextPage()) |
||
| 304 | ->setPreviousPage($propelModelPager->getPreviousPage()); |
||
| 305 | |||
| 306 | return $propelModelPager->getQuery(); |
||
| 307 | } |
||
| 308 | |||
| 309 | /** |
||
| 310 | * @param \Generated\Shared\Transfer\AddressTransfer $addressTransfer |
||
| 311 | * @param \Orm\Zed\Sales\Persistence\SpySalesOrderAddress $addressEntity |
||
| 312 | * |
||
| 313 | * @return \Generated\Shared\Transfer\AddressTransfer |
||
| 314 | */ |
||
| 315 | protected function hydrateAddressTransferFromEntity( |
||
| 316 | AddressTransfer $addressTransfer, |
||
| 317 | SpySalesOrderAddress $addressEntity |
||
| 318 | ): AddressTransfer { |
||
| 319 | $addressTransfer->fromArray($addressEntity->toArray(), true); |
||
| 320 | $addressTransfer->setIso2Code($addressEntity->getCountry()->getIso2Code()); |
||
| 321 | |||
| 322 | return $addressTransfer; |
||
| 323 | } |
||
| 324 | |||
| 325 | /** |
||
| 326 | * @return \Generated\Shared\Transfer\AddressTransfer |
||
| 327 | */ |
||
| 328 | protected function createOrderAddressTransfer(): AddressTransfer |
||
| 329 | { |
||
| 330 | return new AddressTransfer(); |
||
| 331 | } |
||
| 332 | |||
| 333 | /** |
||
| 334 | * @param \Generated\Shared\Transfer\OrderListRequestTransfer $orderListRequestTransfer |
||
| 335 | * |
||
| 336 | * @return \Generated\Shared\Transfer\OrderListTransfer |
||
| 337 | */ |
||
| 338 | public function getCustomerOrderListByCustomerReference(OrderListRequestTransfer $orderListRequestTransfer): OrderListTransfer |
||
| 339 | { |
||
| 340 | $orderListQuery = $this->getFactory() |
||
| 341 | ->createSalesOrderQuery() |
||
| 342 | ->filterByCustomerReference($orderListRequestTransfer->getCustomerReference()); |
||
| 343 | |||
| 344 | if ($orderListRequestTransfer->getOrderReferences()) { |
||
| 345 | $orderListQuery->filterByOrderReference_In($orderListRequestTransfer->getOrderReferences()); |
||
| 346 | } |
||
| 347 | |||
| 348 | $ordersCount = $orderListQuery->count(); |
||
| 349 | if (!$ordersCount) { |
||
| 350 | return new OrderListTransfer(); |
||
| 351 | } |
||
| 352 | |||
| 353 | $orderListQuery = $this->applyFilterToQuery($orderListQuery, $orderListRequestTransfer->getFilter()); |
||
| 354 | |||
| 355 | $orderListTransfer = $this->getFactory() |
||
| 356 | ->createSalesOrderMapper() |
||
| 357 | ->mapSalesOrderEntitiesToOrderListTransfer($orderListQuery->find()->getArrayCopy(), new OrderListTransfer()); |
||
| 358 | |||
| 359 | $orderListTransfer->setPagination((new PaginationTransfer())->setNbResults($ordersCount)); |
||
| 360 | |||
| 361 | return $orderListTransfer; |
||
| 362 | } |
||
| 363 | |||
| 364 | /** |
||
| 365 | * @param \Orm\Zed\Sales\Persistence\SpySalesOrderQuery $orderListQuery |
||
| 366 | * @param \Generated\Shared\Transfer\FilterTransfer|null $filterTransfer |
||
| 367 | * |
||
| 368 | * @return \Orm\Zed\Sales\Persistence\SpySalesOrderQuery |
||
| 369 | */ |
||
| 370 | protected function applyFilterToQuery(SpySalesOrderQuery $orderListQuery, ?FilterTransfer $filterTransfer): SpySalesOrderQuery |
||
| 371 | { |
||
| 372 | if ($filterTransfer) { |
||
| 373 | if ($filterTransfer->getOrderBy() && isset(static::SORT_KEYS_MAP[$filterTransfer->getOrderBy()])) { |
||
| 374 | $filterTransfer->setOrderBy(static::SORT_KEYS_MAP[$filterTransfer->getOrderBy()]); |
||
| 375 | } |
||
| 376 | |||
| 377 | $orderListQuery->mergeWith( |
||
| 378 | (new PropelFilterCriteria($filterTransfer))->toCriteria(), |
||
| 379 | ); |
||
| 380 | } |
||
| 381 | |||
| 382 | return $orderListQuery; |
||
| 383 | } |
||
| 384 | |||
| 385 | /** |
||
| 386 | * @param \Orm\Zed\Sales\Persistence\SpySalesOrderItemQuery $salesOrderItemQuery |
||
| 387 | * @param \Generated\Shared\Transfer\OrderItemFilterTransfer $orderItemFilterTransfer |
||
| 388 | * |
||
| 389 | * @return \Orm\Zed\Sales\Persistence\SpySalesOrderItemQuery |
||
| 390 | */ |
||
| 391 | protected function setOrderItemFilters( |
||
| 392 | SpySalesOrderItemQuery $salesOrderItemQuery, |
||
| 393 | OrderItemFilterTransfer $orderItemFilterTransfer |
||
| 394 | ): SpySalesOrderItemQuery { |
||
| 395 | if ($orderItemFilterTransfer->getSalesOrderItemIds()) { |
||
| 396 | $salesOrderItemQuery->filterByIdSalesOrderItem_In(array_unique($orderItemFilterTransfer->getSalesOrderItemIds())); |
||
| 397 | } |
||
| 398 | |||
| 399 | if ($orderItemFilterTransfer->getSalesOrderItemUuids()) { |
||
| 400 | $salesOrderItemQuery->filterByUuid_In(array_unique($orderItemFilterTransfer->getSalesOrderItemUuids())); |
||
| 401 | } |
||
| 402 | |||
| 403 | if ($orderItemFilterTransfer->getSalesOrderIds()) { |
||
| 404 | $salesOrderItemQuery->filterByFkSalesOrder_In(array_unique($orderItemFilterTransfer->getSalesOrderIds())); |
||
| 405 | } |
||
| 406 | |||
| 407 | if ($orderItemFilterTransfer->getCustomerReferences()) { |
||
| 408 | $salesOrderItemQuery |
||
| 409 | ->useOrderQuery() |
||
| 410 | ->filterByCustomerReference_In(array_unique($orderItemFilterTransfer->getCustomerReferences())) |
||
| 411 | ->endUse(); |
||
| 412 | } |
||
| 413 | |||
| 414 | if ($orderItemFilterTransfer->getOrderReferences()) { |
||
| 415 | $salesOrderItemQuery |
||
| 416 | ->useOrderQuery() |
||
| 417 | ->filterByOrderReference_In(array_unique($orderItemFilterTransfer->getOrderReferences())) |
||
| 418 | ->endUse(); |
||
| 419 | } |
||
| 420 | |||
| 421 | if ($orderItemFilterTransfer->getItemStates()) { |
||
| 422 | $salesOrderItemQuery |
||
| 423 | ->useStateQuery() |
||
| 424 | ->filterByName_In(array_unique($orderItemFilterTransfer->getItemStates())) |
||
| 425 | ->endUse(); |
||
| 426 | } |
||
| 427 | |||
| 428 | return $salesOrderItemQuery; |
||
| 429 | } |
||
| 430 | |||
| 431 | /** |
||
| 432 | * @param \ArrayObject<int, \Generated\Shared\Transfer\FilterFieldTransfer> $filterFieldTransfers |
||
| 433 | * |
||
| 434 | * @return bool |
||
| 435 | */ |
||
| 436 | protected function isSearchByAllFilterFieldSet(ArrayObject $filterFieldTransfers): bool |
||
| 437 | { |
||
| 438 | foreach ($filterFieldTransfers as $filterFieldTransfer) { |
||
| 439 | if ($filterFieldTransfer->getType() === OrderSearchFilterFieldQueryBuilder::SEARCH_TYPE_ALL) { |
||
| 440 | return true; |
||
| 441 | } |
||
| 442 | } |
||
| 443 | |||
| 444 | return false; |
||
| 445 | } |
||
| 446 | |||
| 447 | /** |
||
| 448 | * @param \Generated\Shared\Transfer\OrderFilterTransfer $orderFilterTransfer |
||
| 449 | * |
||
| 450 | * @return \Generated\Shared\Transfer\OrderTransfer |
||
| 451 | */ |
||
| 452 | public function getSalesOrderDetails(OrderFilterTransfer $orderFilterTransfer): OrderTransfer |
||
| 453 | { |
||
| 454 | $orderEntity = $this->getSalesOrderEntity($orderFilterTransfer); |
||
| 455 | |||
| 456 | return $this->createOrderTransfer($orderEntity); |
||
| 457 | } |
||
| 458 | |||
| 459 | /** |
||
| 460 | * @param \Generated\Shared\Transfer\OrderTransfer $orderTransfer |
||
| 461 | * |
||
| 462 | * @return int |
||
| 463 | */ |
||
| 464 | public function getTotalCustomerOrderCount(OrderTransfer $orderTransfer): int |
||
| 465 | { |
||
| 466 | $customerReference = $orderTransfer->getCustomerReference(); |
||
| 467 | |||
| 468 | if ($customerReference === null) { |
||
| 469 | return 0; |
||
| 470 | } |
||
| 471 | |||
| 472 | return $this->getFactory() |
||
| 473 | ->createSalesOrderQuery() |
||
| 474 | ->filterByCustomerReference($customerReference) |
||
| 475 | ->count(); |
||
| 476 | } |
||
| 477 | |||
| 478 | /** |
||
| 479 | * @param int $idSalesOrder |
||
| 480 | * |
||
| 481 | * @return int |
||
| 482 | */ |
||
| 483 | public function countUniqueProductsForOrder(int $idSalesOrder): int |
||
| 484 | { |
||
| 485 | return (int)$this->getFactory() |
||
| 486 | ->createSalesOrderItemQuery() |
||
| 487 | ->filterByFkSalesOrder($idSalesOrder) |
||
| 488 | ->withColumn('COUNT(*)', 'Count') |
||
| 489 | ->select(['Count']) |
||
| 490 | ->groupBySku() |
||
| 491 | ->orderBy('Count') |
||
| 492 | ->count(); |
||
| 493 | } |
||
| 494 | |||
| 495 | /** |
||
| 496 | * @param \Generated\Shared\Transfer\OrderCriteriaTransfer $orderCriteriaTransfer |
||
| 497 | * |
||
| 498 | * @return \Generated\Shared\Transfer\OrderCollectionTransfer |
||
| 499 | */ |
||
| 500 | public function getOrderCollection(OrderCriteriaTransfer $orderCriteriaTransfer): OrderCollectionTransfer |
||
| 501 | { |
||
| 502 | $orderCollectionTransfer = new OrderCollectionTransfer(); |
||
| 503 | |||
| 504 | $salesOrderQuery = $this->getFactory() |
||
| 505 | ->createSalesOrderQuery() |
||
| 506 | ->leftJoinWith('SpySalesOrder.BillingAddress billingAddress') |
||
| 507 | ->leftJoinWith('billingAddress.Country billingCountry') |
||
| 508 | ->leftJoinWith('SpySalesOrder.ShippingAddress shippingAddress') |
||
| 509 | ->leftJoinWith('shippingAddress.Country shippingCountry'); |
||
| 510 | $salesOrderQuery = $this->applySalesOrderFilters($salesOrderQuery, $orderCriteriaTransfer); |
||
| 511 | |||
| 512 | /** @var \ArrayObject<array-key, \Generated\Shared\Transfer\SortTransfer> $sortTransfers */ |
||
| 513 | $sortTransfers = $orderCriteriaTransfer->getSortCollection(); |
||
| 514 | $salesOrderQuery = $this->applySorting($salesOrderQuery, $sortTransfers); |
||
| 515 | |||
| 516 | $paginationTransfer = $orderCriteriaTransfer->getPagination(); |
||
| 517 | if ($paginationTransfer) { |
||
| 518 | $salesOrderQuery = $this->applyPagination($salesOrderQuery, $paginationTransfer); |
||
| 519 | $orderCollectionTransfer->setPagination($paginationTransfer); |
||
| 520 | } |
||
| 521 | |||
| 522 | $salesOrderEntitiesIndexedByIdSalesOrder = $salesOrderQuery->find() |
||
| 523 | ->getArrayCopy('IdSalesOrder'); |
||
| 524 | $salesOrderEntitiesIndexedByIdSalesOrder = $this->expandSalesOrdersWithSalesOrderItems( |
||
| 525 | $salesOrderEntitiesIndexedByIdSalesOrder, |
||
| 526 | ); |
||
| 527 | $salesOrderEntitiesIndexedByIdSalesOrder = $this->expandSalesOrdersWithSalesExpenses( |
||
| 528 | $salesOrderEntitiesIndexedByIdSalesOrder, |
||
| 529 | ); |
||
| 530 | |||
| 531 | foreach ($salesOrderEntitiesIndexedByIdSalesOrder as $salesOrderEntity) { |
||
| 532 | $orderCollectionTransfer->addOrder($this->createOrderTransfer($salesOrderEntity)); |
||
| 533 | } |
||
| 534 | |||
| 535 | return $orderCollectionTransfer; |
||
| 536 | } |
||
| 537 | |||
| 538 | /** |
||
| 539 | * @param \Generated\Shared\Transfer\OrderFilterTransfer $orderFilterTransfer |
||
| 540 | * |
||
| 541 | * @return \Generated\Shared\Transfer\OrderTransfer|null |
||
| 542 | */ |
||
| 543 | public function findOrderWithoutItems(OrderFilterTransfer $orderFilterTransfer): ?OrderTransfer |
||
| 544 | { |
||
| 545 | $orderFilterTransfer->requireSalesOrderId(); |
||
| 546 | |||
| 547 | $salesOrderEntity = $this->getFactory() |
||
| 548 | ->createSalesOrderQuery() |
||
| 549 | ->filterByIdSalesOrder($orderFilterTransfer->getSalesOrderId()) |
||
| 550 | ->findOne(); |
||
| 551 | |||
| 552 | if ($salesOrderEntity === null) { |
||
| 553 | return null; |
||
| 554 | } |
||
| 555 | |||
| 556 | return $this->getFactory() |
||
| 557 | ->createSalesOrderMapper() |
||
| 558 | ->mapSalesOrderEntityToSalesOrderTransfer($salesOrderEntity, new OrderTransfer()); |
||
| 559 | } |
||
| 560 | |||
| 561 | /** |
||
| 562 | * @param \Generated\Shared\Transfer\SalesExpenseCollectionDeleteCriteriaTransfer $salesExpenseCollectionDeleteCriteriaTransfer |
||
| 563 | * |
||
| 564 | * @return list<\Generated\Shared\Transfer\ExpenseTransfer> |
||
| 565 | */ |
||
| 566 | public function getSalesExpensesBySalesExpenseCollectionDeleteCriteria( |
||
| 567 | SalesExpenseCollectionDeleteCriteriaTransfer $salesExpenseCollectionDeleteCriteriaTransfer |
||
| 568 | ): array { |
||
| 569 | $salesExpenseQuery = $this->getFactory()->createSalesExpenseQuery(); |
||
| 570 | $salesExpenseQuery = $this->appySalesExpenseCollectionDeleteCriteriaFilters( |
||
| 571 | $salesExpenseQuery, |
||
| 572 | $salesExpenseCollectionDeleteCriteriaTransfer, |
||
| 573 | ); |
||
| 574 | |||
| 575 | $salesExpenseEntities = $salesExpenseQuery->find(); |
||
| 576 | |||
| 577 | if ($salesExpenseEntities->count() === 0) { |
||
| 578 | return []; |
||
| 579 | } |
||
| 580 | |||
| 581 | return $this->getFactory() |
||
| 582 | ->createSalesExpenseMapper() |
||
| 583 | ->mapSalesExpenseEntitiesToExpenseTransfers($salesExpenseEntities, []); |
||
| 584 | } |
||
| 585 | |||
| 586 | /** |
||
| 587 | * @return list<string> |
||
| 588 | */ |
||
| 589 | public function getOmsOrderItemStates(): array |
||
| 590 | { |
||
| 591 | return $this->getFactory() |
||
| 592 | ->getOmsOrderItemStatePropelQuery() |
||
| 593 | ->select([SpyOmsOrderItemStateTableMap::COL_NAME]) |
||
| 594 | ->orderBy(SpyOmsOrderItemStateTableMap::COL_ID_OMS_ORDER_ITEM_STATE) |
||
| 595 | ->find() |
||
| 596 | ->getData(); |
||
| 597 | } |
||
| 598 | |||
| 599 | /** |
||
| 600 | * @param \Generated\Shared\Transfer\OrderFilterTransfer $orderFilterTransfer |
||
| 601 | * |
||
| 602 | * @throws \Spryker\Zed\Sales\Business\Exception\InvalidSalesOrderException |
||
| 603 | * |
||
| 604 | * @return \Orm\Zed\Sales\Persistence\SpySalesOrder |
||
| 605 | */ |
||
| 606 | protected function getSalesOrderEntity(OrderFilterTransfer $orderFilterTransfer): SpySalesOrder |
||
| 632 | } |
||
| 633 | |||
| 634 | /** |
||
| 635 | * @param \Orm\Zed\Sales\Persistence\SpySalesOrder $salesOrderEntity |
||
| 636 | * |
||
| 637 | * @return \Generated\Shared\Transfer\OrderTransfer |
||
| 638 | */ |
||
| 639 | protected function createOrderTransfer(SpySalesOrder $salesOrderEntity): OrderTransfer |
||
| 640 | { |
||
| 641 | $orderTransfer = $this->getFactory() |
||
| 642 | ->createSalesOrderMapper() |
||
| 643 | ->mapSalesOrderEntityToSalesOrderTransfer($salesOrderEntity, new OrderTransfer()); |
||
| 644 | $orderTransfer = $this->setOrderTotals($salesOrderEntity, $orderTransfer); |
||
| 645 | $orderTransfer = $this->setBillingAddress($salesOrderEntity, $orderTransfer); |
||
| 646 | $orderTransfer = $this->setShippingAddress($salesOrderEntity, $orderTransfer); |
||
| 647 | $orderTransfer = $this->setOrderExpenses($salesOrderEntity, $orderTransfer); |
||
| 648 | $orderTransfer = $this->setMissingCustomer($salesOrderEntity, $orderTransfer); |
||
| 649 | |||
| 650 | return $orderTransfer; |
||
| 651 | } |
||
| 652 | |||
| 653 | /** |
||
| 654 | * @param \Orm\Zed\Sales\Persistence\SpySalesOrderQuery $salesOrderQuery |
||
| 655 | * @param \Generated\Shared\Transfer\OrderFilterTransfer $orderFilterTransfer |
||
| 656 | * |
||
| 657 | * @return \Orm\Zed\Sales\Persistence\SpySalesOrderQuery |
||
| 658 | */ |
||
| 659 | protected function setOrderFilters(SpySalesOrderQuery $salesOrderQuery, OrderFilterTransfer $orderFilterTransfer): SpySalesOrderQuery |
||
| 660 | { |
||
| 661 | if ($orderFilterTransfer->getSalesOrderId()) { |
||
| 662 | $salesOrderQuery->filterByIdSalesOrder($orderFilterTransfer->getSalesOrderId()); |
||
| 663 | } |
||
| 664 | if ($orderFilterTransfer->getCustomerReference()) { |
||
| 665 | $salesOrderQuery->filterByCustomerReference($orderFilterTransfer->getCustomerReference()); |
||
| 666 | } |
||
| 667 | if ($orderFilterTransfer->getOrderReference()) { |
||
| 668 | $salesOrderQuery->filterByOrderReference($orderFilterTransfer->getOrderReference()); |
||
| 669 | } |
||
| 670 | |||
| 671 | return $salesOrderQuery; |
||
| 672 | } |
||
| 673 | |||
| 674 | /** |
||
| 675 | * @param \Orm\Zed\Sales\Persistence\SpySalesOrder $orderEntity |
||
| 676 | * @param \Generated\Shared\Transfer\OrderTransfer $orderTransfer |
||
| 677 | * |
||
| 678 | * @return \Generated\Shared\Transfer\OrderTransfer |
||
| 679 | */ |
||
| 680 | protected function setOrderTotals(SpySalesOrder $orderEntity, OrderTransfer $orderTransfer): OrderTransfer |
||
| 681 | { |
||
| 682 | $salesOrderTotalsEntity = $orderEntity->getLastOrderTotals(); |
||
| 683 | |||
| 684 | if (!$salesOrderTotalsEntity) { |
||
| 685 | return $orderTransfer; |
||
| 686 | } |
||
| 687 | |||
| 688 | $totalsTransfer = $this->getFactory() |
||
| 689 | ->createSalesOrderTotalsMapper() |
||
| 690 | ->mapSalesOrderTotalsTransfer($salesOrderTotalsEntity, new TotalsTransfer(), new TaxTotalTransfer()); |
||
| 691 | |||
| 692 | $orderTransfer->setTotals($totalsTransfer); |
||
| 693 | |||
| 694 | return $orderTransfer; |
||
| 695 | } |
||
| 696 | |||
| 697 | /** |
||
| 698 | * @param \Orm\Zed\Sales\Persistence\SpySalesOrder $orderEntity |
||
| 699 | * @param \Generated\Shared\Transfer\OrderTransfer $orderTransfer |
||
| 700 | * |
||
| 701 | * @return \Generated\Shared\Transfer\OrderTransfer |
||
| 702 | */ |
||
| 703 | protected function setBillingAddress(SpySalesOrder $orderEntity, OrderTransfer $orderTransfer): OrderTransfer |
||
| 704 | { |
||
| 705 | $billingAddressTransfer = $this->getFactory() |
||
| 706 | ->createSalesOrderAddressMapper() |
||
| 707 | ->mapAddressEntityToAddressTransfer(new AddressTransfer(), $orderEntity->getBillingAddress()); |
||
| 708 | |||
| 709 | $orderTransfer->setBillingAddress($billingAddressTransfer); |
||
| 710 | |||
| 711 | return $orderTransfer; |
||
| 712 | } |
||
| 713 | |||
| 714 | /** |
||
| 715 | * @param \Orm\Zed\Sales\Persistence\SpySalesOrder $orderEntity |
||
| 716 | * @param \Generated\Shared\Transfer\OrderTransfer $orderTransfer |
||
| 717 | * |
||
| 718 | * @return \Generated\Shared\Transfer\OrderTransfer |
||
| 719 | */ |
||
| 720 | protected function setShippingAddress(SpySalesOrder $orderEntity, OrderTransfer $orderTransfer): OrderTransfer |
||
| 721 | { |
||
| 722 | $orderShippingAddressEntity = $orderEntity->getShippingAddress(); |
||
| 723 | |||
| 724 | if ($orderShippingAddressEntity === null) { |
||
| 725 | return $orderTransfer; |
||
| 726 | } |
||
| 727 | |||
| 728 | $shippingAddressTransfer = $this->getFactory() |
||
| 729 | ->createSalesOrderAddressMapper() |
||
| 730 | ->mapAddressEntityToAddressTransfer(new AddressTransfer(), $orderShippingAddressEntity); |
||
| 731 | |||
| 732 | $orderTransfer->setShippingAddress($shippingAddressTransfer); |
||
| 733 | |||
| 734 | return $orderTransfer; |
||
| 735 | } |
||
| 736 | |||
| 737 | /** |
||
| 738 | * @param \Orm\Zed\Sales\Persistence\SpySalesOrder $orderEntity |
||
| 739 | * @param \Generated\Shared\Transfer\OrderTransfer $orderTransfer |
||
| 740 | * |
||
| 741 | * @return \Generated\Shared\Transfer\OrderTransfer |
||
| 742 | */ |
||
| 743 | protected function setOrderExpenses(SpySalesOrder $orderEntity, OrderTransfer $orderTransfer): OrderTransfer |
||
| 744 | { |
||
| 745 | foreach ($orderEntity->getExpenses(new Criteria()) as $expenseEntity) { |
||
| 746 | $expenseTransfer = $this->getFactory() |
||
| 747 | ->createSalesExpenseMapper() |
||
| 748 | ->mapExpenseEntityToSalesExpenseTransfer(new ExpenseTransfer(), $expenseEntity); |
||
| 749 | |||
| 750 | $orderTransfer->addExpense($expenseTransfer); |
||
| 751 | } |
||
| 752 | |||
| 753 | return $orderTransfer; |
||
| 754 | } |
||
| 755 | |||
| 756 | /** |
||
| 757 | * @param \Orm\Zed\Sales\Persistence\SpySalesOrder $orderEntity |
||
| 758 | * @param \Generated\Shared\Transfer\OrderTransfer $orderTransfer |
||
| 759 | * |
||
| 760 | * @return \Generated\Shared\Transfer\OrderTransfer |
||
| 761 | */ |
||
| 762 | protected function setMissingCustomer(SpySalesOrder $orderEntity, OrderTransfer $orderTransfer): OrderTransfer |
||
| 770 | } |
||
| 771 | |||
| 772 | /** |
||
| 773 | * @param \Orm\Zed\Sales\Persistence\SpySalesOrderQuery $salesOrderQuery |
||
| 774 | * @param \Generated\Shared\Transfer\OrderCriteriaTransfer $orderCriteriaTransfer |
||
| 775 | * |
||
| 776 | * @return \Orm\Zed\Sales\Persistence\SpySalesOrderQuery |
||
| 777 | */ |
||
| 778 | protected function applySalesOrderFilters( |
||
| 800 | } |
||
| 801 | |||
| 802 | /** |
||
| 803 | * @param \Propel\Runtime\ActiveQuery\ModelCriteria $modelCriteria |
||
| 804 | * @param \ArrayObject<array-key, \Generated\Shared\Transfer\SortTransfer> $sortTransfers |
||
| 805 | * |
||
| 806 | * @return \Propel\Runtime\ActiveQuery\ModelCriteria |
||
| 807 | */ |
||
| 808 | protected function applySorting( |
||
| 820 | } |
||
| 821 | |||
| 822 | /** |
||
| 823 | * @param \Propel\Runtime\ActiveQuery\ModelCriteria $modelCriteria |
||
| 824 | * @param \Generated\Shared\Transfer\PaginationTransfer $paginationTransfer |
||
| 825 | * |
||
| 826 | * @return \Propel\Runtime\ActiveQuery\ModelCriteria |
||
| 827 | */ |
||
| 828 | protected function applyPagination( |
||
| 829 | ModelCriteria $modelCriteria, |
||
| 830 | PaginationTransfer $paginationTransfer |
||
| 831 | ): ModelCriteria { |
||
| 832 | if ($paginationTransfer->getOffset() !== null && $paginationTransfer->getLimit() !== null) { |
||
| 833 | $paginationTransfer->setNbResults($modelCriteria->count()); |
||
| 834 | |||
| 835 | return $modelCriteria |
||
| 836 | ->offset($paginationTransfer->getOffsetOrFail()) |
||
| 837 | ->setLimit($paginationTransfer->getLimitOrFail()); |
||
| 838 | } |
||
| 839 | |||
| 840 | if ($paginationTransfer->getPage() !== null && $paginationTransfer->getMaxPerPage()) { |
||
| 841 | $propelModelPager = $modelCriteria->paginate( |
||
| 842 | $paginationTransfer->getPageOrFail(), |
||
| 843 | $paginationTransfer->getMaxPerPageOrFail(), |
||
| 844 | ); |
||
| 845 | |||
| 846 | $paginationTransfer->setNbResults($propelModelPager->getNbResults()) |
||
| 847 | ->setFirstIndex($propelModelPager->getFirstIndex()) |
||
| 848 | ->setLastIndex($propelModelPager->getLastIndex()) |
||
| 849 | ->setFirstPage($propelModelPager->getFirstPage()) |
||
| 850 | ->setLastPage($propelModelPager->getLastPage()) |
||
| 851 | ->setNextPage($propelModelPager->getNextPage()) |
||
| 852 | ->setPreviousPage($propelModelPager->getPreviousPage()); |
||
| 853 | |||
| 854 | return $propelModelPager->getQuery(); |
||
| 855 | } |
||
| 856 | |||
| 857 | return $modelCriteria; |
||
| 858 | } |
||
| 859 | |||
| 860 | /** |
||
| 861 | * @param array<int, \Orm\Zed\Sales\Persistence\SpySalesOrder> $salesOrderEntitiesIndexedByIdSalesOrder |
||
| 862 | * |
||
| 863 | * @return array<int, \Orm\Zed\Sales\Persistence\SpySalesOrder> |
||
| 864 | */ |
||
| 865 | protected function expandSalesOrdersWithSalesOrderItems(array $salesOrderEntitiesIndexedByIdSalesOrder): array |
||
| 882 | } |
||
| 883 | |||
| 884 | /** |
||
| 885 | * @param array<int, \Orm\Zed\Sales\Persistence\SpySalesOrder> $salesOrderEntitiesIndexedByIdSalesOrder |
||
| 886 | * |
||
| 887 | * @return array<int, \Orm\Zed\Sales\Persistence\SpySalesOrder> |
||
| 888 | */ |
||
| 889 | protected function expandSalesOrdersWithSalesExpenses(array $salesOrderEntitiesIndexedByIdSalesOrder): array |
||
| 906 | } |
||
| 907 | |||
| 908 | /** |
||
| 909 | * @param \Orm\Zed\Sales\Persistence\SpySalesExpenseQuery $salesExpenseQuery |
||
| 910 | * @param \Generated\Shared\Transfer\SalesExpenseCollectionDeleteCriteriaTransfer $salesExpenseCollectionDeleteCriteriaTransfer |
||
| 911 | * |
||
| 912 | * @return \Orm\Zed\Sales\Persistence\SpySalesExpenseQuery |
||
| 913 | */ |
||
| 914 | protected function appySalesExpenseCollectionDeleteCriteriaFilters( |
||
| 927 | } |
||
| 928 | } |
||
| 929 |
