eventespresso / event-espresso-core

PaymentMethods/PayPalCommerce/api/ThirdPartyPayPalApi.php

Indentation +111 added lines, -111 removed lines

@@ -13,128 +13,128 @@
  */
 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 = base64_encode(json_encode(['alg' => 'none'], JSON_HEX_APOS));
-            $assertion2 = base64_encode(
-                json_encode(
-                    [
-                        'iss'      => $this->partner_client_id,
-                        'payer_id' => $this->payer_id,
-                    ],
-                    JSON_HEX_APOS
-                )
-            );
-            // now concatenate the two assertions and add to the headers.
-            $default_headers['PayPal-Auth-Assertion'] = "$assertion1.$assertion2.";
-        }
-        $request_parameters['headers'] = $headers + $default_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 = base64_encode(json_encode(['alg' => 'none'], JSON_HEX_APOS));
+			$assertion2 = base64_encode(
+				json_encode(
+					[
+						'iss'      => $this->partner_client_id,
+						'payer_id' => $this->payer_id,
+					],
+					JSON_HEX_APOS
+				)
+			);
+			// now concatenate the two assertions and add to the headers.
+			$default_headers['PayPal-Auth-Assertion'] = "$assertion1.$assertion2.";
+		}
+		$request_parameters['headers'] = $headers + $default_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;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
             'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
             'PayPal-Partner-Attribution-Id' => $this->bnCode(),
             'Content-Type'                  => 'application/json',
-            'Authorization'                 => 'Bearer ' . $this->accessToken(),
+            '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) {

PaymentMethods/PayPalCommerce/api/orders/CreateOrder.php

Indentation +274 added lines, -274 removed lines

@@ -30,301 +30,301 @@
  */
 class CreateOrder extends OrdersApi
 {
-    /**
-     * Line items total.
-     *
-     * @var float
-     */
-    protected float $items_total = 0.0;
+	/**
+	 * Line items total.
+	 *
+	 * @var float
+	 */
+	protected float $items_total = 0.0;
 
-    /**
-     * Promotions total.
-     *
-     * @var float
-     */
-    protected float $promos_total = 0.0;
+	/**
+	 * Promotions total.
+	 *
+	 * @var float
+	 */
+	protected float $promos_total = 0.0;
 
-    /**
-     * Tax total.
-     *
-     * @var float
-     */
-    protected float $tax_total = 0.0;
+	/**
+	 * Tax total.
+	 *
+	 * @var float
+	 */
+	protected float $tax_total = 0.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;
 
-    private FeatureFlags $feature;
+	private FeatureFlags $feature;
 
 
-    /**
-     * CreateOrder constructor.
-     *
-     * @param PayPalApi      $api
-     * @param EE_Transaction $transaction
-     * @param array          $billing_info
-     * @param FeatureFlags   $feature
-     */
-    public function __construct(PayPalApi $api, EE_Transaction $transaction, array $billing_info, FeatureFlags $feature)
-    {
-        parent::__construct($api);
-        $this->transaction   = $transaction;
-        $this->feature       = $feature;
-        $this->currency_code = CurrencyManager::currencyCode();
-        $this->sanitizeRequestParameters($billing_info);
-    }
+	/**
+	 * CreateOrder constructor.
+	 *
+	 * @param PayPalApi      $api
+	 * @param EE_Transaction $transaction
+	 * @param array          $billing_info
+	 * @param FeatureFlags   $feature
+	 */
+	public function __construct(PayPalApi $api, EE_Transaction $transaction, array $billing_info, FeatureFlags $feature)
+	{
+		parent::__construct($api);
+		$this->transaction   = $transaction;
+		$this->feature       = $feature;
+		$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
-    {
-        $sanitizer       = new RequestSanitizer(new Basic());
-        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
+	{
+		$sanitizer       = new RequestSanitizer(new Basic());
+		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
-     * @throws Exception
-     */
-    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')
-        );
-        $parameters  = [
-            '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->remaining(),
-                        '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
+	 * @throws Exception
+	 */
+	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')
+		);
+		$parameters  = [
+			'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->remaining(),
+						'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(),
 
-                ],
-            ],
-        ];
-        // Do we have the permissions for the fees ?
-        $scopes = PayPalExtraMetaManager::getPmOption(
-            $this->transaction->payment_method(),
-            Domain::META_KEY_AUTHORIZED_SCOPES
-        );
-        if (
-            (
-                (defined('EE_PPC_USE_PAYMENT_FEES') && EE_PPC_USE_PAYMENT_FEES)
-                || (! defined('EE_PPC_USE_PAYMENT_FEES')
-                    && $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
-                )
-            )
-            && ! empty($scopes) && in_array('partnerfee', $scopes)
-        ) {
-            $payment_fees = LoaderFactory::getShared(PartnerPaymentFees::class);
-            $parameters['purchase_units'][0]['payment_instruction'] = [
-                'platform_fees' => [
-                    [
-                        'amount' => [
-                            'value'         => (string) $payment_fees->getPartnerFee($this->transaction),
-                            'currency_code' => $this->currency_code,
-                        ],
-                    ],
-                ]
-            ];
-        }
-        return $parameters;
-    }
+				],
+			],
+		];
+		// Do we have the permissions for the fees ?
+		$scopes = PayPalExtraMetaManager::getPmOption(
+			$this->transaction->payment_method(),
+			Domain::META_KEY_AUTHORIZED_SCOPES
+		);
+		if (
+			(
+				(defined('EE_PPC_USE_PAYMENT_FEES') && EE_PPC_USE_PAYMENT_FEES)
+				|| (! defined('EE_PPC_USE_PAYMENT_FEES')
+					&& $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
+				)
+			)
+			&& ! empty($scopes) && in_array('partnerfee', $scopes)
+		) {
+			$payment_fees = LoaderFactory::getShared(PartnerPaymentFees::class);
+			$parameters['purchase_units'][0]['payment_instruction'] = [
+				'platform_fees' => [
+					[
+						'amount' => [
+							'value'         => (string) $payment_fees->getPartnerFee($this->transaction),
+							'currency_code' => $this->currency_code,
+						],
+					],
+				]
+			];
+		}
+		return $parameters;
+	}
 
 
-    /**
-     * 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'
-                && $line_item->quantity() > 0
-            ) {
-                $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' && $line_item->quantity() > 0) {
-                // 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);
-        // If this is a partial payment, apply the paid amount as a promo.
-        if ($this->transaction->paid() > 0) {
-            $this->promos_total += CurrencyManager::normalizeValue($this->transaction->paid());
-        }
-        $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'
+				&& $line_item->quantity() > 0
+			) {
+				$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' && $line_item->quantity() > 0) {
+				// 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);
+		// If this is a partial payment, apply the paid amount as a promo.
+		if ($this->transaction->paid() > 0) {
+			$this->promos_total += CurrencyManager::normalizeValue($this->transaction->paid());
+		}
+		$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.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.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
-    {
-        PayPalLogger::errorLog(
-            esc_html__('Validating Order Create:', 'event_espresso'),
-            [$this->request_url, $response],
-            $this->transaction->payment_method(),
-            false,
-            $this->transaction
-        );
-        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
+	{
+		PayPalLogger::errorLog(
+			esc_html__('Validating Order Create:', 'event_espresso'),
+			[$this->request_url, $response],
+			$this->transaction->payment_method(),
+			false,
+			$this->transaction
+		);
+		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 +8 added lines, -8 removed lines

@@ -101,9 +101,9 @@ 
      */
     public function sanitizeRequestParameters(array $billing_info): void
     {
-        $sanitizer       = new RequestSanitizer(new Basic());
+        $sanitizer = new RequestSanitizer(new Basic());
         foreach ($billing_info as $item => $value) {
-            $this->billing_info[ $item ] = $sanitizer->clean($value);
+            $this->billing_info[$item] = $sanitizer->clean($value);
         }
     }
 
