src/Entity/PointTransaction.php line 21

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Repository\PointTransactionRepository;
  6. use App\Traits\DateTrait;
  7. use DateTime;
  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 Symfony\Component\Validator\Constraints as Assert;
  16. /**
  17. * @ORM\Entity(repositoryClass=PointTransactionRepository::class)
  18. *
  19. * @Serializer\ExclusionPolicy("ALL")
  20. */
  21. class PointTransaction
  22. {
  23. use DateTrait;
  25. public const TRANSACTION_FEES_TYPE_FEES = 'fees';
  26. public const TRANSACTION_FEES_TYPE_SHIPPING_PRICE = 'shipping_price';
  27. public const USER_VALIDATION_TRANSACTION_TYPE = 'user_validation';
  28. public const TRANSACTION_GOD_CHILD = 'god_child';
  29. public const TRANSACTION_GOD_FATHER = 'god_father';
  30. public const TRANSACTION_ANIMATION = 'animation';
  31. public const TRANSACTION_HIGHLIGHT = 'highlight';
  32. public const TRANSACTION_BONUS_STATUS = 'bonus_status';
  33. public const TRANSACTION_BONUS_BOOSTER = 'bonus_booster';
  34. public const TRANSACTION_RESET = 'reset';
  36. public const TRANSACTION_BONUS_STEP_CA = 'bonus_step_ca';
  38. /** Solde des commandes */
  39. private int $orderSolde = 0;
  40. /** Solde des points de fidélités */
  41. private int $fidelitySolde = 0;
  42. /**
  43. * Identifiant unique auto-incrémenté
  44. *
  45. * @ORM\Id
  46. * @ORM\GeneratedValue
  47. * @ORM\Column(type="integer")
  48. *
  49. * @Expose
  50. * @Serializer\Groups({"point_transaction:id"})
  51. */
  52. private ?int $id = null;
  53. /**
  54. * Utilisateur lié à la transaction
  55. *
  56. * @ORM\ManyToOne(targetEntity=User::class, inversedBy="pointTransactions")
  57. * @ORM\JoinColumn(nullable=false)
  58. *
  59. * @Expose
  60. * @Serializer\Groups({"point_transaction:user"})
  61. */
  62. private ?User $user = null;
  63. /**
  64. * Commande liée à la transaction
  65. *
  66. * @ORM\ManyToOne(targetEntity=SaleOrder::class, inversedBy="pointTransactions")
  67. */
  68. private ?SaleOrder $saleOrder = null;
  69. /**
  70. * Valeur de la transaction
  71. *
  72. * @ORM\Column(type="float")
  73. *
  74. * @Expose
  75. * @Serializer\Groups({"point_transaction:value"})
  76. */
  77. private ?float $value = null;
  78. /**
  79. * Label de la transaction
  80. *
  81. * @ORM\Column(type="string", length=255)
  82. *
  83. * @Assert\NotBlank
  84. *
  85. * @Expose
  86. * @Serializer\Groups({"point_transaction:label"})
  87. */
  88. private ?string $label = null;
  89. /**
  90. * Référence du paiement par carte
  91. *
  92. * @ORM\Column(type="string", length=255, nullable=true)
  93. *
  94. * @Expose
  95. * @Serializer\Groups({"point_transaction:paymentReference"})
  96. */
  97. private ?string $paymentReference = null;
  98. /**
  99. * Future valeur de la transaction lors d'un paiement par carte
  100. * Ce montant sera attribué à la valeur réelle après le retour IPN de la banque
  101. *
  102. * @ORM\Column(type="float", nullable=true)
  103. *
  104. * @Expose
  105. * @Serializer\Groups({"point_transaction:value"})
  106. */
  107. private ?float $paymentValue = null;
  108. /**
  109. * Informations reçues lors du retour IPN de la banque
  110. *
  111. * @ORM\Column(type="json", nullable=true)
  112. *
  113. * @Expose
  114. * @Serializer\Groups({"point_transaction:paymentInformations"})
  115. */
  116. private ?array $paymentInformations = [];
  117. /**
  118. * Date d'expiration de la transaction
  119. *
  120. * @ORM\Column(type="datetime", nullable=true)
  121. */
  122. private ?DateTime $expiredAt = null;
  123. /**
  124. * Transaction liée à une autre transaction
  125. *
  126. * @ORM\ManyToOne(
  127. * targetEntity=PointTransaction::class,
  128. * inversedBy="childrenPointTransactions",
  129. * cascade={"persist", "remove"}
  130. * )
  131. */
  132. private ?PointTransaction $linkedPointTransaction = null;
  133. /**
  134. * Liste des transactions enfants liées à la transaction
  135. *
  136. * @ORM\OneToMany(targetEntity=PointTransaction::class, mappedBy="linkedPointTransaction", orphanRemoval=true)
  137. */
  138. private ?Collection $childrenPointTransactions = null;
  139. /**
  140. * Type de transaction
  141. *
  142. * @ORM\ManyToOne(targetEntity=PointTransactionType::class, inversedBy="pointTransactions")
  143. * @ORM\JoinColumn(nullable=false)
  144. */
  145. private ?PointTransactionType $transactionType = null;
  146. /**
  147. * Déclaration d'achat liée à la transaction
  148. *
  149. * @ORM\ManyToOne(targetEntity=Purchase::class, inversedBy="pointTransactions")
  150. */
  151. private ?Purchase $purchase = null;
  152. /**
  153. * Historique d'import lié à la transaction
  154. *
  155. * @ORM\ManyToOne(
  156. * targetEntity=PointTransactionImportHistory::class,
  157. * inversedBy="pointTransactions",
  158. * cascade={"persist"}
  159. * )
  160. */
  161. private ?PointTransactionImportHistory $importHistory = null;
  162. /**
  163. * Date d'effet de la transaction
  164. *
  165. * @ORM\Column(type="datetime", nullable=true)
  166. */
  167. private ?DateTimeInterface $effectiveAt = null;
  168. /**
  169. * Méthode d'import de la transaction
  170. *
  171. * @ORM\Column(type="string", length=32, nullable=true)
  172. */
  173. private ?string $importMethod = null;
  174. /**
  175. * Commande de produit personnalisé liée à la transaction
  176. *
  177. * @ORM\ManyToOne(targetEntity=CustomProductOrder::class)
  178. */
  179. private ?CustomProductOrder $customProductOrder = null;
  180. /**
  181. * Résultat d'activité lié à la transaction
  182. *
  183. * @ORM\OneToOne(
  184. * targetEntity=UserBusinessResult::class,
  185. * inversedBy="pointTransaction",
  186. * cascade={"persist", "remove"}
  187. * )
  188. */
  189. private ?UserBusinessResult $businessResult = null;
  190. /**
  191. * Catégorie de la transaction
  192. *
  193. * @ORM\Column(type="string", length=64, nullable=true)
  194. */
  195. private ?string $category = null;
  196. /**
  197. * On lie un SaleOrderItem a une transaction seulement à l'annulation, pour pouvoir lier un remboursement a un produit
  198. *
  199. * @ORM\ManyToOne(targetEntity=SaleOrderItem::class, inversedBy="pointTransactions", cascade={"persist"})
  200. */
  201. private ?SaleOrderItem $saleOrderItem = null;
  202. /**
  203. * Panier lié à la transaction quand elle est validée (retour de l'utilisateur depuis l'interface de la banque)
  204. * même si elle n'est pas encore confirmée par la banque (retour automatique IPN)
  205. * quand elle est confirmée, on lui attribue le montant correspondant, sinon il reste à 0
  206. *
  207. * @ORM\ManyToOne(targetEntity=Cart::class,inversedBy="paidPointTransactions")
  208. * @ORM\JoinColumn(nullable=true, onDelete="SET NULL")
  209. */
  210. private ?Cart $paidCart = null;
  211. /**
  212. * Panier lié à la transaction, dans le cadre d'un paiement par carte avant que la transaction ne soit validée
  213. *
  214. * @ORM\ManyToOne(targetEntity=Cart::class,inversedBy="pointTransactions")
  215. * @ORM\JoinColumn(nullable=true, onDelete="SET NULL")
  216. */
  217. private ?Cart $cart = null;
  218. /**
  219. * @ORM\ManyToMany(targetEntity=Invoice::class, mappedBy="transactionPoints")
  220. */
  221. private Collection $invoices;
  222. /**
  223. * Type de frais de la transaction
  224. *
  225. * @ORM\Column(type="string", length=64, nullable=true)
  226. */
  227. private ?string $subtype = null;
  228. /**
  229. * @ORM\Column(type="string", length=255, nullable=true)
  230. */
  231. private $eventKey;
  233. public function __construct()
  234. {
  235. $this->childrenPointTransactions = new ArrayCollection();
  236. $this->invoices = new ArrayCollection();
  237. }
  239. public function __toString()
  240. {
  241. return $this->getValue() . ' - ' . $this->getLabel();
  242. }
  244. // MÉTHODES NÉCESSAIRES POUR LE CALCUL DE POINT : NE PAS EFFACER
  245. public function setOrderSolde($orderSolde): PointTransaction
  246. {
  247. $this->orderSolde += $orderSolde;
  249. return $this;
  250. }
  252. public function getOrderSolde(): int
  253. {
  254. return $this->orderSolde;
  255. }
  257. public function setFidelitySolde($fidelitySolde): PointTransaction
  258. {
  259. $this->fidelitySolde += $fidelitySolde;
  261. return $this;
  262. }
  264. public function getFidelitySolde(): int
  265. {
  266. return $this->fidelitySolde;
  267. }
  269. // END METHODES
  271. public function getId(): ?int
  272. {
  273. return $this->id;
  274. }
  276. public function getValue(): ?float
  277. {
  278. return $this->value;
  279. }
  281. public function setValue(float $value): self
  282. {
  283. $this->value = $value;
  285. return $this;
  286. }
  288. public function getLabel(): ?string
  289. {
  290. $label = $this->label;
  292. if ($this->getTransactionType(true) === PointTransactionType::PAYMENT) {
  293. $label .= ' (' . $this->getPaymentReference() . ')';
  294. }
  296. return $label;
  297. }
  299. public function setLabel(string $label): self
  300. {
  301. $this->label = $label;
  303. return $this;
  304. }
  306. public function getExpiredAt(): ?DateTimeInterface
  307. {
  308. return $this->expiredAt;
  309. }
  311. public function setExpiredAt(?DateTime $expiredAt): self
  312. {
  313. $this->expiredAt = $expiredAt;
  315. return $this;
  316. }
  318. public function getEffectiveAt(): ?DateTimeInterface
  319. {
  320. return $this->effectiveAt;
  321. }
  323. public function setEffectiveAt(?DateTimeInterface $effectiveAt): self
  324. {
  325. $this->effectiveAt = $effectiveAt;
  327. return $this;
  328. }
  330. public function getImportMethod(): ?string
  331. {
  332. return $this->importMethod;
  333. }
  335. public function setImportMethod(?string $importMethod): self
  336. {
  337. $this->importMethod = $importMethod;
  339. return $this;
  340. }
  342. public function getCategory(): ?string
  343. {
  344. return $this->category;
  345. }
  347. public function setCategory(?string $category): self
  348. {
  349. $this->category = $category;
  351. return $this;
  352. }
  354. public function getUser(): ?User
  355. {
  356. return $this->user;
  357. }
  359. public function setUser(?User $user): self
  360. {
  361. $this->user = $user;
  363. return $this;
  364. }
  366. public function getSaleOrder(): ?SaleOrder
  367. {
  368. return $this->saleOrder;
  369. }
  371. public function setSaleOrder(?SaleOrder $saleOrder): self
  372. {
  373. if ($this->saleOrder === $saleOrder) {
  374. return $this;
  375. }
  377. if ($this->saleOrder !== null) {
  378. $this->saleOrder->removePointTransaction($this);
  379. }
  381. $this->saleOrder = $saleOrder;
  383. if ($saleOrder !== null && !$saleOrder->getPointTransactions()
  384. ->contains($this)) {
  385. $saleOrder->addPointTransaction($this);
  386. }
  388. return $this;
  389. }
  391. public function getLinkedPointTransaction(): ?self
  392. {
  393. return $this->linkedPointTransaction;
  394. }
  396. public function setLinkedPointTransaction(?self $linkedPointTransaction): self
  397. {
  398. $this->linkedPointTransaction = $linkedPointTransaction;
  400. return $this;
  401. }
  403. /**
  404. * @return Collection<int, PointTransaction>
  405. */
  406. public function getChildrenPointTransactions(): Collection
  407. {
  408. return $this->childrenPointTransactions;
  409. }
  411. public function addChildrenPointTransaction(PointTransaction $childrenPointTransaction): self
  412. {
  413. if (!$this->childrenPointTransactions->contains($childrenPointTransaction)) {
  414. $this->childrenPointTransactions[] = $childrenPointTransaction;
  415. $childrenPointTransaction->setLinkedPointTransaction($this);
  416. }
  418. return $this;
  419. }
  421. public function removeChildrenPointTransaction(PointTransaction $childrenPointTransaction): self
  422. {
  423. if ($this->childrenPointTransactions->removeElement($childrenPointTransaction)) {
  424. // set the owning side to null (unless already changed)
  425. if ($childrenPointTransaction->getLinkedPointTransaction() === $this) {
  426. $childrenPointTransaction->setLinkedPointTransaction(null);
  427. }
  428. }
  430. return $this;
  431. }
  433. /**
  434. * @param bool $getSlug
  435. * @return PointTransactionType|null|string
  436. */
  437. public function getTransactionType(bool $getSlug = false)
  438. {
  439. if (!$getSlug || !$this->transactionType) {
  440. return $this->transactionType;
  441. }
  443. return $this->transactionType->getSlug();
  444. }
  446. public function setTransactionType(?PointTransactionType $transactionType): self
  447. {
  448. $this->transactionType = $transactionType;
  450. return $this;
  451. }
  453. public function getPurchase(): ?Purchase
  454. {
  455. return $this->purchase;
  456. }
  458. public function setPurchase(?Purchase $purchase): self
  459. {
  460. $this->purchase = $purchase;
  462. return $this;
  463. }
  465. public function getImportHistory(): ?PointTransactionImportHistory
  466. {
  467. return $this->importHistory;
  468. }
  470. public function setImportHistory(?PointTransactionImportHistory $importHistory): self
  471. {
  472. $this->importHistory = $importHistory;
  474. return $this;
  475. }
  477. public function getCustomProductOrder(): ?CustomProductOrder
  478. {
  479. return $this->customProductOrder;
  480. }
  482. public function setCustomProductOrder(?CustomProductOrder $customProductOrder): self
  483. {
  484. $this->customProductOrder = $customProductOrder;
  486. return $this;
  487. }
  489. public function getBusinessResult(): ?UserBusinessResult
  490. {
  491. return $this->businessResult;
  492. }
  494. public function setBusinessResult(?UserBusinessResult $businessResult): self
  495. {
  496. $this->businessResult = $businessResult;
  498. return $this;
  499. }
  501. public function getSaleOrderItem(): ?SaleOrderItem
  502. {
  503. return $this->saleOrderItem;
  504. }
  506. public function setSaleOrderItem(?SaleOrderItem $saleOrderItem): self
  507. {
  508. if ($this->saleOrderItem === $saleOrderItem) {
  509. return $this;
  510. }
  512. if ($this->saleOrderItem !== null) {
  513. $this->saleOrderItem->removePointTransaction($this);
  514. }
  516. $this->saleOrderItem = $saleOrderItem;
  518. if ($saleOrderItem !== null && !$saleOrderItem->getPointTransactions()->contains($this)) {
  519. $saleOrderItem->addPointTransaction($this);
  520. }
  522. return $this;
  523. }
  525. /**
  526. * @return string|null
  527. */
  528. public function getPaymentReference(): ?string
  529. {
  530. return $this->paymentReference;
  531. }
  533. /**
  534. * @param string|null $paymentReference
  535. *
  536. * @return PointTransaction
  537. */
  538. public function setPaymentReference(?string $paymentReference): PointTransaction
  539. {
  540. $this->paymentReference = $paymentReference;
  541. return $this;
  542. }
  544. /**
  545. * @return array
  546. */
  547. public function getPaymentInformations(): array
  548. {
  549. if ($this->paymentInformations === null) {
  550. $this->paymentInformations = [];
  551. }
  552. return $this->paymentInformations;
  553. }
  555. /**
  556. * @param array|null $paymentInformations
  557. *
  558. * @return PointTransaction
  559. */
  560. public function setPaymentInformations(?array $paymentInformations = []): PointTransaction
  561. {
  562. if ($paymentInformations === null) {
  563. $paymentInformations = [];
  564. }
  566. $this->paymentInformations = $paymentInformations;
  567. return $this;
  568. }
  570. /**
  571. * @param string $key
  572. * @param $value
  573. *
  574. * @return $this
  575. */
  576. public function addPaymentInformation(string $key, $value): PointTransaction
  577. {
  578. $this->paymentInformations[$key] = $value;
  579. return $this;
  580. }
  582. /**
  583. * @param string $key
  584. *
  585. * @return $this
  586. */
  587. public function removePaymentInformation(string $key): PointTransaction
  588. {
  589. unset($this->paymentInformations[$key]);
  590. return $this;
  591. }
  593. /**
  594. * @return float|null
  595. */
  596. public function getPaymentValue(): ?float
  597. {
  598. return $this->paymentValue;
  599. }
  601. /**
  602. * @param float|null $paymentValue
  603. *
  604. * @return PointTransaction
  605. */
  606. public function setPaymentValue(?float $paymentValue): PointTransaction
  607. {
  608. $this->paymentValue = $paymentValue;
  609. return $this;
  610. }
  612. /**
  613. * @return Cart|null
  614. */
  615. public function getPaidCart(): ?Cart
  616. {
  617. return $this->paidCart;
  618. }
  620. /**
  621. * @param Cart|null $paidCart
  622. *
  623. * @return PointTransaction
  624. */
  625. public function setPaidCart(?Cart $paidCart = null): self
  626. {
  627. if ($this->paidCart === $paidCart) {
  628. return $this;
  629. }
  631. if ($this->paidCart !== null) {
  632. $this->paidCart->removePaidPointTransaction($this);
  633. }
  635. $this->paidCart = $paidCart;
  637. if ($paidCart !== null && !$paidCart->getPaidPointTransactions()
  638. ->contains($this)) {
  639. $paidCart->addPaidPointTransaction($this);
  640. }
  642. return $this;
  643. }
  645. /**
  646. * @return Cart|null
  647. */
  648. public function getCart(): ?Cart
  649. {
  650. return $this->cart;
  651. }
  653. /**
  654. * @param Cart|null $cart
  655. *
  656. * @return PointTransaction
  657. */
  658. public function setCart(?Cart $cart = null): self
  659. {
  660. if ($this->cart === $cart) {
  661. return $this;
  662. }
  664. if ($this->cart !== null) {
  665. $this->cart->removePointTransaction($this);
  666. }
  668. $this->cart = $cart;
  670. if ($cart !== null && !$cart->getPointTransactions()->contains($this)) {
  671. $cart->addPointTransaction($this);
  672. }
  674. return $this;
  675. }
  677. public function getSubtype(): ?string
  678. {
  679. return $this->subtype;
  680. }
  682. public function setSubtype(?string $subtype): self
  683. {
  684. $this->subtype = $subtype;
  686. return $this;
  687. }
  689. /**
  690. * @return Collection<int, Invoice>
  691. */
  692. public function getInvoices(): Collection
  693. {
  694. return $this->invoices;
  695. }
  697. public function addInvoice(Invoice $invoice): self
  698. {
  699. if (!$this->invoices->contains($invoice)) {
  700. $this->invoices[] = $invoice;
  701. $invoice->addPointTransaction($this);
  702. }
  704. return $this;
  705. }
  707. public function removeInvoice(Invoice $invoice): self
  708. {
  709. if ($this->invoices->removeElement($invoice)) {
  710. $invoice->removePointTransaction($this);
  711. }
  713. return $this;
  714. }
  716. public function getEventKey(): ?string
  717. {
  718. return $this->eventKey;
  719. }
  721. public function setEventKey(?string $eventKey): self
  722. {
  723. $this->eventKey = $eventKey;
  725. return $this;
  726. }
  727. }