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';
  30. // On se refere à la taille en m² (expert-fenetre.rehau) pour calculer les points multiplier par un coefficient
  31. public const POINT_PAID_PER_COEFFICIENT = 'point_paid_per_coefficient';
  33. public const STATUS_PENDING = PurchaseStatus::STATUS_PENDING;
  34. public const STATUS_VALIDATED = PurchaseStatus::STATUS_VALIDATED;
  35. public const STATUS_RETURNED = PurchaseStatus::STATUS_RETURNED;
  36. public const STATUS_REJECTED = PurchaseStatus::STATUS_REJECTED;
  38. /**
  39. * @ORM\Id
  40. * @ORM\GeneratedValue
  41. * @ORM\Column(type="integer")
  42. *
  43. * @Expose
  44. * @Groups({"purchase", "export_purchase_declaration_datatable"})
  45. */
  46. private ?int $id = NULL;
  48. /**
  49. * Numéro de facture
  50. *
  51. * @ORM\Column(type="string", length=64)
  52. *
  53. * @Expose
  54. * @Groups({"purchase", "export_purchase_declaration_datatable"})
  55. */
  56. private $invoiceNumber;
  58. /**
  59. * Date de facture
  60. *
  61. * @ORM\Column(type="date", nullable=true)
  62. *
  63. * @Expose
  64. * @Groups({"purchase", "export_purchase_declaration_datatable"})
  65. */
  66. private $invoiceDate;
  68. /**
  69. * Status de la déclaration
  70. *
  71. * @ORM\Column(type="integer", options={"default": self::STATUS_PENDING})
  72. *
  73. * @Expose
  74. * @Groups({"purchase", "export_purchase_declaration_datatable"})
  75. */
  76. private $status = self::STATUS_PENDING;
  78. /**
  79. * Raison du statut
  80. *
  81. * @ORM\Column(type="string", length=512, nullable=true)
  82. */
  83. private ?string $lastStatusReason = NULL;
  85. /**
  86. * Nom du distributeur
  87. *
  88. * @deprecated Relation sur {@see Distributor}
  89. *
  90. * @ORM\Column(type="string", length=255, nullable=true)
  91. */
  92. private ?string $distributorName = NULL;
  94. /**
  95. * Code postal du distributeur
  96. *
  97. * @deprecated Relation sur {@see Distributor}
  98. *
  99. * @ORM\Column(type="string", length=255, nullable=true)
  100. */
  101. private ?string $distributorPostalCode = NULL;
  103. /**
  104. * Ville du distributeur
  105. *
  106. * @deprecated Relation sur {@see Distributor}
  107. *
  108. * @ORM\Column(type="string", length=255, nullable=true)
  109. */
  110. private ?string $distributorCity = NULL;
  112. /**
  113. * Pays du distributeur
  114. *
  115. * @deprecated Relation sur {@see Distributor}
  116. *
  117. * @ORM\Column(type="string", length=255, nullable=true)
  118. */
  119. private ?string $distributorCountry = NULL;
  121. /**
  122. * Valeur de la déclaration
  123. *
  124. * @deprecated Il y a une relation entre PointTransaction et Purchase {@see Purchase::$pointTransactions}
  125. *
  126. * @ORM\Column(type="integer", nullable=true)
  127. */
  128. private ?int $value = NULL;
  130. /**
  131. * Personne qui a validé la déclaration
  132. *
  133. * @ORM\ManyToOne(targetEntity=User::class,inversedBy="purchasesIHaveProcessed")
  134. * @ORM\JoinColumn(onDelete="SET NULL")
  135. *
  136. * @Expose
  137. * @Groups({"purchase"})
  138. */
  139. private $validator;
  141. /**
  142. * Utilisateur qui a fait la déclaration
  143. *
  144. * @ORM\ManyToOne(targetEntity=User::class,inversedBy="purchases")
  145. *
  146. * @Expose
  147. * @Groups({"purchase", "export_purchase_declaration_datatable"})
  148. */
  149. private $user;
  151. /**
  152. * Distributeur rattaché à la déclaration
  153. *
  154. * @ORM\ManyToOne(targetEntity=Distributor::class, inversedBy="purchases")
  155. *
  156. * @Expose()
  157. * @Groups({"export_purchase_declaration_datatable"})
  158. */
  159. private $distributor;
  161. /**
  162. * @TODO Check que toujours utilse
  163. */
  164. private $imageFile;
  166. /**
  167. * @ORM\OneToMany(
  168. * targetEntity=PurchaseHistory::class,
  169. * mappedBy="purchase",
  170. * cascade={"persist", "remove"}
  171. * )
  172. */
  173. private $purchaseHistories;
  175. /**
  176. * @ORM\OneToMany(
  177. * targetEntity=PurchaseFile::class,
  178. * mappedBy="purchase",
  179. * cascade={"remove", "persist"}
  180. * )
  181. */
  182. private $files;
  184. /**
  185. * @ORM\OneToMany(
  186. * targetEntity=PurchaseProductItem::class,
  187. * mappedBy="purchase",
  188. * cascade={"remove", "persist"},
  189. * orphanRemoval=true
  190. * )
  191. *
  192. * @Expose()
  193. * @Groups({"export_purchase_declaration_datatable"})
  194. */
  195. private $items;
  197. /**
  198. * @ORM\OneToMany(targetEntity=PointTransaction::class, mappedBy="purchase")
  199. */
  200. private Collection $pointTransactions;
  202. /**
  203. * Date de la validation
  204. *
  205. * @ORM\Column(type="datetime", nullable=true)
  206. */
  207. private $validationDate;
  209. /**
  210. * @ORM\Column(type="string", length=255, nullable=true)
  211. */
  212. private ?string $distributorAddress1 = NULL;
  214. /**
  215. * Prénom du client
  216. *
  217. * @ORM\Column(type="string", length=255, nullable=true)
  218. *
  219. * @Expose
  220. * @Groups({"purchase", "export_purchase_declaration_datatable"})
  221. */
  222. private ?string $customerFirstName = NULL;
  224. /**
  225. * Nom du client
  226. *
  227. * @ORM\Column(type="string", length=255, nullable=true)
  228. *
  229. * @Expose
  230. * @Groups({"purchase", "export_purchase_declaration_datatable"})
  231. */
  232. private ?string $customerLastName = NULL;
  234. /**
  235. * Adresse du client
  236. *
  237. * @ORM\Column(type="string", length=255, nullable=true)
  238. *
  239. * @Expose
  240. * @Groups({"purchase", "export_purchase_declaration_datatable"})
  241. */
  242. private ?string $customerAddress1 = NULL;
  244. /**
  245. * Ville du client
  246. *
  247. * @ORM\Column(type="string", length=255, nullable=true)
  248. *
  249. * @Expose
  250. * @Groups({"purchase", "export_purchase_declaration_datatable"})
  251. */
  252. private ?string $customerCity = NULL;
  254. /**
  255. * Code postal du client
  256. *
  257. * @ORM\Column(type="string", length=255, nullable=true)
  258. *
  259. * @Expose
  260. * @Groups({"purchase", "export_purchase_declaration_datatable"})
  261. */
  262. private ?string $customerPostcode = NULL;
  264. /**
  265. * Complément d'adresse du client
  266. *
  267. * @ORM\Column(type="text", nullable=true)
  268. *
  269. * @Expose
  270. * @Groups({"purchase", "export_purchase_declaration_datatable"})
  271. */
  272. private ?string $customerAddress2 = NULL;
  274. /**
  275. * @ORM\Column(type="string", length=255, nullable=true)
  276. */
  277. private ?string $commercialName = NULL;
  280. public function __construct()
  281. {
  282. $this->purchaseHistories = new ArrayCollection();
  283. $this->files = new ArrayCollection();
  284. $this->items = new ArrayCollection();
  285. $this->pointTransactions = new ArrayCollection();
  286. }
  289. use DateTrait;
  291. /*
  292. * ============================================================================================
  293. * =============================== FONCTIONS CUSTOM ===========================================
  294. * ============================================================================================
  295. */
  297. /**
  298. * @return float|int|null
  299. * @Serializer\VirtualProperty()
  300. * @Serializer\SerializedName("get_sum_values")
  301. *
  302. * @Expose()
  303. * @Groups({"purchase"})
  304. */
  305. public function getSumValues()
  306. {
  307. $sum = 0;
  308. /** @var PointTransaction $pointTransaction */
  309. foreach ( $this->pointTransactions as $pointTransaction ) {
  310. $sum += $pointTransaction->getValue();
  311. }
  313. return $sum;
  314. }
  316. /**
  317. * @return float|int
  318. * @deprecated
  319. * $value returns points acquired including boosters
  320. * This method returns points without booster effects
  321. */
  322. public function getBulkValue()
  323. {
  324. $value = 0;
  325. foreach ( $this->items as $item ) {
  326. $value += $item->getProduct()->getValue() * $item->getQuantity();
  327. }
  329. return $value;
  330. }
  333. /**
  334. * @return int|null
  335. * @deprecated Il y a une relation entre PointTransaction et Purchase {@see Purchase::$pointTransactions}
  336. */
  337. public function getValue(): ?int
  338. {
  339. return $this->value;
  340. }
  343. /**
  344. * @param int|null $value
  345. *
  346. * @return $this
  347. * @deprecated Il y a une relation entre PointTransaction et Purchase {@see Purchase::$pointTransactions}
  348. */
  349. public function setValue( ?int $value ): self
  350. {
  351. $this->value = $value;
  353. return $this;
  354. }
  357. /**
  358. * @return mixed
  359. */
  360. public function getImageFile()
  361. {
  362. return $this->imageFile;
  363. }
  366. public function getArrayCategoryValues()
  367. {
  368. $categoryValues = [];
  369. /** @var PurchaseProductItem $item */
  370. foreach ( $this->items as $item ) {
  371. $product = $item->getProduct();
  372. $productCV = $product->getArrayCategoryValues();
  373. if ( $productCV !== NULL ) {
  374. if ( $categoryValues === [] ) {
  375. $categoryValues = $productCV;
  376. } else {
  377. $categoryValues = array_combine(
  378. array_keys( $categoryValues ),
  379. array_map( function ( $a, $b ) {
  380. return $a + $b;
  381. }, $categoryValues, $productCV )
  382. );
  383. }
  384. }
  385. }
  387. return $categoryValues;
  388. }
  391. /*
  392. * ============================================================================================
  393. * ============================== FIN FONCTIONS CUSTOM ========================================
  394. * ============================================================================================
  395. */
  398. /**
  399. * @param $imageFile
  400. *
  401. * @return $this
  402. */
  403. public function setImageFile( $imageFile ): Purchase
  404. {
  405. $this->imageFile = $imageFile;
  407. return $this;
  408. }
  411. /**
  412. * @param array $files
  413. *
  414. * @return $this
  415. */
  416. public function addFiles( array $files ): Purchase
  417. {
  418. $this->files = new ArrayCollection( array_merge( $this->files->toArray(), $files ) );
  420. return $this;
  421. }
  424. public function getId(): ?int
  425. {
  426. return $this->id;
  427. }
  430. public function getInvoiceNumber(): ?string
  431. {
  432. return $this->invoiceNumber;
  433. }
  436. public function setInvoiceNumber( string $invoiceNumber ): self
  437. {
  438. $this->invoiceNumber = $invoiceNumber;
  440. return $this;
  441. }
  444. public function getInvoiceDate(): ?DateTimeInterface
  445. {
  446. return $this->invoiceDate;
  447. }
  450. public function setInvoiceDate( ?DateTimeInterface $invoiceDate ): self
  451. {
  452. $this->invoiceDate = $invoiceDate;
  454. return $this;
  455. }
  458. public function getStatus(): ?string
  459. {
  460. return $this->status;
  461. }
  464. public function setStatus( ?string $status ): self
  465. {
  466. $this->status = $status;
  468. return $this;
  469. }
  472. public function getLastStatusReason(): ?string
  473. {
  474. return $this->lastStatusReason;
  475. }
  478. public function setLastStatusReason( ?string $lastStatusReason ): self
  479. {
  480. $this->lastStatusReason = $lastStatusReason;
  482. return $this;
  483. }
  486. /**
  487. * @return string|null
  488. * @deprecated Relation sur {@see Distributor}
  489. */
  490. public function getDistributorName(): ?string
  491. {
  492. return $this->distributorName;
  493. }
  496. /**
  497. * @param string|null $distributorName
  498. *
  499. * @return $this
  500. * @deprecated Relation sur {@see Distributor}
  501. */
  502. public function setDistributorName( ?string $distributorName ): self
  503. {
  504. $this->distributorName = $distributorName;
  506. return $this;
  507. }
  510. /**
  511. * @return string|null
  512. * @deprecated Relation sur {@see Distributor}
  513. */
  514. public function getDistributorPostalCode(): ?string
  515. {
  516. return $this->distributorPostalCode;
  517. }
  520. /**
  521. * @param string|null $distributorPostalCode
  522. *
  523. * @return $this
  524. * @deprecated Relation sur {@see Distributor}
  525. */
  526. public function setDistributorPostalCode( ?string $distributorPostalCode ): self
  527. {
  528. $this->distributorPostalCode = $distributorPostalCode;
  530. return $this;
  531. }
  534. /**
  535. * @return string|null
  536. * @deprecated Relation sur {@see Distributor}
  537. */
  538. public function getDistributorCity(): ?string
  539. {
  540. return $this->distributorCity;
  541. }
  544. /**
  545. * @param string|null $distributorCity
  546. *
  547. * @return $this
  548. * @deprecated Relation sur {@see Distributor}
  549. */
  550. public function setDistributorCity( ?string $distributorCity ): self
  551. {
  552. $this->distributorCity = $distributorCity;
  554. return $this;
  555. }
  558. /**
  559. * @return string|null
  560. * @deprecated Relation sur {@see Distributor}
  561. */
  562. public function getDistributorCountry(): ?string
  563. {
  564. return $this->distributorCountry;
  565. }
  568. /**
  569. * @param string|null $distributorCountry
  570. *
  571. * @return $this
  572. * @deprecated Relation sur {@see Distributor}
  573. */
  574. public function setDistributorCountry( ?string $distributorCountry ): self
  575. {
  576. $this->distributorCountry = $distributorCountry;
  578. return $this;
  579. }
  582. public function getValidator(): ?User
  583. {
  584. return $this->validator;
  585. }
  588. public function setValidator( ?User $validator ): self
  589. {
  590. $this->validator = $validator;
  592. return $this;
  593. }
  596. public function getUser(): ?User
  597. {
  598. return $this->user;
  599. }
  602. public function setUser( ?User $user ): self
  603. {
  604. $this->user = $user;
  606. return $this;
  607. }
  610. public function getDistributor(): ?Distributor
  611. {
  612. return $this->distributor;
  613. }
  616. public function setDistributor( ?Distributor $distributor ): self
  617. {
  618. $this->distributor = $distributor;
  620. return $this;
  621. }
  624. /**
  625. * @return Collection|PurchaseHistory[]
  626. */
  627. public function getPurchaseHistories(): Collection
  628. {
  629. return $this->purchaseHistories;
  630. }
  633. public function addPurchaseHistory( PurchaseHistory $purchaseHistory ): self
  634. {
  635. if ( !$this->purchaseHistories->contains( $purchaseHistory ) ) {
  636. $this->purchaseHistories[] = $purchaseHistory;
  637. $purchaseHistory->setPurchase( $this );
  638. }
  640. return $this;
  641. }
  644. public function removePurchaseHistory( PurchaseHistory $purchaseHistory ): self
  645. {
  646. if ( $this->purchaseHistories->removeElement( $purchaseHistory ) ) {
  647. // set the owning side to null (unless already changed)
  648. if ( $purchaseHistory->getPurchase() === $this ) {
  649. $purchaseHistory->setPurchase( NULL );
  650. }
  651. }
  653. return $this;
  654. }
  657. /**
  658. * @return Collection|PurchaseFile[]
  659. */
  660. public function getFiles(): Collection
  661. {
  662. return $this->files;
  663. }
  666. public function addFile( PurchaseFile $file ): self
  667. {
  668. if ( !$this->files->contains( $file ) ) {
  669. $this->files[] = $file;
  670. $file->setPurchase( $this );
  671. }
  673. return $this;
  674. }
  677. public function removeFile( PurchaseFile $file ): self
  678. {
  679. if ( $this->files->removeElement( $file ) ) {
  680. // set the owning side to null (unless already changed)
  681. if ( $file->getPurchase() === $this ) {
  682. $file->setPurchase( NULL );
  683. }
  684. }
  686. return $this;
  687. }
  690. /**
  691. * @return Collection|PurchaseProductItem[]
  692. */
  693. public function getItems(): Collection
  694. {
  695. return $this->items;
  696. }
  699. public function addItem( PurchaseProductItem $item ): self
  700. {
  701. if ( !$this->items->contains( $item ) ) {
  702. $this->items[] = $item;
  703. $item->setPurchase( $this );
  704. }
  706. return $this;
  707. }
  710. public function removeItem( PurchaseProductItem $item ): self
  711. {
  712. if ( $this->items->removeElement( $item ) ) {
  713. // set the owning side to null (unless already changed)
  714. if ( $item->getPurchase() === $this ) {
  715. $item->setPurchase( NULL );
  716. }
  717. }
  719. return $this;
  720. }
  723. /**
  724. * @return Collection|PointTransaction[]
  725. */
  726. public function getPointTransactions(): Collection
  727. {
  728. return $this->pointTransactions;
  729. }
  732. public function addPointTransaction( PointTransaction $pointTransaction ): self
  733. {
  734. if ( !$this->pointTransactions->contains( $pointTransaction ) ) {
  735. $this->pointTransactions[] = $pointTransaction;
  736. $pointTransaction->setPurchase( $this );
  737. }
  739. return $this;
  740. }
  743. public function removePointTransaction( PointTransaction $pointTransaction ): self
  744. {
  745. if ( $this->pointTransactions->removeElement( $pointTransaction ) ) {
  746. // set the owning side to null (unless already changed)
  747. if ( $pointTransaction->getPurchase() === $this ) {
  748. $pointTransaction->setPurchase( NULL );
  749. }
  750. }
  752. return $this;
  753. }
  756. public function getValidationDate(): ?DateTimeInterface
  757. {
  758. return $this->validationDate;
  759. }
  762. public function setValidationDate( ?DateTimeInterface $validationDate ): self
  763. {
  764. $this->validationDate = $validationDate;
  766. return $this;
  767. }
  770. public function getDistributorAddress1(): ?string
  771. {
  772. return $this->distributorAddress1;
  773. }
  776. public function setDistributorAddress1( ?string $distributorAddress1 ): self
  777. {
  778. $this->distributorAddress1 = $distributorAddress1;
  780. return $this;
  781. }
  784. public function getCustomerFirstName(): ?string
  785. {
  786. return $this->customerFirstName;
  787. }
  790. public function setCustomerFirstName( ?string $customerFirstName ): self
  791. {
  792. $this->customerFirstName = $customerFirstName;
  794. return $this;
  795. }
  798. public function getCustomerLastName(): ?string
  799. {
  800. return $this->customerLastName;
  801. }
  804. public function setCustomerLastName( ?string $customerLastName ): self
  805. {
  806. $this->customerLastName = $customerLastName;
  808. return $this;
  809. }
  812. public function getCustomerAddress1(): ?string
  813. {
  814. return $this->customerAddress1;
  815. }
  818. public function setCustomerAddress1( ?string $customerAddress1 ): self
  819. {
  820. $this->customerAddress1 = $customerAddress1;
  822. return $this;
  823. }
  826. public function getCustomerCity(): ?string
  827. {
  828. return $this->customerCity;
  829. }
  832. public function setCustomerCity( ?string $customerCity ): self
  833. {
  834. $this->customerCity = $customerCity;
  836. return $this;
  837. }
  840. public function getCustomerPostcode(): ?string
  841. {
  842. return $this->customerPostcode;
  843. }
  846. public function setCustomerPostcode( ?string $customerPostcode ): self
  847. {
  848. $this->customerPostcode = $customerPostcode;
  850. return $this;
  851. }
  854. public function getCustomerAddress2(): ?string
  855. {
  856. return $this->customerAddress2;
  857. }
  860. public function setCustomerAddress2( ?string $customerAddress2 ): self
  861. {
  862. $this->customerAddress2 = $customerAddress2;
  864. return $this;
  865. }
  868. public function getCommercialName(): ?string
  869. {
  870. return $this->commercialName;
  871. }
  874. public function setCommercialName( ?string $commercialName ): self
  875. {
  876. $this->commercialName = $commercialName;
  878. return $this;
  879. }
  880. }