vendor/shopware/core/Checkout/Order/OrderEntity.php line 27

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Checkout\Order;
  5. use Shopware\Core\Checkout\Cart\Price\Struct\CalculatedPrice;
  6. use Shopware\Core\Checkout\Cart\Price\Struct\CartPrice;
  7. use Shopware\Core\Checkout\Document\DocumentCollection;
  8. use Shopware\Core\Checkout\Order\Aggregate\OrderAddress\OrderAddressCollection;
  9. use Shopware\Core\Checkout\Order\Aggregate\OrderAddress\OrderAddressEntity;
  10. use Shopware\Core\Checkout\Order\Aggregate\OrderCustomer\OrderCustomerEntity;
  11. use Shopware\Core\Checkout\Order\Aggregate\OrderDelivery\OrderDeliveryCollection;
  12. use Shopware\Core\Checkout\Order\Aggregate\OrderLineItem\OrderLineItemCollection;
  13. use Shopware\Core\Checkout\Order\Aggregate\OrderTransaction\OrderTransactionCollection;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Entity;
  15. use Shopware\Core\Framework\DataAbstractionLayer\EntityCustomFieldsTrait;
  16. use Shopware\Core\Framework\DataAbstractionLayer\EntityIdTrait;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Pricing\CashRoundingConfig;
  18. use Shopware\Core\Framework\Log\Package;
  19. use Shopware\Core\System\Currency\CurrencyEntity;
  20. use Shopware\Core\System\Language\LanguageEntity;
  21. use Shopware\Core\System\SalesChannel\SalesChannelEntity;
  22. use Shopware\Core\System\StateMachine\Aggregation\StateMachineState\StateMachineStateEntity;
  23. use Shopware\Core\System\Tag\TagCollection;
  24. use Shopware\Core\System\User\UserEntity;
  26. #[Package('customer-order')]
  27. class OrderEntity extends Entity
  28. {
  29.     use EntityIdTrait;
  30.     use EntityCustomFieldsTrait;
  32.     /**
  33.      * @var string
  34.      */
  35.     protected $orderNumber;
  37.     /**
  38.      * @var string
  39.      */
  40.     protected $currencyId;
  42.     /**
  43.      * @var float
  44.      */
  45.     protected $currencyFactor;
  47.     /**
  48.      * @var string
  49.      */
  50.     protected $salesChannelId;
  52.     /**
  53.      * @var string
  54.      */
  55.     protected $billingAddressId;
  57.     /**
  58.      * @var \DateTimeInterface
  59.      */
  60.     protected $orderDateTime;
  62.     /**
  63.      * @var \DateTimeInterface
  64.      */
  65.     protected $orderDate;
  67.     /**
  68.      * @var CartPrice
  69.      */
  70.     protected $price;
  72.     /**
  73.      * @var float
  74.      */
  75.     protected $amountTotal;
  77.     /**
  78.      * @var float|null
  79.      */
  80.     protected $amountNet;
  82.     /**
  83.      * @var float
  84.      */
  85.     protected $positionPrice;
  87.     /**
  88.      * @var string
  89.      */
  90.     protected $taxStatus;
  92.     /**
  93.      * @var CalculatedPrice
  94.      */
  95.     protected $shippingCosts;
  97.     /**
  98.      * @var float
  99.      */
  100.     protected $shippingTotal;
  102.     /**
  103.      * @var OrderCustomerEntity|null
  104.      */
  105.     protected $orderCustomer;
  107.     /**
  108.      * @var CurrencyEntity|null
  109.      */
  110.     protected $currency;
  112.     /**
  113.      * @var string
  114.      */
  115.     protected $languageId;
  117.     /**
  118.      * @var LanguageEntity
  119.      */
  120.     protected $language;
  122.     /**
  123.      * @var SalesChannelEntity|null
  124.      */
  125.     protected $salesChannel;
  127.     /**
  128.      * @var OrderAddressCollection|null
  129.      */
  130.     protected $addresses;
  132.     /**
  133.      * @var OrderAddressEntity|null
  134.      */
  135.     protected $billingAddress;
  137.     /**
  138.      * @var OrderDeliveryCollection|null
  139.      */
  140.     protected $deliveries;
  142.     /**
  143.      * @var OrderLineItemCollection|null
  144.      */
  145.     protected $lineItems;
  147.     /**
  148.      * @var OrderTransactionCollection|null
  149.      */
  150.     protected $transactions;
  152.     /**
  153.      * @var string|null
  154.      */
  155.     protected $deepLinkCode;
  157.     /**
  158.      * @var int
  159.      */
  160.     protected $autoIncrement;
  162.     /**
  163.      * @var StateMachineStateEntity|null
  164.      */
  165.     protected $stateMachineState;
  167.     /**
  168.      * @var string
  169.      */
  170.     protected $stateId;
  172.     /**
  173.      * @var DocumentCollection|null
  174.      */
  175.     protected $documents;
  177.     /**
  178.      * @var TagCollection|null
  179.      */
  180.     protected $tags;
  182.     /**
  183.      * @var string|null
  184.      */
  185.     protected $affiliateCode;
  187.     /**
  188.      * @var string|null
  189.      */
  190.     protected $campaignCode;
  192.     /**
  193.      * @var string|null
  194.      */
  195.     protected $customerComment;
  197.     /**
  198.      * @var array<string>|null
  199.      */
  200.     protected $ruleIds = [];
  202.     /**
  203.      * @var string|null
  204.      */
  205.     protected $createdById;
  207.     /**
  208.      * @var UserEntity|null
  209.      */
  210.     protected $createdBy;
  212.     /**
  213.      * @var string|null
  214.      */
  215.     protected $updatedById;
  217.     /**
  218.      * @var UserEntity|null
  219.      */
  220.     protected $updatedBy;
  222.     /**
  223.      * @var CashRoundingConfig|null
  224.      */
  225.     protected $itemRounding;
  227.     /**
  228.      * @var CashRoundingConfig|null
  229.      */
  230.     protected $totalRounding;
  232.     public function getCurrencyId(): string
  233.     {
  234.         return $this->currencyId;
  235.     }
  237.     public function setCurrencyId(string $currencyId): void
  238.     {
  239.         $this->currencyId = $currencyId;
  240.     }
  242.     public function getCurrencyFactor(): float
  243.     {
  244.         return $this->currencyFactor;
  245.     }
  247.     public function setCurrencyFactor(float $currencyFactor): void
  248.     {
  249.         $this->currencyFactor = $currencyFactor;
  250.     }
  252.     public function getSalesChannelId(): string
  253.     {
  254.         return $this->salesChannelId;
  255.     }
  257.     public function setSalesChannelId(string $salesChannelId): void
  258.     {
  259.         $this->salesChannelId = $salesChannelId;
  260.     }
  262.     public function getBillingAddressId(): string
  263.     {
  264.         return $this->billingAddressId;
  265.     }
  267.     public function setBillingAddressId(string $billingAddressId): void
  268.     {
  269.         $this->billingAddressId = $billingAddressId;
  270.     }
  272.     public function getOrderDateTime(): \DateTimeInterface
  273.     {
  274.         return $this->orderDateTime;
  275.     }
  277.     public function setOrderDateTime(\DateTimeInterface $orderDateTime): void
  278.     {
  279.         $this->orderDateTime = $orderDateTime;
  280.     }
  282.     public function getOrderDate(): \DateTimeInterface
  283.     {
  284.         return $this->orderDate;
  285.     }
  287.     public function setOrderDate(\DateTimeInterface $orderDate): void
  288.     {
  289.         $this->orderDate = $orderDate;
  290.     }
  292.     public function getPrice(): CartPrice
  293.     {
  294.         return $this->price;
  295.     }
  297.     public function setPrice(CartPrice $price): void
  298.     {
  299.         $this->price = $price;
  300.     }
  302.     public function getAmountTotal(): float
  303.     {
  304.         return $this->amountTotal;
  305.     }
  307.     public function getAmountNet(): float
  308.     {
  309.         return $this->amountNet;
  310.     }
  312.     public function getPositionPrice(): float
  313.     {
  314.         return $this->positionPrice;
  315.     }
  317.     public function getTaxStatus(): string
  318.     {
  319.         return $this->taxStatus;
  320.     }
  322.     public function getShippingCosts(): CalculatedPrice
  323.     {
  324.         return $this->shippingCosts;
  325.     }
  327.     public function setShippingCosts(CalculatedPrice $shippingCosts): void
  328.     {
  329.         $this->shippingCosts = $shippingCosts;
  330.     }
  332.     public function getShippingTotal(): float
  333.     {
  334.         return $this->shippingTotal;
  335.     }
  337.     public function getOrderCustomer(): ?OrderCustomerEntity
  338.     {
  339.         return $this->orderCustomer;
  340.     }
  342.     public function setOrderCustomer(OrderCustomerEntity $orderCustomer): void
  343.     {
  344.         $this->orderCustomer = $orderCustomer;
  345.     }
  347.     public function getCurrency(): ?CurrencyEntity
  348.     {
  349.         return $this->currency;
  350.     }
  352.     public function setCurrency(CurrencyEntity $currency): void
  353.     {
  354.         $this->currency = $currency;
  355.     }
  357.     public function getLanguageId(): string
  358.     {
  359.         return $this->languageId;
  360.     }
  362.     public function setLanguageId(string $languageId): void
  363.     {
  364.         $this->languageId = $languageId;
  365.     }
  367.     public function getLanguage(): LanguageEntity
  368.     {
  369.         return $this->language;
  370.     }
  372.     public function setLanguage(LanguageEntity $language): void
  373.     {
  374.         $this->language = $language;
  375.     }
  377.     public function getSalesChannel(): ?SalesChannelEntity
  378.     {
  379.         return $this->salesChannel;
  380.     }
  382.     public function setSalesChannel(SalesChannelEntity $salesChannel): void
  383.     {
  384.         $this->salesChannel = $salesChannel;
  385.     }
  387.     public function getAddresses(): ?OrderAddressCollection
  388.     {
  389.         return $this->addresses;
  390.     }
  392.     public function setAddresses(OrderAddressCollection $addresses): void
  393.     {
  394.         $this->addresses = $addresses;
  395.     }
  397.     public function getDeliveries(): ?OrderDeliveryCollection
  398.     {
  399.         return $this->deliveries;
  400.     }
  402.     public function setDeliveries(OrderDeliveryCollection $deliveries): void
  403.     {
  404.         $this->deliveries = $deliveries;
  405.     }
  407.     public function getLineItems(): ?OrderLineItemCollection
  408.     {
  409.         return $this->lineItems;
  410.     }
  412.     public function setLineItems(OrderLineItemCollection $lineItems): void
  413.     {
  414.         $this->lineItems = $lineItems;
  415.     }
  417.     public function getTransactions(): ?OrderTransactionCollection
  418.     {
  419.         return $this->transactions;
  420.     }
  422.     public function setTransactions(OrderTransactionCollection $transactions): void
  423.     {
  424.         $this->transactions = $transactions;
  425.     }
  427.     public function getDeepLinkCode(): ?string
  428.     {
  429.         return $this->deepLinkCode;
  430.     }
  432.     public function setDeepLinkCode(string $deepLinkCode): void
  433.     {
  434.         $this->deepLinkCode = $deepLinkCode;
  435.     }
  437.     public function getAutoIncrement(): int
  438.     {
  439.         return $this->autoIncrement;
  440.     }
  442.     public function setAutoIncrement(int $autoIncrement): void
  443.     {
  444.         $this->autoIncrement = $autoIncrement;
  445.     }
  447.     public function getStateMachineState(): ?StateMachineStateEntity
  448.     {
  449.         return $this->stateMachineState;
  450.     }
  452.     public function setStateMachineState(StateMachineStateEntity $stateMachineState): void
  453.     {
  454.         $this->stateMachineState = $stateMachineState;
  455.     }
  457.     public function getStateId(): string
  458.     {
  459.         return $this->stateId;
  460.     }
  462.     public function setStateId(string $stateId): void
  463.     {
  464.         $this->stateId = $stateId;
  465.     }
  467.     public function setAmountTotal(float $amountTotal): void
  468.     {
  469.         $this->amountTotal = $amountTotal;
  470.     }
  472.     public function setAmountNet(float $amountNet): void
  473.     {
  474.         $this->amountNet = $amountNet;
  475.     }
  477.     public function setPositionPrice(float $positionPrice): void
  478.     {
  479.         $this->positionPrice = $positionPrice;
  480.     }
  482.     public function setTaxStatus(string $taxStatus): void
  483.     {
  484.         $this->taxStatus = $taxStatus;
  485.     }
  487.     public function setShippingTotal(float $shippingTotal): void
  488.     {
  489.         $this->shippingTotal = $shippingTotal;
  490.     }
  492.     public function getDocuments(): ?DocumentCollection
  493.     {
  494.         return $this->documents;
  495.     }
  497.     public function setDocuments(DocumentCollection $documents): void
  498.     {
  499.         $this->documents = $documents;
  500.     }
  502.     public function getOrderNumber(): ?string
  503.     {
  504.         return $this->orderNumber;
  505.     }
  507.     public function setOrderNumber(string $orderNumber): void
  508.     {
  509.         $this->orderNumber = $orderNumber;
  510.     }
  512.     public function getTags(): ?TagCollection
  513.     {
  514.         return $this->tags;
  515.     }
  517.     public function setTags(TagCollection $tags): void
  518.     {
  519.         $this->tags = $tags;
  520.     }
  522.     public function getNestedLineItems(): ?OrderLineItemCollection
  523.     {
  524.         $lineItems = $this->getLineItems();
  526.         if (!$lineItems) {
  527.             return null;
  528.         }
  530.         /** @var OrderLineItemCollection $roots */
  531.         $roots = $lineItems->filterByProperty('parentId', null);
  532.         $roots->sortByPosition();
  533.         $this->addChildren($lineItems, $roots);
  535.         return $roots;
  536.     }
  538.     public function getAffiliateCode(): ?string
  539.     {
  540.         return $this->affiliateCode;
  541.     }
  543.     public function setAffiliateCode(?string $affiliateCode): void
  544.     {
  545.         $this->affiliateCode = $affiliateCode;
  546.     }
  548.     public function getCampaignCode(): ?string
  549.     {
  550.         return $this->campaignCode;
  551.     }
  553.     public function setCampaignCode(?string $campaignCode): void
  554.     {
  555.         $this->campaignCode = $campaignCode;
  556.     }
  558.     public function getCustomerComment(): ?string
  559.     {
  560.         return $this->customerComment;
  561.     }
  563.     public function setCustomerComment(?string $customerComment): void
  564.     {
  565.         $this->customerComment = $customerComment;
  566.     }
  568.     public function getRuleIds(): ?array
  569.     {
  570.         return $this->ruleIds;
  571.     }
  573.     /**
  574.      * @param array<string>|null $ruleIds
  575.      */
  576.     public function setRuleIds(?array $ruleIds): void
  577.     {
  578.         $this->ruleIds = $ruleIds;
  579.     }
  581.     public function getBillingAddress(): ?OrderAddressEntity
  582.     {
  583.         return $this->billingAddress;
  584.     }
  586.     public function setBillingAddress(OrderAddressEntity $billingAddress): void
  587.     {
  588.         $this->billingAddress = $billingAddress;
  589.     }
  591.     public function getCreatedById(): ?string
  592.     {
  593.         return $this->createdById;
  594.     }
  596.     public function setCreatedById(string $createdById): void
  597.     {
  598.         $this->createdById = $createdById;
  599.     }
  601.     public function getCreatedBy(): ?UserEntity
  602.     {
  603.         return $this->createdBy;
  604.     }
  606.     public function setCreatedBy(UserEntity $createdBy): void
  607.     {
  608.         $this->createdBy = $createdBy;
  609.     }
  611.     public function getUpdatedById(): ?string
  612.     {
  613.         return $this->updatedById;
  614.     }
  616.     public function setUpdatedById(string $updatedById): void
  617.     {
  618.         $this->updatedById = $updatedById;
  619.     }
  621.     public function getUpdatedBy(): ?UserEntity
  622.     {
  623.         return $this->updatedBy;
  624.     }
  626.     public function setUpdatedBy(UserEntity $updatedBy): void
  627.     {
  628.         $this->updatedBy = $updatedBy;
  629.     }
  631.     public function getItemRounding(): ?CashRoundingConfig
  632.     {
  633.         return $this->itemRounding;
  634.     }
  636.     public function setItemRounding(?CashRoundingConfig $itemRounding): void
  637.     {
  638.         $this->itemRounding = $itemRounding;
  639.     }
  641.     public function getTotalRounding(): ?CashRoundingConfig
  642.     {
  643.         return $this->totalRounding;
  644.     }
  646.     public function setTotalRounding(?CashRoundingConfig $totalRounding): void
  647.     {
  648.         $this->totalRounding = $totalRounding;
  649.     }
  651.     private function addChildren(OrderLineItemCollection $lineItems, OrderLineItemCollection $parents): void
  652.     {
  653.         foreach ($parents as $parent) {
  654.             /** @var OrderLineItemCollection $children */
  655.             $children = $lineItems->filterByProperty('parentId', $parent->getId());
  656.             $children->sortByPosition();
  658.             $parent->setChildren($children);
  660.             $this->addChildren($lineItems, $children);
  661.         }
  662.     }
  663. }