@@ -141,7 +141,7 @@ 
             esc_html__('Tickets for an event at %1$s', 'event_espresso'),
             get_bloginfo('name')
         );
-        $parameters  = [
+        $parameters = [
             'intent'              => 'CAPTURE',
             'purchase_units'      => [
                 [
@@ -176,7 +176,7 @@ 
         if (
             (
                 (defined('EE_PPC_USE_PAYMENT_FEES') && EE_PPC_USE_PAYMENT_FEES)
-                || (! defined('EE_PPC_USE_PAYMENT_FEES')
+                || ( ! defined('EE_PPC_USE_PAYMENT_FEES')
                     && $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
                 )
             )
@@ -276,11 +276,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),
         ];
@@ -306,10 +306,10 @@ 
             false,
             $this->transaction
         );
-        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/CaptureOrder.php

Indentation +89 added lines, -89 removed lines

@@ -20,100 +20,100 @@
  */
 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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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(),
-            false,
-            $this->transaction
-        );
-        // 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(),
+			false,
+			$this->transaction
+		);
+		// 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;
+	}
 }

PaymentMethods/PayPalCommerce/api/orders/OrdersApi.php

Indentation +13 added lines, -13 removed lines

@@ -15,21 +15,21 @@
  */
 abstract class OrdersApi
 {
-    protected PayPalApi $api;
+	protected PayPalApi $api;
 
-    protected string $request_url;
+	protected string $request_url;
 
-    protected string $order_id;
+	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/PayPalApi.php

Indentation +61 added lines, -61 removed lines

@@ -15,73 +15,73 @@
  */
 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;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -60,7 +60,7 @@ 
         $response = wp_remote_request($endpoint, $request_parameters);
         // Validate the response.
         $this->inspector->validateResponse($response);
-        if (! $this->inspector->isValid()) {
+        if ( ! $this->inspector->isValid()) {
             PayPalLogger::errorLog($this->inspector->error()['message'], [$endpoint, $request_parameters, $response]);
             return $this->inspector->error();
         }
@@ -68,7 +68,7 @@ 
         $api_response = json_decode($response['body'], true);
         // Validate parameters.
         $this->inspector->validateParameters($api_response);
-        if (! $this->inspector->isValid()) {
+        if ( ! $this->inspector->isValid()) {
             PayPalLogger::errorLog($this->inspector->error()['message'], [$endpoint, $request_parameters, $response]);
             return $this->inspector->error();
         }

PaymentMethods/PayPalCommerce/api/OneTimeString.php

Indentation +39 added lines, -39 removed lines

@@ -14,51 +14,51 @@
  */
 class OneTimeString
 {
-    private string $value;
+	private string $value;
 
 
-    /**
-     *
-     * @param bool $sandbox_mode
-     * @throws Exception
-     */
-    public function __construct(bool $sandbox_mode)
-    {
-        $key_prefix   = $sandbox_mode ? 'sandbox' : 'live';
-        $random_bytes = $this->randomIdentifier();
-        $this->value  = "$key_prefix-$random_bytes";
-    }
+	/**
+	 *
+	 * @param bool $sandbox_mode
+	 * @throws Exception
+	 */
+	public function __construct(bool $sandbox_mode)
+	{
+		$key_prefix   = $sandbox_mode ? 'sandbox' : 'live';
+		$random_bytes = $this->randomIdentifier();
+		$this->value  = "$key_prefix-$random_bytes";
+	}
 
 
-    /**
-     * Create a random string.
-     *
-     * @param int $length
-     * @return string
-     * @throws Exception
-     */
-    private function randomIdentifier(int $length = 50): string
-    {
-        return function_exists('random_bytes')
-            ? bin2hex(random_bytes($length))
-            : bin2hex(openssl_random_pseudo_bytes($length));
-    }
+	/**
+	 * Create a random string.
+	 *
+	 * @param int $length
+	 * @return string
+	 * @throws Exception
+	 */
+	private function randomIdentifier(int $length = 50): string
+	{
+		return function_exists('random_bytes')
+			? bin2hex(random_bytes($length))
+			: bin2hex(openssl_random_pseudo_bytes($length));
+	}
 
 
-    /**
-     * @return string
-     */
-    public function value(): string
-    {
-        return $this->value;
-    }
+	/**
+	 * @return string
+	 */
+	public function value(): string
+	{
+		return $this->value;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function __toString(): string
-    {
-        return $this->value;
-    }
+	/**
+	 * @return string
+	 */
+	public function __toString(): string
+	{
+		return $this->value;
+	}
 }

PaymentMethods/PayPalCommerce/api/FirstPartyPayPalApi.php

Indentation +109 added lines, -109 removed lines

@@ -13,113 +13,113 @@
  */
 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,
-        ];
-        // add default values to incoming headers.
-        $request_parameters['headers'] = $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"),
-        ];
-        // 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,
+		];
+		// add default values to incoming headers.
+		$request_parameters['headers'] = $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"),
+		];
+		// 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;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
             '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"),
