Add option for payment modules

Config/module.xml

@@ -19,7 +19,7 @@
  <language>en_US</language>
  <language>fr_FR</language>
  </languages>
- <version>2.2.16</version>
+ <version>2.2.17</version>
  <authors>
  <author>
  <name>Vincent Lopes-Vicente</name>

Controller/Front/CheckoutController.php

@@ -31,6 +31,7 @@
  */
 class CheckoutController extends BaseFrontOpenApiController
 {
+ const PAYMENT_MODULE_OPTION_CHOICES_SESSION_KEY = 'payment_module_option_choices';
  /**
  * @Route("", name="set_checkout", methods="POST")
  * @OA\Post(
@@ -110,6 +111,11 @@ public function setCheckout(
  $orderEvent
  );
 
+ if (isset($decodedContent['paymentOptionChoices'])) {
+ // Save payment module option choices in session (for the next step)
+ $session->set(self::PAYMENT_MODULE_OPTION_CHOICES_SESSION_KEY, $decodedContent['paymentOptionChoices']);
+ }
+
  $responseCheckout = $checkout
  ->createFromOrder($orderEvent->getOrder());
 
@@ -141,6 +147,10 @@ public function getCheckout(
 
  $checkout->setPickupAddress($request->getSession()->get(OpenApi::PICKUP_ADDRESS_SESSION_KEY));
 
+ $checkout->setPaymentOptionChoices(
+ $request->getSession()->get(self::PAYMENT_MODULE_OPTION_CHOICES_SESSION_KEY)
+ );
+
  return OpenApiService::jsonResponse($checkout);
  }
 

Controller/Front/PaymentController.php

@@ -3,6 +3,8 @@
 namespace OpenApi\Controller\Front;
 
 use OpenApi\Annotations as OA;
+use OpenApi\Events\OpenApiEvents;
+use OpenApi\Events\PaymentModuleOptionEvent;
 use OpenApi\Model\Api\ModelFactory;
 use OpenApi\Model\Api\PaymentModule;
 use OpenApi\Service\OpenApiService;
@@ -103,12 +105,21 @@ protected function getPaymentModule(
  TheliaEvents::MODULE_PAYMENT_IS_VALID
  );
 
+ $paymentModuleOptionEvent = new PaymentModuleOptionEvent($paymentModule, $cart);
+
+ $dispatcher->dispatch(
+ $paymentModuleOptionEvent,
+ OpenApiEvents::MODULE_PAYMENT_GET_OPTIONS
+ );
+
  /** @var PaymentModule $paymentModule */
  $paymentModule = $modelFactory->buildModel('PaymentModule', $paymentModule);
+
  $paymentModule->setValid($isValidPaymentEvent->isValidModule())
  ->setCode($moduleInstance->getCode())
  ->setMinimumAmount($isValidPaymentEvent->getMinimumAmount())
- ->setMaximumAmount($isValidPaymentEvent->getMaximumAmount());
+ ->setMaximumAmount($isValidPaymentEvent->getMaximumAmount())
+ ->setOptionGroups($paymentModuleOptionEvent->getPaymentModuleOptionGroups());
 
  return $paymentModule;
  }

EventListener/ExceptionListener.php

@@ -11,6 +11,7 @@
 use Symfony\Component\HttpKernel\KernelEvents;
 use Thelia\Core\HttpFoundation\JsonResponse;
 use Thelia\Core\Translation\Translator;
+use Thelia\Log\Tlog;
 
 class ExceptionListener implements EventSubscriberInterface
 {
@@ -37,6 +38,8 @@ public function catchAllException(ExceptionEvent $event): void
  return;
  }
 
