vendor/bluue/sales-bundle/src/Entity/CreditNoteLine.php line 39

Open in your IDE?
  1. <?php
  3. /**
  4.  * @author Quentin CHATELAIN (contact@scaledev.fr)
  5.  * @copyright 2021 - ScaleDEV SAS, 12 RUE CHARLES MORET, 10120 ST ANDRE LES VERGERS
  6.  * @license commercial
  7.  */
  9. declare(strict_types=1);
  11. namespace Bluue\SalesBundle\Entity;
  13. use App\Entity\Traits\EntityManagerServiceEntity;
  14. use App\Services\SoftdeleteFilter;
  15. use DateTime;
  16. use App\Entity\TaxRule;
  17. use Doctrine\ORM\NonUniqueResultException;
  18. use Symfony\Component\Uid\Uuid;
  19. use Doctrine\ORM\Mapping as ORM;
  20. use Gedmo\Mapping\Annotation as Gedmo;
  21. use Doctrine\Common\Collections\Collection;
  22. use Doctrine\Common\Collections\ArrayCollection;
  23. use Symfony\Bridge\Doctrine\IdGenerator\UuidGenerator;
  24. use Bluue\SalesBundle\Repository\CreditNoteLineRepository;
  25. use App\DoctrineExtensions\Timestampable\Traits\UserTimestampableEntity;
  26. use App\DoctrineExtensions\SoftDeleteable\Traits\UserSoftDeleteableEntity;
  27. use Bluue\ProductsBundle\Entity\Declination;
  28. use Bluue\ProductsBundle\Entity\Product;
  30. /**
  31.  * @ORM\Entity(repositoryClass=CreditNoteLineRepository::class)
  32.  * @ORM\Table(name="sales_bundle__credit_note_line", indexes={
  33.  *  @ORM\Index(name="deleted_at", columns={"deleted_at"}),
  34.  *  @ORM\Index(name="created_at", columns={"created_at"}),
  35.  *  @ORM\Index(name="updated_at", columns={"updated_at"})
  36.  * })
  37.  * @Gedmo\SoftDeleteable(fieldName="deletedAt", timeAware=false, hardDelete=false)
  38.  */
  39. class CreditNoteLine
  40. {
  41.     use UserTimestampableEntity;
  42.     use UserSoftDeleteableEntity;
  43.     use EntityManagerServiceEntity;
  45.     /**
  46.      * @ORM\Id
  47.      * @ORM\Column(type="uuid")
  48.      * @ORM\GeneratedValue(strategy="CUSTOM")
  49.      * @ORM\CustomIdGenerator(class=UuidGenerator::class)
  50.      */
  51.     private ?Uuid $id = null;
  53.     /**
  54.      * @ORM\ManyToOne(targetEntity=CreditNote::class, inversedBy="lines")
  55.      * @ORM\JoinColumn(nullable=false)
  56.      */
  57.     private ?CreditNote $credit_note = null;
  59.     /**
  60.      * @ORM\ManyToOne(targetEntity=LineType::class)
  61.      */
  62.     private ?LineType $line_type = null;
  64.     /**
  65.      * @ORM\ManyToOne(targetEntity=TaxRule::class)
  66.      */
  67.     private ?TaxRule $tax_rule = null;
  69.     /**
  70.      * @ORM\ManyToOne(targetEntity="CreditNoteLine", inversedBy="childrens")
  71.      * @ORM\JoinColumn(name="parent_id", referencedColumnName="id")
  72.      */
  73.     private ?CreditNoteLine $parent = null;
  75.     /**
  76.      * @ORM\Column(type="boolean")
  77.      */
  78.     private bool $is_group = false;
  80.     /**
  81.      * @ORM\ManyToOne(targetEntity="CreditNoteLine", inversedBy="packChildrens")
  82.      * @ORM\JoinColumn(name="pack_parent_id", referencedColumnName="id")
  83.      */
  84.     private ?CreditNoteLine $packParent = null;
  86.     /**
  87.      * @ORM\Column(type="boolean")
  88.      */
  89.     private bool $is_pack = false;
  91.     /**
  92.      * @ORM\Column(type="string", length=128, nullable="true")
  93.      */
  94.     private ?string $reference = null;
  96.     /**
  97.      * @ORM\Column(type="string", length=128, nullable="true")
  98.      */
  99.     private ?string $referenceBrand = null;
  101.     /**
  102.      * @ORM\Column(type="string", length=255, nullable="true")
  103.      */
  104.     private ?string $name = null;
  106.     /**
  107.      * @ORM\Column(type="text", nullable="true")
  108.      */
  109.     private ?string $description = null;
  111.     /**
  112.      * @ORM\Column(type="decimal", precision=20, scale=6, nullable="true")
  113.      */
  114.     private ?string $unit_price = null;
  116.     /**
  117.      * @ORM\Column(type="decimal", precision=20, scale=6, nullable="true")
  118.      */
  119.     private ?string $unitPriceWithTax = null;
  121.     /**
  122.      * @ORM\Column(type="decimal", precision=20, scale=6, nullable="true")
  123.      */
  124.     private ?string $quantity = null;
  126.     /**
  127.      * @ORM\Column(type="decimal", precision=20, scale=6, nullable="true")
  128.      */
  129.     private ?string $wholesale_price = null;
  131.     /**
  132.      * @ORM\Column(type="decimal", precision=20, scale=6, nullable="true")
  133.      */
  134.     private ?string $margin_ratio = null;
  136.     /**
  137.      * @ORM\Column(type="decimal", precision=20, scale=6, nullable="true")
  138.      */
  139.     private ?string $total_amount_untaxed = null;
  141.     /**
  142.      * @ORM\Column(type="decimal", precision=20, scale=6, nullable="true")
  143.      */
  144.     private ?string $total_tax_amount = null;
  146.     /**
  147.      * @ORM\Column(type="decimal", precision=20, scale=6, nullable="true")
  148.      */
  149.     private ?string $total_amount = null;
  151.     /**
  152.      * @ORM\Column(type="integer")
  153.      */
  154.     private ?int $position = null;
  156.     /**
  157.      * @ORM\Column(type="json")
  158.      */
  159.     private array $options = [];
  161.     /**
  162.      * @ORM\OneToMany(
  163.      *      targetEntity="CreditNoteLine",
  164.      *      mappedBy="parent",
  165.      *      cascade={"persist", "remove"},
  166.      *      fetch="EXTRA_LAZY"
  167.      * )
  168.      * @ORM\OrderBy({"position" = "ASC"})
  169.      */
  170.     private Collection $childrens;
  172.     /**
  173.      * @ORM\OneToMany(
  174.      *      targetEntity="CreditNoteLine",
  175.      *      mappedBy="packParent",
  176.      *      cascade={"persist", "remove"},
  177.      *      fetch="EXTRA_LAZY"
  178.      * )
  179.      * @ORM\OrderBy({"position" = "ASC"})
  180.      */
  181.     private Collection $packChildrens;
  183.     /**
  184.      * @ORM\ManyToOne(targetEntity=Product::class)
  185.      */
  186.     private ?Product $product = null;
  188.     /**
  189.      * @ORM\ManyToOne(targetEntity=Declination::class)
  190.      */
  191.     private ?Declination $declination = null;
  193.     public function __construct()
  194.     {
  195.         $this->childrens = new ArrayCollection();
  196.         $this->packChildrens = new ArrayCollection();
  197.     }
  199.     /**
  200.      * @return Uuid|null
  201.      */
  202.     public function getId(): ?Uuid
  203.     {
  204.         return $this->id;
  205.     }
  207.     /**
  208.      * @return CreditNoteLine
  209.      */
  210.     public function setId(): self
  211.     {
  212.         $this->id = null;
  213.         return $this;
  214.     }
  216.     /**
  217.      * @return CreditNote|null
  218.      */
  219.     public function getCreditNote(): ?CreditNote
  220.     {
  221.         return $this->credit_note;
  222.     }
  224.     /**
  225.      * @param CreditNote $credit_note
  226.      * @return CreditNoteLine
  227.      */
  228.     public function setCreditNote(CreditNote $credit_note): self
  229.     {
  230.         $this->credit_note = $credit_note;
  231.         return $this;
  232.     }
  234.     /**
  235.      * @return LineType|null
  236.      */
  237.     public function getLineType(): ?LineType
  238.     {
  239.         return $this->line_type;
  240.     }
  242.     /**
  243.      * @param LineType|null $line_type
  244.      * @return CreditNoteLine
  245.      */
  246.     public function setLineType(?LineType $line_type): self
  247.     {
  248.         $this->line_type = $line_type;
  249.         return $this;
  250.     }
  252.     /**
  253.      * @return TaxRule|null
  254.      * @throws NonUniqueResultException
  255.      */
  256.     public function getTaxRule(): ?TaxRule
  257.     {
  258.         if ($this->em && $this->tax_rule) {
  259.             SoftdeleteFilter::disable($this->em, [TaxRule::class]);
  260.             $taxRule = $this->em->getRepository(TaxRule::class)
  261.                 ->createQueryBuilder('tr')
  262.                 ->where('tr.id = :taxRuleId')
  263.                 ->setParameter('taxRuleId', $this->tax_rule->getId()->toBinary())
  264.                 ->getQuery()
  265.                 ->getOneOrNullResult();
  266.             SoftdeleteFilter::enable($this->em, [TaxRule::class]);
  267.             return $taxRule;
  268.         }
  269.         return $this->tax_rule;
  270.     }
  272.     /**
  273.      * @param TaxRule|null $tax_rule
  274.      * @return CreditNoteLine
  275.      */
  276.     public function setTaxRule(?TaxRule $tax_rule): self
  277.     {
  278.         $this->tax_rule = $tax_rule;
  279.         return $this;
  280.     }
  282.     /**
  283.      * @return CreditNoteLine|null
  284.      */
  285.     public function getParent(): ?CreditNoteLine
  286.     {
  287.         return $this->parent;
  288.     }
  290.     /**
  291.      * @param CreditNoteLine|null $parent
  292.      * @return CreditNoteLine
  293.      */
  294.     public function setParent(?CreditNoteLine $parent): self
  295.     {
  296.         $this->parent = $parent;
  297.         return $this;
  298.     }
  300.     /**
  301.      * @return bool
  302.      */
  303.     public function getIsGroup(): bool
  304.     {
  305.         return $this->is_group;
  306.     }
  308.     /**
  309.      * @param bool $is_group
  310.      * @return CreditNoteLine
  311.      */
  312.     public function setIsGroup(bool $is_group): self
  313.     {
  314.         $this->is_group = $is_group;
  315.         return $this;
  316.     }
  318.     /**
  319.      * @return CreditNoteLine|null
  320.      */
  321.     public function getPackParent(): ?CreditNoteLine
  322.     {
  323.         return $this->packParent;
  324.     }
  326.     /**
  327.      * @param CreditNoteLine|null $packParent
  328.      * @return CreditNoteLine
  329.      */
  330.     public function setPackParent(?CreditNoteLine $packParent): self
  331.     {
  332.         $this->packParent = $packParent;
  333.         return $this;
  334.     }
  336.     /**
  337.      * @return bool
  338.      */
  339.     public function getIsPack(): bool
  340.     {
  341.         return $this->is_pack;
  342.     }
  344.     /**
  345.      * @param bool $is_pack
  346.      * @return CreditNoteLine
  347.      */
  348.     public function setIsPack(bool $is_pack): self
  349.     {
  350.         $this->is_pack = $is_pack;
  351.         return $this;
  352.     }
  354.     /**
  355.      * @return string|null
  356.      */
  357.     public function getReference(): ?string
  358.     {
  359.         return $this->reference;
  360.     }
  362.     /**
  363.      * @param string|null $reference
  364.      * @return CreditNoteLine
  365.      */
  366.     public function setReference(?string $reference): self
  367.     {
  368.         $this->reference = $reference;
  369.         return $this;
  370.     }
  372.     /**
  373.      * @return string|null
  374.      */
  375.     public function getReferenceBrand(): ?string
  376.     {
  377.         return $this->referenceBrand;
  378.     }
  380.     /**
  381.      * @param string|null $referenceBrand
  382.      * @return CreditNoteLine
  383.      */
  384.     public function setReferenceBrand(?string $referenceBrand): self
  385.     {
  386.         $this->referenceBrand = $referenceBrand;
  387.         return $this;
  388.     }
  390.     /**
  391.      * @return string|null
  392.      */
  393.     public function getName(): ?string
  394.     {
  395.         return $this->name;
  396.     }
  398.     /**
  399.      * @param string|null $name
  400.      * @return CreditNoteLine
  401.      */
  402.     public function setName(?string $name): self
  403.     {
  404.         $this->name = $name;
  405.         return $this;
  406.     }
  408.     /**
  409.      * @return string|null
  410.      */
  411.     public function getDescription(): ?string
  412.     {
  413.         return $this->description;
  414.     }
  416.     /**
  417.      * @param string|null $description
  418.      * @return CreditNoteLine
  419.      */
  420.     public function setDescription(?string $description): self
  421.     {
  422.         $this->description = $description;
  423.         return $this;
  424.     }
  426.     /**
  427.      * @return string|null
  428.      */
  429.     public function getUnitPrice(): ?string
  430.     {
  431.         return $this->unit_price;
  432.     }
  434.     /**
  435.      * @param string|null $unit_price
  436.      * @return CreditNoteLine
  437.      */
  438.     public function setUnitPrice(?string $unit_price): self
  439.     {
  440.         $this->unit_price = $unit_price;
  441.         return $this;
  442.     }
  444.     /**
  445.      * @return string|null
  446.      */
  447.     public function getUnitPriceWithTax(): ?string
  448.     {
  449.         return $this->unitPriceWithTax;
  450.     }
  452.     /**
  453.      * @param string|null $unitPriceWithTax
  454.      * @return CreditNoteLine
  455.      */
  456.     public function setUnitPriceWithTax(?string $unitPriceWithTax): CreditNoteLine
  457.     {
  458.         $this->unitPriceWithTax = $unitPriceWithTax;
  459.         return $this;
  460.     }
  462.     /**
  463.      * @return string|null
  464.      */
  465.     public function getQuantity(): ?string
  466.     {
  467.         return $this->quantity;
  468.     }
  470.     /**
  471.      * @param string|null $quantity
  472.      * @return CreditNoteLine
  473.      */
  474.     public function setQuantity(?string $quantity): self
  475.     {
  476.         $this->quantity = $quantity;
  477.         return $this;
  478.     }
  480.     /**
  481.      * @return string|null
  482.      */
  483.     public function getWholesalePrice(): ?string
  484.     {
  485.         return $this->wholesale_price;
  486.     }
  488.     /**
  489.      * @param string|null $wholesale_price
  490.      * @return CreditNoteLine
  491.      */
  492.     public function setWholesalePrice(?string $wholesale_price): self
  493.     {
  494.         $this->wholesale_price = $wholesale_price;
  495.         return $this;
  496.     }
  498.     /**
  499.      * @return string|null
  500.      */
  501.     public function getMarginRatio(): ?string
  502.     {
  503.         return $this->margin_ratio;
  504.     }
  506.     /**
  507.      * @param string|null $margin_ratio
  508.      * @return CreditNoteLine
  509.      */
  510.     public function setMarginRatio(?string $margin_ratio): self
  511.     {
  512.         $this->margin_ratio = $margin_ratio;
  513.         return $this;
  514.     }
  516.     /**
  517.      * @param bool $calcWithPackaging
  518.      * @return float|null
  519.      */
  520.     public function getTotalMargin(bool $calcWithPackaging = false): ?float
  521.     {
  522.         if ($this->wholesale_price === null) {
  523.             return 0;
  524.         }
  526.         if ($calcWithPackaging && !empty($this->options['unitQuantity'])) {
  527.             $quantity = (float) $this->options['unitQuantity'];
  528.         } else {
  529.             $quantity = (int) $this->quantity;
  530.         }
  532.         $sellPrice = (float) $this->total_amount_untaxed;
  533.         if (!empty($this->options['ecoPart']) && !empty($this->options['ecoPart']['amount'])) {
  534.             $sellPrice -= $this->options['ecoPart']['amount']  * $quantity;
  535.         }
  537.         return $sellPrice - (float) $this->wholesale_price * $quantity;
  538.     }
  540.     /**
  541.      * @return string|null
  542.      */
  543.     public function getTotalAmountUntaxed(): ?string
  544.     {
  545.         return $this->total_amount_untaxed;
  546.     }
  548.     /**
  549.      * @param string|null $total_amount_untaxed
  550.      * @return CreditNoteLine
  551.      */
  552.     public function setTotalAmountUntaxed(?string $total_amount_untaxed): self
  553.     {
  554.         $this->total_amount_untaxed = $total_amount_untaxed;
  555.         return $this;
  556.     }
  558.     /**
  559.      * @return string|null
  560.      */
  561.     public function getTotalTaxAmount(): ?string
  562.     {
  563.         return $this->total_tax_amount;
  564.     }
  566.     /**
  567.      * @param string|null $total_tax_amount
  568.      * @return CreditNoteLine
  569.      */
  570.     public function setTotalTaxAmount(?string $total_tax_amount): self
  571.     {
  572.         $this->total_tax_amount = $total_tax_amount;
  573.         return $this;
  574.     }
  576.     /**
  577.      * @return string|null
  578.      */
  579.     public function getTotalAmount(): ?string
  580.     {
  581.         return $this->total_amount;
  582.     }
  584.     /**
  585.      * @param string|null $total_amount
  586.      * @return CreditNoteLine
  587.      */
  588.     public function setTotalAmount(?string $total_amount): self
  589.     {
  590.         $this->total_amount = $total_amount;
  591.         return $this;
  592.     }
  594.     /**
  595.      * @return int|null
  596.      */
  597.     public function getPosition(): ?int
  598.     {
  599.         return $this->position;
  600.     }
  602.     /**
  603.      * @param int|null $position
  604.      * @return CreditNoteLine
  605.      */
  606.     public function setPosition(?int $position): self
  607.     {
  608.         $this->position = $position;
  609.         return $this;
  610.     }
  612.     /**
  613.      * @return array
  614.      */
  615.     public function getOptions(): array
  616.     {
  617.         return $this->options;
  618.     }
  620.     /**
  621.      * @param array $options
  622.      * @return CreditNoteLine
  623.      */
  624.     public function setOptions(array $options): self
  625.     {
  626.         $this->options = $options;
  627.         return $this;
  628.     }
  630.     /**
  631.      * @param array $options
  632.      * @return CreditNoteLine
  633.      */
  634.     public function addOptions(array $options): self
  635.     {
  636.         return $this->setOptions(array_merge($this->options, $options));
  637.     }
  639.     /**
  640.      * @return Collection|CreditNoteLine[]
  641.      */
  642.     public function getChildrens(): Collection
  643.     {
  644.         return $this->childrens;
  645.     }
  647.     /**
  648.      * @param CreditNoteLine $line
  649.      * @return CreditNoteLine
  650.      */
  651.     public function addChildren(CreditNoteLine $line): self
  652.     {
  653.         if (!$this->childrens->contains($line)) {
  654.             $this->childrens[] = $line;
  655.             $line->setParent($this);
  657.             if ($line->getCreditNote() !== $this->getCreditNote()) {
  658.                 $line->setCreditNote($this->getCreditNote());
  659.             }
  660.         }
  661.         return $this;
  662.     }
  664.     /**
  665.      * @return Collection|CreditNoteLine[]
  666.      */
  667.     public function getPackChildrens(): Collection
  668.     {
  669.         return $this->packChildrens;
  670.     }
  672.     /**
  673.      * @param CreditNoteLine $line
  674.      * @return $this
  675.      */
  676.     public function addPackChildren(CreditNoteLine $line): self
  677.     {
  678.         if (!$this->packChildrens->contains($line)) {
  679.             $this->packChildrens[] = $line;
  680.             $line->setPackParent($this);
  682.             if ($line->getCreditNote() !== $this->getCreditNote()) {
  683.                 $line->setCreditNote($this->getCreditNote());
  684.             }
  685.         }
  686.         return $this;
  687.     }
  689.     /**
  690.      * @return CreditNote|null
  691.      */
  692.     public function getDocument(): ?CreditNote
  693.     {
  694.         return $this->getCreditNote();
  695.     }
  697.     /**
  698.      * @param CreditNote $creditNote
  699.      * @return CreditNoteLine
  700.      */
  701.     public function duplicate(CreditNote $creditNote): CreditNoteLine
  702.     {
  703.         if ($this->id) {
  704.             $clone = clone $this;
  705.             $clone->setId();
  706.             $clone->setCreditNote($creditNote);
  707.             $clone->setCreatedAt(new DateTime());
  708.             $clone->setCreatedBy(null);
  709.             $clone->setUpdatedAt(new DateTime());
  710.             $clone->setUpdatedBy(null);
  712.             $clone->childrens = new ArrayCollection();
  713.             foreach ($this->getChildrens() as $children) {
  714.                 $clone_children = $children->duplicate($creditNote);
  715.                 $clone->addChildren($clone_children);
  717.                 $children->packChildrens = new ArrayCollection();
  718.                 foreach ($children->getPackChildrens() as $packChildren) {
  719.                     $clone_pack_children = $packChildren->duplicate($creditNote);
  720.                     $children->addPackChildren($clone_pack_children);
  721.                 }
  722.             }
  724.             $clone->packChildrens = new ArrayCollection();
  725.             foreach ($this->getPackChildrens() as $packChildren) {
  726.                 $clone_pack_children = $packChildren->duplicate($creditNote);
  727.                 $clone->addPackChildren($clone_pack_children);
  728.             }
  730.             return $clone;
  731.         }
  732.         return $this;
  733.     }
  735.     /**
  736.      * @return bool
  737.      */
  738.     public function isProduct(): bool
  739.     {
  740.         $options = $this->getOptions();
  742.         return !empty($options['product']) && !empty($options['product']['id']);
  743.     }
  745.     /**
  746.      * @return bool
  747.      */
  748.     public function isDeclination(): bool
  749.     {
  750.         return $this->isProduct() && !empty($this->getOptions()['product']['declination_id']);
  751.     }
  753.     /**
  754.      * @return Product|null
  755.      * @throws NonUniqueResultException
  756.      */
  757.     public function getProduct(): ?Product
  758.     {
  759.         if ($this->em && $this->product) {
  760.             SoftdeleteFilter::disable($this->em, [Product::class]);
  761.             $product = $this->em->getRepository(Product::class)
  762.                 ->createQueryBuilder('p')
  763.                 ->where('p.id = :productId')
  764.                 ->setParameter('productId', $this->product->getId()->toBinary())
  765.                 ->getQuery()
  766.                 ->getOneOrNullResult();
  767.             SoftdeleteFilter::enable($this->em, [Product::class]);
  768.             return $product;
  769.         }
  770.         return $this->product;
  771.     }
  773.     /**
  774.      * @param Product|null $Product
  775.      * @return $this
  776.      */
  777.     public function setProduct(?Product $Product): self
  778.     {
  779.         $this->product = $Product;
  780.         return $this;
  781.     }
  783.     /**
  784.      * @return Declination|null
  785.      * @throws NonUniqueResultException
  786.      */
  787.     public function getDeclination(): ?Declination
  788.     {
  789.         if ($this->em && $this->declination) {
  790.             SoftdeleteFilter::disable($this->em, [Declination::class]);
  791.             $declination = $this->em->getRepository(Declination::class)
  792.                 ->createQueryBuilder('d')
  793.                 ->where('d.id = :declinationId')
  794.                 ->setParameter('declinationId', $this->declination->getId()->toBinary())
  795.                 ->getQuery()
  796.                 ->getOneOrNullResult();
  797.             SoftdeleteFilter::enable($this->em, [Declination::class]);
  798.             return $declination;
  799.         }
  800.         return $this->declination;
  801.     }
  803.     /**
  804.      * @param Declination|null $declination
  805.      * @return $this
  806.      */
  807.     public function setDeclination(?Declination $declination): self
  808.     {
  809.         $this->declination = $declination;
  810.         return $this;
  811.     }
  812. }