src/Entity/SalesReturn.php line 16

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Enum\ReturnStatus;
  6. use App\Enum\ReturnType;
  7. use App\Repository\SalesReturnRepository;
  8. use Doctrine\Common\Collections\ArrayCollection;
  9. use Doctrine\Common\Collections\Collection;
  10. use Doctrine\DBAL\Types\Types;
  11. use Doctrine\ORM\Mapping as ORM;
  13. #[ORM\Entity(repositoryClass: SalesReturnRepository::class)]
  14. #[ORM\Table(name: 'sales_return')]
  15. #[ORM\HasLifecycleCallbacks]
  16. class SalesReturn extends BaseEntity
  17. {
  18.     #[ORM\Id]
  19.     #[ORM\GeneratedValue]
  20.     #[ORM\Column(type: 'integer')]
  21.     private ?int $id = null;
  23.     #[ORM\Column(length: 32, unique: true)]
  24.     private ?string $referenceNumber = null;
  26.     #[ORM\ManyToOne(targetEntity: Sales::class, inversedBy: 'returns')]
  27.     #[ORM\JoinColumn(nullable: false, onDelete: 'CASCADE')]
  28.     private ?Sales $sale = null;
  30.     #[ORM\ManyToOne(targetEntity: Customer::class)]
  31.     #[ORM\JoinColumn(nullable: false, onDelete: 'CASCADE')]
  32.     private ?Customer $customer = null;
  34.     #[ORM\Column(length: 32, enumType: ReturnType::class)]
  35.     private ReturnType $type = ReturnType::PARTIAL_RETURN;
  37.     #[ORM\Column(length: 32, enumType: ReturnStatus::class)]
  38.     private ReturnStatus $status = ReturnStatus::REQUESTED;
  40.     #[ORM\Column(type: 'datetime_immutable')]
  41.     private \DateTimeImmutable $requestedAt;
  43.     #[ORM\Column(type: 'datetime_immutable', nullable: true)]
  44.     private ?\DateTimeImmutable $processedAt = null;
  46.     #[ORM\ManyToOne(targetEntity: User::class)]
  47.     #[ORM\JoinColumn(nullable: true, onDelete: 'SET NULL')]
  48.     private ?User $processedBy = null;
  50.     #[ORM\Column(type: Types::TEXT, nullable: true)]
  51.     private ?string $notes = null;
  53.     #[ORM\OneToMany(mappedBy: 'salesReturn', targetEntity: SalesReturnItem::class, cascade: ['persist'], orphanRemoval: true)]
  54.     private Collection $items;
  56.     #[ORM\OneToMany(mappedBy: 'salesReturn', targetEntity: ReturnReplacementItem::class, cascade: ['persist'], orphanRemoval: true)]
  57.     private Collection $replacements;
  59.     public function __construct()
  60.     {
  61.         $this->requestedAt = new \DateTimeImmutable('now');
  62.         $this->items = new ArrayCollection();
  63.         $this->replacements = new ArrayCollection();
  64.     }
  66.     public function getId(): ?int
  67.     {
  68.         return $this->id;
  69.     }
  71.     public function getReferenceNumber(): ?string
  72.     {
  73.         return $this->referenceNumber;
  74.     }
  76.     public function setReferenceNumber(string $referenceNumber): self
  77.     {
  78.         $this->referenceNumber = $referenceNumber;
  80.         return $this;
  81.     }
  83.     public function getSale(): ?Sales
  84.     {
  85.         return $this->sale;
  86.     }
  88.     public function setSale(Sales $sale): self
  89.     {
  90.         $this->sale = $sale;
  92.         return $this;
  93.     }
  95.     public function getCustomer(): ?Customer
  96.     {
  97.         return $this->customer;
  98.     }
  100.     public function setCustomer(Customer $customer): self
  101.     {
  102.         $this->customer = $customer;
  104.         return $this;
  105.     }
  107.     public function getType(): ReturnType
  108.     {
  109.         return $this->type;
  110.     }
  112.     public function setType(ReturnType $type): self
  113.     {
  114.         $this->type = $type;
  116.         return $this;
  117.     }
  119.     public function getStatus(): ReturnStatus
  120.     {
  121.         return $this->status;
  122.     }
  124.     public function setStatus(ReturnStatus $status): self
  125.     {
  126.         $this->status = $status;
  128.         return $this;
  129.     }
  131.     public function getRequestedAt(): \DateTimeImmutable
  132.     {
  133.         return $this->requestedAt;
  134.     }
  136.     public function setRequestedAt(\DateTimeImmutable $requestedAt): self
  137.     {
  138.         $this->requestedAt = $requestedAt;
  140.         return $this;
  141.     }
  143.     public function getProcessedAt(): ?\DateTimeImmutable
  144.     {
  145.         return $this->processedAt;
  146.     }
  148.     public function setProcessedAt(?\DateTimeImmutable $processedAt): self
  149.     {
  150.         $this->processedAt = $processedAt;
  152.         return $this;
  153.     }
  155.     public function getProcessedBy(): ?User
  156.     {
  157.         return $this->processedBy;
  158.     }
  160.     public function setProcessedBy(?User $processedBy): self
  161.     {
  162.         $this->processedBy = $processedBy;
  164.         return $this;
  165.     }
  167.     public function getNotes(): ?string
  168.     {
  169.         return $this->notes;
  170.     }
  172.     public function setNotes(?string $notes): self
  173.     {
  174.         $this->notes = $notes;
  176.         return $this;
  177.     }
  179.     /**
  180.      * @return Collection<int, SalesReturnItem>
  181.      */
  182.     public function getItems(): Collection
  183.     {
  184.         return $this->items;
  185.     }
  187.     public function addItem(SalesReturnItem $item): self
  188.     {
  189.         if (!$this->items->contains($item)) {
  190.             $this->items->add($item);
  191.             $item->setSalesReturn($this);
  192.         }
  194.         return $this;
  195.     }
  197.     public function removeItem(SalesReturnItem $item): self
  198.     {
  199.         if ($this->items->removeElement($item)) {
  200.             if ($item->getSalesReturn() === $this) {
  201.                 $item->setSalesReturn(null);
  202.             }
  203.         }
  205.         return $this;
  206.     }
  208.     /**
  209.      * @return Collection<int, ReturnReplacementItem>
  210.      */
  211.     public function getReplacements(): Collection
  212.     {
  213.         return $this->replacements;
  214.     }
  216.     public function addReplacement(ReturnReplacementItem $replacement): self
  217.     {
  218.         if (!$this->replacements->contains($replacement)) {
  219.             $this->replacements->add($replacement);
  220.             $replacement->setSalesReturn($this);
  221.         }
  223.         return $this;
  224.     }
  226.     public function removeReplacement(ReturnReplacementItem $replacement): self
  227.     {
  228.         if ($this->replacements->removeElement($replacement)) {
  229.             if ($replacement->getSalesReturn() === $this) {
  230.                 $replacement->setSalesReturn(null);
  231.             }
  232.         }
  234.         return $this;
  235.     }
  237.     public function markProcessed(?User $user = null): void
  238.     {
  239.         $this->processedBy = $user;
  240.         $this->processedAt = new \DateTimeImmutable('now');
  241.     }
  243.     public function __toString(): string
  244.     {
  245.         return sprintf('SalesReturn #%s (%s)', $this->referenceNumber ?? $this->id ?? 'NEW', $this->status?->value ?? 'UNKNOWN');
  246.     }
  247. }