src/Entity/PackingList.php line 21

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Exception\InvalidArgumentException;
  6. use Doctrine\Common\Collections\ArrayCollection;
  7. use Doctrine\Common\Collections\Collection;
  8. use Doctrine\ORM\Mapping as ORM;
  9. use Symfony\Component\Validator\Constraints as Assert;
  11. /**
  12.  * @ORM\Entity(
  13.  *     repositoryClass="App\Repository\PackingListRepository"
  14.  * )
  15.  * @ORM\Table(
  16.  *     name="packing_list",
  17.  *     options={"collate"="utf8_swedish_ci"}
  18.  * )
  19.  * @ORM\HasLifecycleCallbacks
  20.  */
  21. class PackingList implements EntityInterface, LoggableInterface, SalesDocumentInterface
  22. {
  23.     use DocumentTrait;
  24.     use LoggableTrait;
  26.     const NUMBER_PREFIX = 'PL';
  27.     const ORDER_NUMBER_PREFIX = 9;
  29.     const STATUS_DRAFT = 'draft';
  30.     const STATUS_SENT = 'sent';
  31.     const STATUS_REJECTED = 'rejected';
  33.     /**
  34.      * @ORM\Id
  35.      * @ORM\Column(
  36.      *     type="integer"
  37.      * )
  38.      * @ORM\GeneratedValue(
  39.      *     strategy="AUTO"
  40.      * )
  41.      *
  42.      * @var int|null
  43.      */
  44.     protected ?int $id = null;
  46.     /**
  47.      * @ORM\Column(
  48.      *     name="`case`",
  49.      *     type="string",
  50.      *     length=30,
  51.      *     nullable=true
  52.      * )
  53.      *
  54.      * @var string|null
  55.      */
  56.     protected ?string $case = null;
  58.     /**
  59.      * @ORM\OneToOne(
  60.      *     targetEntity="CompanyDocumentAddress",
  61.      *     cascade={"persist","remove"},
  62.      *     orphanRemoval=true
  63.      * )
  64.      * @ORM\JoinColumn(
  65.      *     name="delivery_address_id"
  66.      * )
  67.      *
  68.      * @Assert\Valid
  69.      *
  70.      * @var CompanyDocumentAddress|null
  71.      */
  72.     protected ?CompanyDocumentAddress $deliveryAddress = null;
  74.     /**
  75.      * @ORM\OneToMany(
  76.      *     targetEntity="DocumentVersionPackingList",
  77.      *     mappedBy="packingList",
  78.      *     cascade={"persist","remove"}
  79.      * )
  80.      * @ORM\OrderBy({"created" = "DESC"})
  81.      *
  82.      * @var Collection<DocumentVersionPackingList>
  83.      */
  84.     protected Collection $documentVersions;
  86.     /**
  87.      * @ORM\Column(
  88.      *     type="integer",
  89.      * )
  90.      * @Assert\Range(
  91.      *     min=0
  92.      * )
  93.      *
  94.      * @var int
  95.      */
  96.     protected int $height = 0;
  98.     /**
  99.      * @ORM\Column(
  100.      *     type="integer",
  101.      * )
  102.      * @Assert\Range(
  103.      *     min=0
  104.      * )
  105.      *
  106.      * @var int
  107.      */
  108.     protected int $length = 0;
  110.     /**
  111.      * @ORM\ManyToMany(
  112.      *     targetEntity="LogEntry",
  113.      *     cascade={"persist","remove"},
  114.      *     orphanRemoval=true
  115.      * )
  116.      * @ORM\JoinTable(
  117.      *     name="packing_list_log_entry",
  118.      *     joinColumns={
  119.      *         @ORM\JoinColumn(
  120.      *             name="packing_list_id",
  121.      *             referencedColumnName="id",
  122.      *             onDelete="cascade"
  123.      *         )
  124.      *     },
  125.      *     inverseJoinColumns={
  126.      *         @ORM\JoinColumn(
  127.      *             name="log_entry_id",
  128.      *             referencedColumnName="id",
  129.      *             unique=true,
  130.      *             onDelete="cascade"
  131.      *         )
  132.      *     }
  133.      * )
  134.      * @ORM\OrderBy({"time" = "ASC"})
  135.      *
  136.      * @Assert\Valid
  137.      *
  138.      * @var Collection<LogEntry>
  139.      */
  140.     protected $logEntries;
  142.     /**
  143.      * @ORM\Column(
  144.      *     type="string",
  145.      *     length=500,
  146.      *     nullable=true
  147.      * )
  148.      *
  149.      * @var string|null
  150.      */
  151.     protected ?string $marks = null;
  153.     /**
  154.      * @ORM\Column(
  155.      *     type="string",
  156.      *     length=5000,
  157.      *     nullable=true
  158.      * )
  159.      *
  160.      * @var string|null
  161.      */
  162.     protected ?string $notes = null;
  164.     /**
  165.      * @ORM\Column(
  166.      *     name="order_number",
  167.      *     type="integer",
  168.      *     nullable=true
  169.      * )
  170.      *
  171.      * @var int|null
  172.      */
  173.     protected ?int $orderNumber = null;
  175.     /**
  176.      * @ORM\OneToMany(
  177.      *     targetEntity="Parcel",
  178.      *     mappedBy="packingList",
  179.      *     cascade={"persist","remove"},
  180.      *     orphanRemoval=true
  181.      * )
  182.      * @ORM\OrderBy({"number" = "ASC"})
  183.      *
  184.      * @Assert\Valid
  185.      *
  186.      * @var Collection<Parcel>
  187.      */
  188.     protected Collection $parcels;
  190.     /**
  191.      * @ORM\ManyToOne(
  192.      *     targetEntity="SalesCase",
  193.      *     inversedBy="packingLists"
  194.      * )
  195.      * @ORM\JoinColumn(
  196.      *     name="sales_case_id",
  197.      *     referencedColumnName="id",
  198.      *     onDelete="cascade"
  199.      * )
  200.      *
  201.      * @Assert\NotNull
  202.      *
  203.      * @var SalesCase
  204.      */
  205.     protected SalesCase $salesCase;
  207.     /**
  208.      * @ORM\ManyToMany(
  209.      *     targetEntity="SalesItem",
  210.      *     cascade={"persist","remove"},
  211.      *     orphanRemoval=true
  212.      * )
  213.      * @ORM\JoinTable(
  214.      *     name="packing_list_sales_item",
  215.      *     joinColumns={
  216.      *         @ORM\JoinColumn(
  217.      *             name="packing_list_id",
  218.      *             referencedColumnName="id",
  219.      *             onDelete="cascade"
  220.      *         )
  221.      *     },
  222.      *     inverseJoinColumns={
  223.      *         @ORM\JoinColumn(
  224.      *             name="sales_item_id",
  225.      *             referencedColumnName="id",
  226.      *             unique=true,
  227.      *             onDelete="cascade"
  228.      *         )
  229.      *     }
  230.      * )
  231.      * @ORM\OrderBy({"position" = "ASC"})
  232.      *
  233.      * @Assert\Valid
  234.      *
  235.      * @var Collection<SalesItem>
  236.      */
  237.     protected Collection $salesItems;
  239.     /**
  240.      * @ORM\Column(
  241.      *     name="total_weight_gross",
  242.      *     type="integer",
  243.      *     nullable=true
  244.      * )
  245.      *
  246.      * @var int|null
  247.      */
  248.     protected ?int $totalWeightGross = null;
  250.     /**
  251.      * @ORM\Column(
  252.      *     name="total_weight_net",
  253.      *     type="integer",
  254.      *     nullable=true
  255.      * )
  256.      *
  257.      * @var int|null
  258.      */
  259.     protected ?int $totalWeightNet = null;
  261.     /**
  262.      * @ORM\Column(
  263.      *     type="integer",
  264.      * )
  265.      * @Assert\Range(
  266.      *     min=0
  267.      * )
  268.      *
  269.      * @var int
  270.      */
  271.     protected int $width = 0;
  273.     /**
  274.      * @param SalesCase $salesCase
  275.      */
  276.     public function __construct(SalesCase $salesCase)
  277.     {
  278.         $this->salesCase = $salesCase;
  279.         $this->documentVersions = new ArrayCollection();
  280.         $this->logEntries = new ArrayCollection();
  281.         $this->parcels = new ArrayCollection();
  282.         $this->salesItems = new ArrayCollection();
  283.     }
  285.     /**
  286.      * @param DocumentVersionPackingList $documentVersion
  287.      *
  288.      * @throws InvalidArgumentException
  289.      */
  290.     public function addDocumentVersion(DocumentVersionPackingList $documentVersion)
  291.     {
  292.         if ($documentVersion->getPackingList() !== $this) {
  293.             throw new InvalidArgumentException('Document version has mismatching packing list document.');
  294.         }
  295.         $this->documentVersions->add($documentVersion);
  296.     }
  298.     /**
  299.      * @param Parcel $parcel
  300.      */
  301.     public function addParcel(Parcel $parcel): void
  302.     {
  303.         $this->parcels->add($parcel);
  304.     }
  306.     /**
  307.      * @param SalesItem $item
  308.      */
  309.     public function addSalesItem(SalesItem $item)
  310.     {
  311.         $this->salesItems->add($item);
  312.     }
  314.     /**
  315.      * @return null|string
  316.      */
  317.     public function getCase(): ?string
  318.     {
  319.         return $this->case;
  320.     }
  322.     /**
  323.      * @return CompanyDocumentAddress|null
  324.      */
  325.     public function getDeliveryAddress(): ?CompanyDocumentAddress
  326.     {
  327.         return $this->deliveryAddress;
  328.     }
  330.     /**
  331.      * @return Collection<DocumentVersionPackingList>
  332.      */
  333.     public function getDocumentVersions(): Collection
  334.     {
  335.         return $this->documentVersions;
  336.     }
  338.     /**
  339.      * @return int
  340.      */
  341.     public function getHeight(): int
  342.     {
  343.         return $this->height;
  344.     }
  346.     /**
  347.      * @return int|null
  348.      */
  349.     public function getId(): ?int
  350.     {
  351.         return $this->id;
  352.     }
  354.     /**
  355.      * @return int
  356.      */
  357.     public function getLength(): int
  358.     {
  359.         return $this->length;
  360.     }
  362.     /**
  363.      * @return null|string
  364.      */
  365.     public function getMarks(): ?string
  366.     {
  367.         return $this->marks;
  368.     }
  370.     /**
  371.      * @return null|string
  372.      */
  373.     public function getNotes(): ?string
  374.     {
  375.         return $this->notes;
  376.     }
  378.     /**
  379.      * @return string
  380.      */
  381.     public function getNumber(): string
  382.     {
  383.         return self::NUMBER_PREFIX . str_pad($this->salesCase->getId(), 6, '0', STR_PAD_LEFT)
  384.             . '-'
  385.             . ($this->isDraft() ? 'DRAFT' : self::ORDER_NUMBER_PREFIX . str_pad($this->getOrderNumber(), 5, '0', STR_PAD_LEFT));
  386.     }
  388.     /**
  389.      * @return int|null
  390.      */
  391.     public function getOrderNumber(): ?int
  392.     {
  393.         return $this->orderNumber;
  394.     }
  396.     /**
  397.      * @return Collection
  398.      */
  399.     public function getParcels(): Collection
  400.     {
  401.         return $this->parcels;
  402.     }
  404.     /**
  405.      * @return string
  406.      */
  407.     public function getPreviewFileName(): string
  408.     {
  409.         return 'Packing List - ' . $this->getNumber() . ' - Preview ' . date('Y-m-d') . '.pdf';
  410.     }
  412.     /**
  413.      * @return SalesCase
  414.      */
  415.     public function getSalesCase(): SalesCase
  416.     {
  417.         return $this->salesCase;
  418.     }
  420.     /**
  421.      * @return Collection<SalesItem>
  422.      */
  423.     public function getSalesItems(): Collection
  424.     {
  425.         return $this->salesItems;
  426.     }
  428.     /**
  429.      * @return array<string>
  430.      */
  431.     public static function getStatusChoices(): array
  432.     {
  433.         return [
  434.             self::STATUS_DRAFT,
  435.             self::STATUS_SENT,
  436.             self::STATUS_REJECTED,
  437.         ];
  438.     }
  440.     /**
  441.      * @return int
  442.      */
  443.     public function getTotalVolume(): int
  444.     {
  445.         return $this->length * $this->width * $this->height;
  446.     }
  448.     /**
  449.      * @return int|null
  450.      */
  451.     public function getTotalWeightGross(): ?int
  452.     {
  453.         return $this->totalWeightGross;
  454.     }
  456.     /**
  457.      * @return int|null
  458.      */
  459.     public function getTotalWeightNet(): ?int
  460.     {
  461.         return $this->totalWeightNet;
  462.     }
  464.     /**
  465.      * @return int
  466.      */
  467.     public function getWidth(): int
  468.     {
  469.         return $this->width;
  470.     }
  472.     /**
  473.      * @return bool
  474.      */
  475.     public function isDraft(): bool
  476.     {
  477.         return $this->getStatus() == self::STATUS_DRAFT;
  478.     }
  480.     /**
  481.      * @return bool
  482.      */
  483.     public function isRejected(): bool
  484.     {
  485.         return $this->getStatus() == self::STATUS_REJECTED;
  486.     }
  488.     /**
  489.      * @param Parcel $parcel
  490.      */
  491.     public function removeParcel(Parcel $parcel): void
  492.     {
  493.         $this->parcels->removeElement($parcel);
  494.     }
  496.     /**
  497.      * @param SalesItem $item
  498.      */
  499.     public function removeSalesItem(SalesItem $item)
  500.     {
  501.         $this->salesItems->removeElement($item);
  502.     }
  504.     /**
  505.      * @param string|null $case
  506.      */
  507.     public function setCase(?string $case)
  508.     {
  509.         $this->case = $case;
  510.     }
  512.     /**
  513.      * @param CompanyDocumentAddress|null $deliveryAddress
  514.      */
  515.     public function setDeliveryAddress(?CompanyDocumentAddress $deliveryAddress)
  516.     {
  517.         $this->deliveryAddress = $deliveryAddress;
  518.     }
  520.     /**
  521.      * @param int $height
  522.      */
  523.     public function setHeight(int $height)
  524.     {
  525.         $this->height = $height;
  526.     }
  528.     /**
  529.      * @param int $length
  530.      */
  531.     public function setLength(int $length)
  532.     {
  533.         $this->length = $length;
  534.     }
  536.     /**
  537.      * @param string|null $marks
  538.      */
  539.     public function setMarks(?string $marks)
  540.     {
  541.         $this->marks = $marks;
  542.     }
  544.     /**
  545.      * @param string|null $notes
  546.      */
  547.     public function setNotes(?string $notes)
  548.     {
  549.         $this->notes = $notes;
  550.     }
  552.     /**
  553.      * @param int|null $orderNumber
  554.      */
  555.     public function setOrderNumber(?int $orderNumber)
  556.     {
  557.         $this->orderNumber = $orderNumber;
  558.     }
  560.     /**
  561.      * @param int|null $totalWeightGross
  562.      */
  563.     public function setTotalWeightGross(?int $totalWeightGross)
  564.     {
  565.         $this->totalWeightGross = $totalWeightGross;
  566.     }
  568.     /**
  569.      * @param int|null $totalWeightNet
  570.      */
  571.     public function setTotalWeightNet(?int $totalWeightNet)
  572.     {
  573.         $this->totalWeightNet = $totalWeightNet;
  574.     }
  576.     /**
  577.      * @param int $width
  578.      */
  579.     public function setWidth(int $width)
  580.     {
  581.         $this->width = $width;
  582.     }
  583. }