woocommerce-paypal-payments/modules/ppcp-local-alternative-payment-methods/src/BlikGateway.php

<?php
/**
 * The Blik payment gateway.
 *
 * @package WooCommerce\PayPalCommerce\LocalAlternativePaymentMethods
 */

declare(strict_types=1);

namespace WooCommerce\PayPalCommerce\LocalAlternativePaymentMethods;

use WC_Order;
use WC_Payment_Gateway;
use WooCommerce\PayPalCommerce\ApiClient\Endpoint\Orders;
use WooCommerce\PayPalCommerce\ApiClient\Factory\ExperienceContextBuilder;
use WooCommerce\PayPalCommerce\ApiClient\Factory\PurchaseUnitFactory;
use WooCommerce\PayPalCommerce\Button\Exception\RuntimeException;
use WooCommerce\PayPalCommerce\Settings\Data\Definition\PaymentMethodsDefinition;
use WooCommerce\PayPalCommerce\WcGateway\Gateway\PayPalGateway;
use WooCommerce\PayPalCommerce\WcGateway\Gateway\TransactionUrlProvider;
use WooCommerce\PayPalCommerce\WcGateway\Processor\RefundProcessor;

/**
 * Class BlikGateway
 */
class BlikGateway extends WC_Payment_Gateway {

	const ID = 'ppcp-blik';

	/**
	 * PayPal Orders endpoint.
	 *
	 * @var Orders
	 */
	private $orders_endpoint;

	/**
	 * Purchase unit factory.
	 *
	 * @var PurchaseUnitFactory
	 */
	private $purchase_unit_factory;

	/**
	 * The Refund Processor.
	 *
	 * @var RefundProcessor
	 */
	private $refund_processor;

	/**
	 * Service able to provide transaction url for an order.
	 *
	 * @var TransactionUrlProvider
	 */
	protected $transaction_url_provider;

	/**
	 * The ExperienceContextBuilder.
	 */
	protected ExperienceContextBuilder $experience_context_builder;

	/**
	 * BlikGateway constructor.
	 *
	 * @param Orders                   $orders_endpoint PayPal Orders endpoint.
	 * @param PurchaseUnitFactory      $purchase_unit_factory Purchase unit factory.
	 * @param RefundProcessor          $refund_processor The Refund Processor.
	 * @param TransactionUrlProvider   $transaction_url_provider Service providing transaction view URL based on order.
	 * @param ExperienceContextBuilder $experience_context_builder The ExperienceContextBuilder.
	 */
	public function __construct(
		Orders $orders_endpoint,
		PurchaseUnitFactory $purchase_unit_factory,
		RefundProcessor $refund_processor,
		TransactionUrlProvider $transaction_url_provider,
		ExperienceContextBuilder $experience_context_builder
	) {
		$this->id = self::ID;

		$this->supports = array(
			'refunds',
			'products',
		);

		$this->init_apm_defaults();

		$this->icon = esc_url( 'https://www.paypalobjects.com/images/checkout/alternative_payments/paypal_blik_color.svg' );

		$this->init_form_fields();
		$this->init_settings();

		$this->init_apm_settings();

		add_action( 'woocommerce_update_options_payment_gateways_' . $this->id, array( $this, 'process_admin_options' ) );

		$this->orders_endpoint            = $orders_endpoint;
		$this->purchase_unit_factory      = $purchase_unit_factory;
		$this->refund_processor           = $refund_processor;
		$this->transaction_url_provider   = $transaction_url_provider;
		$this->experience_context_builder = $experience_context_builder;
	}

	/**
	 * Initialize the form fields.
	 */
	public function init_form_fields() {
		$this->form_fields = array(
			'enabled'     => array(
				'title'       => __( 'Enable/Disable', 'woocommerce-paypal-payments' ),
				'type'        => 'checkbox',
				'label'       => __( 'Blik', 'woocommerce-paypal-payments' ),
				'default'     => 'no',
				'desc_tip'    => true,
				'description' => __( 'Enable/Disable Blik payment gateway.', 'woocommerce-paypal-payments' ),
			),
			'title'       => array(
				'title'       => __( 'Title', 'woocommerce-paypal-payments' ),
				'type'        => 'text',
				'default'     => $this->title,
				'desc_tip'    => true,
				'description' => __( 'This controls the title which the user sees during checkout.', 'woocommerce-paypal-payments' ),
			),
			'description' => array(
				'title'       => __( 'Description', 'woocommerce-paypal-payments' ),
				'type'        => 'text',
				'default'     => $this->description,
				'desc_tip'    => true,
				'description' => __( 'This controls the description which the user sees during checkout.', 'woocommerce-paypal-payments' ),
			),
		);
	}

