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';
  35. /** Solde des commandes */
  36. private int $orderSolde = 0;
  37. /** Solde des points de fidélités */
  38. private int $fidelitySolde = 0;
  39. /**
  40. * Identifiant unique auto-incrémenté
  41. *
  42. * @ORM\Id
  43. * @ORM\GeneratedValue
  44. * @ORM\Column(type="integer")
  45. *
  46. * @Expose
  47. * @Serializer\Groups({"point_transaction:id"})
  48. */
  49. private ?int $id = NULL;
  50. /**
  51. * Utilisateur lié à la transaction
  52. *
  53. * @ORM\ManyToOne(targetEntity=User::class, inversedBy="pointTransactions")
  54. * @ORM\JoinColumn(nullable=false)
  55. *
  56. * @Expose
  57. * @Serializer\Groups({"point_transaction:user"})
  58. */
  59. private ?User $user = NULL;
  60. /**
  61. * Commande liée à la transaction
  62. *
  63. * @ORM\ManyToOne(targetEntity=SaleOrder::class, inversedBy="pointTransactions")
  64. */
  65. private ?SaleOrder $saleOrder = NULL;
  66. /**
  67. * Valeur de la transaction
  68. *
  69. * @ORM\Column(type="float")
  70. *
  71. * @Expose
  72. * @Serializer\Groups({"point_transaction:value"})
  73. */
  74. private ?float $value = NULL;
  75. /**
  76. * Label de la transaction
  77. *
  78. * @ORM\Column(type="string", length=255)
  79. *
  80. * @Assert\NotBlank
  81. *
  82. * @Expose
  83. * @Serializer\Groups({"point_transaction:label"})
  84. */
  85. private ?string $label = NULL;
  86. /**
  87. * Référence du paiement par carte
  88. *
  89. * @ORM\Column(type="string", length=255, nullable=true)
  90. *
  91. * @Expose
  92. * @Serializer\Groups({"point_transaction:paymentReference"})
  93. */
  94. private ?string $paymentReference = NULL;
  95. /**
  96. * Future valeur de la transaction lors d'un paiement par carte
  97. * Ce montant sera attribué à la valeur réelle après le retour IPN de la banque
  98. *
  99. * @ORM\Column(type="float", nullable=true)
  100. *
  101. * @Expose
  102. * @Serializer\Groups({"point_transaction:value"})
  103. */
  104. private ?float $paymentValue = NULL;
  105. /**
  106. * Informations reçues lors du retour IPN de la banque
  107. *
  108. * @ORM\Column(type="json", nullable=true)
  109. *
  110. * @Expose
  111. * @Serializer\Groups({"point_transaction:paymentInformations"})
  112. */
  113. private ?array $paymentInformations = [];
  114. /**
  115. * Date d'expiration de la transaction
  116. *
  117. * @ORM\Column(type="datetime", nullable=true)
  118. */
  119. private ?DateTime $expiredAt = NULL;
  120. /**
  121. * Transaction liée à une autre transaction
  122. *
  123. * @ORM\ManyToOne(
  124. * targetEntity=PointTransaction::class,
  125. * inversedBy="childrenPointTransactions",
  126. * cascade={"persist", "remove"}
  127. * )
  128. */
  129. private ?PointTransaction $linkedPointTransaction = NULL;
  130. /**
  131. * Liste des transactions enfants liées à la transaction
  132. *
  133. * @ORM\OneToMany(targetEntity=PointTransaction::class, mappedBy="linkedPointTransaction", orphanRemoval=true)
  134. */
  135. private ?Collection $childrenPointTransactions = null;
  136. /**
  137. * Type de transaction
  138. *
  139. * @ORM\ManyToOne(targetEntity=PointTransactionType::class, inversedBy="pointTransactions")
  140. * @ORM\JoinColumn(nullable=false)
  141. */
  142. private ?PointTransactionType $transactionType = NULL;
  143. /**
  144. * Déclaration d'achat liée à la transaction
  145. *
  146. * @ORM\ManyToOne(targetEntity=Purchase::class, inversedBy="pointTransactions")
  147. */
  148. private ?Purchase $purchase = NULL;
  149. /**
  150. * Historique d'import lié à la transaction
  151. *
  152. * @ORM\ManyToOne(
  153. * targetEntity=PointTransactionImportHistory::class,
  154. * inversedBy="pointTransactions",
  155. * cascade={"persist"}
  156. * )
  157. */
  158. private ?PointTransactionImportHistory $importHistory = NULL;
  159. /**
  160. * Date d'effet de la transaction
  161. *
  162. * @ORM\Column(type="datetime", nullable=true)
  163. */
  164. private ?DateTimeInterface $effectiveAt = NULL;
  165. /**
  166. * Méthode d'import de la transaction
  167. *
  168. * @ORM\Column(type="string", length=32, nullable=true)
  169. */
  170. private ?string $importMethod = NULL;
  171. /**
  172. * Commande de produit personnalisé liée à la transaction
  173. *
  174. * @ORM\ManyToOne(targetEntity=CustomProductOrder::class)
  175. */
  176. private ?CustomProductOrder $customProductOrder = NULL;
  177. /**
  178. * Résultat d'activité lié à la transaction
  179. *
  180. * @ORM\OneToOne(
  181. * targetEntity=UserBusinessResult::class,
  182. * inversedBy="pointTransaction",
  183. * cascade={"persist", "remove"}
  184. * )
  185. */
  186. private ?UserBusinessResult $businessResult = NULL;
  187. /**
  188. * Catégorie de la transaction
  189. *
  190. * @ORM\Column(type="string", length=64, nullable=true)
  191. */
  192. private ?string $category = NULL;
  193. /**
  194. * On lie un SaleOrderItem a une transaction seulement à l'annulation, pour pouvoir lier un remboursement a un produit
  195. *
  196. * @ORM\ManyToOne(targetEntity=SaleOrderItem::class, inversedBy="pointTransactions", cascade={"persist"})
  197. */
  198. private ?SaleOrderItem $saleOrderItem = null;
  199. /**
  200. * Panier lié à la transaction quand elle est validée (retour de l'utilisateur depuis l'interface de la banque)
  201. * même si elle n'est pas encore confirmée par la banque (retour automatique IPN)
  202. * quand elle est confirmée, on lui attribue le montant correspondant, sinon il reste à 0
  203. *
  204. * @ORM\ManyToOne(targetEntity=Cart::class,inversedBy="paidPointTransactions")
  205. * @ORM\JoinColumn(nullable=true, onDelete="SET NULL")
  206. */
  207. private ?Cart $paidCart = NULL;
  208. /**
  209. * Panier lié à la transaction, dans le cadre d'un paiement par carte avant que la transaction ne soit validée
  210. *
  211. * @ORM\ManyToOne(targetEntity=Cart::class,inversedBy="pointTransactions")
  212. * @ORM\JoinColumn(nullable=true, onDelete="SET NULL")
  213. */
  214. private ?Cart $cart = NULL;
  215. /**
  216. * @ORM\ManyToMany(targetEntity=Invoice::class, mappedBy="transactionPoints")
  217. */
  218. private Collection $invoices;
  219. /**
  220. * Type de frais de la transaction
  221. *
  222. * @ORM\Column(type="string", length=64, nullable=true)
  223. */
  224. private ?string $subtype = NULL;
  225. /**
  226. * @ORM\Column(type="string", length=255, nullable=true)
  227. */
  228. private $eventKey;
  230. public function __construct()
  231. {
  232. $this->childrenPointTransactions = new ArrayCollection();
  233. $this->invoices = new ArrayCollection();
  234. }
  236. public function __toString()
  237. {
  238. return $this->getValue() . ' - ' . $this->getLabel();
  239. }
  241. // MÉTHODES NÉCESSAIRES POUR LE CALCUL DE POINT : NE PAS EFFACER
  242. public function setOrderSolde($orderSolde): PointTransaction
  243. {
  244. $this->orderSolde += $orderSolde;
  246. return $this;
  247. }
  249. public function getOrderSolde(): int
  250. {
  251. return $this->orderSolde;
  252. }
  254. public function setFidelitySolde($fidelitySolde): PointTransaction
  255. {
  256. $this->fidelitySolde += $fidelitySolde;
  258. return $this;
  259. }
  261. public function getFidelitySolde(): int
  262. {
  263. return $this->fidelitySolde;
  264. }
  266. // END METHODES
  268. public function getId(): ?int
  269. {
  270. return $this->id;
  271. }
  273. public function getValue(): ?float
  274. {
  275. return $this->value;
  276. }
  278. public function setValue(float $value): self
  279. {
  280. $this->value = $value;
  282. return $this;
  283. }
  285. public function getLabel(): ?string
  286. {
  287. $label = $this->label;
  289. if($this->getTransactionType(true) === PointTransactionType::PAYMENT) $label .= ' (' . $this->getPaymentReference() . ')';
  291. return $label;
  292. }
  294. public function setLabel(string $label): self
  295. {
  296. $this->label = $label;
  298. return $this;
  299. }
  301. public function getExpiredAt(): ?DateTimeInterface
  302. {
  303. return $this->expiredAt;
  304. }
  306. public function setExpiredAt(?DateTime $expiredAt): self
  307. {
  308. $this->expiredAt = $expiredAt;
  310. return $this;
  311. }
  313. public function getEffectiveAt(): ?DateTimeInterface
  314. {
  315. return $this->effectiveAt;
  316. }
  318. public function setEffectiveAt(?DateTimeInterface $effectiveAt): self
  319. {
  320. $this->effectiveAt = $effectiveAt;
  322. return $this;
  323. }
  325. public function getImportMethod(): ?string
  326. {
  327. return $this->importMethod;
  328. }
  330. public function setImportMethod(?string $importMethod): self
  331. {
  332. $this->importMethod = $importMethod;
  334. return $this;
  335. }
  337. public function getCategory(): ?string
  338. {
  339. return $this->category;
  340. }
  342. public function setCategory(?string $category): self
  343. {
  344. $this->category = $category;
  346. return $this;
  347. }
  349. public function getUser(): ?User
  350. {
  351. return $this->user;
  352. }
  354. public function setUser(?User $user): self
  355. {
  356. $this->user = $user;
  358. return $this;
  359. }
  361. public function getSaleOrder(): ?SaleOrder
  362. {
  363. return $this->saleOrder;
  364. }
  366. public function setSaleOrder(?SaleOrder $saleOrder): self
  367. {
  368. if($this->saleOrder === $saleOrder) return $this;
  370. if($this->saleOrder !== null) $this->saleOrder->removePointTransaction($this);
  372. $this->saleOrder = $saleOrder;
  374. if($saleOrder !== null && !$saleOrder->getPointTransactions()
  375. ->contains($this)) $saleOrder->addPointTransaction($this);
  377. return $this;
  378. }
  380. public function getLinkedPointTransaction(): ?self
  381. {
  382. return $this->linkedPointTransaction;
  383. }
  385. public function setLinkedPointTransaction(?self $linkedPointTransaction): self
  386. {
  387. $this->linkedPointTransaction = $linkedPointTransaction;
  389. return $this;
  390. }
  392. /**
  393. * @return Collection<int, PointTransaction>
  394. */
  395. public function getChildrenPointTransactions(): Collection
  396. {
  397. return $this->childrenPointTransactions;
  398. }
  400. public function addChildrenPointTransaction(PointTransaction $childrenPointTransaction): self
  401. {
  402. if(!$this->childrenPointTransactions->contains($childrenPointTransaction))
  403. {
  404. $this->childrenPointTransactions[] = $childrenPointTransaction;
  405. $childrenPointTransaction->setLinkedPointTransaction($this);
  406. }
  408. return $this;
  409. }
  411. public function removeChildrenPointTransaction(PointTransaction $childrenPointTransaction): self
  412. {
  413. if($this->childrenPointTransactions->removeElement($childrenPointTransaction))
  414. {
  415. // set the owning side to null (unless already changed)
  416. if($childrenPointTransaction->getLinkedPointTransaction() === $this)
  417. {
  418. $childrenPointTransaction->setLinkedPointTransaction(NULL);
  419. }
  420. }
  422. return $this;
  423. }
  425. /**
  426. * @param bool $getSlug
  427. * @return PointTransactionType|null|string
  428. */
  429. public function getTransactionType(bool $getSlug = false)
  430. {
  431. if(!$getSlug || !$this->transactionType) return $this->transactionType;
  433. return $this->transactionType->getSlug();
  434. }
  436. public function setTransactionType(?PointTransactionType $transactionType): self
  437. {
  438. $this->transactionType = $transactionType;
  440. return $this;
  441. }
  443. public function getPurchase(): ?Purchase
  444. {
  445. return $this->purchase;
  446. }
  448. public function setPurchase(?Purchase $purchase): self
  449. {
  450. $this->purchase = $purchase;
  452. return $this;
  453. }
  455. public function getImportHistory(): ?PointTransactionImportHistory
  456. {
  457. return $this->importHistory;
  458. }
  460. public function setImportHistory(?PointTransactionImportHistory $importHistory): self
  461. {
  462. $this->importHistory = $importHistory;
  464. return $this;
  465. }
  467. public function getCustomProductOrder(): ?CustomProductOrder
  468. {
  469. return $this->customProductOrder;
  470. }
  472. public function setCustomProductOrder(?CustomProductOrder $customProductOrder): self
  473. {
  474. $this->customProductOrder = $customProductOrder;
  476. return $this;
  477. }
  479. public function getBusinessResult(): ?UserBusinessResult
  480. {
  481. return $this->businessResult;
  482. }
  484. public function setBusinessResult(?UserBusinessResult $businessResult): self
  485. {
  486. $this->businessResult = $businessResult;
  488. return $this;
  489. }
  491. public function getSaleOrderItem(): ?SaleOrderItem
  492. {
  493. return $this->saleOrderItem;
  494. }
  496. public function setSaleOrderItem(?SaleOrderItem $saleOrderItem): self
  497. {
  498. if($this->saleOrderItem === $saleOrderItem)
  499. {
  500. return $this;
  501. }
  503. if($this->saleOrderItem !== null)
  504. {
  505. $this->saleOrderItem->removePointTransaction($this);
  506. }
  508. $this->saleOrderItem = $saleOrderItem;
  510. if($saleOrderItem !== null && !$saleOrderItem->getPointTransactions()->contains($this))
  511. {
  512. $saleOrderItem->addPointTransaction($this);
  513. }
  515. return $this;
  516. }
  518. /**
  519. * @return string|null
  520. */
  521. public function getPaymentReference(): ?string
  522. {
  523. return $this->paymentReference;
  524. }
  526. /**
  527. * @param string|null $paymentReference
  528. *
  529. * @return PointTransaction
  530. */
  531. public function setPaymentReference(?string $paymentReference): PointTransaction
  532. {
  533. $this->paymentReference = $paymentReference;
  534. return $this;
  535. }
  537. /**
  538. * @return array
  539. */
  540. public function getPaymentInformations(): array
  541. {
  542. if($this->paymentInformations === null) $this->paymentInformations = [];
  543. return $this->paymentInformations;
  544. }
  546. /**
  547. * @param array|null $paymentInformations
  548. *
  549. * @return PointTransaction
  550. */
  551. public function setPaymentInformations(?array $paymentInformations = []): PointTransaction
  552. {
  553. if($paymentInformations === null) $paymentInformations = [];
  555. $this->paymentInformations = $paymentInformations;
  556. return $this;
  557. }
  559. /**
  560. * @param string $key
  561. * @param $value
  562. *
  563. * @return $this
  564. */
  565. public function addPaymentInformation(string $key, $value): PointTransaction
  566. {
  567. $this->paymentInformations[$key] = $value;
  568. return $this;
  569. }
  571. /**
  572. * @param string $key
  573. *
  574. * @return $this
  575. */
  576. public function removePaymentInformation(string $key): PointTransaction
  577. {
  578. unset($this->paymentInformations[$key]);
  579. return $this;
  580. }
  582. /**
  583. * @return float|null
  584. */
  585. public function getPaymentValue(): ?float
  586. {
  587. return $this->paymentValue;
  588. }
  590. /**
  591. * @param float|null $paymentValue
  592. *
  593. * @return PointTransaction
  594. */
  595. public function setPaymentValue(?float $paymentValue): PointTransaction
  596. {
  597. $this->paymentValue = $paymentValue;
  598. return $this;
  599. }
  601. /**
  602. * @return Cart|null
  603. */
  604. public function getPaidCart(): ?Cart
  605. {
  606. return $this->paidCart;
  607. }
  609. /**
  610. * @param Cart|null $paidCart
  611. *
  612. * @return PointTransaction
  613. */
  614. public function setPaidCart(?Cart $paidCart = null): self
  615. {
  616. if($this->paidCart === $paidCart) return $this;
  618. if($this->paidCart !== null) $this->paidCart->removePaidPointTransaction($this);
  620. $this->paidCart = $paidCart;
  622. if($paidCart !== null && !$paidCart->getPaidPointTransactions()
  623. ->contains($this)) $paidCart->addPaidPointTransaction($this);
  625. return $this;
  626. }
  628. /**
  629. * @return Cart|null
  630. */
  631. public function getCart(): ?Cart
  632. {
  633. return $this->cart;
  634. }
  636. /**
  637. * @param Cart|null $cart
  638. *
  639. * @return PointTransaction
  640. */
  641. public function setCart(?Cart $cart = null): self
  642. {
  643. if($this->cart === $cart) return $this;
  645. if($this->cart !== null) $this->cart->removePointTransaction($this);
  647. $this->cart = $cart;
  649. if($cart !== null && !$cart->getPointTransactions()->contains($this)) $cart->addPointTransaction($this);
  651. return $this;
  652. }
  654. public function getSubtype(): ?string
  655. {
  656. return $this->subtype;
  657. }
  659. public function setSubtype(?string $subtype): self
  660. {
  661. $this->subtype = $subtype;
  663. return $this;
  664. }
  666. /**
  667. * @return Collection<int, Invoice>
  668. */
  669. public function getInvoices(): Collection
  670. {
  671. return $this->invoices;
  672. }
  674. public function addInvoice(Invoice $invoice): self
  675. {
  676. if(!$this->invoices->contains($invoice))
  677. {
  678. $this->invoices[] = $invoice;
  679. $invoice->addPointTransaction($this);
  680. }
  682. return $this;
  683. }
  685. public function removeInvoice(Invoice $invoice): self
  686. {
  687. if($this->invoices->removeElement($invoice))
  688. {
  689. $invoice->removePointTransaction($this);
  690. }
  692. return $this;
  693. }
  695. public function getEventKey(): ?string
  696. {
  697. return $this->eventKey;
  698. }
  700. public function setEventKey(?string $eventKey): self
  701. {
  702. $this->eventKey = $eventKey;
  704. return $this;
  705. }
  706. }