# sequra/3.1.1/src/Services/Payment/class-payment-method-service.php

seQura, version 3.1.1. 445 lines.

- Page: https://pluginprobe.com/plugins/sequra/3.1.1/code/src/Services/Payment/class-payment-method-service.php
- Raw: https://pluginprobe.com/plugins/sequra/3.1.1/raw/src/Services/Payment/class-payment-method-service.php
- Modified: 2025-01-29T10:47:34+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/sequra/3.1.1/code/src/Services/Payment/class-payment-method-service.php#L10-L20`.

```php
<?php
/**
 * Payment method service
 *
 * @package    SeQura/WC
 * @subpackage SeQura/WC/Services
 */

namespace SeQura\WC\Services\Payment;

use SeQura\Core\BusinessLogic\AdminAPI\AdminAPI;
use SeQura\Core\BusinessLogic\CheckoutAPI\CheckoutAPI;
use SeQura\Core\BusinessLogic\CheckoutAPI\Solicitation\Response\SolicitationResponse;
use SeQura\Core\BusinessLogic\Domain\Order\Models\SeQuraForm;
use SeQura\Core\Infrastructure\Logger\LogContextData;
use SeQura\Core\Infrastructure\ORM\Interfaces\RepositoryInterface;
use SeQura\Core\Infrastructure\ORM\QueryFilter\Operators;
use SeQura\Core\Infrastructure\ORM\QueryFilter\QueryFilter;
use SeQura\WC\Core\Extension\BusinessLogic\DataAccess\PaymentMethods\Entities\Payment_Method;
use SeQura\WC\Core\Extension\BusinessLogic\DataAccess\PaymentMethods\Entities\Payment_Methods;
use SeQura\WC\Core\Extension\BusinessLogic\Domain\Order\Builders\Interface_Create_Order_Request_Builder;
use SeQura\WC\Core\Extension\Infrastructure\Configuration\Configuration;
use SeQura\WC\Dto\Payment_Method_Data;
use SeQura\WC\Dto\Payment_Method_Option;
use SeQura\WC\Services\Interface_Logger_Service;
use SeQura\WC\Services\Order\Interface_Order_Service;
use Throwable;
use WC_Order;

/**
 * Handle use cases related to payment methods
 */
class Payment_Method_Service implements Interface_Payment_Method_Service {

	/**
	 * Part payment
	 */
	const PART_PAYMENT = 'part_payment';
	
	/**
	 * Configuration
	 *
	 * @var Configuration
	 */
	private $configuration;

	/**
	 * Payment methods
	 *
	 * @var Payment_Method_Option[]
	 */
	private $payment_methods;

	/**
	 * Create order request builder
	 *
	 * @var Interface_Create_Order_Request_Builder
	 */
	private $create_order_request_builder;

	/**
	 * Order service
	 *
	 * @var Interface_Order_Service
	 */
	private $order_service;

	/**
	 * Logger
	 *
	 * @var Interface_Logger_Service
	 */
	private $logger;

	/**
	 * Payment methods repository
	 *
	 * @var RepositoryInterface
	 */
	private $payment_methods_repo;

	/**
	 * Constructor
	 */
	public function __construct( 
		Configuration $configuration,
		Interface_Create_Order_Request_Builder $create_order_request_builder,
		Interface_Order_Service $order_service,
		Interface_Logger_Service $logger,
		RepositoryInterface $payment_methods_repo
	) {
		$this->configuration                = $configuration;
		$this->create_order_request_builder = $create_order_request_builder;
		$this->order_service                = $order_service;
		$this->logger                       = $logger;
		$this->payment_methods_repo         = $payment_methods_repo;
	}

	/**
	 * Request solicitation
	 */
	private function request_solicitation( ?WC_Order $order = null ): ?SolicitationResponse {
		try {
			$this->create_order_request_builder->set_current_order( $order );
			
			if ( ! $this->create_order_request_builder->is_allowed() ) {
				$ctx = $order ? array( new LogContextData( 'order_id', $order->get_id() ) ) : array();
				$this->logger->log_debug( 'Order is not allowed for solicitation', __FUNCTION__, __CLASS__, $ctx );
				return null;
			}
	
			$response = CheckoutAPI::get()
			->solicitation( $this->configuration->get_store_id() )
			->solicitFor( $this->create_order_request_builder );
			
			if ( ! $response->isSuccessful() ) {
				$ctx   = $order ? array( new LogContextData( 'order_id', $order->get_id() ) ) : array();
				$ctx[] = new LogContextData( 'response', $response->toArray() );
				$this->logger->log_error( 'Solicitation response is not successful', __FUNCTION__, __CLASS__, $ctx );
			}

			return $response instanceof SolicitationResponse ? $response : null;
		} catch ( Throwable $e ) {
			$this->logger->log_throwable( $e, __FUNCTION__, __CLASS__ );
			return null;
		}
	}

	/**
	 * Get identification form
	 */
	public function get_identification_form( WC_Order $order ): ?SeQuraForm {
		
		$response = $this->request_solicitation( $order );

		if ( ! $response || ! $response->isSuccessful() ) {
			return null;
		}

		/**
		 * Filter the options to be sent to seQura if needed
		 * 
		 * @since 2.0.0
		 * */
		$opts = \apply_filters(
			'wc_sequra_pumbaa_options', 
			array(
				'product'  => $this->order_service->get_product( $order ),
				'campaign' => $this->order_service->get_campaign( $order ),
			), 
			$order,
			array() 
		);

		try {
			$cart_info = $this->order_service->get_cart_info( $order );

			if ( ! $cart_info ) {
				$this->logger->log_error( 'Cart info is null', __FUNCTION__, __CLASS__, array( new LogContextData( 'order_id', $order->get_id() ) ) );
				return null;
			}

			$response = CheckoutAPI::get()
			->solicitation( $this->configuration->get_store_id() )
			->getIdentificationForm( 
				$cart_info->ref, 
				isset( $opts['product'] ) && '' !== $opts['product'] ? $opts['product'] : null,
				isset( $opts['campaign'] ) && '' !== $opts['campaign'] ? $opts['campaign'] : null
			);

			if ( ! $response ) {
				$this->logger->log_error( 'Identification form response is null', __FUNCTION__, __CLASS__, array( new LogContextData( 'order_id', $order->get_id() ) ) );
				return null;
			}

			if ( ! $response->isSuccessful() ) {
				$this->logger->log_error(
					'Identification form response is not successful',
					__FUNCTION__,
					__CLASS__,
					array( 
						new LogContextData( 'response', $response->toArray() ),
						new LogContextData( 'order_id', $order->get_id() ),
					)
				);
				return null;
			}

			return $response->getIdentificationForm();
		} catch ( Throwable $e ) {
			$this->logger->log_throwable( $e, __FUNCTION__, __CLASS__ );
			return null;
		}
	}

	/**
	 * Get payment methods
	 * 
	 * @return Payment_Method_Option[]
	 */
	public function get_payment_methods( ?WC_Order $order = null ) {
		if ( null !== $this->payment_methods ) {
			return $this->payment_methods;
		}
		// TODO: Implement a cache system to avoid multiple requests with the same payload.
		$response = $this->request_solicitation( $order );

		if ( ! $response || ! $response->isSuccessful() ) {
			return array();
		}
		$this->payment_methods = array();
		foreach ( (array) ( $response->toArray()['availablePaymentMethods'] ?? array() ) as $raw ) {
			$this->payment_methods[] = Payment_Method_Option::from_array( $raw );
		}
		return $this->payment_methods;
	}

	/**
	 * Get all payment methods from cache
	 * 
	 * @param string $store_id The store ID.
	 * @param string $merchant The merchant ID.
	 * @return Payment_Methods
	 */
	private function get_payment_methods_from_cache( $store_id, $merchant ) {
		/**
		 * Payment methods entity 
		 *
		 * @var Payment_Methods|null $payment_methods 
		 */
		$payment_methods = $this->payment_methods_repo->selectOne(
			( new QueryFilter() )
			->where( 'storeId', Operators::EQUALS, $store_id )
			->where( 'merchantId', Operators::EQUALS, $merchant ) 
		);

		return $payment_methods;
	}

	/**
	 * Save payment methods to cache
	 *
	 * @param Payment_Methods $payment_methods The payment methods.
	 */
	private function save_payment_methods_to_cache( $payment_methods ) {
		/**
		 * Payment methods entity
		 *
		 * @var Payment_Methods|null $payment_methods 
		 */
		$entity = $this->get_payment_methods_from_cache( 
			$payment_methods->getStoreId(),
			$payment_methods->getMerchantId() 
		);
		if ( null === $entity ) {
			$this->payment_methods_repo->save( $payment_methods );
		} else {
			$entity->setPaymentMethods( $payment_methods->getPaymentMethods() );
			$this->payment_methods_repo->update( $entity );
		}
	}

	/**
	 * Get all payment methods from the API
	 * 
	 * @param string $store_id The store ID.
	 * @param string $merchant The merchant ID.
	 * @return Payment_Methods|null
	 */
	private function get_payment_methods_from_api( $store_id, $merchant ) {
		try {
			$response = AdminAPI::get()->paymentMethods( $store_id )->getPaymentMethods( $merchant );
			if ( ! $response->isSuccessful() ) {
				return null;
			}
			$payment_methods = new Payment_Methods();
			$payment_methods->setStoreId( $store_id );
			$payment_methods->setMerchantId( $merchant );
			$payment_methods->setPaymentMethods( Payment_Method::fromBatch( $response->toArray() ) );
			return $payment_methods;
		} catch ( Throwable $e ) {
			$this->logger->log_throwable( $e, __FUNCTION__, __CLASS__, array( new LogContextData( 'store_id', $store_id ), new LogContextData( 'merchant', $merchant ) ) );
			return null;
		}
	}

	/**
	 * Get a list of all payment methods defined for store and merchant
	 * 
	 * @throws Throwable
	 * 
	 * @param bool $cache Use cache if available.
	 * @return array<string, string>[]
	 */
	public function get_all_payment_methods( ?string $store_id, ?string $merchant, $cache = true ): array {
		if ( ! $store_id || ! $merchant ) {
			return array();
		}

		$merchant        = strval( $merchant );
		$store_id        = strval( $store_id );
		$payment_methods = $cache ? $this->get_payment_methods_from_cache( $store_id, $merchant ) : null;

		if ( ! $payment_methods ) {
			$payment_methods = $this->get_payment_methods_from_api( $store_id, $merchant );
			if ( $payment_methods ) {
				// Save the payment methods in the cache.
				$this->save_payment_methods_to_cache( $payment_methods );
			}
		}

		if ( ! $payment_methods ) {
			return array();
		}

		$arr = array();
		foreach ( $payment_methods->getPaymentMethods() as $method ) {
			$arr[] = $method->toArray();
		}

		return $arr;
	}

	/**
	 * Look for available payment methods which can be used with the widget
	 * 
	 * @throws Throwable
	 * 
	 * @return array<string, string>[]
	 */
	public function get_all_widget_compatible_payment_methods( string $store_id, ?string $merchant ): array {
		$compatible_payment_methods = array();
		foreach ( $this->get_all_payment_methods( $store_id, $merchant ) as $method ) {
			if ( $method['supportsWidgets'] ) {
				$compatible_payment_methods[] = $method;
			}
		}
		return $compatible_payment_methods;
	}

	/**
	 * Look for available payment methods that can be used with part payments
	 * 
	 * @throws Throwable
	 * 
	 * @return array<string, string>[]
	 */
	public function get_all_mini_widget_compatible_payment_methods( string $store_id, ?string $merchant ): array {
		$compatible_payment_methods = array();
		foreach ( $this->get_all_payment_methods( $store_id, $merchant ) as $method ) {
			if ( $method['supportsInstallmentPayments'] ) {
				$compatible_payment_methods[] = $method;
			}
		}
		return $compatible_payment_methods;
	}

	/**
	 * Look for available payment methods which can be used with the widget
	 * 
	 * @throws Throwable
	 * 
	 * @return array<string, string>[]
	 */
	public function get_cart_widget( string $store_id, ?string $merchant ): array {
		$compatible_payment_methods = array();
		foreach ( $this->get_all_payment_methods( $store_id, $merchant ) as $method ) {
			if ( $method['supportsWidgets'] ) {
				$compatible_payment_methods[] = $method;
			}
		}
		return $compatible_payment_methods;
	}

	/**
	 * Check if the payment method can be displayed in the widget
	 * 
	 * @param array<string, string> $method the payment method. Must contain 'product' at least.
	 */
	private function supports_widgets( array $method ): bool {
		return isset( $method['product'] ) && in_array( $method['product'], array( 'i1', 'pp5', 'pp3', 'pp6', 'pp9', 'sp1' ), true );
	}

	/**
	 * Check if the payment method represents a part payment
	 * 
	 * @param array<string, string> $method the payment method. Must contain 'product' at least.
	 */
	private function supports_installment_payments( array $method ): bool {
		// phpcs:ignore
		// return isset( $method['product'] ) && in_array( $method['product'], array( 'pp5', 'pp3', 'pp6', 'pp9', 'sp1' ), true );
		return isset( $method['product'] ) && in_array( $method['product'], array( 'pp3' ), true );
	}

	/**
	 * Check if the payment method data matches a valid payment method.
	 */
	public function is_payment_method_data_valid( ?Payment_Method_Data $data ): bool {
		if ( null !== $data ) {
			foreach ( $this->get_payment_methods() as $pm ) {
				if ( $pm->match( $data ) ) {
					return true;
				}
			}
		}
		return false;
	}

	/**
	 * Check if the current page is the order pay page
	 */
	public function is_order_pay_page(): bool {
		return ( (int) strval( \get_query_var( 'order-pay' ) ) ) > 0;
	}

	/**
	 * Check if the current page is the checkout page
	 */
	public function is_checkout(): bool {
		/**
		 * Check if current page is checkout
		 * 
		 * @since 3.0.0
		 */
		return (bool) \apply_filters( 'sequra_is_checkout', \is_checkout() || $this->is_order_pay_page() || $this->is_store_api_request() );
	}

	/**
	 * Returns true if the request is a store REST API request.
	 *
	 * @return bool
	 */
	private function is_store_api_request() {
		// @phpstan-ignore-next-line
		if ( method_exists( 'WooCommerce', 'is_store_api_request' ) ) {
			return WC()->is_store_api_request();
		}
		if ( empty( $_SERVER['REQUEST_URI'] ) ) {
			return false;
		}
		// phpcs:disable WordPress.Security.ValidatedSanitizedInput.MissingUnslash, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
		return false !== strpos( $_SERVER['REQUEST_URI'], trailingslashit( rest_get_url_prefix() ) . 'wc/store/' );
	}
}

```