+            'Authorization'                 => 'Basic '.base64_encode("$this->client_id:$this->client_secret"),
         ];
         // Add body if this is a POST request.
         if ($body_parameters && ($method === 'POST' || $method === 'PUT')) {

PaymentMethods/PayPalCommerce/tools/extra_meta/PayPalExtraMeta.php

Indentation +186 added lines, -186 removed lines

@@ -18,190 +18,190 @@
  */
 class PayPalExtraMeta
 {
-    public EE_Payment_Method $pm;
-
-    public string $metadata_key;
-
-
-    /**
-     * Class constructor.
-     *
-     * @param EE_Payment_Method $pm_instance
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(EE_Payment_Method $pm_instance)
-    {
-        $this->pm           = $pm_instance;
-        $this->metadata_key = $pm_instance->debug_mode()
-            ? Domain::META_KEY_PAYPAL_DATA_SANDBOX
-            : Domain::META_KEY_PAYPAL_DATA;
-    }
-
-
-    /**
-     * Save/update the provided data to the PM extra meta.
-     *
-     * @param array $data
-     * @return bool
-     */
-    public function saveBatch(array $data): bool
-    {
-        // Update the PM data.
-        try {
-            $paypal_data = $this->getMetaData();
-            $this->saveMetaData(array_replace_recursive($paypal_data, $data));
-        } catch (Exception $e) {
-            PayPalLogger::errorLog(
-                sprintf(
-                    esc_html__('Could not save merchant data. %1$s', 'event_espresso'),
-                    $e->getMessage()
-                ),
-                ['data' => $data, 'trace' => $e->getTrace()],
-                $this->pm
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Get PM extra meta by meta name/option.
-     *
-     * @param string $option_name
-     * @return mixed
-     */
-    public function getOption(string $option_name)
-    {
-        $meta_data = $this->getMetaData();
-        return $meta_data[ $option_name ] ?? false;
-    }
-
-
-    /**
-     * Get PM metadata.
-     * Return the metadata array if all good. False otherwise.
-     *
-     * @return array
-     */
-    public function getMetaData(): array
-    {
-        try {
-            return (array) $this->pm->get_extra_meta($this->metadata_key, true, []);
-        } catch (EE_Error | ReflectionException $e) {
-            PayPalLogger::errorLog(
-                sprintf(
-                    esc_html__('Error getting the PM meta data: %1$s', 'event_espresso'),
-                    $e->getMessage()
-                ),
-                ['trace' => $e->getTrace()],
-                $this->pm
-            );
-            return [];
-        }
-    }
-
-
-    /**
-     * Save/update the provided option to the PM extra meta.
-     *
-     * @param string $name
-     * @param        $value
-     * @return bool
-     */
-    public function saveOption(string $name, $value): bool
-    {
-        $meta_data = $this->getMetaData();
-        if (! $meta_data) {
-            $meta_data = [];
-        }
-        $meta_data[ $name ] = $value;
-        return $this->saveMetaData($meta_data);
-    }
-
-
-    /**
-     * Save/update the PM extra meta.
-     *
-     * @param array $data
-     * @return bool
-     */
-    public function saveMetaData(array $data): bool
-    {
-        try {
-            $this->pm->update_extra_meta($this->metadata_key, $data);
-        } catch (Exception $e) {
-            PayPalLogger::errorLog(
-                sprintf(
-                    esc_html__('Error saving the PM meta data: %1$s', 'event_espresso'),
-                    $e->getMessage()
-                ),
-                ['data' => $data, 'trace' => $e->getTrace()],
-                $this->pm
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Delete PM option.
-     *
-     * @param string $name
-     * @return bool
-     */
-    public function deleteOption(string $name): bool
-    {
-        $meta_data = $this->getMetaData();
-        if (! $meta_data) {
-            return false;
-        }
-        // If the option does not exist, don't bother saving, but return true anyways.
-        if (! isset($meta_data[ $name ])) {
-            return true;
-        }
-        unset($meta_data[ $name ]);
-        return $this->saveMetaData($meta_data);
-    }
-
-
-    /**
-     * Delete all the PM extra meta.
-     *
-     * @return bool
-     */
-    public function deleteAllMetaData(): bool
-    {
-        return $this->deleteMetaData(Domain::META_KEY_PAYPAL_DATA)
-            && $this->deleteMetaData(Domain::META_KEY_PAYPAL_DATA_SANDBOX);
-    }
-
-
-    /**
-     * Delete the PM extra meta.
-     *
-     * @param null $metadata_key
-     * @return bool
-     */
-    public function deleteMetaData($metadata_key = null): bool
-    {
-        try {
-            // Related to PM and sandbox mode metadata (default), or by the provided metadata key?
-            $metadata_key = $metadata_key ?? $this->metadata_key;
-            $this->pm->delete_extra_meta($metadata_key);
-        } catch (Exception $e) {
-            PayPalLogger::errorLog(
-                sprintf(
-                    esc_html__('Error deleting the PM meta data: %1$s', 'event_espresso'),
-                    $e->getMessage()
-                ),
-                ['trace' => $e->getTrace()],
-                $this->pm
-            );
-            return false;
-        }
-        return true;
-    }
+	public EE_Payment_Method $pm;
+
+	public string $metadata_key;
+
+
+	/**
+	 * Class constructor.
+	 *
+	 * @param EE_Payment_Method $pm_instance
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(EE_Payment_Method $pm_instance)
+	{
+		$this->pm           = $pm_instance;
+		$this->metadata_key = $pm_instance->debug_mode()
+			? Domain::META_KEY_PAYPAL_DATA_SANDBOX
+			: Domain::META_KEY_PAYPAL_DATA;
+	}
+
+
+	/**
+	 * Save/update the provided data to the PM extra meta.
+	 *
+	 * @param array $data
+	 * @return bool
+	 */
+	public function saveBatch(array $data): bool
+	{
+		// Update the PM data.
+		try {
+			$paypal_data = $this->getMetaData();
+			$this->saveMetaData(array_replace_recursive($paypal_data, $data));
+		} catch (Exception $e) {
+			PayPalLogger::errorLog(
+				sprintf(
+					esc_html__('Could not save merchant data. %1$s', 'event_espresso'),
+					$e->getMessage()
+				),
+				['data' => $data, 'trace' => $e->getTrace()],
+				$this->pm
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Get PM extra meta by meta name/option.
+	 *
+	 * @param string $option_name
+	 * @return mixed
+	 */
+	public function getOption(string $option_name)
+	{
+		$meta_data = $this->getMetaData();
+		return $meta_data[ $option_name ] ?? false;
+	}
+
+
+	/**
+	 * Get PM metadata.
+	 * Return the metadata array if all good. False otherwise.
+	 *
+	 * @return array
+	 */
+	public function getMetaData(): array
+	{
+		try {
+			return (array) $this->pm->get_extra_meta($this->metadata_key, true, []);
+		} catch (EE_Error | ReflectionException $e) {
+			PayPalLogger::errorLog(
+				sprintf(
+					esc_html__('Error getting the PM meta data: %1$s', 'event_espresso'),
+					$e->getMessage()
+				),
+				['trace' => $e->getTrace()],
+				$this->pm
+			);
+			return [];
+		}
+	}
+
+
+	/**
+	 * Save/update the provided option to the PM extra meta.
+	 *
+	 * @param string $name
+	 * @param        $value
+	 * @return bool
+	 */
+	public function saveOption(string $name, $value): bool
+	{
+		$meta_data = $this->getMetaData();
+		if (! $meta_data) {
+			$meta_data = [];
+		}
+		$meta_data[ $name ] = $value;
+		return $this->saveMetaData($meta_data);
+	}
+
+
+	/**
+	 * Save/update the PM extra meta.
+	 *
+	 * @param array $data
+	 * @return bool
+	 */
+	public function saveMetaData(array $data): bool
+	{
+		try {
+			$this->pm->update_extra_meta($this->metadata_key, $data);
+		} catch (Exception $e) {
+			PayPalLogger::errorLog(
+				sprintf(
+					esc_html__('Error saving the PM meta data: %1$s', 'event_espresso'),
+					$e->getMessage()
+				),
+				['data' => $data, 'trace' => $e->getTrace()],
+				$this->pm
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Delete PM option.
+	 *
+	 * @param string $name
+	 * @return bool
+	 */
+	public function deleteOption(string $name): bool
+	{
+		$meta_data = $this->getMetaData();
+		if (! $meta_data) {
+			return false;
+		}
+		// If the option does not exist, don't bother saving, but return true anyways.
+		if (! isset($meta_data[ $name ])) {
+			return true;
+		}
+		unset($meta_data[ $name ]);
+		return $this->saveMetaData($meta_data);
+	}
+
+
+	/**
+	 * Delete all the PM extra meta.
+	 *
+	 * @return bool
+	 */
+	public function deleteAllMetaData(): bool
+	{
+		return $this->deleteMetaData(Domain::META_KEY_PAYPAL_DATA)
+			&& $this->deleteMetaData(Domain::META_KEY_PAYPAL_DATA_SANDBOX);
+	}
+
+
+	/**
+	 * Delete the PM extra meta.
+	 *
+	 * @param null $metadata_key
+	 * @return bool
+	 */
+	public function deleteMetaData($metadata_key = null): bool
+	{
+		try {
+			// Related to PM and sandbox mode metadata (default), or by the provided metadata key?
+			$metadata_key = $metadata_key ?? $this->metadata_key;
+			$this->pm->delete_extra_meta($metadata_key);
+		} catch (Exception $e) {
+			PayPalLogger::errorLog(
+				sprintf(
+					esc_html__('Error deleting the PM meta data: %1$s', 'event_espresso'),
+					$e->getMessage()
+				),
+				['trace' => $e->getTrace()],
+				$this->pm
+			);
+			return false;
+		}
+		return true;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -75,7 +75,7 @@ 
     public function getOption(string $option_name)
     {
         $meta_data = $this->getMetaData();
-        return $meta_data[ $option_name ] ?? false;
+        return $meta_data[$option_name] ?? false;
     }
 
 
@@ -113,10 +113,10 @@ 
     public function saveOption(string $name, $value): bool
     {
         $meta_data = $this->getMetaData();
-        if (! $meta_data) {
+        if ( ! $meta_data) {
             $meta_data = [];
         }
-        $meta_data[ $name ] = $value;
+        $meta_data[$name] = $value;
         return $this->saveMetaData($meta_data);
     }
 
@@ -155,14 +155,14 @@ 
     public function deleteOption(string $name): bool
     {
         $meta_data = $this->getMetaData();
-        if (! $meta_data) {
+        if ( ! $meta_data) {
             return false;
         }
         // If the option does not exist, don't bother saving, but return true anyways.
-        if (! isset($meta_data[ $name ])) {
+        if ( ! isset($meta_data[$name])) {
             return true;
         }
-        unset($meta_data[ $name ]);
+        unset($meta_data[$name]);
         return $this->saveMetaData($meta_data);
     }
 

PaymentMethods/PayPalCommerce/tools/extra_meta/PayPalExtraMetaManager.php

Indentation +376 added lines, -376 removed lines

@@ -22,380 +22,380 @@
  */
 class PayPalExtraMetaManager
 {
-    private static ?OpenSSLEncryption $encryptor = null;
-
-    private static ?PayPalExtraMeta $pay_pal_extra_meta = null;
-
-
-    /**
-     * Get PayPal extra meta helper.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return PayPalExtraMeta
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function extraMeta(EE_Payment_Method $paypal_pm): PayPalExtraMeta
-    {
-        if (! PayPalExtraMetaManager::$pay_pal_extra_meta instanceof PayPalExtraMeta) {
-            PayPalExtraMetaManager::$pay_pal_extra_meta = new PayPalExtraMeta($paypal_pm);
-        }
-        return PayPalExtraMetaManager::$pay_pal_extra_meta;
-    }
-
-
-    /**
-     * Get OpenSSLEncryption instance.
-     *
-     * @return OpenSSLEncryption
-     */
-    public static function encryptor(): OpenSSLEncryption
-    {
-        if (! PayPalExtraMetaManager::$encryptor instanceof OpenSSLEncryption) {
-            PayPalExtraMetaManager::$encryptor = LoaderFactory::getLoader()->getShared(
-                OpenSSLEncryption::class,
-                [new Base64Encoder()]
-            );
-        }
-        return PayPalExtraMetaManager::$encryptor;
-    }
-
-
-    /**
-     * Get payment method option/extra meta
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $option_name
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getPmOption(EE_Payment_Method $paypal_pm, string $option_name)
-    {
-        $option_value = PayPalExtraMetaManager::extraMeta($paypal_pm)->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 = PayPalExtraMetaManager::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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function savePmOption(EE_Payment_Method $paypal_pm, string $option_name, $option_value): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function savePmOptions(EE_Payment_Method $paypal_pm, array $options_list): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->saveBatch($options_list);
-    }
-
-
-    /**
-     * Delete payment method option/extra meta
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $option_name
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function deletePmOption(EE_Payment_Method $paypal_pm, string $option_name): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteOption($option_name);
-    }
-
-
-    /**
-     * Get all options for payment method.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getAllData(EE_Payment_Method $paypal_pm): array
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->getMetaData();
-    }
-
-
-    /**
-     * Delete payment method metadata.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function deleteData(EE_Payment_Method $paypal_pm): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteMetaData();
-    }
-
-
-    /**
-     * Delete all payment method metadata.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function deleteAllData(EE_Payment_Method $paypal_pm): bool
-    {
-        return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteAllMetaData();
-    }
-
-    /**
-     * Save the debug mode option if it changed.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $request_data
-     * @return bool             Updated or not.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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' => (bool) $request_data['sandbox_mode']]);
-            } catch (EE_Error $e) {
-                PayPalLogger::errorLog(
-                    sprintf(
-                        esc_html__('Note, debug mode not saved ! %1$s', 'event_espresso'),
-                        $e->getMessage()
-                    ),
-                    ['request_data' => $request_data, 'trace' => $e->getTrace()],
-                    $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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function savePartnerAccessToken(EE_Payment_Method $paypal_pm, array $response): bool
-    {
-        $paypal_data         = [];
-        $expected_parameters = [
-            Domain::META_KEY_ACCESS_TOKEN,
-            Domain::META_KEY_TOKEN_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 ] = PayPalExtraMetaManager::encryptString(
-                            $response[ $api_key ],
-                            $paypal_pm
-                        );
-                        break;
-                    case Domain::META_KEY_TOKEN_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 $e) {
-                PayPalLogger::errorLog(
-                    $e->getMessage(),
-                    ['response' => $response, 'trace' => $e->getTrace()],
-                    $paypal_pm
-                );
-                return false;
-            }
-        }
-        return PayPalExtraMetaManager::savePmOptions($paypal_pm, $paypal_data);
-    }
-
-
-    /**
-     * Save merchant/seller API credentials.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $response
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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 PayPalExtraMetaManager::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'])) {
-            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);
-        }
-        // Save the scopes that were authorized.
-        if (! empty($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'])) {
-            $scopes = [];
-            foreach ($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'] as $scope) {
-                // Scope will look like: 'https://uri.paypal.com/services/payments/partnerfee'
-                $split       = explode('/', $scope);
-                $split_count = count($split);
-                // Get the scope itself.
-                $scopes[] = $split[ $split_count - 1 ];
-            }
-            if (empty($scopes)) {
-                // In case the there's a change in how scopes come in just save the list.
-                $scopes = $data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'];
-            }
-            PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_AUTHORIZED_SCOPES, $scopes);
-        }
-        return PayPalExtraMetaManager::savePmOption(
-            $paypal_pm,
-            Domain::META_KEY_ALLOWED_CHECKOUT_TYPE,
-            $allowed_checkout_type
-        );
-    }
-
-
-    /**
-     * Encrypt a text field.
-     *
-     * @param string            $text
-     * @param EE_Payment_Method $paypal_pm
-     * @return string|null
-     * @throws Exception
-     */
-    public static function encryptString(string $text, EE_Payment_Method $paypal_pm): ?string
-    {
-        // We sure we are getting something ?
-        if (! $text) {
-            return $text;
-        }
-
-        try {
-            // Do encrypt.
-            $sanitized_text = sanitize_text_field($text);
-            $key_identifier = $paypal_pm->debug_mode()
-                ? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
-                : PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
-            $encrypted      = PayPalExtraMetaManager::encryptor()->encrypt($sanitized_text, $key_identifier);
-        } catch (Exception $e) {
-            PayPalLogger::errorLog(
-                $e->getMessage(),
-                ['trace' => $e->getTrace()],
-                $paypal_pm
-            );
-        }
-        return $encrypted ?? null;
-    }
-
-
-    /**
-     * 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 {
-            $key_identifier = $paypal_pm->debug_mode()
-                ? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
-                : PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
-            $decrypted      = PayPalExtraMetaManager::encryptor()->decrypt($text, $key_identifier);
-        } catch (Exception $e) {
-            PayPalLogger::errorLog(
-                $e->getMessage(),
-                ['trace' => $e->getTrace()],
-                $paypal_pm
-            );
-            return $text;
-        }
-        return $decrypted ?? $text;
-    }
+	private static ?OpenSSLEncryption $encryptor = null;
+
+	private static ?PayPalExtraMeta $pay_pal_extra_meta = null;
+
+
+	/**
+	 * Get PayPal extra meta helper.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return PayPalExtraMeta
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function extraMeta(EE_Payment_Method $paypal_pm): PayPalExtraMeta
+	{
+		if (! PayPalExtraMetaManager::$pay_pal_extra_meta instanceof PayPalExtraMeta) {
+			PayPalExtraMetaManager::$pay_pal_extra_meta = new PayPalExtraMeta($paypal_pm);
+		}
+		return PayPalExtraMetaManager::$pay_pal_extra_meta;
+	}
+
+
+	/**
+	 * Get OpenSSLEncryption instance.
+	 *
+	 * @return OpenSSLEncryption
+	 */
+	public static function encryptor(): OpenSSLEncryption
+	{
+		if (! PayPalExtraMetaManager::$encryptor instanceof OpenSSLEncryption) {
+			PayPalExtraMetaManager::$encryptor = LoaderFactory::getLoader()->getShared(
+				OpenSSLEncryption::class,
+				[new Base64Encoder()]
+			);
+		}
+		return PayPalExtraMetaManager::$encryptor;
+	}
+
+
+	/**
+	 * Get payment method option/extra meta
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $option_name
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getPmOption(EE_Payment_Method $paypal_pm, string $option_name)
+	{
+		$option_value = PayPalExtraMetaManager::extraMeta($paypal_pm)->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 = PayPalExtraMetaManager::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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function savePmOption(EE_Payment_Method $paypal_pm, string $option_name, $option_value): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function savePmOptions(EE_Payment_Method $paypal_pm, array $options_list): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->saveBatch($options_list);
+	}
+
+
+	/**
+	 * Delete payment method option/extra meta
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $option_name
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function deletePmOption(EE_Payment_Method $paypal_pm, string $option_name): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteOption($option_name);
+	}
+
+
+	/**
+	 * Get all options for payment method.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getAllData(EE_Payment_Method $paypal_pm): array
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->getMetaData();
+	}
+
+
+	/**
+	 * Delete payment method metadata.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function deleteData(EE_Payment_Method $paypal_pm): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteMetaData();
+	}
+
+
+	/**
+	 * Delete all payment method metadata.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function deleteAllData(EE_Payment_Method $paypal_pm): bool
+	{
+		return PayPalExtraMetaManager::extraMeta($paypal_pm)->deleteAllMetaData();
+	}
+
+	/**
+	 * Save the debug mode option if it changed.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $request_data
+	 * @return bool             Updated or not.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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' => (bool) $request_data['sandbox_mode']]);
+			} catch (EE_Error $e) {
+				PayPalLogger::errorLog(
+					sprintf(
+						esc_html__('Note, debug mode not saved ! %1$s', 'event_espresso'),
+						$e->getMessage()
+					),
+					['request_data' => $request_data, 'trace' => $e->getTrace()],
+					$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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function savePartnerAccessToken(EE_Payment_Method $paypal_pm, array $response): bool
+	{
+		$paypal_data         = [];
+		$expected_parameters = [
+			Domain::META_KEY_ACCESS_TOKEN,
+			Domain::META_KEY_TOKEN_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 ] = PayPalExtraMetaManager::encryptString(
+							$response[ $api_key ],
+							$paypal_pm
+						);
+						break;
+					case Domain::META_KEY_TOKEN_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 $e) {
+				PayPalLogger::errorLog(
+					$e->getMessage(),
+					['response' => $response, 'trace' => $e->getTrace()],
+					$paypal_pm
+				);
+				return false;
+			}
+		}
+		return PayPalExtraMetaManager::savePmOptions($paypal_pm, $paypal_data);
+	}
+
+
+	/**
+	 * Save merchant/seller API credentials.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $response
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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 PayPalExtraMetaManager::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'])) {
+			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);
+		}
+		// Save the scopes that were authorized.
+		if (! empty($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'])) {
+			$scopes = [];
+			foreach ($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'] as $scope) {
+				// Scope will look like: 'https://uri.paypal.com/services/payments/partnerfee'
+				$split       = explode('/', $scope);
+				$split_count = count($split);
+				// Get the scope itself.
+				$scopes[] = $split[ $split_count - 1 ];
+			}
+			if (empty($scopes)) {
+				// In case the there's a change in how scopes come in just save the list.
+				$scopes = $data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'];
+			}
+			PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_AUTHORIZED_SCOPES, $scopes);
+		}
+		return PayPalExtraMetaManager::savePmOption(
+			$paypal_pm,
+			Domain::META_KEY_ALLOWED_CHECKOUT_TYPE,
+			$allowed_checkout_type
+		);
+	}
+
+
+	/**
+	 * Encrypt a text field.
+	 *
+	 * @param string            $text
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string|null
+	 * @throws Exception
+	 */
+	public static function encryptString(string $text, EE_Payment_Method $paypal_pm): ?string
+	{
+		// We sure we are getting something ?
+		if (! $text) {
+			return $text;
+		}
+
+		try {
+			// Do encrypt.
+			$sanitized_text = sanitize_text_field($text);
+			$key_identifier = $paypal_pm->debug_mode()
+				? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
+				: PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
+			$encrypted      = PayPalExtraMetaManager::encryptor()->encrypt($sanitized_text, $key_identifier);
+		} catch (Exception $e) {
+			PayPalLogger::errorLog(
+				$e->getMessage(),
+				['trace' => $e->getTrace()],
+				$paypal_pm
+			);
+		}
+		return $encrypted ?? null;
+	}
+
+
+	/**
+	 * 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 {
+			$key_identifier = $paypal_pm->debug_mode()
+				? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
+				: PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
+			$decrypted      = PayPalExtraMetaManager::encryptor()->decrypt($text, $key_identifier);
+		} catch (Exception $e) {
+			PayPalLogger::errorLog(
+				$e->getMessage(),
+				['trace' => $e->getTrace()],
+				$paypal_pm
+			);
+			return $text;
+		}
+		return $decrypted ?? $text;
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -37,7 +37,7 @@ 
      */
     public static function extraMeta(EE_Payment_Method $paypal_pm): PayPalExtraMeta
     {
-        if (! PayPalExtraMetaManager::$pay_pal_extra_meta instanceof PayPalExtraMeta) {
+        if ( ! PayPalExtraMetaManager::$pay_pal_extra_meta instanceof PayPalExtraMeta) {
             PayPalExtraMetaManager::$pay_pal_extra_meta = new PayPalExtraMeta($paypal_pm);
         }
         return PayPalExtraMetaManager::$pay_pal_extra_meta;
@@ -51,7 +51,7 @@ 
      */
     public static function encryptor(): OpenSSLEncryption
     {
-        if (! PayPalExtraMetaManager::$encryptor instanceof OpenSSLEncryption) {
+        if ( ! PayPalExtraMetaManager::$encryptor instanceof OpenSSLEncryption) {
             PayPalExtraMetaManager::$encryptor = LoaderFactory::getLoader()->getShared(
                 OpenSSLEncryption::class,
                 [new Base64Encoder()]
@@ -228,7 +228,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;
             }
@@ -236,16 +236,16 @@ 
                 switch ($api_key) {
                     case Domain::META_KEY_ACCESS_TOKEN:
                     case Domain::META_KEY_PARTNER_MERCHANT_ID:
-                        $paypal_data[ $api_key ] = PayPalExtraMetaManager::encryptString(
-                            $response[ $api_key ],
+                        $paypal_data[$api_key] = PayPalExtraMetaManager::encryptString(
+                            $response[$api_key],
                             $paypal_pm
                         );
                         break;
                     case Domain::META_KEY_TOKEN_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 $e) {
                 PayPalLogger::errorLog(
@@ -274,11 +274,11 @@ 
         $api_credentials     = [];
         $expected_parameters = [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 PayPalExtraMetaManager::savePmOptions($paypal_pm, $api_credentials);
     }
@@ -298,7 +298,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'])) {
+        if ( ! empty($data['response']['products'][0]['name'])) {
             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.
@@ -309,18 +309,18 @@ 
         }
         // 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);
         }
         // Save the scopes that were authorized.
-        if (! empty($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'])) {
+        if ( ! empty($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'])) {
             $scopes = [];
             foreach ($data['response']['oauth_integrations'][0]['oauth_third_party'][0]['scopes'] as $scope) {
                 // Scope will look like: 'https://uri.paypal.com/services/payments/partnerfee'
                 $split       = explode('/', $scope);
                 $split_count = count($split);
                 // Get the scope itself.
-                $scopes[] = $split[ $split_count - 1 ];
+                $scopes[] = $split[$split_count - 1];
             }
             if (empty($scopes)) {
                 // In case the there's a change in how scopes come in just save the list.
@@ -347,7 +347,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;
         }
 
@@ -379,7 +379,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.