eventespresso / event-espresso-core

PaymentMethods/PayPalCommerce/api/orders/CreateOrder.php

Indentation +232 added lines, -232 removed lines

@@ -23,258 +23,258 @@
  */
 class CreateOrder extends OrdersApi
 {
-    /**
-     * Line items total.
-     *
-     * @var float
-     */
-    protected $items_total = 0;
+	/**
+	 * Line items total.
+	 *
+	 * @var float
+	 */
+	protected $items_total = 0;
 
-    /**
-     * Promotions total.
-     *
-     * @var float
-     */
-    protected $promos_total = 0;
+	/**
+	 * Promotions total.
+	 *
+	 * @var float
+	 */
+	protected $promos_total = 0;
 
-    /**
-     * Tax total.
-     *
-     * @var float
-     */
-    protected $tax_total = 0;
+	/**
+	 * Tax total.
+	 *
+	 * @var float
+	 */
+	protected $tax_total = 0;
 
-    /**
-     * Currency.
-     *
-     * @var string
-     */
-    protected string $currency_code;
+	/**
+	 * Currency.
+	 *
+	 * @var string
+	 */
+	protected string $currency_code;
 
-    /**
-     * Billing info.
-     *
-     * @var array
-     */
-    protected array $billing_info;
+	/**
+	 * Billing info.
+	 *
+	 * @var array
+	 */
+	protected array $billing_info;
 
-    /**
-     * Transaction this order is for.
-     *
-     * @var EE_Transaction
-     */
-    protected EE_Transaction $transaction;
+	/**
+	 * Transaction this order is for.
+	 *
+	 * @var EE_Transaction
+	 */
+	protected EE_Transaction $transaction;
 
 
-    /**
-     * CreateOrder constructor.
-     *
-     * @param PayPalApi      $api
-     * @param EE_Transaction $transaction
-     * @param array          $billing_info
-     */
-    public function __construct(PayPalApi $api, EE_Transaction $transaction, array $billing_info)
-    {
-        parent::__construct($api);
-        $this->transaction   = $transaction;
-        $this->currency_code = CurrencyManager::currencyCode();
-        $this->sanitizeRequestParameters($billing_info);
-    }
+	/**
+	 * CreateOrder constructor.
+	 *
+	 * @param PayPalApi      $api
+	 * @param EE_Transaction $transaction
+	 * @param array          $billing_info
+	 */
+	public function __construct(PayPalApi $api, EE_Transaction $transaction, array $billing_info)
+	{
+		parent::__construct($api);
+		$this->transaction   = $transaction;
+		$this->currency_code = CurrencyManager::currencyCode();
+		$this->sanitizeRequestParameters($billing_info);
+	}
 
 
-    /**
-     * Sanitize the array of billing form data.
-     *
-     * @param array $billing_info
-     * @return void
-     */
-    public function sanitizeRequestParameters(array $billing_info): void
-    {
-        $email_validator = new Basic();
-        $sanitizer       = new RequestSanitizer($email_validator);
-        foreach ($billing_info as $item => $value)
-        {
-            $this->billing_info[ $item ] = $sanitizer->clean($value);
-        }
-    }
+	/**
+	 * Sanitize the array of billing form data.
+	 *
+	 * @param array $billing_info
+	 * @return void
+	 */
+	public function sanitizeRequestParameters(array $billing_info): void
+	{
+		$email_validator = new Basic();
+		$sanitizer       = new RequestSanitizer($email_validator);
+		foreach ($billing_info as $item => $value)
+		{
+			$this->billing_info[ $item ] = $sanitizer->clean($value);
+		}
+	}
 
 
-    /**
-     * Create PayPal Order.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create(): array
-    {
-        $order_parameters = $this->getParameters();
-        // Create Order request.
-        $create_response = $this->api->sendRequest($order_parameters, $this->request_url);
-        return $this->validateOrder($create_response, $order_parameters);
-    }
+	/**
+	 * Create PayPal Order.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create(): array
+	{
+		$order_parameters = $this->getParameters();
+		// Create Order request.
+		$create_response = $this->api->sendRequest($order_parameters, $this->request_url);
+		return $this->validateOrder($create_response, $order_parameters);
+	}
 
 
-    /**
-     * Form order parameters.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function getParameters(): array
-    {
-        $registrant  = $this->transaction->primary_registration();
-        $attendee    = $registrant->attendee();
-        $event       = $registrant->event();
-        $description = $event->name() ?: sprintf(
-            esc_html__('Tickets for an event at %1$s', 'event_espresso'),
-            get_bloginfo('name')
-        );
-        return [
-            'intent'              => 'CAPTURE',
-            'purchase_units'      => [
-                [
-                    'custom_id'   => $this->transaction->ID(),
-                    'description' => substr(wp_strip_all_tags($description), 0, 125),
-                    'items'       => $this->getLineItems(),
-                    'amount'      => [
-                        'value'         => $this->transaction->total(),
-                        'currency_code' => $this->currency_code,
-                        'breakdown'     => $this->getBreakdown(),
-                    ],
-                ],
-            ],
-            'application_context' => [
-                'shipping_preference' => 'NO_SHIPPING',
-                'user_action'         => 'PAY_NOW',
-            ],
-            'payer'               => [
-                'email_address' => $attendee->email(),
-                'name'          => [
-                    'given_name' => $attendee->fname(),
-                    'surname'    => $attendee->lname(),
+	/**
+	 * Form order parameters.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function getParameters(): array
+	{
+		$registrant  = $this->transaction->primary_registration();
+		$attendee    = $registrant->attendee();
+		$event       = $registrant->event();
+		$description = $event->name() ?: sprintf(
+			esc_html__('Tickets for an event at %1$s', 'event_espresso'),
+			get_bloginfo('name')
+		);
+		return [
+			'intent'              => 'CAPTURE',
+			'purchase_units'      => [
+				[
+					'custom_id'   => $this->transaction->ID(),
+					'description' => substr(wp_strip_all_tags($description), 0, 125),
+					'items'       => $this->getLineItems(),
+					'amount'      => [
+						'value'         => $this->transaction->total(),
+						'currency_code' => $this->currency_code,
+						'breakdown'     => $this->getBreakdown(),
+					],
+				],
+			],
+			'application_context' => [
+				'shipping_preference' => 'NO_SHIPPING',
+				'user_action'         => 'PAY_NOW',
+			],
+			'payer'               => [
+				'email_address' => $attendee->email(),
+				'name'          => [
+					'given_name' => $attendee->fname(),
+					'surname'    => $attendee->lname(),
 
-                ],
-            ],
-        ];
-    }
+				],
+			],
+		];
+	}
 
 
-    /**
-     * Itemize the payment. List all the line items, discounts and taxes.
-     *
-     * @return array
-     * @throws EE_Error|ReflectionException
-     */
-    protected function getLineItems(): array
-    {
-        // Order line items.
-        $line_items       = [];
-        $event_line_items = $this->transaction->items_purchased();
-        // List actual line items.
-        foreach ($event_line_items as $line_item) {
-            if ($line_item instanceof EE_Line_Item && $line_item->OBJ_type() !== 'Promotion') {
-                $item_money     = $line_item->unit_price();
-                $li_description = $line_item->desc() ?? esc_html__('Event Ticket', 'event_espresso');
-                $line_items [] = [
-                    'name'        => substr(wp_strip_all_tags($line_item->name()), 0, 126),
-                    'quantity'    => $line_item->quantity(),
-                    'description' => substr(wp_strip_all_tags($li_description), 0, 125),
-                    'unit_amount' => [
-                        'currency_code' => $this->currency_code,
-                        'value'         => $item_money,
-                    ],
-                    'category'    => 'DIGITAL_GOODS',
-                ];
-                // Line item total.
-                $this->items_total += $line_item->pretaxTotal();
-            } elseif ($line_item->OBJ_type() === 'Promotion') {
-                // Promotions total.
-                $this->promos_total += $line_item->total();
-            }
-        }
-        // Make sure we have an absolute number with only two decimal laces.
-        $this->items_total  = CurrencyManager::normalizeValue($this->items_total);
-        $this->promos_total = CurrencyManager::normalizeValue($this->promos_total);
-        $this->countTaxTotal();
-        return $line_items;
-    }
+	/**
+	 * Itemize the payment. List all the line items, discounts and taxes.
+	 *
+	 * @return array
+	 * @throws EE_Error|ReflectionException
+	 */
+	protected function getLineItems(): array
+	{
+		// Order line items.
+		$line_items       = [];
+		$event_line_items = $this->transaction->items_purchased();
+		// List actual line items.
+		foreach ($event_line_items as $line_item) {
+			if ($line_item instanceof EE_Line_Item && $line_item->OBJ_type() !== 'Promotion') {
+				$item_money     = $line_item->unit_price();
+				$li_description = $line_item->desc() ?? esc_html__('Event Ticket', 'event_espresso');
+				$line_items [] = [
+					'name'        => substr(wp_strip_all_tags($line_item->name()), 0, 126),
+					'quantity'    => $line_item->quantity(),
+					'description' => substr(wp_strip_all_tags($li_description), 0, 125),
+					'unit_amount' => [
+						'currency_code' => $this->currency_code,
+						'value'         => $item_money,
+					],
+					'category'    => 'DIGITAL_GOODS',
+				];
+				// Line item total.
+				$this->items_total += $line_item->pretaxTotal();
+			} elseif ($line_item->OBJ_type() === 'Promotion') {
+				// Promotions total.
+				$this->promos_total += $line_item->total();
+			}
+		}
+		// Make sure we have an absolute number with only two decimal laces.
+		$this->items_total  = CurrencyManager::normalizeValue($this->items_total);
+		$this->promos_total = CurrencyManager::normalizeValue($this->promos_total);
+		$this->countTaxTotal();
+		return $line_items;
+	}
 
 
-    /**
-     * Count the tax total.
-     *
-     * @return void
-     * @throws EE_Error|ReflectionException
-     */
-    protected function countTaxTotal(): void
-    {
-        // List taxes.
-        $this->tax_total = 0;
-        $tax_items       = $this->transaction->tax_items();
-        foreach ($tax_items as $tax_item) {
-            $this->tax_total += $tax_item->total();
-        }
-        $this->tax_total = CurrencyManager::normalizeValue($this->tax_total);
-    }
+	/**
+	 * Count the tax total.
+	 *
+	 * @return void
+	 * @throws EE_Error|ReflectionException
+	 */
+	protected function countTaxTotal(): void
+	{
+		// List taxes.
+		$this->tax_total = 0;
+		$tax_items       = $this->transaction->tax_items();
+		foreach ($tax_items as $tax_item) {
+			$this->tax_total += $tax_item->total();
+		}
+		$this->tax_total = CurrencyManager::normalizeValue($this->tax_total);
+	}
 
 
-    /**
-     * Itemize the payment the breakdown list.
-     *
-     * @return array
-     */
-    protected function getBreakdown(): array
-    {
-        $breakdown['item_total'] = [
-            'currency_code' => $this->currency_code,
-            'value'         => $this->items_total,
-        ];
-        $breakdown['tax_total']  = [
-            'currency_code' => $this->currency_code,
-            'value'         => $this->tax_total,
-        ];
-        $breakdown['discount']   = [
-            'currency_code' => $this->currency_code,
-            'value'         => abs($this->promos_total),
-        ];
-        return $breakdown;
-    }
+	/**
+	 * Itemize the payment the breakdown list.
+	 *
+	 * @return array
+	 */
+	protected function getBreakdown(): array
+	{
+		$breakdown['item_total'] = [
+			'currency_code' => $this->currency_code,
+			'value'         => $this->items_total,
+		];
+		$breakdown['tax_total']  = [
+			'currency_code' => $this->currency_code,
+			'value'         => $this->tax_total,
+		];
+		$breakdown['discount']   = [
+			'currency_code' => $this->currency_code,
+			'value'         => abs($this->promos_total),
+		];
+		return $breakdown;
+	}
 
 
-    /**
-     * Makes sure that we have received an Order back from the API call.
-     *
-     * @param $response
-     * @param $parameters
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function validateOrder($response, $parameters): array
-    {
-        $message = esc_html__('Validating Order Create:', 'event_espresso');
-        PayPalLogger::errorLog($message, [$this->request_url, $response], $this->transaction->payment_method());
-        if (! empty($response['error'])) {
-            return $response;
-        }
-        if (! isset($response['id'])) {
-            $message = esc_html__('Unexpected response. Unable to find the order.', 'event_espresso');
-            try {
-                PayPalLogger::errorLog(
-                    $message,
-                    [$this->request_url, $parameters, $response],
-                    $this->transaction->payment_method()
-                );
-            } catch (EE_Error | ReflectionException $e) {
-                // Just continue.
-            }
-            return [
-                'error'   => $response['error'] ?? 'missing_order',
-                'message' => $response['message'] ?? $message,
-            ];
-        }
-        return $response;
-    }
+	/**
+	 * Makes sure that we have received an Order back from the API call.
+	 *
+	 * @param $response
+	 * @param $parameters
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function validateOrder($response, $parameters): array
+	{
+		$message = esc_html__('Validating Order Create:', 'event_espresso');
+		PayPalLogger::errorLog($message, [$this->request_url, $response], $this->transaction->payment_method());
+		if (! empty($response['error'])) {
+			return $response;
+		}
+		if (! isset($response['id'])) {
+			$message = esc_html__('Unexpected response. Unable to find the order.', 'event_espresso');
+			try {
+				PayPalLogger::errorLog(
+					$message,
+					[$this->request_url, $parameters, $response],
+					$this->transaction->payment_method()
+				);
+			} catch (EE_Error | ReflectionException $e) {
+				// Just continue.
+			}
+			return [
+				'error'   => $response['error'] ?? 'missing_order',
+				'message' => $response['message'] ?? $message,
+			];
+		}
+		return $response;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -94,7 +94,7 @@ 
         $sanitizer       = new RequestSanitizer($email_validator);
         foreach ($billing_info as $item => $value)
         {
-            $this->billing_info[ $item ] = $sanitizer->clean($value);
+            $this->billing_info[$item] = $sanitizer->clean($value);
         }
     }
 
@@ -231,11 +231,11 @@ 
             'currency_code' => $this->currency_code,
             'value'         => $this->items_total,
         ];
-        $breakdown['tax_total']  = [
+        $breakdown['tax_total'] = [
             'currency_code' => $this->currency_code,
             'value'         => $this->tax_total,
         ];
-        $breakdown['discount']   = [
+        $breakdown['discount'] = [
             'currency_code' => $this->currency_code,
             'value'         => abs($this->promos_total),
         ];
@@ -256,10 +256,10 @@ 
     {
         $message = esc_html__('Validating Order Create:', 'event_espresso');
         PayPalLogger::errorLog($message, [$this->request_url, $response], $this->transaction->payment_method());
-        if (! empty($response['error'])) {
+        if ( ! empty($response['error'])) {
             return $response;
         }
-        if (! isset($response['id'])) {
+        if ( ! isset($response['id'])) {
             $message = esc_html__('Unexpected response. Unable to find the order.', 'event_espresso');
             try {
                 PayPalLogger::errorLog(

PaymentMethods/PayPalCommerce/api/orders/OrdersApi.php

Indentation +22 added lines, -22 removed lines

@@ -15,30 +15,30 @@
  */
 abstract class OrdersApi
 {
-    /**
-     * @var PayPalApi
-     */
-    protected PayPalApi $api;
+	/**
+	 * @var PayPalApi
+	 */
+	protected PayPalApi $api;
 
-    /**
-     * @var string
-     */
-    protected string $request_url;
+	/**
+	 * @var string
+	 */
+	protected string $request_url;
 
-    /**
-     * @var string
-     */
-    protected string $order_id;
+	/**
+	 * @var string
+	 */
+	protected string $order_id;
 
 
-    /**
-     * Orders API constructor.
-     *
-     * @param PayPalApi $api
-     */
-    public function __construct(PayPalApi $api)
-    {
-        $this->api         = $api;
-        $this->request_url = $this->api->apiEndpoint() . 'checkout/orders/';
-    }
+	/**
+	 * Orders API constructor.
+	 *
+	 * @param PayPalApi $api
+	 */
+	public function __construct(PayPalApi $api)
+	{
+		$this->api         = $api;
+		$this->request_url = $this->api->apiEndpoint() . 'checkout/orders/';
+	}
 }

PaymentMethods/PayPalCommerce/api/orders/CaptureOrder.php

Indentation +81 added lines, -81 removed lines

@@ -20,92 +20,92 @@
  */
 class CaptureOrder extends OrdersApi
 {
-    /**
-     * Currency.
-     *
-     * @var string
-     */
-    protected string $currency_code;
+	/**
+	 * Currency.
+	 *
+	 * @var string
+	 */
+	protected string $currency_code;
 
-    /**
-     * Transaction this order is for.
-     *
-     * @var EE_Transaction
-     */
-    protected EE_Transaction $transaction;
+	/**
+	 * Transaction this order is for.
+	 *
+	 * @var EE_Transaction
+	 */
+	protected EE_Transaction $transaction;
 
 
-    /**
-     * CaptureOrder constructor.
-     *
-     * @param PayPalApi      $api
-     * @param EE_Transaction $transaction
-     * @param string         $order_id
-     */
-    public function __construct(PayPalApi $api, EE_Transaction $transaction, string $order_id)
-    {
-        parent::__construct($api);
-        $this->transaction   = $transaction;
-        $this->order_id      = $order_id;
-        $this->currency_code = CurrencyManager::currencyCode();
-        $this->request_url   = $this->request_url . $order_id . '/capture';
-    }
+	/**
+	 * CaptureOrder constructor.
+	 *
+	 * @param PayPalApi      $api
+	 * @param EE_Transaction $transaction
+	 * @param string         $order_id
+	 */
+	public function __construct(PayPalApi $api, EE_Transaction $transaction, string $order_id)
+	{
+		parent::__construct($api);
+		$this->transaction   = $transaction;
+		$this->order_id      = $order_id;
+		$this->currency_code = CurrencyManager::currencyCode();
+		$this->request_url   = $this->request_url . $order_id . '/capture';
+	}
 
 
-    /**
-     * Capture payment for PayPal Order.
-     *
-     * @return array
-     */
-    public function capture(): array
-    {
-        // Create Order request.
-        $capture_response = $this->api->sendRequest([], $this->request_url);
-        return $this->validateOrder($capture_response);
-    }
+	/**
+	 * Capture payment for PayPal Order.
+	 *
+	 * @return array
+	 */
+	public function capture(): array
+	{
+		// Create Order request.
+		$capture_response = $this->api->sendRequest([], $this->request_url);
+		return $this->validateOrder($capture_response);
+	}
 
 
-    /**
-     * Makes sure that we have received an Order back from the API call.
-     *
-     * @param $response
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function validateOrder($response): array
-    {
-        $message = esc_html__('Validating Order Capture:', 'event_espresso');
-        PayPalLogger::errorLog($message, [$this->request_url, $response], $this->transaction->payment_method());
-        // We got a direct error response. Not valid. Return that error.
-        if (! empty($response['error'])) {
-            return $response;
-        }
-        // This also could be a retry capture, so consider this valid, if order already captured.
-        if (! empty($response['message']['details']['issue'])
-            && $response['message']['details']['issue'] === 'ORDER_ALREADY_CAPTURED'
-        ) {
-            // Need to make sure we pass on the order ID.
-            if (empty($response['id'])) {
-                $response['id'] = $this->order_id;
-            }
-            $response['status'] = 'ORDER_ALREADY_CAPTURED';
-            return $response;
-        }
-        // A success capture should return the order ID.
-        if (! isset($response['id'])) {
-            $message = esc_html__('Unexpected response. No order returned.', 'event_espresso');
-            try {
-                PayPalLogger::errorLog($message, [$this->request_url, $response], $this->transaction->payment_method());
-            } catch (EE_Error | ReflectionException $e) {
-                // Just continue.
-            }
-            return [
-                'error'   => $response['error'] ?? 'missing_order',
-                'message' => $response['message'] ?? $message,
-                'name'    => $response['name'] ?? 'UNKNOWN_ERROR',
-            ];
-        }
-        return $response;
-    }
+	/**
+	 * Makes sure that we have received an Order back from the API call.
+	 *
+	 * @param $response
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function validateOrder($response): array
+	{
+		$message = esc_html__('Validating Order Capture:', 'event_espresso');
+		PayPalLogger::errorLog($message, [$this->request_url, $response], $this->transaction->payment_method());
+		// We got a direct error response. Not valid. Return that error.
+		if (! empty($response['error'])) {
+			return $response;
+		}
+		// This also could be a retry capture, so consider this valid, if order already captured.
+		if (! empty($response['message']['details']['issue'])
+			&& $response['message']['details']['issue'] === 'ORDER_ALREADY_CAPTURED'
+		) {
+			// Need to make sure we pass on the order ID.
+			if (empty($response['id'])) {
+				$response['id'] = $this->order_id;
+			}
+			$response['status'] = 'ORDER_ALREADY_CAPTURED';
+			return $response;
+		}
+		// A success capture should return the order ID.
+		if (! isset($response['id'])) {
+			$message = esc_html__('Unexpected response. No order returned.', 'event_espresso');
+			try {
+				PayPalLogger::errorLog($message, [$this->request_url, $response], $this->transaction->payment_method());
+			} catch (EE_Error | ReflectionException $e) {
+				// Just continue.
+			}
+			return [
+				'error'   => $response['error'] ?? 'missing_order',
+				'message' => $response['message'] ?? $message,
+				'name'    => $response['name'] ?? 'UNKNOWN_ERROR',
+			];
+		}
+		return $response;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -48,7 +48,7 @@ 
         $this->transaction   = $transaction;
         $this->order_id      = $order_id;
         $this->currency_code = CurrencyManager::currencyCode();
-        $this->request_url   = $this->request_url . $order_id . '/capture';
+        $this->request_url   = $this->request_url.$order_id.'/capture';
     }
 
 
@@ -78,11 +78,11 @@ 
         $message = esc_html__('Validating Order Capture:', 'event_espresso');
         PayPalLogger::errorLog($message, [$this->request_url, $response], $this->transaction->payment_method());
         // We got a direct error response. Not valid. Return that error.
-        if (! empty($response['error'])) {
+        if ( ! empty($response['error'])) {
             return $response;
         }
         // This also could be a retry capture, so consider this valid, if order already captured.
-        if (! empty($response['message']['details']['issue'])
+        if ( ! empty($response['message']['details']['issue'])
             && $response['message']['details']['issue'] === 'ORDER_ALREADY_CAPTURED'
         ) {
             // Need to make sure we pass on the order ID.
@@ -93,7 +93,7 @@ 
             return $response;
         }
         // A success capture should return the order ID.
-        if (! isset($response['id'])) {
+        if ( ! isset($response['id'])) {
             $message = esc_html__('Unexpected response. No order returned.', 'event_espresso');
             try {
                 PayPalLogger::errorLog($message, [$this->request_url, $response], $this->transaction->payment_method());

PaymentMethods/PayPalCommerce/api/FirstPartyPayPalApi.php

Indentation +111 added lines, -111 removed lines

@@ -13,115 +13,115 @@
  */
 class FirstPartyPayPalApi extends PayPalApi
 {
-    /**
-     * Client ID. Used to process payments.
-     *
-     * @var string
-     */
-    protected string $client_id = '';
-
-    /**
-     * Client secret. Used to process payments.
-     *
-     * @var string
-     */
-    protected string $client_secret = '';
-
-    /**
-     * BN Code. Partner-Attribution-Id.
-     *
-     * @var string
-     */
-    protected string $bn_code = '';
-
-
-    /**
-     * @param string $client_id
-     * @param string $client_secret
-     * @param string $bn_code
-     * @param bool   $sandbox_mode
-     */
-    public function __construct(string $client_id, string $client_secret, string $bn_code, bool $sandbox_mode = true)
-    {
-        parent::__construct($sandbox_mode);
-        $this->client_id     = $client_id;
-        $this->client_secret = $client_secret;
-        $this->bn_code       = $bn_code;
-    }
-
-
-    /**
-     * Send an API request.
-     *
-     * @param array  $body_parameters
-     * @param string $endpoint
-     * @param string $method
-     * @param array  $headers
-     * @return Object|array
-     */
-    public function sendRequest(array $body_parameters, string $endpoint, string $method = 'POST', array $headers = [])
-    {
-        $request_parameters = $this->getRequestParameters($body_parameters, $method, $headers);
-        return $this->request($endpoint, $request_parameters);
-    }
-
-
-    /**
-     * Build the request parameters.
-     *
-     * @param array  $body_parameters
-     * @param string $method
-     * @param array  $headers
-     * @return array
-     */
-    private function getRequestParameters(array $body_parameters, string $method, array $headers): array
-    {
-        $request_parameters = [
-            'method'      => $method,
-            'timeout'     => 60,
-            'redirection' => 5,
-            'blocking'    => true,
-        ];
-        $default_headers = [
-            'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
-            'PayPal-Partner-Attribution-Id' => $this->bn_code,
-            'Content-Type'                  => 'application/json',
-            'Authorization'                 => 'Basic ' . base64_encode(
-                $this->client_id . ':' . $this->client_secret
-            ),
-        ];
-        $request_parameters['headers'] = array_merge($default_headers, $headers);
-        // Add body if this is a POST request.
-        if ($body_parameters && ($method === 'POST' || $method === 'PUT')) {
-            $request_parameters['body'] = json_encode($body_parameters);
-        }
-        return $request_parameters;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function clientId(): string
-    {
-        return $this->client_id;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function clientSecret(): string
-    {
-        return $this->client_secret;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function bnCode(): string
-    {
-        return $this->bn_code;
-    }
+	/**
+	 * Client ID. Used to process payments.
+	 *
+	 * @var string
+	 */
+	protected string $client_id = '';
+
+	/**
+	 * Client secret. Used to process payments.
+	 *
+	 * @var string
+	 */
+	protected string $client_secret = '';
+
+	/**
+	 * BN Code. Partner-Attribution-Id.
+	 *
+	 * @var string
+	 */
+	protected string $bn_code = '';
+
+
+	/**
+	 * @param string $client_id
+	 * @param string $client_secret
+	 * @param string $bn_code
+	 * @param bool   $sandbox_mode
+	 */
+	public function __construct(string $client_id, string $client_secret, string $bn_code, bool $sandbox_mode = true)
+	{
+		parent::__construct($sandbox_mode);
+		$this->client_id     = $client_id;
+		$this->client_secret = $client_secret;
+		$this->bn_code       = $bn_code;
+	}
+
+
+	/**
+	 * Send an API request.
+	 *
+	 * @param array  $body_parameters
+	 * @param string $endpoint
+	 * @param string $method
+	 * @param array  $headers
+	 * @return Object|array
+	 */
+	public function sendRequest(array $body_parameters, string $endpoint, string $method = 'POST', array $headers = [])
+	{
+		$request_parameters = $this->getRequestParameters($body_parameters, $method, $headers);
+		return $this->request($endpoint, $request_parameters);
+	}
+
+
+	/**
+	 * Build the request parameters.
+	 *
+	 * @param array  $body_parameters
+	 * @param string $method
+	 * @param array  $headers
+	 * @return array
+	 */
+	private function getRequestParameters(array $body_parameters, string $method, array $headers): array
+	{
+		$request_parameters = [
+			'method'      => $method,
+			'timeout'     => 60,
+			'redirection' => 5,
+			'blocking'    => true,
+		];
+		$default_headers = [
+			'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
+			'PayPal-Partner-Attribution-Id' => $this->bn_code,
+			'Content-Type'                  => 'application/json',
+			'Authorization'                 => 'Basic ' . base64_encode(
+				$this->client_id . ':' . $this->client_secret
+			),
+		];
+		$request_parameters['headers'] = array_merge($default_headers, $headers);
+		// Add body if this is a POST request.
+		if ($body_parameters && ($method === 'POST' || $method === 'PUT')) {
+			$request_parameters['body'] = json_encode($body_parameters);
+		}
+		return $request_parameters;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function clientId(): string
+	{
+		return $this->client_id;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function clientSecret(): string
+	{
+		return $this->client_secret;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function bnCode(): string
+	{
+		return $this->bn_code;
+	}
 }

PaymentMethods/PayPalCommerce/api/PayPalApi.php

Indentation +60 added lines, -60 removed lines

@@ -15,72 +15,72 @@
  */
 abstract class PayPalApi
 {
-    /**
-     * @var bool Debug mode enabled ?
-     */
-    protected bool $sandbox_mode;
+	/**
+	 * @var bool Debug mode enabled ?
+	 */
+	protected bool $sandbox_mode;
 
-    /**
-     * API request/response validation helper.
-     *
-     * @var ResponseInspector
-     */
-    protected ResponseInspector $inspector;
+	/**
+	 * API request/response validation helper.
+	 *
+	 * @var ResponseInspector
+	 */
+	protected ResponseInspector $inspector;
 
-    /**
-     * @var string PayPal API endpoint.
-     */
-    protected string $api_endpoint = '';
+	/**
+	 * @var string PayPal API endpoint.
+	 */
+	protected string $api_endpoint = '';
 
 
-    /**
-     * @param bool $sandbox_mode
-     */
-    public function __construct(bool $sandbox_mode = true) {
-        $this->sandbox_mode = $sandbox_mode;
-        // Is this a sandbox request.
-        $this->api_endpoint = $this->sandbox_mode
-            ? 'https://api-m.sandbox.paypal.com/v2/'
-            : 'https://api-m.paypal.com/v2/';
-        $this->inspector     = new ResponseInspector();
-    }
+	/**
+	 * @param bool $sandbox_mode
+	 */
+	public function __construct(bool $sandbox_mode = true) {
+		$this->sandbox_mode = $sandbox_mode;
+		// Is this a sandbox request.
+		$this->api_endpoint = $this->sandbox_mode
+			? 'https://api-m.sandbox.paypal.com/v2/'
+			: 'https://api-m.paypal.com/v2/';
+		$this->inspector     = new ResponseInspector();
+	}
 
 
-    /**
-     * Send an API request.
-     *
-     * @param string $endpoint
-     * @param array  $request_parameters
-     * @return Object|array
-     */
-    public function request(string $endpoint, array $request_parameters)
-    {
-        // Sent the API request.
-        $response = wp_remote_request($endpoint, $request_parameters);
-        // Validate the response.
-        $this->inspector->validateResponse($response);
-        if (! $this->inspector->isValid()) {
-            PayPalLogger::errorLog($this->inspector->error()['message'], [$endpoint, $request_parameters, $response]);
-            return $this->inspector->error();
-        }
-        // Decode the parameters.
-        $api_response = json_decode($response['body'], true);
-        // Validate parameters.
-        $this->inspector->validateParameters($api_response);
-        if (! $this->inspector->isValid()) {
-            PayPalLogger::errorLog($this->inspector->error()['message'], [$endpoint, $request_parameters, $response]);
-            return $this->inspector->error();
-        }
-        // All seem ok, return the response.
-        return $api_response;
-    }
+	/**
+	 * Send an API request.
+	 *
+	 * @param string $endpoint
+	 * @param array  $request_parameters
+	 * @return Object|array
+	 */
+	public function request(string $endpoint, array $request_parameters)
+	{
+		// Sent the API request.
+		$response = wp_remote_request($endpoint, $request_parameters);
+		// Validate the response.
+		$this->inspector->validateResponse($response);
+		if (! $this->inspector->isValid()) {
+			PayPalLogger::errorLog($this->inspector->error()['message'], [$endpoint, $request_parameters, $response]);
+			return $this->inspector->error();
+		}
+		// Decode the parameters.
+		$api_response = json_decode($response['body'], true);
+		// Validate parameters.
+		$this->inspector->validateParameters($api_response);
+		if (! $this->inspector->isValid()) {
+			PayPalLogger::errorLog($this->inspector->error()['message'], [$endpoint, $request_parameters, $response]);
+			return $this->inspector->error();
+		}
+		// All seem ok, return the response.
+		return $api_response;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function apiEndpoint(): string
-    {
-        return $this->api_endpoint;
-    }
+	/**
+	 * @return string
+	 */
+	public function apiEndpoint(): string
+	{
+		return $this->api_endpoint;
+	}
 }

PaymentMethods/PayPalCommerce/api/ThirdPartyPayPalApi.php

Indentation +110 added lines, -110 removed lines

@@ -13,127 +13,127 @@
  */
 class ThirdPartyPayPalApi extends PayPalApi
 {
-    /**
-     * Partner access token used to process payments.
-     *
-     * @var string
-     */
-    protected string $access_token = '';
+	/**
+	 * Partner access token used to process payments.
+	 *
+	 * @var string
+	 */
+	protected string $access_token = '';
 
-    /**
-     * Partner Client ID.
-     *
-     * @var string
-     */
-    protected string $partner_client_id = '';
+	/**
+	 * Partner Client ID.
+	 *
+	 * @var string
+	 */
+	protected string $partner_client_id = '';
 
-    /**
-     * Merchant (seller) merchant ID.
-     *
-     * @var string
-     */
-    protected string $payer_id = '';
+	/**
+	 * Merchant (seller) merchant ID.
+	 *
+	 * @var string
+	 */
+	protected string $payer_id = '';
 
-    /**
-     * BN Code. Partner-Attribution-Id.
-     *
-     * @var string
-     */
-    protected string $bn_code = '';
+	/**
+	 * BN Code. Partner-Attribution-Id.
+	 *
+	 * @var string
+	 */
+	protected string $bn_code = '';
 
 
-    /**
-     * @param string $access_token
-     * @param string $bn_code
-     * @param string $partner_client_id
-     * @param string $payer_id
-     * @param bool   $sandbox_mode
-     */
-    public function __construct(
-        string $access_token,
-        string $bn_code,
-        string $partner_client_id = '',
-        string $payer_id = '',
-        bool   $sandbox_mode = true
-    ) {
-        parent::__construct($sandbox_mode);
-        $this->access_token      = $access_token;
-        $this->partner_client_id = $partner_client_id;
-        $this->payer_id          = $payer_id;
-        $this->bn_code           = $bn_code;
-    }
+	/**
+	 * @param string $access_token
+	 * @param string $bn_code
+	 * @param string $partner_client_id
+	 * @param string $payer_id
+	 * @param bool   $sandbox_mode
+	 */
+	public function __construct(
+		string $access_token,
+		string $bn_code,
+		string $partner_client_id = '',
+		string $payer_id = '',
+		bool   $sandbox_mode = true
+	) {
+		parent::__construct($sandbox_mode);
+		$this->access_token      = $access_token;
+		$this->partner_client_id = $partner_client_id;
+		$this->payer_id          = $payer_id;
+		$this->bn_code           = $bn_code;
+	}
 
 
-    /**
-     * Send an API request.
-     *
-     * @param array  $body_parameters
-     * @param string $endpoint
-     * @param string $method
-     * @param array  $headers
-     * @return Object|array
-     */
-    public function sendRequest(array $body_parameters, string $endpoint, string $method = 'POST', array $headers = [])
-    {
-        $request_parameters = $this->getRequestParameters($body_parameters, $method, $headers);
-        return $this->request($endpoint, $request_parameters);
-    }
+	/**
+	 * Send an API request.
+	 *
+	 * @param array  $body_parameters
+	 * @param string $endpoint
+	 * @param string $method
+	 * @param array  $headers
+	 * @return Object|array
+	 */
+	public function sendRequest(array $body_parameters, string $endpoint, string $method = 'POST', array $headers = [])
+	{
+		$request_parameters = $this->getRequestParameters($body_parameters, $method, $headers);
+		return $this->request($endpoint, $request_parameters);
+	}
 
 
-    /**
-     * Build the request parameters.
-     *
-     * @param array  $body_parameters
-     * @param string $method
-     * @param array  $headers
-     * @return array
-     */
-    private function getRequestParameters(array $body_parameters, string $method, array $headers): array
-    {
-        $request_parameters = [
-            'method' => $method,
-        ];
-        $default_headers    = [
-            'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
-            'PayPal-Partner-Attribution-Id' => $this->bnCode(),
-            'Content-Type'                  => 'application/json',
-            'Authorization'                 => 'Bearer ' . $this->accessToken(),
-        ];
-        // If we have merchant credentials then we are onboard and can do requests on behalf of the seller.
-        if ($this->partner_client_id && $this->payer_id) {
-            $assertion1 = [
-                'alg' => 'none',
-            ];
-            $assertion2 = [
-                'iss'      => $this->partner_client_id,
-                'payer_id' => $this->payer_id,
-            ];
-            $default_headers['PayPal-Auth-Assertion'] = base64_encode(json_encode($assertion1, JSON_HEX_APOS)) . '.' .
-                                                        base64_encode(json_encode($assertion2, JSON_HEX_APOS)) . '.';
-        }
-        $request_parameters['headers'] = array_merge($default_headers, $headers);
-        // Add body if this is a POST request.
-        if ($body_parameters && ($method === 'POST' || $method === 'PUT')) {
-            $request_parameters['body'] = json_encode($body_parameters);
-        }
-        return $request_parameters;
-    }
+	/**
+	 * Build the request parameters.
+	 *
+	 * @param array  $body_parameters
+	 * @param string $method
+	 * @param array  $headers
+	 * @return array
+	 */
+	private function getRequestParameters(array $body_parameters, string $method, array $headers): array
+	{
+		$request_parameters = [
+			'method' => $method,
+		];
+		$default_headers    = [
+			'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
+			'PayPal-Partner-Attribution-Id' => $this->bnCode(),
+			'Content-Type'                  => 'application/json',
+			'Authorization'                 => 'Bearer ' . $this->accessToken(),
+		];
+		// If we have merchant credentials then we are onboard and can do requests on behalf of the seller.
+		if ($this->partner_client_id && $this->payer_id) {
+			$assertion1 = [
+				'alg' => 'none',
+			];
+			$assertion2 = [
+				'iss'      => $this->partner_client_id,
+				'payer_id' => $this->payer_id,
+			];
+			$default_headers['PayPal-Auth-Assertion'] = base64_encode(json_encode($assertion1, JSON_HEX_APOS)) . '.' .
+														base64_encode(json_encode($assertion2, JSON_HEX_APOS)) . '.';
+		}
+		$request_parameters['headers'] = array_merge($default_headers, $headers);
+		// Add body if this is a POST request.
+		if ($body_parameters && ($method === 'POST' || $method === 'PUT')) {
+			$request_parameters['body'] = json_encode($body_parameters);
+		}
+		return $request_parameters;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function accessToken(): string
-    {
-        return $this->access_token;
-    }
+	/**
+	 * @return string
+	 */
+	public function accessToken(): string
+	{
+		return $this->access_token;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function bnCode(): string
-    {
-        return $this->bn_code;
-    }
+	/**
+	 * @return string
+	 */
+	public function bnCode(): string
+	{
+		return $this->bn_code;
+	}
 }

PaymentMethods/PayPalCommerce/modules/EED_PayPalCommerce.module.php

Indentation +455 added lines, -455 removed lines

@@ -21,459 +21,459 @@
  */
 class EED_PayPalCommerce extends EED_Module
 {
-    /**
-     * @return EED_Module
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(): EED_Module
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * Run - initial module setup.
-     *
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * For hooking into EE Core and other modules.
-     *
-     * @return void
-     */
-    public static function set_hooks(): void
-    {
-        if (DbStatus::isOnline()) {
-            // Don't load PM on the front-end if not Connected.
-            add_filter(
-                'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-                [__CLASS__, 'filterPaymentMethods'],
-                100,
-                3
-            );
-        }
-    }
-
-
-    /**
-     * For hooking into EE Core and other modules Admin.
-     *
-     * @return void
-     */
-    public static function set_hooks_admin(): void
-    {
-        if (DbStatus::isOnline()) {
-            // Create an Order.
-            add_action('wp_ajax_eeaPPCCreateOrder', [__CLASS__, 'createOrderRequest']);
-            add_action('wp_ajax_nopriv_eeaPPCCreateOrder', [__CLASS__, 'createOrderRequest']);
-            // Capture the Order.
-            add_action('wp_ajax_eeaPPCCaptureOrder', [__CLASS__, 'captureOrderRequest']);
-            add_action('wp_ajax_nopriv_eeaPPCCaptureOrder', [__CLASS__, 'captureOrderRequest']);
-            // Log errors from the JS side.
-            add_action('wp_ajax_eeaPPCommerceLogError', [__CLASS__, 'logJsError']);
-            add_action('wp_ajax_nopriv_eeaPPCommerceLogError', [__CLASS__, 'logJsError']);
-            // Don't load PM in the admin if not Connected.
-            add_filter(
-                'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-                [__CLASS__, 'filterPaymentMethods'],
-                100,
-                3
-            );
-        }
-    }
-
-
-    /**
-     * Create the order and return its data as JSON.
-     * (AJAX)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function createOrderRequest(): void
-    {
-        $paypal_pm   = EED_PayPalCommerce::getPaymentMethod();
-        $request     = EED_Module::getRequest();
-        $post_params = $request->postParams();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            PayPalLogger::errorLogAndExit(
-                esc_html__('Related payment method not found (create Order).', 'event_espresso'),
-                $post_params
-            );
-        }
-        $transaction  = EED_PayPalCommerce::getTransaction();
-        $billing_info = $post_params['billing_info'] ?? [];
-        if ($billing_info) {
-            $billing_info_decoded = json_decode(stripslashes($billing_info), true);
-            $billing_info         = is_array($billing_info_decoded) ? $billing_info_decoded : [];
-        }
-        if (! $transaction) {
-            PayPalLogger::errorLogAndExit(
-                esc_html__('Transaction info not found.', 'event_espresso'),
-                $post_params,
-                $paypal_pm
-            );
-        }
-        $order_data = EED_PayPalCommerce::createOrder($transaction, $billing_info, $paypal_pm);
-        wp_send_json($order_data);
-    }
-
-
-    /**
-     * Capture the order and return status in JSON.
-     * (AJAX)
-     *
-     * @return void
-     */
-    public static function captureOrderRequest(): void
-    {
-        $error_message = false;
-        $paypal_pm     = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            $error_message = esc_html__('Payment method not found (capture Order).', 'event_espresso');
-        }
-        $transaction = EED_PayPalCommerce::getTransaction();
-        if (! $transaction) {
-            $error_message = esc_html__('Transaction not found.', 'event_espresso');
-        }
-        $order_id = EED_Module::getRequest()->getRequestParam('order_id', '', DataType::STRING);
-        if (! $order_id) {
-            $error_message = esc_html__('Order ID missing.', 'event_espresso');
-        }
-        // We had an error. Log and EXIT.
-        if ($error_message) {
-            PayPalLogger::errorLogAndExit($error_message, EED_Module::getRequest()->postParams(), $paypal_pm);
-        }
-        $capture_response = EED_PayPalCommerce::captureOrder($transaction, $paypal_pm, $order_id);
-        wp_send_json($capture_response);
-    }
-
-
-    /**
-     * Create a new Order using the PP API.
-     *
-     * @param EE_Transaction    $transaction
-     * @param array             $billing_info
-     * @param EE_Payment_Method $paypal_pm
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function createOrder(
-        EE_Transaction    $transaction,
-        array             $billing_info,
-        EE_Payment_Method $paypal_pm
-    ): array {
-        $create_order_api = EED_PayPalCommerce::getCreateOrderApi($transaction, $billing_info, $paypal_pm);
-        if (! $create_order_api instanceof CreateOrder) {
-            return [
-                'error'   => 'CREATE_ORDER_API_FAULT',
-                'message' => esc_html__('The Create Order API request fault.', 'event_espresso'),
-            ];
-        }
-        $order = $create_order_api->create();
-        if (isset($order['error'])) {
-            return [
-                'error'   => 'CREATE_ORDER_API_RESPONSE_ERROR',
-                'message' => $order['message'],
-            ];
-        }
-        return [
-            'pp_order_id' => $order['id'],
-        ];
-    }
-
-
-    /**
-     * Create a new Order using the PP API.
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $order_id
-     * @return array
-     */
-    public static function captureOrder(
-        EE_Transaction    $transaction,
-        EE_Payment_Method $paypal_pm,
-        string            $order_id
-    ): array {
-        $capture_order_api = EED_PayPalCommerce::getCaptureOrderApi($transaction, $paypal_pm, $order_id);
-        if (! $capture_order_api instanceof CaptureOrder) {
-            return [
-                'error'   => 'CAPTURE_ORDER_API_FAULT',
-                'message' => esc_html__('A capture Order API request fault.', 'event_espresso'),
-            ];
-        }
-        $order = $capture_order_api->capture();
-        if (isset($order['error'])) {
-            return $order;
-        }
-        // Attach the transaction ID to this order.
-        try {
-            $order['ee_txn_id'] = $transaction->ID();
-        } catch (Exception $e) {
-            // Just don't set the txn id.
-        }
-        // If this was a capture request on an already Captured order, try using the initial capture data (if any saved)
-        // that has more information on the order than this retry capture response.
-        if ($order['status'] === 'ORDER_ALREADY_CAPTURED'
-            || empty($order['purchase_units'][0]['payments']['captures'][0]['amount']['value'])
-        ) {
-            // Get the previous order. Maybe it's the same order but will hold a bit more information.
-            $previous_order = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_LAST_ORDER);
-            if ($previous_order['id'] === $order['id']
-                && ! empty($previous_order['purchase_units'][0]['payments']['captures'][0]['amount']['value'])
-            ) {
-                // Can use the initially captured order information.
-                $order = $previous_order;
-            }
-        }
-        // Save this order details.
-        PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_LAST_ORDER, $order);
-        $nonce = wp_create_nonce(Domain::CAPTURE_ORDER_NONCE_NAME);
-        return [
-            'pp_order_nonce'  => $nonce,
-            'pp_order_id'     => $order['id'],
-            'pp_order_status' => $order['status'] ?? 'ORDER_STATUS_UNKNOWN',
-            'pp_order_amount' => $order['purchase_units'][0]['payments']['captures'][0]['amount']['value'] ?? '',
-        ];
-    }
-
-
-    /**
-     * Create an Order for this transaction.
-     *
-     * @param EE_Transaction    $transaction
-     * @param array             $billing_info
-     * @param EE_Payment_Method $paypal_pm
-     * @return CreateOrder|null
-     */
-    public static function getCreateOrderApi(
-        EE_Transaction    $transaction,
-        array             $billing_info,
-        EE_Payment_Method $paypal_pm
-    ): ?CreateOrder {
-        $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
-            return null;
-        }
-        return new CreateOrder($paypal_api, $transaction, $billing_info);
-    }
-
-
-    /**
-     * Create an Order for this transaction.
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $order_id
-     * @return CaptureOrder|null
-     */
-    public static function getCaptureOrderApi(
-        EE_Transaction    $transaction,
-        EE_Payment_Method $paypal_pm,
-        string            $order_id
-    ): ?CaptureOrder {
-        $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
-            return null;
-        }
-        return new CaptureOrder($paypal_api, $transaction, $order_id);
-    }
-
-
-    /**
-     * Return a PayPal API object, or false on failure.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return PayPalApi|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getPayPalApi(EE_Payment_Method $paypal_pm): ?PayPalApi
-    {
-        // Try getting the first party credentials to determine if this is a first party integration that's active.
-        $client_id     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_CLIENT_ID);
-        $client_secret = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_CLIENT_SECRET);
-        $bn_code       = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
-        if ($client_id && $client_secret) {
-            return new FirstPartyPayPalApi($client_id, $client_secret, $bn_code, $paypal_pm->debug_mode());
-        }
-        // Third party integration credentials:
-        $access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
-        if (! $access_token || ! $bn_code) {
-            return null;
-        }
-        $partner_client_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_CLIENT_ID) ?: '';
-        $payer_id          = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_MERCHANT_ID) ?: '';
-        return new ThirdPartyPayPalApi(
-            $access_token, $bn_code, $partner_client_id, $payer_id, $paypal_pm->debug_mode()
-        );
-    }
-
-
-    /**
-     * Requests a client token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return array
-     */
-    public static function requestClientToken(EE_Payment_Method $paypal_pm): array
-    {
-        $error      = [
-            'error' => 'GET_CLIENT_TOKEN_FAULT',
-        ];
-        $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
-            $error['message'] = esc_html__('Got an error while trying to get the client token.', 'event_espresso');
-            return $error;
-        }
-        $client_token_api = new ClientToken($paypal_api, $paypal_pm->debug_mode());
-        $client_token     = $client_token_api->getToken();
-        if (isset($client_token['error'])) {
-            return $client_token;
-        }
-        if (empty($client_token)) {
-            $error['message'] = esc_html__('Client token not valid.', 'event_espresso');
-            return $error;
-        }
-        return $client_token;
-    }
-
-
-    /**
-     * Retrieve the payment method from the provided data.
-     *
-     * @return EE_Transaction|null
-     */
-    public static function getTransaction(): ?EE_Transaction
-    {
-        try {
-            $txn_id      = EED_Module::getRequest()->getRequestParam('txn_id', 0, DataType::INT);
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($txn_id);
-            if (! $transaction instanceof EE_Transaction) {
-                PayPalLogger::errorLog(
-                    esc_html__('No transaction found by ID:', 'event_espresso'),
-                    EED_Module::getRequest()->postParams()
-                );
-                return null;
-            }
-        } catch (Exception $e) {
-            return null;
-        }
-        return $transaction;
-    }
-
-
-    /**
-     * Return a PayPal API object, or false on failure.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     */
-    public static function isThirdParty(EE_Payment_Method $paypal_pm): bool
-    {
-        $pp_meta_data = PayPalExtraMetaManager::getAllData($paypal_pm);
-        return ! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-               && ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ]);
-    }
-
-
-    /**
-     * Retrieve the payment method from the provided data.
-     *
-     * @return EE_Payment_Method|null
-     */
-    public static function getPaymentMethod(): ?EE_Payment_Method
-    {
-        try {
-            // Check if all required parameters are present.
-            $pm_slug        = EED_Module::getRequest()->getRequestParam('payment_method');
-            $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_slug);
-            if ($payment_method instanceof EE_Payment_Method) {
-                return $payment_method;
-            }
-        } catch (Exception $e) {
-            return null;
-        }
-        return null;
-    }
-
-
-    /**
-     * Log JS error.
-     *
-     * @return void
-     */
-    public static function logJsError(): void
-    {
-        // Default to the "first" PayPal checkout PM.
-        $request        = EED_Module::getRequest();
-        $pm_slug        = $request->getRequestParam('pm_slug', Domain::PM_SLUG);
-        $payment_method = null;
-        $txn_id         = 'unknown';
-        try {
-            $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pm_slug);
-            $txn_id         = sanitize_text_field($request->getRequestParam('txn_id', '-'));
-        } catch (Exception $e) {
-            // Don't throw out anything, log at least something.
-        }
-        PayPalLogger::errorLog("JS Error on transaction: {$txn_id}", $request->postParams(), $payment_method);
-    }
-
-
-    /**
-     * Filter the Payment Methods list.
-     *
-     * @param EE_Payment_Method[] $payment_methods
-     * @param EE_Transaction      $transaction
-     * @param string              $scope @see EEM_Payment_Method::get_all_for_events
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function filterPaymentMethods(
-        array          $payment_methods,
-        EE_Transaction $transaction,
-        string         $scope
-    ): array {
-        // Don't allow this PM on the checkout page if not Connected.
-        foreach ($payment_methods as $key => $pm) {
-            // It is a PayPal Commerce payment method. Check if it's connected. If not - remove from the list.
-            if (str_contains($pm->slug(), Domain::PM_SLUG) && ! EED_PayPalOnboard::isOnboard($pm)) {
-                unset($payment_methods[ $key ]);
-            }
-        }
-        return $payment_methods;
-    }
-
-
-    /**
-     *  Get all active states.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getActiveStates(): array
-    {
-        $state_options = [];
-        $states        = EEM_State::instance()->get_all_active_states();
-        if (! empty($states)) {
-            foreach ($states as $numeral => $state) {
-                if ($state instanceof EE_State) {
-                    $state_options[ $numeral ] = $state->abbrev();
-                }
-            }
-        }
-        return $state_options;
-    }
+	/**
+	 * @return EED_Module
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(): EED_Module
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * Run - initial module setup.
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * For hooking into EE Core and other modules.
+	 *
+	 * @return void
+	 */
+	public static function set_hooks(): void
+	{
+		if (DbStatus::isOnline()) {
+			// Don't load PM on the front-end if not Connected.
+			add_filter(
+				'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+				[__CLASS__, 'filterPaymentMethods'],
+				100,
+				3
+			);
+		}
+	}
+
+
+	/**
+	 * For hooking into EE Core and other modules Admin.
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin(): void
+	{
+		if (DbStatus::isOnline()) {
+			// Create an Order.
+			add_action('wp_ajax_eeaPPCCreateOrder', [__CLASS__, 'createOrderRequest']);
+			add_action('wp_ajax_nopriv_eeaPPCCreateOrder', [__CLASS__, 'createOrderRequest']);
+			// Capture the Order.
+			add_action('wp_ajax_eeaPPCCaptureOrder', [__CLASS__, 'captureOrderRequest']);
+			add_action('wp_ajax_nopriv_eeaPPCCaptureOrder', [__CLASS__, 'captureOrderRequest']);
+			// Log errors from the JS side.
+			add_action('wp_ajax_eeaPPCommerceLogError', [__CLASS__, 'logJsError']);
+			add_action('wp_ajax_nopriv_eeaPPCommerceLogError', [__CLASS__, 'logJsError']);
+			// Don't load PM in the admin if not Connected.
+			add_filter(
+				'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+				[__CLASS__, 'filterPaymentMethods'],
+				100,
+				3
+			);
+		}
+	}
+
+
+	/**
+	 * Create the order and return its data as JSON.
+	 * (AJAX)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function createOrderRequest(): void
+	{
+		$paypal_pm   = EED_PayPalCommerce::getPaymentMethod();
+		$request     = EED_Module::getRequest();
+		$post_params = $request->postParams();
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			PayPalLogger::errorLogAndExit(
+				esc_html__('Related payment method not found (create Order).', 'event_espresso'),
+				$post_params
+			);
+		}
+		$transaction  = EED_PayPalCommerce::getTransaction();
+		$billing_info = $post_params['billing_info'] ?? [];
+		if ($billing_info) {
+			$billing_info_decoded = json_decode(stripslashes($billing_info), true);
+			$billing_info         = is_array($billing_info_decoded) ? $billing_info_decoded : [];
+		}
+		if (! $transaction) {
+			PayPalLogger::errorLogAndExit(
+				esc_html__('Transaction info not found.', 'event_espresso'),
+				$post_params,
+				$paypal_pm
+			);
+		}
+		$order_data = EED_PayPalCommerce::createOrder($transaction, $billing_info, $paypal_pm);
+		wp_send_json($order_data);
+	}
+
+
+	/**
+	 * Capture the order and return status in JSON.
+	 * (AJAX)
+	 *
+	 * @return void
+	 */
+	public static function captureOrderRequest(): void
+	{
+		$error_message = false;
+		$paypal_pm     = EED_PayPalCommerce::getPaymentMethod();
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			$error_message = esc_html__('Payment method not found (capture Order).', 'event_espresso');
+		}
+		$transaction = EED_PayPalCommerce::getTransaction();
+		if (! $transaction) {
+			$error_message = esc_html__('Transaction not found.', 'event_espresso');
+		}
+		$order_id = EED_Module::getRequest()->getRequestParam('order_id', '', DataType::STRING);
+		if (! $order_id) {
+			$error_message = esc_html__('Order ID missing.', 'event_espresso');
+		}
+		// We had an error. Log and EXIT.
+		if ($error_message) {
+			PayPalLogger::errorLogAndExit($error_message, EED_Module::getRequest()->postParams(), $paypal_pm);
+		}
+		$capture_response = EED_PayPalCommerce::captureOrder($transaction, $paypal_pm, $order_id);
+		wp_send_json($capture_response);
+	}
+
+
+	/**
+	 * Create a new Order using the PP API.
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param array             $billing_info
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function createOrder(
+		EE_Transaction    $transaction,
+		array             $billing_info,
+		EE_Payment_Method $paypal_pm
+	): array {
+		$create_order_api = EED_PayPalCommerce::getCreateOrderApi($transaction, $billing_info, $paypal_pm);
+		if (! $create_order_api instanceof CreateOrder) {
+			return [
+				'error'   => 'CREATE_ORDER_API_FAULT',
+				'message' => esc_html__('The Create Order API request fault.', 'event_espresso'),
+			];
+		}
+		$order = $create_order_api->create();
+		if (isset($order['error'])) {
+			return [
+				'error'   => 'CREATE_ORDER_API_RESPONSE_ERROR',
+				'message' => $order['message'],
+			];
+		}
+		return [
+			'pp_order_id' => $order['id'],
+		];
+	}
+
+
+	/**
+	 * Create a new Order using the PP API.
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $order_id
+	 * @return array
+	 */
+	public static function captureOrder(
+		EE_Transaction    $transaction,
+		EE_Payment_Method $paypal_pm,
+		string            $order_id
+	): array {
+		$capture_order_api = EED_PayPalCommerce::getCaptureOrderApi($transaction, $paypal_pm, $order_id);
+		if (! $capture_order_api instanceof CaptureOrder) {
+			return [
+				'error'   => 'CAPTURE_ORDER_API_FAULT',
+				'message' => esc_html__('A capture Order API request fault.', 'event_espresso'),
+			];
+		}
+		$order = $capture_order_api->capture();
+		if (isset($order['error'])) {
+			return $order;
+		}
+		// Attach the transaction ID to this order.
+		try {
+			$order['ee_txn_id'] = $transaction->ID();
+		} catch (Exception $e) {
+			// Just don't set the txn id.
+		}
+		// If this was a capture request on an already Captured order, try using the initial capture data (if any saved)
+		// that has more information on the order than this retry capture response.
+		if ($order['status'] === 'ORDER_ALREADY_CAPTURED'
+			|| empty($order['purchase_units'][0]['payments']['captures'][0]['amount']['value'])
+		) {
+			// Get the previous order. Maybe it's the same order but will hold a bit more information.
+			$previous_order = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_LAST_ORDER);
+			if ($previous_order['id'] === $order['id']
+				&& ! empty($previous_order['purchase_units'][0]['payments']['captures'][0]['amount']['value'])
+			) {
+				// Can use the initially captured order information.
+				$order = $previous_order;
+			}
+		}
+		// Save this order details.
+		PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_LAST_ORDER, $order);
+		$nonce = wp_create_nonce(Domain::CAPTURE_ORDER_NONCE_NAME);
+		return [
+			'pp_order_nonce'  => $nonce,
+			'pp_order_id'     => $order['id'],
+			'pp_order_status' => $order['status'] ?? 'ORDER_STATUS_UNKNOWN',
+			'pp_order_amount' => $order['purchase_units'][0]['payments']['captures'][0]['amount']['value'] ?? '',
+		];
+	}
+
+
+	/**
+	 * Create an Order for this transaction.
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param array             $billing_info
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return CreateOrder|null
+	 */
+	public static function getCreateOrderApi(
+		EE_Transaction    $transaction,
+		array             $billing_info,
+		EE_Payment_Method $paypal_pm
+	): ?CreateOrder {
+		$paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
+		if (! $paypal_api instanceof PayPalApi) {
+			return null;
+		}
+		return new CreateOrder($paypal_api, $transaction, $billing_info);
+	}
+
+
+	/**
+	 * Create an Order for this transaction.
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $order_id
+	 * @return CaptureOrder|null
+	 */
+	public static function getCaptureOrderApi(
+		EE_Transaction    $transaction,
+		EE_Payment_Method $paypal_pm,
+		string            $order_id
+	): ?CaptureOrder {
+		$paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
+		if (! $paypal_api instanceof PayPalApi) {
+			return null;
+		}
+		return new CaptureOrder($paypal_api, $transaction, $order_id);
+	}
+
+
+	/**
+	 * Return a PayPal API object, or false on failure.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return PayPalApi|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getPayPalApi(EE_Payment_Method $paypal_pm): ?PayPalApi
+	{
+		// Try getting the first party credentials to determine if this is a first party integration that's active.
+		$client_id     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_CLIENT_ID);
+		$client_secret = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_CLIENT_SECRET);
+		$bn_code       = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
+		if ($client_id && $client_secret) {
+			return new FirstPartyPayPalApi($client_id, $client_secret, $bn_code, $paypal_pm->debug_mode());
+		}
+		// Third party integration credentials:
+		$access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
+		if (! $access_token || ! $bn_code) {
+			return null;
+		}
+		$partner_client_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_CLIENT_ID) ?: '';
+		$payer_id          = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_MERCHANT_ID) ?: '';
+		return new ThirdPartyPayPalApi(
+			$access_token, $bn_code, $partner_client_id, $payer_id, $paypal_pm->debug_mode()
+		);
+	}
+
+
+	/**
+	 * Requests a client token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return array
+	 */
+	public static function requestClientToken(EE_Payment_Method $paypal_pm): array
+	{
+		$error      = [
+			'error' => 'GET_CLIENT_TOKEN_FAULT',
+		];
+		$paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
+		if (! $paypal_api instanceof PayPalApi) {
+			$error['message'] = esc_html__('Got an error while trying to get the client token.', 'event_espresso');
+			return $error;
+		}
+		$client_token_api = new ClientToken($paypal_api, $paypal_pm->debug_mode());
+		$client_token     = $client_token_api->getToken();
+		if (isset($client_token['error'])) {
+			return $client_token;
+		}
+		if (empty($client_token)) {
+			$error['message'] = esc_html__('Client token not valid.', 'event_espresso');
+			return $error;
+		}
+		return $client_token;
+	}
+
+
+	/**
+	 * Retrieve the payment method from the provided data.
+	 *
+	 * @return EE_Transaction|null
+	 */
+	public static function getTransaction(): ?EE_Transaction
+	{
+		try {
+			$txn_id      = EED_Module::getRequest()->getRequestParam('txn_id', 0, DataType::INT);
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($txn_id);
+			if (! $transaction instanceof EE_Transaction) {
+				PayPalLogger::errorLog(
+					esc_html__('No transaction found by ID:', 'event_espresso'),
+					EED_Module::getRequest()->postParams()
+				);
+				return null;
+			}
+		} catch (Exception $e) {
+			return null;
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 * Return a PayPal API object, or false on failure.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 */
+	public static function isThirdParty(EE_Payment_Method $paypal_pm): bool
+	{
+		$pp_meta_data = PayPalExtraMetaManager::getAllData($paypal_pm);
+		return ! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
+			   && ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ]);
+	}
+
+
+	/**
+	 * Retrieve the payment method from the provided data.
+	 *
+	 * @return EE_Payment_Method|null
+	 */
+	public static function getPaymentMethod(): ?EE_Payment_Method
+	{
+		try {
+			// Check if all required parameters are present.
+			$pm_slug        = EED_Module::getRequest()->getRequestParam('payment_method');
+			$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_slug);
+			if ($payment_method instanceof EE_Payment_Method) {
+				return $payment_method;
+			}
+		} catch (Exception $e) {
+			return null;
+		}
+		return null;
+	}
+
+
+	/**
+	 * Log JS error.
+	 *
+	 * @return void
+	 */
+	public static function logJsError(): void
+	{
+		// Default to the "first" PayPal checkout PM.
+		$request        = EED_Module::getRequest();
+		$pm_slug        = $request->getRequestParam('pm_slug', Domain::PM_SLUG);
+		$payment_method = null;
+		$txn_id         = 'unknown';
+		try {
+			$payment_method = EEM_Payment_Method::instance()->get_one_of_type($pm_slug);
+			$txn_id         = sanitize_text_field($request->getRequestParam('txn_id', '-'));
+		} catch (Exception $e) {
+			// Don't throw out anything, log at least something.
+		}
+		PayPalLogger::errorLog("JS Error on transaction: {$txn_id}", $request->postParams(), $payment_method);
+	}
+
+
+	/**
+	 * Filter the Payment Methods list.
+	 *
+	 * @param EE_Payment_Method[] $payment_methods
+	 * @param EE_Transaction      $transaction
+	 * @param string              $scope @see EEM_Payment_Method::get_all_for_events
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function filterPaymentMethods(
+		array          $payment_methods,
+		EE_Transaction $transaction,
+		string         $scope
+	): array {
+		// Don't allow this PM on the checkout page if not Connected.
+		foreach ($payment_methods as $key => $pm) {
+			// It is a PayPal Commerce payment method. Check if it's connected. If not - remove from the list.
+			if (str_contains($pm->slug(), Domain::PM_SLUG) && ! EED_PayPalOnboard::isOnboard($pm)) {
+				unset($payment_methods[ $key ]);
+			}
+		}
+		return $payment_methods;
+	}
+
+
+	/**
+	 *  Get all active states.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getActiveStates(): array
+	{
+		$state_options = [];
+		$states        = EEM_State::instance()->get_all_active_states();
+		if (! empty($states)) {
+			foreach ($states as $numeral => $state) {
+				if ($state instanceof EE_State) {
+					$state_options[ $numeral ] = $state->abbrev();
+				}
+			}
+		}
+		return $state_options;
+	}
 }

Spacing +17 added lines, -17 removed lines

@@ -103,7 +103,7 @@ 
         $paypal_pm   = EED_PayPalCommerce::getPaymentMethod();
         $request     = EED_Module::getRequest();
         $post_params = $request->postParams();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
+        if ( ! $paypal_pm instanceof EE_Payment_Method) {
             PayPalLogger::errorLogAndExit(
                 esc_html__('Related payment method not found (create Order).', 'event_espresso'),
                 $post_params
@@ -115,7 +115,7 @@ 
             $billing_info_decoded = json_decode(stripslashes($billing_info), true);
             $billing_info         = is_array($billing_info_decoded) ? $billing_info_decoded : [];
         }
-        if (! $transaction) {
+        if ( ! $transaction) {
             PayPalLogger::errorLogAndExit(
                 esc_html__('Transaction info not found.', 'event_espresso'),
                 $post_params,
@@ -137,15 +137,15 @@ 
     {
         $error_message = false;
         $paypal_pm     = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
+        if ( ! $paypal_pm instanceof EE_Payment_Method) {
             $error_message = esc_html__('Payment method not found (capture Order).', 'event_espresso');
         }
         $transaction = EED_PayPalCommerce::getTransaction();
-        if (! $transaction) {
+        if ( ! $transaction) {
             $error_message = esc_html__('Transaction not found.', 'event_espresso');
         }
         $order_id = EED_Module::getRequest()->getRequestParam('order_id', '', DataType::STRING);
-        if (! $order_id) {
+        if ( ! $order_id) {
             $error_message = esc_html__('Order ID missing.', 'event_espresso');
         }
         // We had an error. Log and EXIT.
@@ -173,7 +173,7 @@ 
         EE_Payment_Method $paypal_pm
     ): array {
         $create_order_api = EED_PayPalCommerce::getCreateOrderApi($transaction, $billing_info, $paypal_pm);
-        if (! $create_order_api instanceof CreateOrder) {
+        if ( ! $create_order_api instanceof CreateOrder) {
             return [
                 'error'   => 'CREATE_ORDER_API_FAULT',
                 'message' => esc_html__('The Create Order API request fault.', 'event_espresso'),
@@ -206,7 +206,7 @@ 
         string            $order_id
     ): array {
         $capture_order_api = EED_PayPalCommerce::getCaptureOrderApi($transaction, $paypal_pm, $order_id);
-        if (! $capture_order_api instanceof CaptureOrder) {
+        if ( ! $capture_order_api instanceof CaptureOrder) {
             return [
                 'error'   => 'CAPTURE_ORDER_API_FAULT',
                 'message' => esc_html__('A capture Order API request fault.', 'event_espresso'),
@@ -262,7 +262,7 @@ 
         EE_Payment_Method $paypal_pm
     ): ?CreateOrder {
         $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
+        if ( ! $paypal_api instanceof PayPalApi) {
             return null;
         }
         return new CreateOrder($paypal_api, $transaction, $billing_info);
@@ -283,7 +283,7 @@ 
         string            $order_id
     ): ?CaptureOrder {
         $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
+        if ( ! $paypal_api instanceof PayPalApi) {
             return null;
         }
         return new CaptureOrder($paypal_api, $transaction, $order_id);
@@ -309,7 +309,7 @@ 
         }
         // Third party integration credentials:
         $access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
-        if (! $access_token || ! $bn_code) {
+        if ( ! $access_token || ! $bn_code) {
             return null;
         }
         $partner_client_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_CLIENT_ID) ?: '';
@@ -332,7 +332,7 @@ 
             'error' => 'GET_CLIENT_TOKEN_FAULT',
         ];
         $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
+        if ( ! $paypal_api instanceof PayPalApi) {
             $error['message'] = esc_html__('Got an error while trying to get the client token.', 'event_espresso');
             return $error;
         }
@@ -359,7 +359,7 @@ 
         try {
             $txn_id      = EED_Module::getRequest()->getRequestParam('txn_id', 0, DataType::INT);
             $transaction = EEM_Transaction::instance()->get_one_by_ID($txn_id);
-            if (! $transaction instanceof EE_Transaction) {
+            if ( ! $transaction instanceof EE_Transaction) {
                 PayPalLogger::errorLog(
                     esc_html__('No transaction found by ID:', 'event_espresso'),
                     EED_Module::getRequest()->postParams()
@@ -382,8 +382,8 @@ 
     public static function isThirdParty(EE_Payment_Method $paypal_pm): bool
     {
         $pp_meta_data = PayPalExtraMetaManager::getAllData($paypal_pm);
-        return ! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-               && ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ]);
+        return ! empty($pp_meta_data[Domain::META_KEY_SELLER_MERCHANT_ID])
+               && ! empty($pp_meta_data[Domain::META_KEY_ACCESS_TOKEN]);
     }
 
 
@@ -449,7 +449,7 @@ 
         foreach ($payment_methods as $key => $pm) {
             // It is a PayPal Commerce payment method. Check if it's connected. If not - remove from the list.
             if (str_contains($pm->slug(), Domain::PM_SLUG) && ! EED_PayPalOnboard::isOnboard($pm)) {
-                unset($payment_methods[ $key ]);
+                unset($payment_methods[$key]);
             }
         }
         return $payment_methods;
@@ -467,10 +467,10 @@ 
     {
         $state_options = [];
         $states        = EEM_State::instance()->get_all_active_states();
-        if (! empty($states)) {
+        if ( ! empty($states)) {
             foreach ($states as $numeral => $state) {
                 if ($state instanceof EE_State) {
-                    $state_options[ $numeral ] = $state->abbrev();
+                    $state_options[$numeral] = $state->abbrev();
                 }
             }
         }

PaymentMethods/PayPalCommerce/modules/EED_PayPalOnboard.module.php

Indentation +656 added lines, -656 removed lines

@@ -20,660 +20,660 @@
  */
 class EED_PayPalOnboard extends EED_Module
 {
-    /**
-     * @return EED_Module
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(): EED_Module
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * Run - initial module setup.
-     *
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * For hooking into EE Admin Core and other modules.
-     *
-     * @return void
-     */
-    public static function set_hooks_admin(): void
-    {
-        if (DbStatus::isOnline()) {
-            // Get onboarding URL.
-            add_action('wp_ajax_eeaPpGetOnboardingUrl', [__CLASS__, 'getOnboardingUrl']);
-            // Catch the return/redirect from PayPal onboarding page.
-            add_action('init', [__CLASS__, 'updateOnboardingStatus'], 10);
-            // Return the connection/onboard status.
-            add_action('wp_ajax_eeaPpGetOnboardStatus', [__CLASS__, 'getOnboardStatus']);
-            // Revoke access.
-            add_action('wp_ajax_eeaPpOffboard', [__CLASS__, 'offboard']);
-            // Admin notice.
-            add_action('admin_init', [__CLASS__, 'adminNotice']);
-        }
-    }
-
-
-    /**
-     * Get the onboarding URL.
-     * (AJAX)
-     *
-     * @return void
-     */
-    public static function getOnboardingUrl(): void
-    {
-        $signup_link = '';
-        try {
-            $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-            if (! $paypal_pm instanceof EE_Payment_Method) {
-                PayPalLogger::errorLogAndExit(
-                    esc_html__('No payment method.', 'event_espresso'),
-                    EED_Module::getRequest()->postParams(),
-                    $paypal_pm
-                );
-            }
-            PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
-            // $signup_link   = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
-            // $token_expired = EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm);
-            // if (! $signup_link || $token_expired) {
-            $signup_link = EED_PayPalOnboard::requestOnboardingUrl($paypal_pm);
-            // }
-            if (! $signup_link) {
-                $err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
-                PayPalLogger::errorLogAndExit($err_msg, ['signup_link' => $signup_link], $paypal_pm);
-            }
-            PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL, $signup_link);
-        } catch (Exception $exception) {
-            PayPalLogger::errorLogAndExit($exception->getMessage());
-        }
-        // Is it empty (can happen if we didn't get the URL through the API).
-        $signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
-        wp_send_json(
-            [
-                'signup_link' => $signup_link,
-            ]
-        );
-    }
-
-
-    /**
-     * Request the sign-up link from PayPal.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param bool              $one_time_request
-     * @return string
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public static function requestOnboardingUrl(EE_Payment_Method $paypal_pm, bool $one_time_request = false): string
-    {
-        $signup_link = '';
-        // Get the access token.
-        $access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
-        if (! $access_token) {
-            $err_msg = esc_html__('Error! No access token.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
-            return '';
-        }
-        // Request the access token.
-        $body_params = EED_PayPalOnboard::signupLinkRequestBody($paypal_pm);
-        $bn_code     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
-        $post_params = [
-            'method'  => 'POST',
-            'headers' => [
-                'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
-                'Content-Type'                  => 'application/json',
-                'Authorization'                 => 'Bearer ' . $access_token,
-                'PayPal-Partner-Attribution-Id' => $bn_code,
-            ],
-            'body'    => $body_params,
-        ];
-        $request_url = Domain::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
-        $response    = EED_PayPalOnboard::sendRequest($paypal_pm, $request_url, $post_params);
-        // Check the data we received.
-        if (isset($response['error']) || empty($response['links'])) {
-            // Did the original access token get replaced by any chance ?
-            if (! $one_time_request
-                && ! empty($response['message'])
-                && $response['message'] === 'Access Token not found in cache'
-            ) {
-                // Clear all PM metadata and try getting the access token One more time.
-                PayPalExtraMetaManager::deleteAllData($paypal_pm);
-                return EED_PayPalOnboard::requestOnboardingUrl($paypal_pm, true);
-            }
-            $err_msg = esc_html__('Incoming sign-up link parameter validation failed.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, $response, $paypal_pm);
-            return '';
-        }
-        // Now retrieve that sign-up link.
-        foreach ($response['links'] as $link) {
-            if ($link['rel'] === 'action_url') {
-                $signup_link = $link['href'] ?? '';
-            }
-        }
-        return $signup_link;
-    }
-
-
-    /**
-     * Get the return URL.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws Exception
-     */
-    public static function signupLinkRequestBody(EE_Payment_Method $paypal_pm): string
-    {
-        $identifier_string = new OneTimeString($paypal_pm->debug_mode());
-        $tracking_id       = $identifier_string->value();
-        $request           = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $checkout_type     = $request->getRequestParam('checkout_type', 'EXPRESS_CHECKOUT', DataType::STRING);
-        // Save the identifier for future use.
-        PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_TRACKING_ID, $tracking_id);
-        // Assemble the return URL.
-        $return_url = EED_PayPalOnboard::getReturnUrl($paypal_pm);
-        return json_encode([
-            'tracking_id'             => $tracking_id,
-            'operations'              => [
-                [
-                    'operation'                  => 'API_INTEGRATION',
-                    'api_integration_preference' => [
-                        'rest_api_integration' => [
-                            'integration_method'  => 'PAYPAL',
-                            'integration_type'    => 'THIRD_PARTY',
-                            'third_party_details' => [
-                                'features' => ['PAYMENT', 'REFUND'],
-                            ],
-                        ],
-                    ],
-                ],
-            ],
-            'products'                => [$checkout_type],
-            'legal_consents'          => [
-                [
-                    'type'    => 'SHARE_DATA_CONSENT',
-                    'granted' => true,
-                ],
-            ],
-            'partner_config_override' => [
-                'return_url' => $return_url,
-            ],
-        ]);
-    }
-
-
-    /**
-     * Get the return URL.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getReturnUrl(EE_Payment_Method $paypal_pm): string
-    {
-        $wp_nonce = EED_Module::getRequest()->getRequestParam('wp_nonce');
-        $nonce    = wp_create_nonce(Domain::NONCE_NAME_ONBOARDING_RETURN);
-        return add_query_arg(
-            [
-                'page'                        => 'espresso_payment_settings',
-                'webhook_action'              => 'eepPpcMerchantOnboard',
-                'payment_method'              => $paypal_pm->slug(),
-                '_wpnonce'                    => $wp_nonce,
-                'nonce'                       => $nonce,
-                Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Redirect to the payment method (PP) settings home page.
-     *
-     * @return void
-     */
-    public static function redirectToPmSettingsHome(): void
-    {
-        $get_params = EED_Module::getRequest()->getParams();
-        if (empty($get_params['payment_method'])) {
-            // Simply do not redirect.
-            return;
-        }
-        $args_to_add = [
-            'page'           => 'espresso_payment_settings',
-            'payment_method' => $get_params['payment_method'],
-        ];
-        if (isset($get_params['sandbox_mode'])) {
-            $args_to_add[ Domain::META_KEY_SANDBOX_MODE ] = $get_params['sandbox_mode'];
-        }
-        $home_url = add_query_arg($args_to_add, admin_url('admin.php'));
-        wp_redirect($home_url);
-        exit;
-    }
-
-
-    /**
-     * Check user’s onboarding status.
-     * This will handle the user return from the auth page and also check the status via the API.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function updateOnboardingStatus(): void
-    {
-        // Check if this is the webhook from PayPal.
-        if (! isset($_GET['webhook_action'], $_GET['nonce'])
-            || $_GET['webhook_action'] !== 'eepPpcMerchantOnboard'
-        ) {
-            return;  // Ignore.
-        }
-        $get_params = EED_Module::getRequest()->getParams();
-        // Get the payment method.
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        // Check the response (GET) parameters.
-        if (! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
-            // Missing parameters. Can't proceed.
-            PayPalLogger::errorLog(
-                esc_html__('Missing required onboarding parameters.', 'event_espresso'),
-                $get_params,
-                $paypal_pm
-            );
-            EED_PayPalOnboard::redirectToPmSettingsHome();
-            return;
-        }
-        // Check on the onboarding status (recommended by PP).
-        $onboarding_status = EED_PayPalOnboard::trackSellerOnboarding(
-            $paypal_pm,
-            $get_params[ Domain::META_KEY_SELLER_MERCHANT_ID ]
-        );
-        if (! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
-            PayPalLogger::errorLog(
-                $onboarding_status['message'],
-                array_merge($get_params, $onboarding_status),
-                $paypal_pm
-            );
-            EED_PayPalOnboard::redirectToPmSettingsHome();
-            return;
-        }
-        // Start saving the setup and info.
-        PayPalExtraMetaManager::parseAndSaveOptions($paypal_pm, $onboarding_status);
-        // Save the credentials.
-        PayPalExtraMetaManager::saveSellerApiCredentials($paypal_pm, $get_params);
-        // If onboarded successfully, remove the onboarding URL.
-        PayPalExtraMetaManager::deletePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
-        // Also clen GET params by redirecting, because PP auto redirects to the return_url on closing the onboarding window.
-        EED_PayPalOnboard::redirectToPmSettingsHome();
-    }
-
-
-    /**
-     * Check if all required parameters for the onboarding status check are present.
-     *
-     * @param array $data
-     * @param mixed $paypal_pm
-     * @return bool
-     */
-    public static function onboardingStatusResponseValid(array $data, $paypal_pm): bool
-    {
-        // Check that we have all the required parameters and the nonce is ok.
-        if ($paypal_pm instanceof EE_Payment_Method
-            && wp_verify_nonce($data['nonce'], Domain::NONCE_NAME_ONBOARDING_RETURN)
-            && ! empty($data[ Domain::API_PARAM_PARTNER_ID ])
-            && ! empty($data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-            && isset($data[ Domain::API_PARAM_EMAIL_CONFIRMED ])
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Get partner access token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getPartnerAccessToken(EE_Payment_Method $paypal_pm): string
-    {
-        // Do we have it saved ?
-        $access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
-        $expired      = EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm);
-        // If we don't have it, request/update it.
-        if (! $access_token || $expired) {
-            return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
-        }
-        // Access token is saved as encrypted, so return decrypted.
-        return $access_token;
-    }
-
-
-    /**
-     * Get partner access token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     */
-    public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
-    {
-        $expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_EXPIRES_IN);
-        if (! $expires_at) {
-            return true;
-        }
-        // Validate the token expiration date.
-        $now          = time();
-        $minutes_left = round(($expires_at - $now) / 60);
-        // Count as expired if less than 60 minutes till expiration left.
-        if ($minutes_left <= 60) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Request the partner access token from PayPal and save/update it.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function requestPartnerAccessToken(EE_Payment_Method $paypal_pm): string
-    {
-        $nonce = wp_create_nonce('eea_pp_commerce_get_access_token');
-        // Request the access token.
-        $post_args = [
-            'method' => 'POST',
-            'body'   => [
-                'nonce'                       => $nonce,
-                'api_version'                 => 'v1',
-                Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
-            ],
-        ];
-        if (defined('LOCAL_MIDDLEMAN_SERVER')) {
-            $post_args['sslverify'] = false;
-        }
-        $post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
-        $response = EED_PayPalOnboard::sendRequest($paypal_pm, $post_url, $post_args);
-        if (isset($response['error'])) {
-            return '';
-        }
-        // Check the data we received.
-        if (! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
-            return '';
-        }
-        // If we are here all seems to be ok. Save the token and it's data.
-        $saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
-        if (! $saved) {
-            return '';
-        }
-        return $response['access_token'];
-    }
-
-
-    /**
-     * Request seller onboarding status from PayPal.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $merchant_id
-     * @return array
-     */
-    public static function trackSellerOnboarding(EE_Payment_Method $paypal_pm, string $merchant_id): array
-    {
-        $track_onboarding = EED_PayPalOnboard::getTrackOnboardingApi($paypal_pm, $merchant_id);
-        if (! $track_onboarding instanceof TrackSellerOnboarding) {
-            $err_msg = esc_html__('Failed to track seller onboarding.', 'event_espresso');
-            return ['error' => 'TRACK_ONBOARDING_FAILED', 'message' => $err_msg];
-        }
-        return $track_onboarding->isValid();
-    }
-
-
-    /**
-     * Returns the Track Seller Onboarding API.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $merchant_id
-     * @return TrackSellerOnboarding|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getTrackOnboardingApi(
-        EE_Payment_Method $paypal_pm,
-        string            $merchant_id
-    ): ?TrackSellerOnboarding {
-        $partner_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
-        $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi || ! $partner_id) {
-            return null;
-        }
-        return new TrackSellerOnboarding($paypal_api, $partner_id, $merchant_id, $paypal_pm->debug_mode());
-    }
-
-
-    /**
-     * Check the onboard status and return the result.
-     * (AJAX)
-     *
-     * @return void
-     */
-    public static function getOnboardStatus(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            $err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
-            wp_send_json(['on_board' => false]);
-        }
-        try {
-            $seller_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_MERCHANT_ID) ?? '--';
-        } catch (Exception $e) {
-            $seller_id = '--';
-        }
-        wp_send_json(
-            [
-                'on_board'  => EED_PayPalOnboard::isOnboard($paypal_pm),
-                'seller_id' => $seller_id,
-            ]
-        );
-    }
-
-
-    /**
-     * De-authorize the seller. Remove all API credentials.
-     * (AJAX)
-     *
-     * @return void
-     */
-    public static function offboard(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            wp_send_json([
-                'error'   => 'INVALID_PM',
-                'message' => esc_html__(
-                    'Invalid payment method. Please refresh the page and try again.',
-                    'event_espresso'
-                ),
-            ]);
-        }
-        PayPalExtraMetaManager::deleteAllData($paypal_pm);
-        wp_send_json(['success' => true]);
-    }
-
-
-    /**
-     * Checks if already onboard.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return boolean
-     */
-    public static function isOnboard(EE_Payment_Method $payment_method): bool
-    {
-        $pp_meta_data = PayPalExtraMetaManager::getAllData($payment_method);
-        return
-            // onborded with a third party integration ?
-            (! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ])
-            )
-            // or with the first party integration ?
-            || (! empty($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_PAYER_ID ])
-            );
-    }
-
-
-    /**
-     * Send a request and return a decoded response body.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $request_url
-     * @param array             $request_args
-     * @return array
-     */
-    public static function sendRequest(EE_Payment_Method $paypal_pm, string $request_url, array $request_args): array
-    {
-        $error_return = ['error' => true];
-        $response     = wp_remote_request($request_url, $request_args);
-        if (is_wp_error($response)) {
-            $message = $response->get_error_message();
-            PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
-            $error_return['message'] = $message;
-            return $error_return;
-        }
-        $response_body = (isset($response['body']) && $response['body']) ? json_decode($response['body'], true) : [];
-        if (empty($response_body) || isset($response_body['error'])) {
-            $message = $response_body['error_description']
-                       ?? sprintf(
-                           esc_html__('Unknown response received while sending a request to: %1$s', 'event_espresso'),
-                           $request_url
-                       );
-            PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
-            $error_return['message'] = $message;
-            return $error_return;
-        }
-        return $response_body;
-    }
-
-
-    /**
-     * Check the response for a partner token request.
-     *
-     * @param                   $response
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     */
-    public static function partnerTokenResponseValid($response, EE_Payment_Method $paypal_pm): bool
-    {
-        // Check the data we received.
-        if (
-            empty($response['nonce'])
-            || ! wp_verify_nonce($response['nonce'], 'eea_pp_commerce_get_access_token')
-            || empty($response['access_token'])
-            || empty($response['app_id'])
-            || empty($response['expires_in'])
-            || empty($response['partner_client_id'])
-            || empty($response['partner_merchant_id'])
-        ) {
-            // This is an error.
-            $err_msg = esc_html__('Incoming parameter validation failed.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, (array) $response, $paypal_pm);
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Returns the base URL to the middleman server.
-     * If LOCAL_MIDDLEMAN_SERVER is defined, requests will be sent to connect.eventespresso.test
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getMiddlemanBaseUrl(EE_Payment_Method $payment_method): string
-    {
-        $target = defined('LOCAL_MIDDLEMAN_SERVER') ? 'test' : 'com';
-        // If this PM is used under different provider accounts, you might need an account indicator.
-        $account = defined('EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR') ? EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR : '';
-        $postfix = $payment_method->debug_mode() ? '_sandbox' : '';
-        $path    = 'paypal_commerce' . $account . $postfix;
-        return 'https://connect.eventespresso.' . $target . '/' . $path . '/';
-    }
-
-
-    /**
-     * This Payment Method admin notices.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function adminNotice()
-    {
-        // Show the notice if PayPal Commerce PM is active but merchant is not onboard.
-        $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
-        if ($pp_commerce instanceof EE_Payment_Method
-            && $pp_commerce->active()
-            && ! EED_PayPalOnboard::isOnboard($pp_commerce)
-        ) {
-            add_action('admin_notices', [__CLASS__, 'notOnboardNotice']);
-        }
-    }
-
-
-    /**
-     * Contents of the not onboard admin notice.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function notOnboardNotice()
-    {
-        $open_anchor = $close_anchor = '';
-        $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
-        if ($pp_commerce instanceof EE_Payment_Method) {
-            $pm_page = add_query_arg(
-                [
-                    'page'           => 'espresso_payment_settings',
-                    'webhook_action' => 'eepPpcMerchantOnboard',
-                    'payment_method' => $pp_commerce->slug(),
-                ],
-                admin_url('admin.php')
-            );
-            $open_anchor  = "<a href='$pm_page'>";
-            $close_anchor = "</a>";
-        }
-        echo '<div class="error"><p>'
-        . sprintf(
-            esc_html__(
-                '%1$sPayPal Commerce%2$s payment method was activated but is not connected to PayPal. Please %3$sfinish setting up%4$s this payment method.',
-                'event_espresso'
-            ),
-            '<strong>',
-            '</strong>',
-            $open_anchor,
-            $close_anchor
-        )
-        . '</p></div>';
-    }
+	/**
+	 * @return EED_Module
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(): EED_Module
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * Run - initial module setup.
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * For hooking into EE Admin Core and other modules.
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin(): void
+	{
+		if (DbStatus::isOnline()) {
+			// Get onboarding URL.
+			add_action('wp_ajax_eeaPpGetOnboardingUrl', [__CLASS__, 'getOnboardingUrl']);
+			// Catch the return/redirect from PayPal onboarding page.
+			add_action('init', [__CLASS__, 'updateOnboardingStatus'], 10);
+			// Return the connection/onboard status.
+			add_action('wp_ajax_eeaPpGetOnboardStatus', [__CLASS__, 'getOnboardStatus']);
+			// Revoke access.
+			add_action('wp_ajax_eeaPpOffboard', [__CLASS__, 'offboard']);
+			// Admin notice.
+			add_action('admin_init', [__CLASS__, 'adminNotice']);
+		}
+	}
+
+
+	/**
+	 * Get the onboarding URL.
+	 * (AJAX)
+	 *
+	 * @return void
+	 */
+	public static function getOnboardingUrl(): void
+	{
+		$signup_link = '';
+		try {
+			$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+			if (! $paypal_pm instanceof EE_Payment_Method) {
+				PayPalLogger::errorLogAndExit(
+					esc_html__('No payment method.', 'event_espresso'),
+					EED_Module::getRequest()->postParams(),
+					$paypal_pm
+				);
+			}
+			PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
+			// $signup_link   = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
+			// $token_expired = EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm);
+			// if (! $signup_link || $token_expired) {
+			$signup_link = EED_PayPalOnboard::requestOnboardingUrl($paypal_pm);
+			// }
+			if (! $signup_link) {
+				$err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
+				PayPalLogger::errorLogAndExit($err_msg, ['signup_link' => $signup_link], $paypal_pm);
+			}
+			PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL, $signup_link);
+		} catch (Exception $exception) {
+			PayPalLogger::errorLogAndExit($exception->getMessage());
+		}
+		// Is it empty (can happen if we didn't get the URL through the API).
+		$signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
+		wp_send_json(
+			[
+				'signup_link' => $signup_link,
+			]
+		);
+	}
+
+
+	/**
+	 * Request the sign-up link from PayPal.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param bool              $one_time_request
+	 * @return string
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public static function requestOnboardingUrl(EE_Payment_Method $paypal_pm, bool $one_time_request = false): string
+	{
+		$signup_link = '';
+		// Get the access token.
+		$access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
+		if (! $access_token) {
+			$err_msg = esc_html__('Error! No access token.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
+			return '';
+		}
+		// Request the access token.
+		$body_params = EED_PayPalOnboard::signupLinkRequestBody($paypal_pm);
+		$bn_code     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
+		$post_params = [
+			'method'  => 'POST',
+			'headers' => [
+				'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
+				'Content-Type'                  => 'application/json',
+				'Authorization'                 => 'Bearer ' . $access_token,
+				'PayPal-Partner-Attribution-Id' => $bn_code,
+			],
+			'body'    => $body_params,
+		];
+		$request_url = Domain::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
+		$response    = EED_PayPalOnboard::sendRequest($paypal_pm, $request_url, $post_params);
+		// Check the data we received.
+		if (isset($response['error']) || empty($response['links'])) {
+			// Did the original access token get replaced by any chance ?
+			if (! $one_time_request
+				&& ! empty($response['message'])
+				&& $response['message'] === 'Access Token not found in cache'
+			) {
+				// Clear all PM metadata and try getting the access token One more time.
+				PayPalExtraMetaManager::deleteAllData($paypal_pm);
+				return EED_PayPalOnboard::requestOnboardingUrl($paypal_pm, true);
+			}
+			$err_msg = esc_html__('Incoming sign-up link parameter validation failed.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, $response, $paypal_pm);
+			return '';
+		}
+		// Now retrieve that sign-up link.
+		foreach ($response['links'] as $link) {
+			if ($link['rel'] === 'action_url') {
+				$signup_link = $link['href'] ?? '';
+			}
+		}
+		return $signup_link;
+	}
+
+
+	/**
+	 * Get the return URL.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws Exception
+	 */
+	public static function signupLinkRequestBody(EE_Payment_Method $paypal_pm): string
+	{
+		$identifier_string = new OneTimeString($paypal_pm->debug_mode());
+		$tracking_id       = $identifier_string->value();
+		$request           = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$checkout_type     = $request->getRequestParam('checkout_type', 'EXPRESS_CHECKOUT', DataType::STRING);
+		// Save the identifier for future use.
+		PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_TRACKING_ID, $tracking_id);
+		// Assemble the return URL.
+		$return_url = EED_PayPalOnboard::getReturnUrl($paypal_pm);
+		return json_encode([
+			'tracking_id'             => $tracking_id,
+			'operations'              => [
+				[
+					'operation'                  => 'API_INTEGRATION',
+					'api_integration_preference' => [
+						'rest_api_integration' => [
+							'integration_method'  => 'PAYPAL',
+							'integration_type'    => 'THIRD_PARTY',
+							'third_party_details' => [
+								'features' => ['PAYMENT', 'REFUND'],
+							],
+						],
+					],
+				],
+			],
+			'products'                => [$checkout_type],
+			'legal_consents'          => [
+				[
+					'type'    => 'SHARE_DATA_CONSENT',
+					'granted' => true,
+				],
+			],
+			'partner_config_override' => [
+				'return_url' => $return_url,
+			],
+		]);
+	}
+
+
+	/**
+	 * Get the return URL.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getReturnUrl(EE_Payment_Method $paypal_pm): string
+	{
+		$wp_nonce = EED_Module::getRequest()->getRequestParam('wp_nonce');
+		$nonce    = wp_create_nonce(Domain::NONCE_NAME_ONBOARDING_RETURN);
+		return add_query_arg(
+			[
+				'page'                        => 'espresso_payment_settings',
+				'webhook_action'              => 'eepPpcMerchantOnboard',
+				'payment_method'              => $paypal_pm->slug(),
+				'_wpnonce'                    => $wp_nonce,
+				'nonce'                       => $nonce,
+				Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Redirect to the payment method (PP) settings home page.
+	 *
+	 * @return void
+	 */
+	public static function redirectToPmSettingsHome(): void
+	{
+		$get_params = EED_Module::getRequest()->getParams();
+		if (empty($get_params['payment_method'])) {
+			// Simply do not redirect.
+			return;
+		}
+		$args_to_add = [
+			'page'           => 'espresso_payment_settings',
+			'payment_method' => $get_params['payment_method'],
+		];
+		if (isset($get_params['sandbox_mode'])) {
+			$args_to_add[ Domain::META_KEY_SANDBOX_MODE ] = $get_params['sandbox_mode'];
+		}
+		$home_url = add_query_arg($args_to_add, admin_url('admin.php'));
+		wp_redirect($home_url);
+		exit;
+	}
+
+
+	/**
+	 * Check user’s onboarding status.
+	 * This will handle the user return from the auth page and also check the status via the API.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function updateOnboardingStatus(): void
+	{
+		// Check if this is the webhook from PayPal.
+		if (! isset($_GET['webhook_action'], $_GET['nonce'])
+			|| $_GET['webhook_action'] !== 'eepPpcMerchantOnboard'
+		) {
+			return;  // Ignore.
+		}
+		$get_params = EED_Module::getRequest()->getParams();
+		// Get the payment method.
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		// Check the response (GET) parameters.
+		if (! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
+			// Missing parameters. Can't proceed.
+			PayPalLogger::errorLog(
+				esc_html__('Missing required onboarding parameters.', 'event_espresso'),
+				$get_params,
+				$paypal_pm
+			);
+			EED_PayPalOnboard::redirectToPmSettingsHome();
+			return;
+		}
+		// Check on the onboarding status (recommended by PP).
+		$onboarding_status = EED_PayPalOnboard::trackSellerOnboarding(
+			$paypal_pm,
+			$get_params[ Domain::META_KEY_SELLER_MERCHANT_ID ]
+		);
+		if (! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
+			PayPalLogger::errorLog(
+				$onboarding_status['message'],
+				array_merge($get_params, $onboarding_status),
+				$paypal_pm
+			);
+			EED_PayPalOnboard::redirectToPmSettingsHome();
+			return;
+		}
+		// Start saving the setup and info.
+		PayPalExtraMetaManager::parseAndSaveOptions($paypal_pm, $onboarding_status);
+		// Save the credentials.
+		PayPalExtraMetaManager::saveSellerApiCredentials($paypal_pm, $get_params);
+		// If onboarded successfully, remove the onboarding URL.
+		PayPalExtraMetaManager::deletePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
+		// Also clen GET params by redirecting, because PP auto redirects to the return_url on closing the onboarding window.
+		EED_PayPalOnboard::redirectToPmSettingsHome();
+	}
+
+
+	/**
+	 * Check if all required parameters for the onboarding status check are present.
+	 *
+	 * @param array $data
+	 * @param mixed $paypal_pm
+	 * @return bool
+	 */
+	public static function onboardingStatusResponseValid(array $data, $paypal_pm): bool
+	{
+		// Check that we have all the required parameters and the nonce is ok.
+		if ($paypal_pm instanceof EE_Payment_Method
+			&& wp_verify_nonce($data['nonce'], Domain::NONCE_NAME_ONBOARDING_RETURN)
+			&& ! empty($data[ Domain::API_PARAM_PARTNER_ID ])
+			&& ! empty($data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
+			&& isset($data[ Domain::API_PARAM_EMAIL_CONFIRMED ])
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Get partner access token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getPartnerAccessToken(EE_Payment_Method $paypal_pm): string
+	{
+		// Do we have it saved ?
+		$access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
+		$expired      = EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm);
+		// If we don't have it, request/update it.
+		if (! $access_token || $expired) {
+			return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
+		}
+		// Access token is saved as encrypted, so return decrypted.
+		return $access_token;
+	}
+
+
+	/**
+	 * Get partner access token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 */
+	public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
+	{
+		$expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_EXPIRES_IN);
+		if (! $expires_at) {
+			return true;
+		}
+		// Validate the token expiration date.
+		$now          = time();
+		$minutes_left = round(($expires_at - $now) / 60);
+		// Count as expired if less than 60 minutes till expiration left.
+		if ($minutes_left <= 60) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Request the partner access token from PayPal and save/update it.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function requestPartnerAccessToken(EE_Payment_Method $paypal_pm): string
+	{
+		$nonce = wp_create_nonce('eea_pp_commerce_get_access_token');
+		// Request the access token.
+		$post_args = [
+			'method' => 'POST',
+			'body'   => [
+				'nonce'                       => $nonce,
+				'api_version'                 => 'v1',
+				Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
+			],
+		];
+		if (defined('LOCAL_MIDDLEMAN_SERVER')) {
+			$post_args['sslverify'] = false;
+		}
+		$post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
+		$response = EED_PayPalOnboard::sendRequest($paypal_pm, $post_url, $post_args);
+		if (isset($response['error'])) {
+			return '';
+		}
+		// Check the data we received.
+		if (! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
+			return '';
+		}
+		// If we are here all seems to be ok. Save the token and it's data.
+		$saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
+		if (! $saved) {
+			return '';
+		}
+		return $response['access_token'];
+	}
+
+
+	/**
+	 * Request seller onboarding status from PayPal.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $merchant_id
+	 * @return array
+	 */
+	public static function trackSellerOnboarding(EE_Payment_Method $paypal_pm, string $merchant_id): array
+	{
+		$track_onboarding = EED_PayPalOnboard::getTrackOnboardingApi($paypal_pm, $merchant_id);
+		if (! $track_onboarding instanceof TrackSellerOnboarding) {
+			$err_msg = esc_html__('Failed to track seller onboarding.', 'event_espresso');
+			return ['error' => 'TRACK_ONBOARDING_FAILED', 'message' => $err_msg];
+		}
+		return $track_onboarding->isValid();
+	}
+
+
+	/**
+	 * Returns the Track Seller Onboarding API.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $merchant_id
+	 * @return TrackSellerOnboarding|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getTrackOnboardingApi(
+		EE_Payment_Method $paypal_pm,
+		string            $merchant_id
+	): ?TrackSellerOnboarding {
+		$partner_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
+		$paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
+		if (! $paypal_api instanceof PayPalApi || ! $partner_id) {
+			return null;
+		}
+		return new TrackSellerOnboarding($paypal_api, $partner_id, $merchant_id, $paypal_pm->debug_mode());
+	}
+
+
+	/**
+	 * Check the onboard status and return the result.
+	 * (AJAX)
+	 *
+	 * @return void
+	 */
+	public static function getOnboardStatus(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			$err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
+			wp_send_json(['on_board' => false]);
+		}
+		try {
+			$seller_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_MERCHANT_ID) ?? '--';
+		} catch (Exception $e) {
+			$seller_id = '--';
+		}
+		wp_send_json(
+			[
+				'on_board'  => EED_PayPalOnboard::isOnboard($paypal_pm),
+				'seller_id' => $seller_id,
+			]
+		);
+	}
+
+
+	/**
+	 * De-authorize the seller. Remove all API credentials.
+	 * (AJAX)
+	 *
+	 * @return void
+	 */
+	public static function offboard(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			wp_send_json([
+				'error'   => 'INVALID_PM',
+				'message' => esc_html__(
+					'Invalid payment method. Please refresh the page and try again.',
+					'event_espresso'
+				),
+			]);
+		}
+		PayPalExtraMetaManager::deleteAllData($paypal_pm);
+		wp_send_json(['success' => true]);
+	}
+
+
+	/**
+	 * Checks if already onboard.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return boolean
+	 */
+	public static function isOnboard(EE_Payment_Method $payment_method): bool
+	{
+		$pp_meta_data = PayPalExtraMetaManager::getAllData($payment_method);
+		return
+			// onborded with a third party integration ?
+			(! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ])
+			)
+			// or with the first party integration ?
+			|| (! empty($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_PAYER_ID ])
+			);
+	}
+
+
+	/**
+	 * Send a request and return a decoded response body.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $request_url
+	 * @param array             $request_args
+	 * @return array
+	 */
+	public static function sendRequest(EE_Payment_Method $paypal_pm, string $request_url, array $request_args): array
+	{
+		$error_return = ['error' => true];
+		$response     = wp_remote_request($request_url, $request_args);
+		if (is_wp_error($response)) {
+			$message = $response->get_error_message();
+			PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
+			$error_return['message'] = $message;
+			return $error_return;
+		}
+		$response_body = (isset($response['body']) && $response['body']) ? json_decode($response['body'], true) : [];
+		if (empty($response_body) || isset($response_body['error'])) {
+			$message = $response_body['error_description']
+					   ?? sprintf(
+						   esc_html__('Unknown response received while sending a request to: %1$s', 'event_espresso'),
+						   $request_url
+					   );
+			PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
+			$error_return['message'] = $message;
+			return $error_return;
+		}
+		return $response_body;
+	}
+
+
+	/**
+	 * Check the response for a partner token request.
+	 *
+	 * @param                   $response
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 */
+	public static function partnerTokenResponseValid($response, EE_Payment_Method $paypal_pm): bool
+	{
+		// Check the data we received.
+		if (
+			empty($response['nonce'])
+			|| ! wp_verify_nonce($response['nonce'], 'eea_pp_commerce_get_access_token')
+			|| empty($response['access_token'])
+			|| empty($response['app_id'])
+			|| empty($response['expires_in'])
+			|| empty($response['partner_client_id'])
+			|| empty($response['partner_merchant_id'])
+		) {
+			// This is an error.
+			$err_msg = esc_html__('Incoming parameter validation failed.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, (array) $response, $paypal_pm);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Returns the base URL to the middleman server.
+	 * If LOCAL_MIDDLEMAN_SERVER is defined, requests will be sent to connect.eventespresso.test
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getMiddlemanBaseUrl(EE_Payment_Method $payment_method): string
+	{
+		$target = defined('LOCAL_MIDDLEMAN_SERVER') ? 'test' : 'com';
+		// If this PM is used under different provider accounts, you might need an account indicator.
+		$account = defined('EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR') ? EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR : '';
+		$postfix = $payment_method->debug_mode() ? '_sandbox' : '';
+		$path    = 'paypal_commerce' . $account . $postfix;
+		return 'https://connect.eventespresso.' . $target . '/' . $path . '/';
+	}
+
+
+	/**
+	 * This Payment Method admin notices.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function adminNotice()
+	{
+		// Show the notice if PayPal Commerce PM is active but merchant is not onboard.
+		$pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
+		if ($pp_commerce instanceof EE_Payment_Method
+			&& $pp_commerce->active()
+			&& ! EED_PayPalOnboard::isOnboard($pp_commerce)
+		) {
+			add_action('admin_notices', [__CLASS__, 'notOnboardNotice']);
+		}
+	}
+
+
+	/**
+	 * Contents of the not onboard admin notice.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function notOnboardNotice()
+	{
+		$open_anchor = $close_anchor = '';
+		$pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
+		if ($pp_commerce instanceof EE_Payment_Method) {
+			$pm_page = add_query_arg(
+				[
+					'page'           => 'espresso_payment_settings',
+					'webhook_action' => 'eepPpcMerchantOnboard',
+					'payment_method' => $pp_commerce->slug(),
+				],
+				admin_url('admin.php')
+			);
+			$open_anchor  = "<a href='$pm_page'>";
+			$close_anchor = "</a>";
+		}
+		echo '<div class="error"><p>'
+		. sprintf(
+			esc_html__(
+				'%1$sPayPal Commerce%2$s payment method was activated but is not connected to PayPal. Please %3$sfinish setting up%4$s this payment method.',
+				'event_espresso'
+			),
+			'<strong>',
+			'</strong>',
+			$open_anchor,
+			$close_anchor
+		)
+		. '</p></div>';
+	}
 }

Spacing +32 added lines, -32 removed lines

@@ -75,7 +75,7 @@ 
         $signup_link = '';
         try {
             $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-            if (! $paypal_pm instanceof EE_Payment_Method) {
+            if ( ! $paypal_pm instanceof EE_Payment_Method) {
                 PayPalLogger::errorLogAndExit(
                     esc_html__('No payment method.', 'event_espresso'),
                     EED_Module::getRequest()->postParams(),
@@ -88,7 +88,7 @@ 
             // if (! $signup_link || $token_expired) {
             $signup_link = EED_PayPalOnboard::requestOnboardingUrl($paypal_pm);
             // }
-            if (! $signup_link) {
+            if ( ! $signup_link) {
                 $err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
                 PayPalLogger::errorLogAndExit($err_msg, ['signup_link' => $signup_link], $paypal_pm);
             }
@@ -97,7 +97,7 @@ 
             PayPalLogger::errorLogAndExit($exception->getMessage());
         }
         // Is it empty (can happen if we didn't get the URL through the API).
-        $signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
+        $signup_link = $signup_link ? $signup_link.'?&displayMode=minibrowser' : '#';
         wp_send_json(
             [
                 'signup_link' => $signup_link,
@@ -120,7 +120,7 @@ 
         $signup_link = '';
         // Get the access token.
         $access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
-        if (! $access_token) {
+        if ( ! $access_token) {
             $err_msg = esc_html__('Error! No access token.', 'event_espresso');
             PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
             return '';
@@ -133,17 +133,17 @@ 
             'headers' => [
                 'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
                 'Content-Type'                  => 'application/json',
-                'Authorization'                 => 'Bearer ' . $access_token,
+                'Authorization'                 => 'Bearer '.$access_token,
                 'PayPal-Partner-Attribution-Id' => $bn_code,
             ],
             'body'    => $body_params,
         ];
-        $request_url = Domain::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
+        $request_url = Domain::getPayPalApiUrl($paypal_pm).'/v2/customer/partner-referrals';
         $response    = EED_PayPalOnboard::sendRequest($paypal_pm, $request_url, $post_params);
         // Check the data we received.
         if (isset($response['error']) || empty($response['links'])) {
             // Did the original access token get replaced by any chance ?
-            if (! $one_time_request
+            if ( ! $one_time_request
                 && ! empty($response['message'])
                 && $response['message'] === 'Access Token not found in cache'
             ) {
@@ -255,7 +255,7 @@ 
             'payment_method' => $get_params['payment_method'],
         ];
         if (isset($get_params['sandbox_mode'])) {
-            $args_to_add[ Domain::META_KEY_SANDBOX_MODE ] = $get_params['sandbox_mode'];
+            $args_to_add[Domain::META_KEY_SANDBOX_MODE] = $get_params['sandbox_mode'];
         }
         $home_url = add_query_arg($args_to_add, admin_url('admin.php'));
         wp_redirect($home_url);
@@ -274,16 +274,16 @@ 
     public static function updateOnboardingStatus(): void
     {
         // Check if this is the webhook from PayPal.
-        if (! isset($_GET['webhook_action'], $_GET['nonce'])
+        if ( ! isset($_GET['webhook_action'], $_GET['nonce'])
             || $_GET['webhook_action'] !== 'eepPpcMerchantOnboard'
         ) {
-            return;  // Ignore.
+            return; // Ignore.
         }
         $get_params = EED_Module::getRequest()->getParams();
         // Get the payment method.
         $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
         // Check the response (GET) parameters.
-        if (! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
+        if ( ! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
             // Missing parameters. Can't proceed.
             PayPalLogger::errorLog(
                 esc_html__('Missing required onboarding parameters.', 'event_espresso'),
@@ -296,9 +296,9 @@ 
         // Check on the onboarding status (recommended by PP).
         $onboarding_status = EED_PayPalOnboard::trackSellerOnboarding(
             $paypal_pm,
-            $get_params[ Domain::META_KEY_SELLER_MERCHANT_ID ]
+            $get_params[Domain::META_KEY_SELLER_MERCHANT_ID]
         );
-        if (! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
+        if ( ! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
             PayPalLogger::errorLog(
                 $onboarding_status['message'],
                 array_merge($get_params, $onboarding_status),
@@ -330,9 +330,9 @@ 
         // Check that we have all the required parameters and the nonce is ok.
         if ($paypal_pm instanceof EE_Payment_Method
             && wp_verify_nonce($data['nonce'], Domain::NONCE_NAME_ONBOARDING_RETURN)
-            && ! empty($data[ Domain::API_PARAM_PARTNER_ID ])
-            && ! empty($data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-            && isset($data[ Domain::API_PARAM_EMAIL_CONFIRMED ])
+            && ! empty($data[Domain::API_PARAM_PARTNER_ID])
+            && ! empty($data[Domain::META_KEY_SELLER_MERCHANT_ID])
+            && isset($data[Domain::API_PARAM_EMAIL_CONFIRMED])
         ) {
             return true;
         }
@@ -354,7 +354,7 @@ 
         $access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
         $expired      = EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm);
         // If we don't have it, request/update it.
-        if (! $access_token || $expired) {
+        if ( ! $access_token || $expired) {
             return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
         }
         // Access token is saved as encrypted, so return decrypted.
@@ -371,7 +371,7 @@ 
     public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
     {
         $expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_EXPIRES_IN);
-        if (! $expires_at) {
+        if ( ! $expires_at) {
             return true;
         }
         // Validate the token expiration date.
@@ -408,18 +408,18 @@ 
         if (defined('LOCAL_MIDDLEMAN_SERVER')) {
             $post_args['sslverify'] = false;
         }
-        $post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
+        $post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm).'get_token';
         $response = EED_PayPalOnboard::sendRequest($paypal_pm, $post_url, $post_args);
         if (isset($response['error'])) {
             return '';
         }
         // Check the data we received.
-        if (! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
+        if ( ! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
             return '';
         }
         // If we are here all seems to be ok. Save the token and it's data.
         $saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
-        if (! $saved) {
+        if ( ! $saved) {
             return '';
         }
         return $response['access_token'];
@@ -436,7 +436,7 @@ 
     public static function trackSellerOnboarding(EE_Payment_Method $paypal_pm, string $merchant_id): array
     {
         $track_onboarding = EED_PayPalOnboard::getTrackOnboardingApi($paypal_pm, $merchant_id);
-        if (! $track_onboarding instanceof TrackSellerOnboarding) {
+        if ( ! $track_onboarding instanceof TrackSellerOnboarding) {
             $err_msg = esc_html__('Failed to track seller onboarding.', 'event_espresso');
             return ['error' => 'TRACK_ONBOARDING_FAILED', 'message' => $err_msg];
         }
@@ -459,7 +459,7 @@ 
     ): ?TrackSellerOnboarding {
         $partner_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
         $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi || ! $partner_id) {
+        if ( ! $paypal_api instanceof PayPalApi || ! $partner_id) {
             return null;
         }
         return new TrackSellerOnboarding($paypal_api, $partner_id, $merchant_id, $paypal_pm->debug_mode());
@@ -475,7 +475,7 @@ 
     public static function getOnboardStatus(): void
     {
         $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
+        if ( ! $paypal_pm instanceof EE_Payment_Method) {
             $err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
             PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
             wp_send_json(['on_board' => false]);
@@ -503,7 +503,7 @@ 
     public static function offboard(): void
     {
         $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
+        if ( ! $paypal_pm instanceof EE_Payment_Method) {
             wp_send_json([
                 'error'   => 'INVALID_PM',
                 'message' => esc_html__(
@@ -528,13 +528,13 @@ 
         $pp_meta_data = PayPalExtraMetaManager::getAllData($payment_method);
         return
             // onborded with a third party integration ?
-            (! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ])
+            ( ! empty($pp_meta_data[Domain::META_KEY_SELLER_MERCHANT_ID])
+                && ! empty($pp_meta_data[Domain::META_KEY_ACCESS_TOKEN])
             )
             // or with the first party integration ?
-            || (! empty($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_PAYER_ID ])
+            || ( ! empty($pp_meta_data[Domain::META_KEY_CLIENT_ID])
+                && ! empty($pp_meta_data[Domain::META_KEY_CLIENT_SECRET])
+                && ! empty($pp_meta_data[Domain::META_KEY_PAYER_ID])
             );
     }
 
@@ -615,8 +615,8 @@ 
         // If this PM is used under different provider accounts, you might need an account indicator.
         $account = defined('EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR') ? EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR : '';
         $postfix = $payment_method->debug_mode() ? '_sandbox' : '';
-        $path    = 'paypal_commerce' . $account . $postfix;
-        return 'https://connect.eventespresso.' . $target . '/' . $path . '/';
+        $path    = 'paypal_commerce'.$account.$postfix;
+        return 'https://connect.eventespresso.'.$target.'/'.$path.'/';
     }
 
 

PaymentMethods/PayPalCommerce/tools/extra_meta/PayPalExtraMetaManager.php

Indentation +262 added lines, -262 removed lines

@@ -22,290 +22,290 @@
  */
 class PayPalExtraMetaManager
 {
-    /**
-     * Get payment method option/extra meta
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $option_name
-     * @return mixed
-     */
-    public static function getPmOption(EE_Payment_Method $paypal_pm, string $option_name)
-    {
-        $pp_meta_data = self::extraMeta($paypal_pm);
-        $option_value = $pp_meta_data->getOption($option_name);
-        // Decrypt the encrypted options.
-        if (
-            $option_name === Domain::META_KEY_ACCESS_TOKEN
-            || $option_name === Domain::META_KEY_PARTNER_MERCHANT_ID
-            || $option_name === Domain::META_KEY_CLIENT_SECRET
-        ) {
-            $option_value = self::decryptString($option_value, $paypal_pm);
-        }
-        return $option_value;
-    }
+	/**
+	 * Get payment method option/extra meta
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $option_name
+	 * @return mixed
+	 */
+	public static function getPmOption(EE_Payment_Method $paypal_pm, string $option_name)
+	{
+		$pp_meta_data = self::extraMeta($paypal_pm);
+		$option_value = $pp_meta_data->getOption($option_name);
+		// Decrypt the encrypted options.
+		if (
+			$option_name === Domain::META_KEY_ACCESS_TOKEN
+			|| $option_name === Domain::META_KEY_PARTNER_MERCHANT_ID
+			|| $option_name === Domain::META_KEY_CLIENT_SECRET
+		) {
+			$option_value = self::decryptString($option_value, $paypal_pm);
+		}
+		return $option_value;
+	}
 
 
-    /**
-     * Save payment method option/extra meta
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $option_name
-     * @param                   $option_value
-     * @return bool
-     */
-    public static function savePmOption(EE_Payment_Method $paypal_pm, string $option_name, $option_value): bool
-    {
-        $pp_meta_data = self::extraMeta($paypal_pm);
-        return $pp_meta_data->saveOption($option_name, $option_value);
-    }
+	/**
+	 * Save payment method option/extra meta
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $option_name
+	 * @param                   $option_value
+	 * @return bool
+	 */
+	public static function savePmOption(EE_Payment_Method $paypal_pm, string $option_name, $option_value): bool
+	{
+		$pp_meta_data = self::extraMeta($paypal_pm);
+		return $pp_meta_data->saveOption($option_name, $option_value);
+	}
 
 
-    /**
-     * Save a list of payment method options/extra meta.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $options_list
-     * @return bool
-     */
-    public static function savePmOptions(EE_Payment_Method $paypal_pm, array $options_list): bool
-    {
-        $pp_meta_data = self::extraMeta($paypal_pm);
-        return $pp_meta_data->saveBatch($options_list);
-    }
+	/**
+	 * Save a list of payment method options/extra meta.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $options_list
+	 * @return bool
+	 */
+	public static function savePmOptions(EE_Payment_Method $paypal_pm, array $options_list): bool
+	{
+		$pp_meta_data = self::extraMeta($paypal_pm);
+		return $pp_meta_data->saveBatch($options_list);
+	}
 
 
-    /**
-     * Delete payment method option/extra meta
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $option_name
-     * @return bool
-     */
-    public static function deletePmOption(EE_Payment_Method $paypal_pm, string $option_name): bool
-    {
-        $pp_meta_data = self::extraMeta($paypal_pm);
-        return $pp_meta_data->deleteOption($option_name);
-    }
+	/**
+	 * Delete payment method option/extra meta
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $option_name
+	 * @return bool
+	 */
+	public static function deletePmOption(EE_Payment_Method $paypal_pm, string $option_name): bool
+	{
+		$pp_meta_data = self::extraMeta($paypal_pm);
+		return $pp_meta_data->deleteOption($option_name);
+	}
 
 
-    /**
-     * Get all options for payment method.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return array|bool
-     */
-    public static function getAllData(EE_Payment_Method $paypal_pm)
-    {
-        $pp_meta_data = self::extraMeta($paypal_pm);
-        return $pp_meta_data->getMetaData();
-    }
+	/**
+	 * Get all options for payment method.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return array|bool
+	 */
+	public static function getAllData(EE_Payment_Method $paypal_pm)
+	{
+		$pp_meta_data = self::extraMeta($paypal_pm);
+		return $pp_meta_data->getMetaData();
+	}
 
 
-    /**
-     * Delete all options for this payment method.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     */
-    public static function deleteAllData(EE_Payment_Method $paypal_pm): bool
-    {
-        $pp_meta_data = self::extraMeta($paypal_pm);
-        return $pp_meta_data->deleteMetaData();
-    }
+	/**
+	 * Delete all options for this payment method.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 */
+	public static function deleteAllData(EE_Payment_Method $paypal_pm): bool
+	{
+		$pp_meta_data = self::extraMeta($paypal_pm);
+		return $pp_meta_data->deleteMetaData();
+	}
 
 
-    /**
-     * Save the debug mode option if it changed.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $request_data
-     * @return bool             Updated or not.
-     */
-    public static function updateDebugMode(EE_Payment_Method $paypal_pm, array $request_data): bool
-    {
-        if (
-            isset($request_data['sandbox_mode'])
-            && in_array($request_data['sandbox_mode'], ['0', '1'], true)
-            && $paypal_pm->debug_mode() !== (bool) $request_data['sandbox_mode']
-        ) {
-            try {
-                $paypal_pm->save(['PMD_debug_mode' => $request_data['sandbox_mode']]);
-            } catch (EE_Error $e) {
-                $err_msg = sprintf(
-                    esc_html__('Note, debug mode not saved ! %1$s', 'event_espresso'),
-                    $e->getMessage()
-                );
-                PayPalLogger::errorLog($err_msg, $request_data, $paypal_pm);
-                return false;
-            }
-             return true;
-        }
-        return false;
-    }
+	/**
+	 * Save the debug mode option if it changed.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $request_data
+	 * @return bool             Updated or not.
+	 */
+	public static function updateDebugMode(EE_Payment_Method $paypal_pm, array $request_data): bool
+	{
+		if (
+			isset($request_data['sandbox_mode'])
+			&& in_array($request_data['sandbox_mode'], ['0', '1'], true)
+			&& $paypal_pm->debug_mode() !== (bool) $request_data['sandbox_mode']
+		) {
+			try {
+				$paypal_pm->save(['PMD_debug_mode' => $request_data['sandbox_mode']]);
+			} catch (EE_Error $e) {
+				$err_msg = sprintf(
+					esc_html__('Note, debug mode not saved ! %1$s', 'event_espresso'),
+					$e->getMessage()
+				);
+				PayPalLogger::errorLog($err_msg, $request_data, $paypal_pm);
+				return false;
+			}
+			 return true;
+		}
+		return false;
+	}
 
 
-    /**
-     * Save partner access token and parameters.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $response
-     * @return bool
-     */
-    public static function savePartnerAccessToken(EE_Payment_Method $paypal_pm, array $response): bool
-    {
-        $paypal_data         = [];
-        $expected_parameters = [
-            Domain::META_KEY_ACCESS_TOKEN,
-            Domain::META_KEY_EXPIRES_IN,
-            Domain::META_KEY_APP_ID,
-            Domain::META_KEY_PARTNER_CLIENT_ID,
-            Domain::META_KEY_PARTNER_MERCHANT_ID,
-            Domain::META_KEY_BN_CODE,
-        ];
-        foreach ($expected_parameters as $api_key) {
-            if (! isset($response[ $api_key ])) {
-                // Don't want to try saving data that doesn't exist.
-                continue;
-            }
-            try {
-                switch ($api_key) {
-                    case Domain::META_KEY_ACCESS_TOKEN:
-                    case Domain::META_KEY_PARTNER_MERCHANT_ID:
-                        $paypal_data[ $api_key ] = self::encryptString($response[ $api_key ], $paypal_pm);
-                        break;
-                    case Domain::META_KEY_EXPIRES_IN:
-                        $paypal_data[ $api_key ] = time() + (int) sanitize_key($response[ $api_key ]);
-                        break;
-                    default:
-                        $paypal_data[ $api_key ] = sanitize_text_field($response[ $api_key ]);
-                }
-            } catch (Exception $exception) {
-                PayPalLogger::errorLog($exception->getMessage(), $response, $paypal_pm);
-                return false;
-            }
-        }
-        return self::savePmOptions($paypal_pm, $paypal_data);
-    }
+	/**
+	 * Save partner access token and parameters.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $response
+	 * @return bool
+	 */
+	public static function savePartnerAccessToken(EE_Payment_Method $paypal_pm, array $response): bool
+	{
+		$paypal_data         = [];
+		$expected_parameters = [
+			Domain::META_KEY_ACCESS_TOKEN,
+			Domain::META_KEY_EXPIRES_IN,
+			Domain::META_KEY_APP_ID,
+			Domain::META_KEY_PARTNER_CLIENT_ID,
+			Domain::META_KEY_PARTNER_MERCHANT_ID,
+			Domain::META_KEY_BN_CODE,
+		];
+		foreach ($expected_parameters as $api_key) {
+			if (! isset($response[ $api_key ])) {
+				// Don't want to try saving data that doesn't exist.
+				continue;
+			}
+			try {
+				switch ($api_key) {
+					case Domain::META_KEY_ACCESS_TOKEN:
+					case Domain::META_KEY_PARTNER_MERCHANT_ID:
+						$paypal_data[ $api_key ] = self::encryptString($response[ $api_key ], $paypal_pm);
+						break;
+					case Domain::META_KEY_EXPIRES_IN:
+						$paypal_data[ $api_key ] = time() + (int) sanitize_key($response[ $api_key ]);
+						break;
+					default:
+						$paypal_data[ $api_key ] = sanitize_text_field($response[ $api_key ]);
+				}
+			} catch (Exception $exception) {
+				PayPalLogger::errorLog($exception->getMessage(), $response, $paypal_pm);
+				return false;
+			}
+		}
+		return self::savePmOptions($paypal_pm, $paypal_data);
+	}
 
 
-    /**
-     * Save merchant/seller API credentials.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $response
-     * @return bool
-     */
-    public static function saveSellerApiCredentials(EE_Payment_Method $paypal_pm, array $response): bool
-    {
-        $api_credentials     = [];
-        $expected_parameters = [
-            Domain::META_KEY_SELLER_MERCHANT_ID,
-        ];
-        foreach ($expected_parameters as $api_key) {
-            if (! isset($response[ $api_key ])) {
-                // Don't want to try saving data that doesn't exist.
-                continue;
-            }
-            $api_credentials[ $api_key ] = $response[ $api_key ];
-        }
-        return self::savePmOptions($paypal_pm, $api_credentials);
-    }
+	/**
+	 * Save merchant/seller API credentials.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $response
+	 * @return bool
+	 */
+	public static function saveSellerApiCredentials(EE_Payment_Method $paypal_pm, array $response): bool
+	{
+		$api_credentials     = [];
+		$expected_parameters = [
+			Domain::META_KEY_SELLER_MERCHANT_ID,
+		];
+		foreach ($expected_parameters as $api_key) {
+			if (! isset($response[ $api_key ])) {
+				// Don't want to try saving data that doesn't exist.
+				continue;
+			}
+			$api_credentials[ $api_key ] = $response[ $api_key ];
+		}
+		return self::savePmOptions($paypal_pm, $api_credentials);
+	}
 
 
-    /**
-     * Save other payment method related settings from a data array.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $data
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function parseAndSaveOptions(EE_Payment_Method $paypal_pm, array $data): bool
-    {
-        $allowed_checkout_type = 'express_checkout';
-        // Note, although PayPal shows that this should include PPCP_CUSTOM or EXPRESS_CHECKOUT only,
-        // in reality, it will also include other products like MOBILE_PAYMENT_ACCEPTANCE etc.
-        if (! empty($data['response']['products'][0]['name']) && is_array($data['response']['products'])) {
-            foreach ($data['response']['products'] as $product) {
-                if (str_contains($product['name'], 'PPCP')) {
-                    // This merchant has PPCP in the products list, so we can enable both (all) checkout types.
-                    $allowed_checkout_type = 'all';
-                    break;
-                }
-            }
-        }
-        // Set the Checkout type (a PM option), just in case merchant doesn't save PM options manually.
-        $checkout_type = $paypal_pm->get_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, true, false);
-        if (! $checkout_type) {
-            $paypal_pm->update_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, $allowed_checkout_type);
-        }
-        return PayPalExtraMetaManager::savePmOption(
-            $paypal_pm,
-            Domain::META_KEY_ALLOWED_CHECKOUT_TYPE,
-            $allowed_checkout_type
-        );
-    }
+	/**
+	 * Save other payment method related settings from a data array.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $data
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function parseAndSaveOptions(EE_Payment_Method $paypal_pm, array $data): bool
+	{
+		$allowed_checkout_type = 'express_checkout';
+		// Note, although PayPal shows that this should include PPCP_CUSTOM or EXPRESS_CHECKOUT only,
+		// in reality, it will also include other products like MOBILE_PAYMENT_ACCEPTANCE etc.
+		if (! empty($data['response']['products'][0]['name']) && is_array($data['response']['products'])) {
+			foreach ($data['response']['products'] as $product) {
+				if (str_contains($product['name'], 'PPCP')) {
+					// This merchant has PPCP in the products list, so we can enable both (all) checkout types.
+					$allowed_checkout_type = 'all';
+					break;
+				}
+			}
+		}
+		// Set the Checkout type (a PM option), just in case merchant doesn't save PM options manually.
+		$checkout_type = $paypal_pm->get_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, true, false);
+		if (! $checkout_type) {
+			$paypal_pm->update_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, $allowed_checkout_type);
+		}
+		return PayPalExtraMetaManager::savePmOption(
+			$paypal_pm,
+			Domain::META_KEY_ALLOWED_CHECKOUT_TYPE,
+			$allowed_checkout_type
+		);
+	}
 
 
-    /**
-     * Get PayPal extra meta helper.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return PayPalExtraMeta
-     */
-    public static function extraMeta(EE_Payment_Method $paypal_pm): PayPalExtraMeta
-    {
-        return LoaderFactory::getLoader()->getShared(PayPalExtraMeta::class, [$paypal_pm]);
-    }
+	/**
+	 * Get PayPal extra meta helper.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return PayPalExtraMeta
+	 */
+	public static function extraMeta(EE_Payment_Method $paypal_pm): PayPalExtraMeta
+	{
+		return LoaderFactory::getLoader()->getShared(PayPalExtraMeta::class, [$paypal_pm]);
+	}
 
 
-    /**
-     * Encrypt a text field.
-     *
-     * @param string            $text
-     * @param EE_Payment_Method $paypal_pm
-     * @return string|null
-     */
-    public static function encryptString(string $text, EE_Payment_Method $paypal_pm): ?string
-    {
-        // We sure we are getting something ?
-        if (! $text) {
-            return $text;
-        }
-        // Do encrypt.
-        $encryptor      = LoaderFactory::getLoader()->getShared(OpenSSLEncryption::class, [new Base64Encoder()]);
-        $sanitized_text = sanitize_text_field($text);
-        $key_identifier = $paypal_pm->debug_mode()
-            ? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
-            : PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
-        return $encryptor->encrypt($sanitized_text, $key_identifier);
-    }
+	/**
+	 * Encrypt a text field.
+	 *
+	 * @param string            $text
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string|null
+	 */
+	public static function encryptString(string $text, EE_Payment_Method $paypal_pm): ?string
+	{
+		// We sure we are getting something ?
+		if (! $text) {
+			return $text;
+		}
+		// Do encrypt.
+		$encryptor      = LoaderFactory::getLoader()->getShared(OpenSSLEncryption::class, [new Base64Encoder()]);
+		$sanitized_text = sanitize_text_field($text);
+		$key_identifier = $paypal_pm->debug_mode()
+			? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
+			: PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
+		return $encryptor->encrypt($sanitized_text, $key_identifier);
+	}
 
 
-    /**
-     * Decrypt a string.
-     *
-     * @param string            $text
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     */
-    public static function decryptString(string $text, EE_Payment_Method $paypal_pm): string
-    {
-        // Are we even getting something ?
-        if (! $text) {
-            return $text;
-        }
-        // Try decrypting.
-        try {
-            $encryptor      = LoaderFactory::getLoader()->getShared(OpenSSLEncryption::class, [new Base64Encoder()]);
-            $key_identifier = $paypal_pm->debug_mode()
-                ? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
-                : PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
-            $decrypted      = $encryptor->decrypt($text, $key_identifier);
-        } catch (Exception $e) {
-            return $text;
-        }
-        return $decrypted ?? $text;
-    }
+	/**
+	 * Decrypt a string.
+	 *
+	 * @param string            $text
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 */
+	public static function decryptString(string $text, EE_Payment_Method $paypal_pm): string
+	{
+		// Are we even getting something ?
+		if (! $text) {
+			return $text;
+		}
+		// Try decrypting.
+		try {
+			$encryptor      = LoaderFactory::getLoader()->getShared(OpenSSLEncryption::class, [new Base64Encoder()]);
+			$key_identifier = $paypal_pm->debug_mode()
+				? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
+				: PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
+			$decrypted      = $encryptor->decrypt($text, $key_identifier);
+		} catch (Exception $e) {
+			return $text;
+		}
+		return $decrypted ?? $text;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -163,7 +163,7 @@ 
             Domain::META_KEY_BN_CODE,
         ];
         foreach ($expected_parameters as $api_key) {
-            if (! isset($response[ $api_key ])) {
+            if ( ! isset($response[$api_key])) {
                 // Don't want to try saving data that doesn't exist.
                 continue;
             }
@@ -171,13 +171,13 @@ 
                 switch ($api_key) {
                     case Domain::META_KEY_ACCESS_TOKEN:
                     case Domain::META_KEY_PARTNER_MERCHANT_ID:
-                        $paypal_data[ $api_key ] = self::encryptString($response[ $api_key ], $paypal_pm);
+                        $paypal_data[$api_key] = self::encryptString($response[$api_key], $paypal_pm);
                         break;
                     case Domain::META_KEY_EXPIRES_IN:
-                        $paypal_data[ $api_key ] = time() + (int) sanitize_key($response[ $api_key ]);
+                        $paypal_data[$api_key] = time() + (int) sanitize_key($response[$api_key]);
                         break;
                     default:
-                        $paypal_data[ $api_key ] = sanitize_text_field($response[ $api_key ]);
+                        $paypal_data[$api_key] = sanitize_text_field($response[$api_key]);
                 }
             } catch (Exception $exception) {
                 PayPalLogger::errorLog($exception->getMessage(), $response, $paypal_pm);
@@ -202,11 +202,11 @@ 
             Domain::META_KEY_SELLER_MERCHANT_ID,
         ];
         foreach ($expected_parameters as $api_key) {
-            if (! isset($response[ $api_key ])) {
+            if ( ! isset($response[$api_key])) {
                 // Don't want to try saving data that doesn't exist.
                 continue;
             }
-            $api_credentials[ $api_key ] = $response[ $api_key ];
+            $api_credentials[$api_key] = $response[$api_key];
         }
         return self::savePmOptions($paypal_pm, $api_credentials);
     }
@@ -226,7 +226,7 @@ 
         $allowed_checkout_type = 'express_checkout';
         // Note, although PayPal shows that this should include PPCP_CUSTOM or EXPRESS_CHECKOUT only,
         // in reality, it will also include other products like MOBILE_PAYMENT_ACCEPTANCE etc.
-        if (! empty($data['response']['products'][0]['name']) && is_array($data['response']['products'])) {
+        if ( ! empty($data['response']['products'][0]['name']) && is_array($data['response']['products'])) {
             foreach ($data['response']['products'] as $product) {
                 if (str_contains($product['name'], 'PPCP')) {
                     // This merchant has PPCP in the products list, so we can enable both (all) checkout types.
@@ -237,7 +237,7 @@ 
         }
         // Set the Checkout type (a PM option), just in case merchant doesn't save PM options manually.
         $checkout_type = $paypal_pm->get_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, true, false);
-        if (! $checkout_type) {
+        if ( ! $checkout_type) {
             $paypal_pm->update_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, $allowed_checkout_type);
         }
         return PayPalExtraMetaManager::savePmOption(
@@ -270,7 +270,7 @@ 
     public static function encryptString(string $text, EE_Payment_Method $paypal_pm): ?string
     {
         // We sure we are getting something ?
-        if (! $text) {
+        if ( ! $text) {
             return $text;
         }
         // Do encrypt.
@@ -293,7 +293,7 @@ 
     public static function decryptString(string $text, EE_Payment_Method $paypal_pm): string
     {
         // Are we even getting something ?
-        if (! $text) {
+        if ( ! $text) {
             return $text;
         }
         // Try decrypting.