src/Entity/Payment/Payment.php line 39

  1. <?php
  3. /*
  4.  * This file is part of the Pellipop project.
  5.  *
  6.  * (c) Mobizel
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace App\Entity\Payment;
  16. use App\Entity\Customer\Customer;
  17. use App\Entity\IdentifiableTrait;
  18. use App\Entity\Order\Order;
  19. use App\Entity\Promotion\PromotionCode;
  20. use App\PaymentStates;
  21. use App\Repository\Payment\PaymentRepository;
  22. use Doctrine\ORM\Mapping as ORM;
  23. use Gedmo\Timestampable\Traits\TimestampableEntity;
  24. use Payum\Core\Model\CreditCardInterface;
  25. use Payum\Core\Model\PaymentInterface;
  26. use Sylius\Component\Resource\Annotation\SyliusCrudRoutes;
  27. use Sylius\Component\Resource\Model\ResourceInterface;
  29. #[ORM\Entity(repositoryClass: PaymentRepository::class)]
  30. #[ORM\Table(name: 'app_payment')]
  31. #[SyliusCrudRoutes(alias: 'app.payment', path: '/admin/payments', section: 'backend', templates: 'backend/payment', grid: 'app_backend_payment', only: ['index', 'show'], vars: [
  32.     'all' => [
  33.         'subheader' => 'app.ui.manage_your_payments',
  34.     ],
  35.     'index' => [
  36.         'icon' => 'payment',
  37.     ],
  38. ])]
  39. class Payment implements ResourceInterface, PaymentInterface
  40. {
  41.     use IdentifiableTrait;
  42.     use TimestampableEntity;
  44.     #[ORM\Column(type: 'string', length: 100)]
  45.     private string $number;
  47.     #[ORM\ManyToOne(targetEntity: Customer::class)]
  49.     #[ORM\JoinColumn(name: "customer_id", referencedColumnName: "id", onDelete: "CASCADE")]
  50.     private ?Customer $customer = null;
  52.     #[ORM\Column(type: 'string', length: 20)]
  53.     private string $state;
  55.     #[ORM\Column(type: 'integer')]
  56.     private int $credits = 0;
  58.     #[ORM\Column(type: 'string')]
  59.     private string $description;
  61.     #[ORM\Column(type: 'integer')]
  62.     private int $amount = 0;
  64.     #[ORM\Column(type: 'string', length: 10)]
  65.     private string $currencyCode;
  67.     #[ORM\Column(type: 'json')]
  68.     private array $details;
  70.     #[ORM\ManyToOne(targetEntity: PromotionCode::class, inversedBy: 'payments')]
  71.     #[ORM\JoinColumn(nullable: true)]
  72.     private ?PromotionCode $promotionCode;
  74.     /** Order paid by this payment when paymentType is order_direct or order_complement. */
  75.     #[ORM\ManyToOne(targetEntity: Order::class)]
  76.     #[ORM\JoinColumn(nullable: true, onDelete: 'SET NULL')]
  77.     private ?Order $order = null;
  79.     /** credit_pack | order_direct | order_complement */
  80.     #[ORM\Column(type: 'string', length: 30, nullable: true, options: ['default' => 'credit_pack'])]
  81.     private ?string $paymentType = 'credit_pack';
  83.     /** Credits to debit from customer when paymentType is order_complement (after Stripe confirms). */
  84.     #[ORM\Column(type: 'integer', options: ['default' => 0])]
  85.     private int $creditsToDebit = 0;
  87.     public function __construct()
  88.     {
  89.         $this->details = [];
  90.         $this->state = PaymentStates::STATE_NEW;
  91.     }
  93.     /**
  94.      * Get the value of customer
  95.      *
  96.      * @return ?Customer
  97.      */
  98.     public function getCustomer(): ?Customer
  99.     {
  100.         return $this->customer;
  101.     }
  103.     /**
  104.      * Set the value of customer
  105.      *
  106.      * @return self
  107.      */
  108.     public function setCustomer(?Customer $customer): self
  109.     {
  110.         $this->customer = $customer;
  112.         return $this;
  113.     }
  115.     /**
  116.      * Get the value of state
  117.      *
  118.      * @return string
  119.      */
  120.     public function getState(): string
  121.     {
  122.         return $this->state;
  123.     }
  125.     /**
  126.      * Set the value of state
  127.      *
  128.      * @return self
  129.      */
  130.     public function setState(string $state): self
  131.     {
  132.         $this->state = $state;
  134.         return $this;
  135.     }
  136.     /**
  137.      * Get the value of credits
  138.      *
  139.      * @return ?int
  140.      */
  141.     public function getCredits(): ?int
  142.     {
  143.         return $this->credits;
  144.     }
  146.     /**
  147.      * Set the value of credits
  148.      *
  149.      * @return self
  150.      */
  151.     public function setCredits(?int $credits): self
  152.     {
  153.         $this->credits = $credits;
  155.         return $this;
  156.     }
  157.     
  158.     public function __toString(): string
  159.     {
  160.         return (string) ($this->getNumber() ?? $this->getId());
  161.     }
  164.     /**
  165.      * Get the value of description
  166.      *
  167.      * @return string
  168.      */
  169.     public function getDescription()
  170.     {
  171.         return $this->description;
  172.     }
  174.     /**
  175.      * Set the value of description
  176.      *
  177.      * @param string $description
  178.      *
  179.      * @return self
  180.      */
  181.     public function setDescription(string $description): self
  182.     {
  183.         $this->description = $description;
  185.         return $this;
  186.     }
  188.     /**
  189.      * Get the value of amount
  190.      *
  191.      * @return int
  192.      */
  193.     public function getAmount()
  194.     {
  195.         return $this->amount;
  196.     }
  198.     /**
  199.      * Set the value of amount
  200.      *
  201.      * @param int $amount
  202.      *
  203.      * @return self
  204.      */
  205.     public function setAmount(int $amount): self
  206.     {
  207.         $this->amount = $amount;
  209.         return $this;
  210.     }
  212.     /**
  213.      * Get the value of currencyCode
  214.      *
  215.      * @return string
  216.      */
  217.     public function getCurrencyCode()
  218.     {
  219.         return $this->currencyCode;
  220.     }
  222.     /**
  223.      * Set the value of currencyCode
  224.      *
  225.      * @param string $currencyCode
  226.      *
  227.      * @return self
  228.      */
  229.     public function setCurrencyCode(string $currencyCode): self
  230.     {
  231.         $this->currencyCode = $currencyCode;
  233.         return $this;
  234.     }
  236.     /**
  237.      * Get the value of number
  238.      *
  239.      * @return array
  240.      */
  241.     public function getDetails(): array
  242.     {
  243.         return $this->details;
  244.     }
  246.     /**
  247.      * Set the value of details
  248.      *
  249.      *  @param object $details
  250.      *
  251.      * @return self
  252.      */
  253.     public function setDetails($details): self
  254.     {
  255.         if ($details instanceof \Traversable) {
  256.             $details = iterator_to_array($details);
  257.         }
  259.         $this->details = $details;
  261.         return $this;
  262.     }
  264.     /**
  265.      * Get the value of number
  266.      *
  267.      * @return string
  268.      */
  269.     public function getNumber()
  270.     {
  271.         return $this->number;
  272.     }
  274.     /**
  275.      * Set the value of number
  276.      *
  277.      * @param string $number
  278.      *
  279.      * @return self
  280.      */
  281.     public function setNumber(string $number): self
  282.     {
  283.         $this->number = $number;
  285.         return $this;
  286.     }
  288.     /**
  289.      * Get the value of promotionCode
  290.      *
  291.      * @return ?PromotionCode
  292.      */
  293.     public function getPromotionCode(): ?PromotionCode
  294.     {
  295.         return $this->promotionCode;
  296.     }
  298.     /**
  299.      * Set the value of promotionCode
  300.      *
  301.      * @param ?PromotionCode $promotionCode
  302.      *
  303.      * @return self
  304.      */
  305.     public function setPromotionCode(?PromotionCode $promotionCode): self
  306.     {
  307.         $this->promotionCode = $promotionCode;
  309.         return $this;
  310.     }
  312.     public function getClientEmail(): string
  313.     {
  314.         return $this->getCustomer()->getEmail() ?? '';
  315.     }
  317.     public function getClientId(): string
  318.     {
  319.         return (string) $this->getCustomer()->getId() ?? '';
  320.     }
  322.     public function getTotalAmount(): int
  323.     {
  324.         return $this->getAmount();
  325.     }
  327.     public function getCreditCard(): CreditCardInterface|null
  328.     {
  329.         return null;
  330.     }
  332.     public function getPaymentIntent(): ?string
  333.     {
  334.         if (isset($this->getDetails()['object']) && $this->getDetails()['object'] === 'payment_intent') {
  335.             return ((string) $this->getDetails()['id']) ?? null;
  336.         }
  338.         return null;
  339.     }
  341.     public function getClientSecret(): ?string
  342.     {
  343.         if (isset($this->getDetails()['client_secret'])) {
  344.             return ((string) $this->getDetails()['client_secret']) ?? null;
  345.         }
  347.         return null;
  348.     }
  350.     public function getOrder(): ?Order
  351.     {
  352.         return $this->order;
  353.     }
  355.     public function setOrder(?Order $order): self
  356.     {
  357.         $this->order = $order;
  358.         return $this;
  359.     }
  361.     public function getPaymentType(): ?string
  362.     {
  363.         return $this->paymentType;
  364.     }
  366.     public function setPaymentType(?string $paymentType): self
  367.     {
  368.         $this->paymentType = $paymentType;
  369.         return $this;
  370.     }
  372.     public function getCreditsToDebit(): int
  373.     {
  374.         return $this->creditsToDebit;
  375.     }
  377.     public function setCreditsToDebit(int $creditsToDebit): self
  378.     {
  379.         $this->creditsToDebit = $creditsToDebit;
  380.         return $this;
  381.     }
  383.     public function isOrderPayment(): bool
  384.     {
  385.         return $this->paymentType === 'order_direct' || $this->paymentType === 'order_complement';
  386.     }
  387. }