src/Entity/Purchase.php line 22

Open in your IDE?
  1. <?php
  3.     namespace App\Entity;
  5.     use App\Constants\Purchase as PurchaseStatus;
  6.     use App\Repository\PurchaseRepository;
  7.     use App\Traits\DateTrait;
  8.     use DateTimeInterface;
  9.     use Doctrine\Common\Collections\ArrayCollection;
  10.     use Doctrine\Common\Collections\Collection;
  11.     use Doctrine\ORM\Mapping as ORM;
  12.     use JMS\Serializer\Annotation as Serializer;
  13.     use JMS\Serializer\Annotation\Expose;
  14.     use JMS\Serializer\Annotation\Groups;
  17.     /**
  18.      * @ORM\Entity(repositoryClass=PurchaseRepository::class)
  19.      *
  20.      * @Serializer\ExclusionPolicy("ALL")
  21.      */
  22.     class Purchase
  23.     {
  24.         // Un nombre de points est attribué à chaque référence
  25.         public const POINT_WITH_REFERENCE = 'point_with_reference';
  26.         //  On se référence au prix total payé par l’installateur
  27.         public const POINT_PRICE_PAID_TOTAL = 'point_price_paid_total';
  28.         //  On se référence au prix unitaire par produit payé par l’installateur
  29.         public const POINT_PRICE_PAID_PER_UNIT = 'point_price_paid_per_unit';
  31.         public const STATUS_PENDING   = PurchaseStatus::STATUS_PENDING;
  32.         public const STATUS_VALIDATED = PurchaseStatus::STATUS_VALIDATED;
  33.         public const STATUS_RETURNED  = PurchaseStatus::STATUS_RETURNED;
  34.         public const STATUS_REJECTED  = PurchaseStatus::STATUS_REJECTED;
  36.         /**
  37.          * @ORM\Id
  38.          * @ORM\GeneratedValue
  39.          * @ORM\Column(type="integer")
  40.          *
  41.          * @Expose
  42.          * @Groups({"purchase", "export_purchase_declaration_datatable"})
  43.          */
  44.         private ?int $id = NULL;
  46.         /**
  47.          * Numéro de facture
  48.          *
  49.          * @ORM\Column(type="string", length=64)
  50.          *
  51.          * @Expose
  52.          * @Groups({"purchase", "export_purchase_declaration_datatable"})
  53.          */
  54.         private $invoiceNumber;
  56.         /**
  57.          * Date de facture
  58.          *
  59.          * @ORM\Column(type="date", nullable=true)
  60.          *
  61.          * @Expose
  62.          * @Groups({"purchase", "export_purchase_declaration_datatable"})
  63.          */
  64.         private $invoiceDate;
  66.         /**
  67.          * Status de la déclaration
  68.          *
  69.          * @ORM\Column(type="integer", options={"default": self::STATUS_PENDING})
  70.          *
  71.          * @Expose
  72.          * @Groups({"purchase", "export_purchase_declaration_datatable"})
  73.          */
  74.         private $status = self::STATUS_PENDING;
  76.         /**
  77.          * Raison du statut
  78.          *
  79.          * @ORM\Column(type="string", length=512, nullable=true)
  80.          */
  81.         private ?string $lastStatusReason = NULL;
  83.         /**
  84.          * Nom du distributeur
  85.          *
  86.          * @deprecated  Relation sur {@see Distributor}
  87.          *
  88.          * @ORM\Column(type="string", length=255, nullable=true)
  89.          */
  90.         private ?string $distributorName = NULL;
  92.         /**
  93.          * Code postal du distributeur
  94.          *
  95.          * @deprecated Relation sur {@see Distributor}
  96.          *
  97.          * @ORM\Column(type="string", length=255, nullable=true)
  98.          */
  99.         private ?string $distributorPostalCode = NULL;
  101.         /**
  102.          * Ville du distributeur
  103.          *
  104.          * @deprecated Relation sur {@see Distributor}
  105.          *
  106.          * @ORM\Column(type="string", length=255, nullable=true)
  107.          */
  108.         private ?string $distributorCity = NULL;
  110.         /**
  111.          * Pays du distributeur
  112.          *
  113.          * @deprecated Relation sur {@see Distributor}
  114.          *
  115.          * @ORM\Column(type="string", length=255, nullable=true)
  116.          */
  117.         private ?string $distributorCountry = NULL;
  119.         /**
  120.          * Valeur de la déclaration
  121.          *
  122.          * @deprecated Il y a une relation entre PointTransaction et Purchase {@see Purchase::$pointTransactions}
  123.          *
  124.          * @ORM\Column(type="integer", nullable=true)
  125.          */
  126.         private ?int $value = NULL;
  128.         /**
  129.          * Personne qui a validé la déclaration
  130.          *
  131.          * @ORM\ManyToOne(targetEntity=User::class,inversedBy="purchasesIHaveProcessed")
  132.          * @ORM\JoinColumn(onDelete="SET NULL")
  133.          *
  134.          * @Expose
  135.          * @Groups({"purchase"})
  136.          */
  137.         private $validator;
  139.         /**
  140.          * Utilisateur qui a fait la déclaration
  141.          *
  142.          * @ORM\ManyToOne(targetEntity=User::class,inversedBy="purchases")
  143.          *
  144.          * @Expose
  145.          * @Groups({"purchase", "export_purchase_declaration_datatable"})
  146.          */
  147.         private $user;
  149.         /**
  150.          * Distributeur rattaché à la déclaration
  151.          *
  152.          * @ORM\ManyToOne(targetEntity=Distributor::class, inversedBy="purchases")
  153.          *
  154.          * @Expose()
  155.          * @Groups({"export_purchase_declaration_datatable"})
  156.          */
  157.         private $distributor;
  159.         /**
  160.          * @TODO Check que toujours utilse
  161.          */
  162.         private $imageFile;
  164.         /**
  165.          * @ORM\OneToMany(
  166.          *     targetEntity=PurchaseHistory::class,
  167.          *     mappedBy="purchase",
  168.          *     cascade={"persist", "remove"}
  169.          * )
  170.          */
  171.         private $purchaseHistories;
  173.         /**
  174.          * @ORM\OneToMany(
  175.          *     targetEntity=PurchaseFile::class,
  176.          *     mappedBy="purchase",
  177.          *     cascade={"remove", "persist"}
  178.          * )
  179.          */
  180.         private $files;
  182.         /**
  183.          * @ORM\OneToMany(
  184.          *     targetEntity=PurchaseProductItem::class,
  185.          *     mappedBy="purchase",
  186.          *     cascade={"remove", "persist"},
  187.          *     orphanRemoval=true
  188.          * )
  189.          *
  190.          * @Expose()
  191.          * @Groups({"export_purchase_declaration_datatable"})
  192.          */
  193.         private $items;
  195.         /**
  196.          * @ORM\OneToMany(targetEntity=PointTransaction::class, mappedBy="purchase")
  197.          */
  198.         private Collection $pointTransactions;
  200.         /**
  201.          * Date de la validation
  202.          *
  203.          * @ORM\Column(type="datetime", nullable=true)
  204.          */
  205.         private $validationDate;
  207.         /**
  208.          * @ORM\Column(type="string", length=255, nullable=true)
  209.          */
  210.         private ?string $distributorAddress1 = NULL;
  212.         /**
  213.          * Prénom du client
  214.          *
  215.          * @ORM\Column(type="string", length=255, nullable=true)
  216.          *
  217.          * @Expose
  218.          * @Groups({"purchase", "export_purchase_declaration_datatable"})
  219.          */
  220.         private ?string $customerFirstName = NULL;
  222.         /**
  223.          * Nom du client
  224.          *
  225.          * @ORM\Column(type="string", length=255, nullable=true)
  226.          *
  227.          * @Expose
  228.          * @Groups({"purchase", "export_purchase_declaration_datatable"})
  229.          */
  230.         private ?string $customerLastName = NULL;
  232.         /**
  233.          * Adresse du client
  234.          *
  235.          * @ORM\Column(type="string", length=255, nullable=true)
  236.          *
  237.          * @Expose
  238.          * @Groups({"purchase", "export_purchase_declaration_datatable"})
  239.          */
  240.         private ?string $customerAddress1 = NULL;
  242.         /**
  243.          * Ville du client
  244.          *
  245.          * @ORM\Column(type="string", length=255, nullable=true)
  246.          *
  247.          * @Expose
  248.          * @Groups({"purchase", "export_purchase_declaration_datatable"})
  249.          */
  250.         private ?string $customerCity = NULL;
  252.         /**
  253.          * Code postal du client
  254.          *
  255.          * @ORM\Column(type="string", length=255, nullable=true)
  256.          *
  257.          * @Expose
  258.          * @Groups({"purchase", "export_purchase_declaration_datatable"})
  259.          */
  260.         private ?string $customerPostcode = NULL;
  262.         /**
  263.          * Complément d'adresse du client
  264.          *
  265.          * @ORM\Column(type="text", nullable=true)
  266.          *
  267.          * @Expose
  268.          * @Groups({"purchase", "export_purchase_declaration_datatable"})
  269.          */
  270.         private ?string $customerAddress2 = NULL;
  272.         /**
  273.          * @ORM\Column(type="string", length=255, nullable=true)
  274.          */
  275.         private ?string $commercialName = NULL;
  278.         public function __construct()
  279.         {
  280.             $this->purchaseHistories = new ArrayCollection();
  281.             $this->files             = new ArrayCollection();
  282.             $this->items             = new ArrayCollection();
  283.             $this->pointTransactions = new ArrayCollection();
  284.         }
  287.         use DateTrait;
  289.         /*
  290.          * ============================================================================================
  291.          * =============================== FONCTIONS CUSTOM ===========================================
  292.          * ============================================================================================
  293.          */
  295.         /**
  296.          * @return float|int|null
  297.          * @Serializer\VirtualProperty()
  298.          * @Serializer\SerializedName("get_sum_values")
  299.          *
  300.          * @Expose()
  301.          * @Groups({"purchase"})
  302.          */
  303.         public function getSumValues()
  304.         {
  305.             $sum = 0;
  306.             /** @var PointTransaction $pointTransaction */
  307.             foreach ( $this->pointTransactions as $pointTransaction ) {
  308.                 $sum += $pointTransaction->getValue();
  309.             }
  311.             return $sum;
  312.         }
  314.         /**
  315.          * @return float|int
  316.          * @deprecated
  317.          * $value returns points acquired including boosters
  318.          * This method returns points without booster effects
  319.          */
  320.         public function getBulkValue()
  321.         {
  322.             $value = 0;
  323.             foreach ( $this->items as $item ) {
  324.                 $value += $item->getProduct()->getValue() * $item->getQuantity();
  325.             }
  327.             return $value;
  328.         }
  331.         /**
  332.          * @return int|null
  333.          * @deprecated Il y a une relation entre PointTransaction et Purchase {@see Purchase::$pointTransactions}
  334.          */
  335.         public function getValue(): ?int
  336.         {
  337.             return $this->value;
  338.         }
  341.         /**
  342.          * @param int|null $value
  343.          *
  344.          * @return $this
  345.          * @deprecated Il y a une relation entre PointTransaction et Purchase {@see Purchase::$pointTransactions}
  346.          */
  347.         public function setValue( ?int $value ): self
  348.         {
  349.             $this->value = $value;
  351.             return $this;
  352.         }
  355.         /**
  356.          * @return mixed
  357.          */
  358.         public function getImageFile()
  359.         {
  360.             return $this->imageFile;
  361.         }
  364.         public function getArrayCategoryValues()
  365.         {
  366.             $categoryValues = [];
  367.             /** @var PurchaseProductItem $item */
  368.             foreach ( $this->items as $item ) {
  369.                 $product   = $item->getProduct();
  370.                 $productCV = $product->getArrayCategoryValues();
  371.                 if ( $productCV !== NULL ) {
  372.                     if ( $categoryValues === [] ) {
  373.                         $categoryValues = $productCV;
  374.                     } else {
  375.                         $categoryValues = array_combine(
  376.                             array_keys( $categoryValues ),
  377.                             array_map( function ( $a, $b ) {
  378.                                 return $a + $b;
  379.                             }, $categoryValues, $productCV )
  380.                         );
  381.                     }
  382.                 }
  383.             }
  385.             return $categoryValues;
  386.         }
  389.         /*
  390.          * ============================================================================================
  391.          * ============================== FIN FONCTIONS CUSTOM ========================================
  392.          * ============================================================================================
  393.          */
  396.         /**
  397.          * @param $imageFile
  398.          *
  399.          * @return $this
  400.          */
  401.         public function setImageFile( $imageFile ): Purchase
  402.         {
  403.             $this->imageFile = $imageFile;
  405.             return $this;
  406.         }
  409.         /**
  410.          * @param array $files
  411.          *
  412.          * @return $this
  413.          */
  414.         public function addFiles( array $files ): Purchase
  415.         {
  416.             $this->files = new ArrayCollection( array_merge( $this->files->toArray(), $files ) );
  418.             return $this;
  419.         }
  422.         public function getId(): ?int
  423.         {
  424.             return $this->id;
  425.         }
  428.         public function getInvoiceNumber(): ?string
  429.         {
  430.             return $this->invoiceNumber;
  431.         }
  434.         public function setInvoiceNumber( string $invoiceNumber ): self
  435.         {
  436.             $this->invoiceNumber = $invoiceNumber;
  438.             return $this;
  439.         }
  442.         public function getInvoiceDate(): ?DateTimeInterface
  443.         {
  444.             return $this->invoiceDate;
  445.         }
  448.         public function setInvoiceDate( ?DateTimeInterface $invoiceDate ): self
  449.         {
  450.             $this->invoiceDate = $invoiceDate;
  452.             return $this;
  453.         }
  456.         public function getStatus(): ?string
  457.         {
  458.             return $this->status;
  459.         }
  462.         public function setStatus( ?string $status ): self
  463.         {
  464.             $this->status = $status;
  466.             return $this;
  467.         }
  470.         public function getLastStatusReason(): ?string
  471.         {
  472.             return $this->lastStatusReason;
  473.         }
  476.         public function setLastStatusReason( ?string $lastStatusReason ): self
  477.         {
  478.             $this->lastStatusReason = $lastStatusReason;
  480.             return $this;
  481.         }
  484.         /**
  485.          * @return string|null
  486.          * @deprecated Relation sur {@see Distributor}
  487.          */
  488.         public function getDistributorName(): ?string
  489.         {
  490.             return $this->distributorName;
  491.         }
  494.         /**
  495.          * @param string|null $distributorName
  496.          *
  497.          * @return $this
  498.          * @deprecated Relation sur {@see Distributor}
  499.          */
  500.         public function setDistributorName( ?string $distributorName ): self
  501.         {
  502.             $this->distributorName = $distributorName;
  504.             return $this;
  505.         }
  508.         /**
  509.          * @return string|null
  510.          * @deprecated Relation sur {@see Distributor}
  511.          */
  512.         public function getDistributorPostalCode(): ?string
  513.         {
  514.             return $this->distributorPostalCode;
  515.         }
  518.         /**
  519.          * @param string|null $distributorPostalCode
  520.          *
  521.          * @return $this
  522.          * @deprecated Relation sur {@see Distributor}
  523.          */
  524.         public function setDistributorPostalCode( ?string $distributorPostalCode ): self
  525.         {
  526.             $this->distributorPostalCode = $distributorPostalCode;
  528.             return $this;
  529.         }
  532.         /**
  533.          * @return string|null
  534.          * @deprecated Relation sur {@see Distributor}
  535.          */
  536.         public function getDistributorCity(): ?string
  537.         {
  538.             return $this->distributorCity;
  539.         }
  542.         /**
  543.          * @param string|null $distributorCity
  544.          *
  545.          * @return $this
  546.          * @deprecated Relation sur {@see Distributor}
  547.          */
  548.         public function setDistributorCity( ?string $distributorCity ): self
  549.         {
  550.             $this->distributorCity = $distributorCity;
  552.             return $this;
  553.         }
  556.         /**
  557.          * @return string|null
  558.          * @deprecated Relation sur {@see Distributor}
  559.          */
  560.         public function getDistributorCountry(): ?string
  561.         {
  562.             return $this->distributorCountry;
  563.         }
  566.         /**
  567.          * @param string|null $distributorCountry
  568.          *
  569.          * @return $this
  570.          * @deprecated Relation sur {@see Distributor}
  571.          */
  572.         public function setDistributorCountry( ?string $distributorCountry ): self
  573.         {
  574.             $this->distributorCountry = $distributorCountry;
  576.             return $this;
  577.         }
  580.         public function getValidator(): ?User
  581.         {
  582.             return $this->validator;
  583.         }
  586.         public function setValidator( ?User $validator ): self
  587.         {
  588.             $this->validator = $validator;
  590.             return $this;
  591.         }
  594.         public function getUser(): ?User
  595.         {
  596.             return $this->user;
  597.         }
  600.         public function setUser( ?User $user ): self
  601.         {
  602.             $this->user = $user;
  604.             return $this;
  605.         }
  608.         public function getDistributor(): ?Distributor
  609.         {
  610.             return $this->distributor;
  611.         }
  614.         public function setDistributor( ?Distributor $distributor ): self
  615.         {
  616.             $this->distributor = $distributor;
  618.             return $this;
  619.         }
  622.         /**
  623.          * @return Collection|PurchaseHistory[]
  624.          */
  625.         public function getPurchaseHistories(): Collection
  626.         {
  627.             return $this->purchaseHistories;
  628.         }
  631.         public function addPurchaseHistory( PurchaseHistory $purchaseHistory ): self
  632.         {
  633.             if ( !$this->purchaseHistories->contains( $purchaseHistory ) ) {
  634.                 $this->purchaseHistories[] = $purchaseHistory;
  635.                 $purchaseHistory->setPurchase( $this );
  636.             }
  638.             return $this;
  639.         }
  642.         public function removePurchaseHistory( PurchaseHistory $purchaseHistory ): self
  643.         {
  644.             if ( $this->purchaseHistories->removeElement( $purchaseHistory ) ) {
  645.                 // set the owning side to null (unless already changed)
  646.                 if ( $purchaseHistory->getPurchase() === $this ) {
  647.                     $purchaseHistory->setPurchase( NULL );
  648.                 }
  649.             }
  651.             return $this;
  652.         }
  655.         /**
  656.          * @return Collection|PurchaseFile[]
  657.          */
  658.         public function getFiles(): Collection
  659.         {
  660.             return $this->files;
  661.         }
  664.         public function addFile( PurchaseFile $file ): self
  665.         {
  666.             if ( !$this->files->contains( $file ) ) {
  667.                 $this->files[] = $file;
  668.                 $file->setPurchase( $this );
  669.             }
  671.             return $this;
  672.         }
  675.         public function removeFile( PurchaseFile $file ): self
  676.         {
  677.             if ( $this->files->removeElement( $file ) ) {
  678.                 // set the owning side to null (unless already changed)
  679.                 if ( $file->getPurchase() === $this ) {
  680.                     $file->setPurchase( NULL );
  681.                 }
  682.             }
  684.             return $this;
  685.         }
  688.         /**
  689.          * @return Collection|PurchaseProductItem[]
  690.          */
  691.         public function getItems(): Collection
  692.         {
  693.             return $this->items;
  694.         }
  697.         public function addItem( PurchaseProductItem $item ): self
  698.         {
  699.             if ( !$this->items->contains( $item ) ) {
  700.                 $this->items[] = $item;
  701.                 $item->setPurchase( $this );
  702.             }
  704.             return $this;
  705.         }
  708.         public function removeItem( PurchaseProductItem $item ): self
  709.         {
  710.             if ( $this->items->removeElement( $item ) ) {
  711.                 // set the owning side to null (unless already changed)
  712.                 if ( $item->getPurchase() === $this ) {
  713.                     $item->setPurchase( NULL );
  714.                 }
  715.             }
  717.             return $this;
  718.         }
  721.         /**
  722.          * @return Collection|PointTransaction[]
  723.          */
  724.         public function getPointTransactions(): Collection
  725.         {
  726.             return $this->pointTransactions;
  727.         }
  730.         public function addPointTransaction( PointTransaction $pointTransaction ): self
  731.         {
  732.             if ( !$this->pointTransactions->contains( $pointTransaction ) ) {
  733.                 $this->pointTransactions[] = $pointTransaction;
  734.                 $pointTransaction->setPurchase( $this );
  735.             }
  737.             return $this;
  738.         }
  741.         public function removePointTransaction( PointTransaction $pointTransaction ): self
  742.         {
  743.             if ( $this->pointTransactions->removeElement( $pointTransaction ) ) {
  744.                 // set the owning side to null (unless already changed)
  745.                 if ( $pointTransaction->getPurchase() === $this ) {
  746.                     $pointTransaction->setPurchase( NULL );
  747.                 }
  748.             }
  750.             return $this;
  751.         }
  754.         public function getValidationDate(): ?DateTimeInterface
  755.         {
  756.             return $this->validationDate;
  757.         }
  760.         public function setValidationDate( ?DateTimeInterface $validationDate ): self
  761.         {
  762.             $this->validationDate = $validationDate;
  764.             return $this;
  765.         }
  768.         public function getDistributorAddress1(): ?string
  769.         {
  770.             return $this->distributorAddress1;
  771.         }
  774.         public function setDistributorAddress1( ?string $distributorAddress1 ): self
  775.         {
  776.             $this->distributorAddress1 = $distributorAddress1;
  778.             return $this;
  779.         }
  782.         public function getCustomerFirstName(): ?string
  783.         {
  784.             return $this->customerFirstName;
  785.         }
  788.         public function setCustomerFirstName( ?string $customerFirstName ): self
  789.         {
  790.             $this->customerFirstName = $customerFirstName;
  792.             return $this;
  793.         }
  796.         public function getCustomerLastName(): ?string
  797.         {
  798.             return $this->customerLastName;
  799.         }
  802.         public function setCustomerLastName( ?string $customerLastName ): self
  803.         {
  804.             $this->customerLastName = $customerLastName;
  806.             return $this;
  807.         }
  810.         public function getCustomerAddress1(): ?string
  811.         {
  812.             return $this->customerAddress1;
  813.         }
  816.         public function setCustomerAddress1( ?string $customerAddress1 ): self
  817.         {
  818.             $this->customerAddress1 = $customerAddress1;
  820.             return $this;
  821.         }
  824.         public function getCustomerCity(): ?string
  825.         {
  826.             return $this->customerCity;
  827.         }
  830.         public function setCustomerCity( ?string $customerCity ): self
  831.         {
  832.             $this->customerCity = $customerCity;
  834.             return $this;
  835.         }
  838.         public function getCustomerPostcode(): ?string
  839.         {
  840.             return $this->customerPostcode;
  841.         }
  844.         public function setCustomerPostcode( ?string $customerPostcode ): self
  845.         {
  846.             $this->customerPostcode = $customerPostcode;
  848.             return $this;
  849.         }
  852.         public function getCustomerAddress2(): ?string
  853.         {
  854.             return $this->customerAddress2;
  855.         }
  858.         public function setCustomerAddress2( ?string $customerAddress2 ): self
  859.         {
  860.             $this->customerAddress2 = $customerAddress2;
  862.             return $this;
  863.         }
  866.         public function getCommercialName(): ?string
  867.         {
  868.             return $this->commercialName;
  869.         }
  872.         public function setCommercialName( ?string $commercialName ): self
  873.         {
  874.             $this->commercialName = $commercialName;
  876.             return $this;
  877.         }
  878.     }