+ Tlog::getInstance()->error($event->getThrowable()->getTraceAsString());
+
  /** @var Error $error */
  $error = $this->modelFactory->buildModel(
  'Error',

Events/OpenApiEvents.php

@@ -5,4 +5,5 @@
 class OpenApiEvents
 {
  const MODULE_DELIVERY_GET_OPTIONS = 'thelia.module.delivery.options';
+ const MODULE_PAYMENT_GET_OPTIONS = 'thelia.module.payment.options';
 }

Events/PaymentModuleOptionEvent.php

@@ -0,0 +1,124 @@
+<?php
+
+namespace OpenApi\Events;
+
+use OpenApi\Model\Api\PaymentModuleOption;
+use OpenApi\Model\Api\PaymentModuleOptionGroup;
+use Thelia\Core\Event\ActionEvent;
+use Thelia\Core\Translation\Translator;
+use Thelia\Model\Address;
+use Thelia\Model\Base\CountryQuery;
+use Thelia\Model\Cart;
+use Thelia\Model\Country;
+use Thelia\Model\Module;
+use Thelia\Model\State;
+
+class PaymentModuleOptionEvent extends ActionEvent
+{
+ protected Module $module;
+
+ protected Cart $cart;
+
+ protected ?Address $address = null;
+
+ protected ?Country $country = null;
+
+ protected ?State $state = null;
+
+ protected array $paymentModuleOptionGroups = [];
+
+ public function __construct(
+ Module $module,
+ Cart $cart = null,
+ ) {
+ $this->module = $module;
+ $address = $cart?->getAddressRelatedByAddressInvoiceId() ?? $cart?->getAddressRelatedByAddressDeliveryId() ?? null;
+ $this->address = $address;
+ $this->cart = $cart;
+ $this->country = $address?->getCountry() ?? CountryQuery::create()->filterByByDefault(true)->findOne();
+ $this->state = $address?->getState() ?? $this->country?->getStates()?->getFirst() ?? null;
+
+ if (!$module->isPayementModule()) {
+ throw new \Exception(Translator::getInstance()->trans($module->getTitle().' is not a payment module.'));
+ }
+ }
+
+ public function getPaymentModuleOptionGroups()
+ {
+ return $this->paymentModuleOptionGroups;
+ }
+
+ public function setPaymentModuleOptionGroups($paymentModuleOptionGroups)
+ {
+ $this->paymentModuleOptionGroups = $paymentModuleOptionGroups;
+
+ return $this;
+ }
+
+ public function appendPaymentModuleOptionGroups(PaymentModuleOptionGroup $paymentModuleOptionGroup)
+ {
+ $this->paymentModuleOptionGroups[] = $paymentModuleOptionGroup;
+
+ return $this;
+ }
+
+ public function getModule()
+ {
+ return $this->module;
+ }
+
+ public function setModule($module)
+ {
+ $this->module = $module;
+
+ return $this;
+ }
+
+ public function getCart()
+ {
+ return $this->cart;
+ }
+
+ public function setCart($cart)
+ {
+ $this->cart = $cart;
+
+ return $this;
+ }
+
+ public function getAddress()
+ {
+ return $this->address;
+ }
+
+ public function setAddress($address)
+ {
+ $this->address = $address;
+
+ return $this;
+ }
+
+ public function getCountry()
+ {
+ return $this->country;
+ }
+
+ public function setCountry($country)
+ {
+ $this->country = $country;
+
+ return $this;
+ }
+
+ public function getState()
+ {
+ return $this->state;
+ }
+
+ public function setState($state)
+ {
+ $this->state = $state;
+
+ return $this;
+ }
+}

Model/Api/Checkout.php

@@ -70,6 +70,17 @@ class Checkout extends BaseApiModel
  */
  protected $pickupAddress;
 
+ /**
+ * @var array
+ * @OA\Property(
+ * type="array",
+ * @OA\Items(
+ * ref="#/components/schemas/PaymentModuleOptionChoice"
+ * )
+ * )
+ */
+ protected $paymentOptionChoices = [];
+
  /**
  * @var bool
  * @OA\Property(
@@ -305,5 +316,14 @@ public function setDeliveryModuleOptionCode($deliveryModuleOptionCode)
  return $this;
  }
 
+ public function getPaymentOptionChoices(): array
+ {
+ return $this->paymentOptionChoices;
+ }
 
+ public function setPaymentOptionChoices(?array $paymentOptionChoices = []): Checkout
+ {
+ $this->paymentOptionChoices = $paymentOptionChoices;
+ return $this;
+ }
 }

Model/Api/PaymentModule.php

@@ -59,6 +59,17 @@ class PaymentModule extends BaseApiModel
  */
  protected $maximumAmount;
 
+ /**
+ * @var array
+ * @OA\Property(
+ * type="array",
+ * @OA\Items(
+ * ref="#/components/schemas/PaymentModuleOptionGroup"
+ * )
+ * )
+ */
+ protected $optionGroups;
+
  /**
  * @var array
  * @OA\Property(
@@ -170,6 +181,24 @@ public function setMaximumAmount($maximumAmount)
  return $this;
  }
 
+ /**
+ * @return array
+ */
+ public function getOptionGroups()
+ {
+ return $this->optionGroups;
+ }
+
+ /**
+ * @return PaymentModule
+ */
+ public function setOptionGroups($optionGroups)
+ {
+ $this->optionGroups = $optionGroups;
+
+ return $this;
+ }
+
  /**
  * @return array
  */

Model/Api/PaymentModuleOption.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace OpenApi\Model\Api;
+
+use OpenApi\Attributes\Property;
+use OpenApi\Attributes\Schema;
+use Symfony\Component\Validator\Constraints\NotBlank;
+
+
+#[Schema(description: "An option for payment module")]
+class PaymentModuleOption extends BaseApiModel
+{
+ #[Property(type: "string")]
+ #[NotBlank(groups: ["read"])]
+ protected string $code;
+
+ #[Property(type: "boolean")]
+ protected bool $valid;
+
+ #[Property(type: "string")]
+ protected string $title;
+
+ #[Property(type: "string")]
+ protected string $description;
+
+ #[Property(description: "Option logo url", type: "string")]
+ protected string $image;
+
+ public function getCode(): string
+ {
+ return $this->code;
+ }
+
+ public function setCode(string $code): PaymentModuleOption
+ {
+ $this->code = $code;
+ return $this;
+ }
+
+ public function isValid(): bool
+ {
+ return $this->valid;
+ }
+
+ public function setValid(bool $valid): PaymentModuleOption
+ {
+ $this->valid = $valid;
+ return $this;
+ }
+
+ public function getTitle(): string
+ {
+ return $this->title;
+ }
+
+ public function setTitle(string $title): PaymentModuleOption
+ {
+ $this->title = $title;
+ return $this;
+ }
+
+ public function getDescription(): string
+ {
+ return $this->description;
+ }
+
+ public function setDescription(string $description): PaymentModuleOption
+ {
+ $this->description = $description;
+ return $this;
+ }
+
+ public function getImage(): string
+ {
+ return $this->image;
+ }
+
+ public function setImage(string $image): PaymentModuleOption
+ {
+ $this->image = $image;
+ return $this;
+ }
+}