src/Entity/Order.php line 28

  1. <?php
  3. namespace App\Entity;
  5. use App\Enum\UnitType;
  6. use App\Enum\AmountUnitType;
  7. use App\Enum\CustomerClass;
  8. use App\Enum\CustomerGeneralClass;
  9. use App\Enum\OrderCommissionable;
  10. use App\Enum\OrderStatus;
  11. use App\Entity\OrderType;
  12. use App\Enum\State;
  13. use App\Repository\OrderRepository;
  14. use Doctrine\Common\Collections\ArrayCollection;
  15. use Doctrine\Common\Collections\Collection;
  16. use Doctrine\DBAL\Types\Types;
  17. use Doctrine\ORM\Mapping as ORM;
  18. use Gedmo\Timestampable\Traits\TimestampableEntity;
  20. #[ORM\Entity(repositoryClass: OrderRepository::class)]
  21. #[ORM\Table(name: '`order`')]
  22. #[ORM\Index(columns: ['invoice_number'], name: 'invoice_number_idx')]
  23. #[ORM\Index(columns: ['order_code', 'item_code'], name: 'order_code_item_code_idx')]
  24. #[ORM\Index(columns: ['user_payment_period_id', 'customer_general_class'], name: 'upp_customer_general_class_idx')]
  25. #[ORM\Index(columns: ['incentive_date'], name: 'order_incentive_date')]
  26. #[ORM\Index(columns: ['user_id'], name: 'order_user_id')]
  28. class Order
  29. {
  30.     use TimestampableEntity;
  31.     #[ORM\Id]
  32.     #[ORM\GeneratedValue]
  33.     #[ORM\Column]
  34.     private ?int $id = null;
  36.     #[ORM\Column(type: Types::DATE_MUTABLE, nullable: true)]
  37.     private ?\DateTimeInterface $incentiveDate = null;
  39.     #[ORM\Column(length: 255, nullable: true)]
  40.     private ?string $batchName = null;
  42.     #[ORM\Column(nullable: true)]
  43.     private ?float $amount = null;
  45.     #[ORM\Column(nullable: true)]
  46.     private ?AmountUnitType $amountUnitType = null;
  48.     #[ORM\Column(type: Types::DATETIME_MUTABLE, nullable: true)]
  49.     private ?\DateTimeInterface $statusDate = null;
  51.     #[ORM\Column(type: Types::DATETIME_MUTABLE, nullable: true)]
  52.     private ?\DateTimeInterface $createdDate = null;
  54.     #[ORM\Column(length: 255, nullable: true)]
  55.     private ?string $customerName = null;
  57.     #[ORM\Column(length: 255, nullable: true)]
  58.     private ?CustomerClass $customerSalesClass = null;
  60.     #[ORM\Column(type: Types::TEXT, nullable: true)]
  61.     private ?string $description = null;
  63.     #[ORM\Column(nullable: true)]
  64.     private ?int $discount = null;
  67.     #[ORM\Column(nullable: true)]
  68.     private ?int $quantity = 1;
  70.     #[ORM\Column(length: 255, nullable: true)]
  71.     private ?string $relatedItemCode = null;
  73.     #[ORM\Column(length: 255, nullable: true)]
  74.     private ?string $relatedOrderCode = null;
  77.     #[ORM\Column(nullable: true)]
  78.     private ?int $shipToNumber = null;
  80.     #[ORM\Column(length: 255, nullable: true)]
  81.     private ?State $shipToState = null;
  83.     #[ORM\Column(length: 255, nullable: true)]
  84.     private ?string $shipToZip = null;
  86.     #[ORM\Column(length: 255, nullable: true)]
  87.     private ?string $invoiceNumber = null;
  89.     #[ORM\Column(type: Types::DATE_MUTABLE, nullable: true)]
  90.     private ?\DateTimeInterface $invoiceDate = null;
  91.     #[ORM\Column(length: 255, nullable: true)]
  92.     private ?string $orderRefNumber = null;
  95.     #[ORM\Column(length: 255, nullable: true)]
  96.     private ?string $independentRepNumber = null;
  98.     #[ORM\Column(nullable: true)]
  99.     private ?float $commissionRatePercent = null;
  102.     #[ORM\ManyToOne(fetch: "EAGER")]
  103.     private ?User $user = null;
  105.     #[ORM\Column]
  106.     private ?int $splitPercent = 0;
  108.     #[ORM\Column]
  109.     private bool $isCommissionable = true;
  111.     #[ORM\Column(length: 255, nullable: true)]
  112.     private ?string $customerEmployeeRepCode = null;
  114.     #[ORM\ManyToOne(cascade: ['REMOVE'], inversedBy: 'orders')]
  115.     private ?UserPaymentPeriod $userPaymentPeriod = null;
  117.     #[ORM\Column(length: 255, nullable: true)]
  118.     private ?CustomerGeneralClass $customerGeneralClass = null;
  120.     #[ORM\Column(length: 255, nullable: true)]
  121.     private ?string $employeeRepCode = null;
  123.     #[ORM\Column(length: 255, nullable: true)]
  124.     private ?UnitType $commissionRateUnitType = null;
  126.     #[ORM\Column(length: 255, nullable: true)]
  127.     private ?string $orderCode = null;
  129.     #[ORM\Column(length: 255, nullable: true)]
  130.     private ?string $itemCode = null;
  132.     #[ORM\ManyToOne(inversedBy: 'orders')]
  133.     private ?Period $period = null;
  135.     #[ORM\ManyToOne(inversedBy: 'orders', fetch: "EAGER")]
  136.     private ?Customer $customer = null;
  138.     #[ORM\Column(length: 255, nullable: true)]
  139.     private ?string $customerNumber = null;
  141.     #[ORM\ManyToOne(inversedBy: 'orders', fetch: "EAGER")]
  142.     private ?OrderType $orderType = null;
  144.     #[ORM\ManyToOne(inversedBy: 'orders', fetch: "EAGER")]
  145.     private ?BatchType $batchType = null;
  147.     #[ORM\OneToMany(mappedBy: 'orderItem', targetEntity: Commission::class, cascade: ['persist', 'remove'])]
  148.     #[ORM\OrderBy(['user' => 'ASC'])]
  149.     private Collection $commissions;
  151.     #[ORM\OneToMany(mappedBy: 'orderItem', targetEntity: Credit::class, cascade: ['persist', 'remove'])]
  152.     #[ORM\OrderBy(['user' => 'ASC'])]
  153.     private Collection $credits;
  155.     #[ORM\Column(length: 255)]
  156.     private ?OrderStatus $status = OrderStatus::NEW;
  158.     #[ORM\OneToMany(mappedBy: 'orderItem', targetEntity: OrderAssignment::class, cascade: ['persist', 'remove'])]
  159.     private Collection $orderAssignments;
  161.     #[ORM\Column(length: 255, nullable: true)]
  162.     private ?string $customerNumber2 = null;
  164.     #[ORM\Column(length: 255, nullable: true)]
  165.     private ?string $customerNumberTruncated = null;
  167.     #[ORM\ManyToOne(inversedBy: 'orders')]
  168.     private ?ImportFile $importFile = null;
  170.     #[ORM\Column]
  171.     private ?bool $rollable = true;
  173.     #[ORM\Column]
  174.     private ?bool $manual = false;
  176.     public function __construct()
  177.     {
  178.         $this->commissions = new ArrayCollection();
  179.         $this->credits = new ArrayCollection();
  180.         $this->orderAssignments = new ArrayCollection();
  181.     }
  183.     public function setId($id): ?int
  184.     {
  185.         return $this->id = $id;
  186.     }
  188.     public function getId(): ?int
  189.     {
  190.         return $this->id;
  191.     }
  193.     public function getIncentiveDate(): ?\DateTimeInterface
  194.     {
  195.         return $this->incentiveDate;
  196.     }
  198.     public function setIncentiveDate(?\DateTimeInterface $incentiveDate): self
  199.     {
  200.         $this->incentiveDate = $incentiveDate;
  202.         return $this;
  203.     }
  205.     public function getBatchName(): ?string
  206.     {
  207.         return $this->batchName;
  208.     }
  210.     public function setBatchName(?string $batchName): self
  211.     {
  212.         $this->batchName = $batchName;
  214.         return $this;
  215.     }
  219.     public function getDividedAmount(): ?float
  220.     {
  221.         return ($this->amount ?: 0) / 100.00;
  222.     }
  224.     public function getAmount(): ?float
  225.     {
  226.         return $this->amount;
  227.     }
  229.     public function setAmount(?float $amount): self
  230.     {
  231.         $this->amount = $amount;
  233.         return $this;
  234.     }
  236.     public function getAmountUnitType() : ?AmountUnitType
  237.     {
  238.         return $this->amountUnitType;
  239.     }
  241.     public function getAmountUnitTypeString() : string
  242.     {
  243.        return $this->amountUnitType?->value ?: 'USD';
  244.     }
  246.     public function setAmountUnitType(?AmountUnitType $amountUnitType): self
  247.     {
  248.         $this->amountUnitType = $amountUnitType;
  250.         return $this;
  251.     }
  255.     public function getStatusDate(): ?\DateTimeInterface
  256.     {
  257.         return $this->statusDate;
  258.     }
  260.     public function setStatusDate(?\DateTimeInterface $statusDate): self
  261.     {
  262.         $this->statusDate = $statusDate;
  264.         return $this;
  265.     }
  267.     public function getCreatedDate(): ?\DateTimeInterface
  268.     {
  269.         return $this->createdDate;
  270.     }
  272.     public function setCreatedDate(?\DateTimeInterface $createdDate): self
  273.     {
  274.         $this->createdDate = $createdDate;
  276.         return $this;
  277.     }
  279.     public function getCustomerName(): ?string
  280.     {
  281.         return $this->customerName;
  282.     }
  284.     public function setCustomerName(?string $customerName): self
  285.     {
  286.         $this->customerName = $customerName;
  288.         return $this;
  289.     }
  291.     public function getDescription(): ?string
  292.     {
  293.         return $this->description;
  294.     }
  296.     public function setDescription(?string $description): self
  297.     {
  298.         $this->description = $description;
  300.         return $this;
  301.     }
  303.     public function getDiscount(): ?int
  304.     {
  305.         return $this->discount;
  306.     }
  308.     public function setDiscount(?int $discount): self
  309.     {
  310.         $this->discount = $discount;
  312.         return $this;
  313.     }
  316.     public function getQuantity(): ?int
  317.     {
  318.         return $this->quantity;
  319.     }
  321.     public function setQuantity(?int $quantity): self
  322.     {
  323.         $this->quantity = $quantity;
  325.         return $this;
  326.     }
  328.     public function getRelatedItemCode(): ?string
  329.     {
  330.         return $this->relatedItemCode;
  331.     }
  333.     public function setRelatedItemCode(?string $relatedItemCode): self
  334.     {
  335.         $this->relatedItemCode = $relatedItemCode;
  337.         return $this;
  338.     }
  340.     public function getRelatedOrderCode(): ?string
  341.     {
  342.         return $this->relatedOrderCode;
  343.     }
  345.     public function setRelatedOrderCode(?string $relatedOrderCode): self
  346.     {
  347.         $this->relatedOrderCode = $relatedOrderCode;
  349.         return $this;
  350.     }
  354.     public function getShipToNumber(): ?int
  355.     {
  356.         return $this->shipToNumber;
  357.     }
  359.     public function setShipToNumber(?int $shipToNumber): self
  360.     {
  361.         $this->shipToNumber = $shipToNumber;
  363.         return $this;
  364.     }
  366.     public function getShipToState(): ?string
  367.     {
  368.         return $this->shipToState?->value ?: '';
  369.     }
  371.     public function setShipToState(?State $shipToState): self
  372.     {
  373.         $this->shipToState = $shipToState;
  375.         return $this;
  376.     }
  378.     public function getShipToZip(): ?string
  379.     {
  380.         return $this->shipToZip;
  381.     }
  383.     public function setShipToZip(?string $shipToZip): self
  384.     {
  385.         $this->shipToZip = $shipToZip;
  387.         return $this;
  388.     }
  390.     public function getInvoiceNumber(): ?string
  391.     {
  392.         return $this->invoiceNumber;
  393.     }
  395.     public function setInvoiceNumber(?string $invoiceNumber): self
  396.     {
  397.         $this->invoiceNumber = $invoiceNumber;
  399.         return $this;
  400.     }
  402.     public function getOrderRefNumber(): ?string
  403.     {
  404.         return $this->orderRefNumber;
  405.     }
  407.     public function setOrderRefNumber(?string $orderRefNumber): self
  408.     {
  409.         $this->orderRefNumber = $orderRefNumber;
  411.         return $this;
  412.     }
  414.     public function getCustomerSalesClass(): ?CustomerClass
  415.     {
  416.         return $this->customerSalesClass;
  417.     }
  419.     public function setCustomerSalesClass(?CustomerClass $customerSalesClass): self
  420.     {
  421.         $this->customerSalesClass = $customerSalesClass;
  423.         $general = null;
  424.         if ($customerSalesClass) {
  425.             if ($customerSalesClass == CustomerClass::TM_OTG) {
  426.                 $general = CustomerGeneralClass::OTG;
  427.             } else {
  428.                 $general = CustomerGeneralClass::from($customerSalesClass->value);
  429.             }
  430.         }
  431.         $this->setCustomerGeneralClass($general);
  433.         return $this;
  434.     }
  436.     public function getIndependentRepNumber(): ?string
  437.     {
  438.         return $this->independentRepNumber;
  439.     }
  441.     public function setIndependentRepNumber(?string $independentRepNumber): self
  442.     {
  443.         $this->independentRepNumber = $independentRepNumber;
  445.         return $this;
  446.     }
  448.     public function getCommissionRatePercent(): ?float
  449.     {
  450.         return $this->commissionRatePercent;
  451.     }
  453.     public function setCommissionRatePercent(?float $commissionRatePercent): self
  454.     {
  455.         $this->commissionRatePercent = $commissionRatePercent;
  457.         return $this;
  458.     }
  460.     public function getInvoiceDate(): ?\DateTimeInterface
  461.     {
  462.         return $this->invoiceDate;
  463.     }
  465.     public function setInvoiceDate(?\DateTimeInterface $invoiceDate): self
  466.     {
  467.         $this->invoiceDate = $invoiceDate;
  469.         return $this;
  470.     }
  473.     public function getUser(): ?User
  474.     {
  475.         return $this->user;
  476.     }
  478.     public function setUser(?User $user): self
  479.     {
  480.         $this->user = $user;
  482.         return $this;
  483.     }
  485.     public function getSplitPercent(): ?int
  486.     {
  487.         return $this->splitPercent;
  488.     }
  490.     public function setSplitPercent(?int $splitPercent): self
  491.     {
  492.         $this->splitPercent = $splitPercent;
  494.         return $this;
  495.     }
  497.     public function getIsCommissionable(): bool
  498.     {
  499.         return $this->isCommissionable;
  500.     }
  502.     public function setIsCommissionable(bool $isCommissionable): self
  503.     {
  504.         $this->isCommissionable = $isCommissionable;
  506.         return $this;
  507.     }
  509.     public function getCustomerEmployeeRepCode(): ?string
  510.     {
  511.         return $this->customerEmployeeRepCode;
  512.     }
  514.     public function setCustomerEmployeeRepCode(?string $customerEmployeeRepCode): self
  515.     {
  516.         $this->customerEmployeeRepCode = $customerEmployeeRepCode;
  518.         return $this;
  519.     }
  521.     public function getUserPaymentPeriod(): ?UserPaymentPeriod
  522.     {
  523.         return $this->userPaymentPeriod;
  524.     }
  526.     public function setUserPaymentPeriod(?UserPaymentPeriod $userPaymentPeriod): self
  527.     {
  528.         $this->userPaymentPeriod = $userPaymentPeriod;
  530.         return $this;
  531.     }
  533.     public function getCustomerGeneralClass(): ?CustomerGeneralClass
  534.     {
  535.         return $this->customerGeneralClass;
  536.     }
  538.     public function setCustomerGeneralClass(?CustomerGeneralClass $customerGeneralClass): self
  539.     {
  540.         $this->customerGeneralClass = $customerGeneralClass;
  542.         return $this;
  543.     }
  545.     public function getEmployeeRepCode(): ?string
  546.     {
  547.         return $this->employeeRepCode;
  548.     }
  550.     public function setEmployeeRepCode(?string $employeeRepCode): self
  551.     {
  552.         $this->employeeRepCode = $employeeRepCode;
  554.         return $this;
  555.     }
  557.     public function getCommissionRateUnitType(): ?UnitType
  558.     {
  559.         return $this->commissionRateUnitType;
  560.     }
  562.     public function setCommissionRateUnitType(?UnitType $commissionRateUnitType): self
  563.     {
  564.         $this->commissionRateUnitType = $commissionRateUnitType;
  566.         return $this;
  567.     }
  569.     public function getOrderCode(): ?string
  570.     {
  571.         return $this->orderCode;
  572.     }
  574.     public function setOrderCode(?string $orderCode): self
  575.     {
  576.         $this->orderCode = $orderCode;
  578.         return $this;
  579.     }
  581.     public function getItemCode(): ?string
  582.     {
  583.         return $this->itemCode;
  584.     }
  586.     public function setItemCode(?string $itemCode): self
  587.     {
  588.         $this->itemCode = $itemCode;
  590.         return $this;
  591.     }
  593.     public function getPeriod(): ?Period
  594.     {
  595.         return $this->period;
  596.     }
  598.     public function setPeriod(?Period $period): self
  599.     {
  600.         $this->period = $period;
  602.         return $this;
  603.     }
  605.     public function getCustomer(): ?Customer
  606.     {
  607.         return $this->customer;
  608.     }
  610.     public function setCustomer(?Customer $customer): self
  611.     {
  612.         $this->customer = $customer;
  614.         return $this;
  615.     }
  617.     public function getCustomerNumber(): ?string
  618.     {
  619.         return $this->customerNumber;
  620.     }
  622.     public function setCustomerNumber(?string $customerNumber): self
  623.     {
  624.         $this->customerNumber = $customerNumber;
  626.         return $this;
  627.     }
  629.     public function getOrderType(): ?OrderType
  630.     {
  631.         return $this->orderType;
  632.     }
  634.     public function setOrderType(?OrderType $orderType): self
  635.     {
  636.         $this->orderType = $orderType;
  638.         return $this;
  639.     }
  641.     public function getBatchType(): ?BatchType
  642.     {
  643.         return $this->batchType;
  644.     }
  646.     public function setBatchType(?BatchType $batchType): self
  647.     {
  648.         $this->batchType = $batchType;
  650.         return $this;
  651.     }
  653.     /**
  654.      * @return Collection<int, Commission>
  655.      */
  656.     public function getCommissions(): Collection
  657.     {
  658.         return $this->commissions;
  659.     }
  662.     public function getXactlyCommissions(): Collection
  663.     {
  664.         return $this->commissions->filter(function (Commission $commission) {
  665.             return !$commission->isL6();
  666.         });
  667.     }
  668.     /**
  669.      * @return Collection<int, Credit>
  670.      */
  671.     public function getL6Commissions(): Collection
  672.     {
  673.         return $this->commissions->filter(function (Commission $commission) {
  674.             return $commission->isL6();
  675.         });
  676.     }
  678.     public function addCommission(Commission $commission): static
  679.     {
  680.         if (!$this->commissions->contains($commission)) {
  681.             $this->commissions->add($commission);
  682.             $commission->setOrderItem($this);
  683.         }
  685.         return $this;
  686.     }
  688.     public function removeCommission(Commission $commission): static
  689.     {
  690.         if ($this->commissions->removeElement($commission)) {
  691.             // set the owning side to null (unless already changed)
  692.             if ($commission->getOrderItem() === $this) {
  693.                 $commission->setOrderItem(null);
  694.             }
  695.         }
  697.         return $this;
  698.     }
  700.     /**
  701.      * @return Collection<int, Credit>
  702.      */
  703.     public function getCredits(): Collection
  704.     {
  705.         return $this->credits;
  706.     }
  707.     /**
  708.      * @return Collection<int, Credit>
  709.      */
  710.     public function getXactlyCredits(): Collection
  711.     {
  712.         return $this->credits->filter(function (Credit $credit) {
  713.             return !$credit->isL6();
  714.         });
  715.     }
  716.     /**
  717.      * @return Collection<int, Credit>
  718.      */
  719.     public function getL6Credits(): Collection
  720.     {
  721.         return $this->credits->filter(function (Credit $credit) {
  722.             return $credit->isL6();
  723.         });
  724.     }
  726.     public function addCredit(Credit $credit): static
  727.     {
  728.         if (!$this->credits->contains($credit)) {
  729.             $this->credits->add($credit);
  730.             $credit->setOrderItem($this);
  731.         }
  733.         return $this;
  734.     }
  736.     public function removeCredit(Credit $credit): static
  737.     {
  738.         if ($this->credits->removeElement($credit)) {
  739.             // set the owning side to null (unless already changed)
  740.             if ($credit->getOrderItem() === $this) {
  741.                 $credit->setOrderItem(null);
  742.             }
  743.         }
  745.         return $this;
  746.     }
  748.     public function getStatus(): ?OrderStatus
  749.     {
  750.         return $this->status;
  751.     }
  753.     public function setStatus(OrderStatus $status): static
  754.     {
  755.         $this->status = $status;
  757.         $this->statusDate = new \DateTime('now', new \DateTimeZone('UTC'));
  759.         return $this;
  760.     }
  762.     /**
  763.      * @return Collection<int, OrderAssignment>
  764.      */
  765.     public function getOrderAssignments(): Collection
  766.     {
  767.         return $this->orderAssignments;
  768.     }
  770.     public function addOrderAssignment(OrderAssignment $orderAssignment): static
  771.     {
  772.         if (!$this->orderAssignments->contains($orderAssignment)) {
  773.             $this->orderAssignments->add($orderAssignment);
  774.             $orderAssignment->setOrderItem($this);
  775.         }
  777.         return $this;
  778.     }
  780.     public function removeOrderAssignment(OrderAssignment $orderAssignment): static
  781.     {
  782.         if ($this->orderAssignments->removeElement($orderAssignment)) {
  783.             // set the owning side to null (unless already changed)
  784.             if ($orderAssignment->getOrderItem() === $this) {
  785.                 $orderAssignment->setOrderItem(null);
  786.             }
  787.         }
  789.         return $this;
  790.     }
  792.     public function getCustomerNumber2(): ?string
  793.     {
  794.         return $this->customerNumber2;
  795.     }
  797.     public function setCustomerNumber2(?string $customerNumber2): static
  798.     {
  799.         $this->customerNumber2 = $customerNumber2;
  801.         return $this;
  802.     }
  804.     public function getCustomerNumberTruncated(): ?string
  805.     {
  806.         return $this->customerNumberTruncated;
  807.     }
  809.     public function setCustomerNumberTruncated(?string $customerNumberTruncated): static
  810.     {
  811.         $this->customerNumberTruncated = $customerNumberTruncated;
  813.         return $this;
  814.     }
  816.     public function getImportFile(): ?ImportFile
  817.     {
  818.         return $this->importFile;
  819.     }
  821.     public function setImportFile(?ImportFile $importFile): static
  822.     {
  823.         $this->importFile = $importFile;
  825.         return $this;
  826.     }
  828.     public function __toString(): string
  829.     {
  830.         return sprintf('%s - %s', $this->getOrderCode(), $this->getItemCode());
  831.     }
  833.     public function isRollable(): ?bool
  834.     {
  835.         return $this->rollable;
  836.     }
  838.     public function setRollable(bool $rollable): static
  839.     {
  840.         $this->rollable = $rollable;
  842.         return $this;
  843.     }
  845.     public function isManual(): ?bool
  846.     {
  847.         return $this->manual;
  848.     }
  850.     public function setManual(bool $manual): static
  851.     {
  852.         $this->manual = $manual;
  854.         return $this;
  855.     }
  856. }