	/**
	 * Processes the order.
	 *
	 * @param int $order_id The WC order ID.
	 * @return array
	 */
	public function process_payment( $order_id ) {
		$wc_order = wc_get_order( $order_id );
		if ( ! ( $wc_order instanceof WC_Order ) ) {
			return array(
				'result'   => 'failure',
				'redirect' => wc_get_checkout_url(),
			);
		}
		$wc_order->update_status( 'pending', __( 'Awaiting Blik to confirm the payment.', 'woocommerce-paypal-payments' ) );

		$purchase_unit = $this->purchase_unit_factory->from_wc_order( $wc_order );
		$amount        = $purchase_unit->amount()->to_array();

		$request_body = array(
			'intent'                 => 'CAPTURE',
			'payment_source'         => array(
				'blik' => array(
					'country_code'       => $wc_order->get_billing_country(),
					'name'               => $wc_order->get_billing_first_name() . ' ' . $wc_order->get_billing_last_name(),
					'email'              => $wc_order->get_billing_email(),
					'experience_context' => $this->experience_context_builder
						->with_order_return_urls( $wc_order )
						->build()
						->with_locale( 'en-PL' )
						->to_array(),
				),
			),
			'processing_instruction' => 'ORDER_COMPLETE_ON_PAYMENT_APPROVAL',
			'purchase_units'         => array(
				array(
					'reference_id' => $purchase_unit->reference_id(),
					'amount'       => array(
						'currency_code' => $amount['currency_code'],
						'value'         => $amount['value'],
					),
					'custom_id'    => $purchase_unit->custom_id(),
					'invoice_id'   => $purchase_unit->invoice_id(),
				),
			),
		);

		try {
			$response = $this->orders_endpoint->create( $request_body );
		} catch ( RuntimeException $exception ) {
			$wc_order->update_status(
				'failed',
				$exception->getMessage()
			);

			return array(
				'result'   => 'failure',
				'redirect' => wc_get_checkout_url(),
			);
		}

		$body = json_decode( $response['body'] );

		$wc_order->update_meta_data( PayPalGateway::ORDER_ID_META_KEY, $body->id );
		$wc_order->save_meta_data();

		$payer_action = '';
		foreach ( $body->links as $link ) {
			if ( $link->rel === 'payer-action' ) {
				$payer_action = $link->href;
			}
		}

		WC()->cart->empty_cart();

		return array(
			'result'   => 'success',
			'redirect' => esc_url( $payer_action ),
		);
	}

	/**
	 * Process refund.
	 *
	 * If the gateway declares 'refunds' support, this will allow it to refund.
	 * a passed in amount.
	 *
	 * @param  int    $order_id Order ID.
	 * @param  float  $amount Refund amount.
	 * @param  string $reason Refund reason.
	 * @return boolean True or false based on success, or a WP_Error object.
	 */
	public function process_refund( $order_id, $amount = null, $reason = '' ) {
		$order = wc_get_order( $order_id );
		if ( ! ( $order instanceof WC_Order ) ) {
			return false;
		}
		return $this->refund_processor->process( $order, (float) $amount, (string) $reason );
	}

	/**
	 * Return transaction url for this gateway and given order.
	 *
	 * @param WC_Order $order WC order to get transaction url by.
	 *
	 * @return string
	 */
	public function get_transaction_url( $order ): string {
		$this->view_transaction_url = $this->transaction_url_provider->get_transaction_url_base( $order );

		return parent::get_transaction_url( $order );
	}

	/**
	 * Initialize APM gateway defaults from centralized definition.
	 */
	private function init_apm_defaults(): void {
		$defaults = PaymentMethodsDefinition::get_apm_defaults()[ self::ID ];

		$this->method_title       = $defaults['method_title'];
		$this->method_description = $defaults['method_description'];
	}

	/**
	 * Load saved settings and override defaults.
	 */
	private function init_apm_settings(): void {
		$defaults = PaymentMethodsDefinition::get_apm_defaults()[ self::ID ];

		$this->title       = $this->get_option( 'title', $defaults['title'] );
		$this->description = $this->get_option( 'description', $defaults['description'] );
	}
}