eventespresso / event-espresso-core

espresso.php

Indentation +107 added lines, -107 removed lines

@@ -37,138 +37,138 @@
  * @since       4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time.
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time.
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
 <div class="error">
     <p>
         <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
     </p>
 </div>
 <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '7.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '7.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
 <div class="error">
     <p>
         <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="https://www.php.net/downloads.php">https://php.net/downloads.php</a>'
-                    );
-        ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="https://www.php.net/downloads.php">https://php.net/downloads.php</a>'
+					);
+		?>
     </p>
 </div>
 <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
 
-        require_once __DIR__ . '/vendor/autoload.php';
+		require_once __DIR__ . '/vendor/autoload.php';
 
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version(): string
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '5.0.34.rc.000');
-        }
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version(): string
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '5.0.34.rc.000');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-            update_option('event-espresso-core_allow_tracking', 'no');
-            update_option('event-espresso-core_tracking_notice', 'hide');
-            // Run WP GraphQL activation callback
-            espressoLoadWpGraphQL();
-            graphql_activation_callback();
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+			update_option('event-espresso-core_allow_tracking', 'no');
+			update_option('event-espresso-core_tracking_notice', 'hide');
+			// Run WP GraphQL activation callback
+			espressoLoadWpGraphQL();
+			graphql_activation_callback();
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        /**
-         * espresso_plugin_deactivation
-         */
-        function espresso_plugin_deactivation()
-        {
-            // Run WP GraphQL deactivation callback
-            espressoLoadWpGraphQL();
-            graphql_deactivation_callback();
-            delete_option('event-espresso-core_allow_tracking');
-            delete_option('event-espresso-core_tracking_notice');
-        }
-        register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
+		/**
+		 * espresso_plugin_deactivation
+		 */
+		function espresso_plugin_deactivation()
+		{
+			// Run WP GraphQL deactivation callback
+			espressoLoadWpGraphQL();
+			graphql_deactivation_callback();
+			delete_option('event-espresso-core_allow_tracking');
+			delete_option('event-espresso-core_tracking_notice');
+		}
+		register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin(string $plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin(string $plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
 
 
 if (! function_exists('espressoLoadWpGraphQL')) {
-    function espressoLoadWpGraphQL()
-    {
-        if (
-            ! class_exists('WPGraphQL')
-            && is_readable(__DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php')
-        ) {
-            require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
-        }
-    }
+	function espressoLoadWpGraphQL()
+	{
+		if (
+			! class_exists('WPGraphQL')
+			&& is_readable(__DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php')
+		) {
+			require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
+		}
+	}
 }

PaymentMethods/PayPalCommerce/api/orders/CreateOrder.php

Indentation +275 added lines, -275 removed lines

@@ -30,302 +30,302 @@
  */
 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'         => (string) CurrencyManager::normalizeValue($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'         => (string) CurrencyManager::normalizeValue($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)
-        ) {
-            /** @var PartnerPaymentFees $payment_fees */
-            $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)
+		) {
+			/** @var PartnerPaymentFees $payment_fees */
+			$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     = CurrencyManager::normalizeValue($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'         => (string) $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     = CurrencyManager::normalizeValue($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'         => (string) $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'         => (string) $this->items_total,
-        ];
-        $breakdown['tax_total']  = [
-            'currency_code' => $this->currency_code,
-            'value'         => (string) $this->tax_total,
-        ];
-        $breakdown['discount']   = [
-            'currency_code' => $this->currency_code,
-            'value'         => (string) 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'         => (string) $this->items_total,
+		];
+		$breakdown['tax_total']  = [
+			'currency_code' => $this->currency_code,
+			'value'         => (string) $this->tax_total,
+		];
+		$breakdown['discount']   = [
+			'currency_code' => $this->currency_code,
+			'value'         => (string) 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) {
-                error_log("PayPalLogger Error: $message: " . json_encode($response));
-            }
-            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) {
+				error_log("PayPalLogger Error: $message: " . json_encode($response));
+			}
+			return [
+				'error'   => $response['error'] ?? 'missing_order',
+				'message' => $response['message'] ?? $message,
+			];
+		}
+		return $response;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -103,7 +103,7 @@ 
     {
         $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)
                 )
             )
@@ -277,11 +277,11 @@ 
             'currency_code' => $this->currency_code,
             'value'         => (string) $this->items_total,
         ];
-        $breakdown['tax_total']  = [
+        $breakdown['tax_total'] = [
             'currency_code' => $this->currency_code,
             'value'         => (string) $this->tax_total,
         ];
-        $breakdown['discount']   = [
+        $breakdown['discount'] = [
             'currency_code' => $this->currency_code,
             'value'         => (string) abs($this->promos_total),
         ];
@@ -307,10 +307,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(
@@ -319,7 +319,7 @@ 
                     $this->transaction->payment_method()
                 );
             } catch (EE_Error | ReflectionException $e) {
-                error_log("PayPalLogger Error: $message: " . json_encode($response));
+                error_log("PayPalLogger Error: $message: ".json_encode($response));
             }
             return [
                 'error'   => $response['error'] ?? 'missing_order',

PaymentMethods/PayPalCommerce/modules/EED_PayPalCommerce.module.php

Indentation +465 added lines, -465 removed lines

@@ -23,469 +23,469 @@
  */
 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
-            );
-        }
-    }
-
-
-    /**
-     * 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']);
-            // 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
-            );
-        }
-    }
-
-
-    /**
-     * 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();
-        $post_params = EED_Module::getRequest()->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);
-    }
-
-
-    /**
-     * 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'),
-            ];
-        }
-        // Make sure we have a payment method saved.
-        $payment_method = EED_PayPalCommerce::getPaymentMethod();
-        if ($payment_method->ID()) {
-            $transaction->set_payment_method_ID($payment_method->ID());
-        }
-        $order = $create_order_api->create();
-        if (isset($order['error'])) {
-            $last_payment = $transaction->last_payment();
-            if ($last_payment instanceof EE_Payment) {
-                EEG_PayPalCheckout::updatePaymentStatus(
-                    $last_payment,
-                    EEM_Payment::status_id_failed,
-                    $order,
-                    $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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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'),
-            ];
-        }
-        return $capture_order_api->capture();
-    }
-
-
-    /**
-     * Get Order Details using the PP API.
-     *
-     * @param string            $order_id
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment_Method $paypal_pm
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getOrderDetails(
-        string            $order_id,
-        EE_Transaction    $transaction,
-        EE_Payment_Method $paypal_pm
-    ): array {
-        $order_details = EED_PayPalCommerce::getOrderDetailsApi($order_id, $transaction, $paypal_pm);
-        if (! $order_details instanceof OrderDetails) {
-            return [
-                'error'   => 'ORDER_DETAILS_API_FAULT',
-                'message' => esc_html__('Get Order Details API request fault.', 'event_espresso'),
-            ];
-        }
-        return $order_details->get();
-    }
-
-
-    /**
-     * Initialize and return Create Order API.
-     *
-     * @param EE_Transaction    $transaction
-     * @param array             $billing_info
-     * @param EE_Payment_Method $paypal_pm
-     * @return CreateOrder|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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 LoaderFactory::getNew(CreateOrder::class, [$paypal_api, $transaction, $billing_info]);
-    }
-
-
-    /**
-     * Initialize and return Capture Order API.
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $order_id
-     * @return CaptureOrder|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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 LoaderFactory::getNew(CaptureOrder::class, [$paypal_api, $transaction, $order_id]);
-    }
-
-
-    /**
-     * Initialize and return Order Details API.
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $order_id
-     * @return OrderDetails|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getOrderDetailsApi(
-        string $order_id,
-        EE_Transaction $transaction,
-        EE_Payment_Method $paypal_pm
-    ): ?OrderDetails {
-        $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
-            return null;
-        }
-        return LoaderFactory::getNew(OrderDetails::class, [$paypal_api, $order_id, $transaction]);
-    }
-
-
-    /**
-     * 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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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.
-        }
-        $transaction = EED_PayPalCommerce::getTransaction();
-        PayPalLogger::errorLog(
-            "JS Error on transaction: $txn_id",
-            $request->postParams(),
-            $payment_method,
-            false,
-            $transaction
-        );
-    }
-
-
-    /**
-     * Filter the Payment Methods list.
-     * if needed, this filter can also supply the $transaction and $scope parameters.
-     *
-     * @param EE_Payment_Method[] $payment_methods
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function filterPaymentMethods(array $payment_methods): 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
+			);
+		}
+	}
+
+
+	/**
+	 * 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']);
+			// 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
+			);
+		}
+	}
+
+
+	/**
+	 * 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();
+		$post_params = EED_Module::getRequest()->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);
+	}
+
+
+	/**
+	 * 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'),
+			];
+		}
+		// Make sure we have a payment method saved.
+		$payment_method = EED_PayPalCommerce::getPaymentMethod();
+		if ($payment_method->ID()) {
+			$transaction->set_payment_method_ID($payment_method->ID());
+		}
+		$order = $create_order_api->create();
+		if (isset($order['error'])) {
+			$last_payment = $transaction->last_payment();
+			if ($last_payment instanceof EE_Payment) {
+				EEG_PayPalCheckout::updatePaymentStatus(
+					$last_payment,
+					EEM_Payment::status_id_failed,
+					$order,
+					$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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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'),
+			];
+		}
+		return $capture_order_api->capture();
+	}
+
+
+	/**
+	 * Get Order Details using the PP API.
+	 *
+	 * @param string            $order_id
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getOrderDetails(
+		string            $order_id,
+		EE_Transaction    $transaction,
+		EE_Payment_Method $paypal_pm
+	): array {
+		$order_details = EED_PayPalCommerce::getOrderDetailsApi($order_id, $transaction, $paypal_pm);
+		if (! $order_details instanceof OrderDetails) {
+			return [
+				'error'   => 'ORDER_DETAILS_API_FAULT',
+				'message' => esc_html__('Get Order Details API request fault.', 'event_espresso'),
+			];
+		}
+		return $order_details->get();
+	}
+
+
+	/**
+	 * Initialize and return Create Order API.
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param array             $billing_info
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return CreateOrder|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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 LoaderFactory::getNew(CreateOrder::class, [$paypal_api, $transaction, $billing_info]);
+	}
+
+
+	/**
+	 * Initialize and return Capture Order API.
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $order_id
+	 * @return CaptureOrder|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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 LoaderFactory::getNew(CaptureOrder::class, [$paypal_api, $transaction, $order_id]);
+	}
+
+
+	/**
+	 * Initialize and return Order Details API.
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $order_id
+	 * @return OrderDetails|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getOrderDetailsApi(
+		string $order_id,
+		EE_Transaction $transaction,
+		EE_Payment_Method $paypal_pm
+	): ?OrderDetails {
+		$paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
+		if (! $paypal_api instanceof PayPalApi) {
+			return null;
+		}
+		return LoaderFactory::getNew(OrderDetails::class, [$paypal_api, $order_id, $transaction]);
+	}
+
+
+	/**
+	 * 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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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.
+		}
+		$transaction = EED_PayPalCommerce::getTransaction();
+		PayPalLogger::errorLog(
+			"JS Error on transaction: $txn_id",
+			$request->postParams(),
+			$payment_method,
+			false,
+			$transaction
+		);
+	}
+
+
+	/**
+	 * Filter the Payment Methods list.
+	 * if needed, this filter can also supply the $transaction and $scope parameters.
+	 *
+	 * @param EE_Payment_Method[] $payment_methods
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function filterPaymentMethods(array $payment_methods): 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;
+	}
 }

PaymentMethods/PayPalCommerce/PayPalCheckout/EEG_PayPalCheckout.gateway.php

Indentation +295 added lines, -295 removed lines

@@ -13,310 +13,310 @@
  */
 class EEG_PayPalCheckout extends EE_Onsite_Gateway
 {
-    /**
-     * Currencies supported by this gateway.
-     *
-     * @var array
-     */
-    protected $_currencies_supported = [
-        'AUD',
-        'BRL',
-        'CAD',
-        'CNY',
-        'CZK',
-        'DKK',
-        'EUR',
-        'HKD',
-        'HUF',
-        'ILS',
-        'JPY',
-        'MYR',
-        'MXN',
-        'TWD',
-        'NZD',
-        'NOK',
-        'PHP',
-        'PLN',
-        'GBP',
-        'RUB',
-        'SGD',
-        'SEK',
-        'CHF',
-        'THB',
-        'USD',
-    ];
+	/**
+	 * Currencies supported by this gateway.
+	 *
+	 * @var array
+	 */
+	protected $_currencies_supported = [
+		'AUD',
+		'BRL',
+		'CAD',
+		'CNY',
+		'CZK',
+		'DKK',
+		'EUR',
+		'HKD',
+		'HUF',
+		'ILS',
+		'JPY',
+		'MYR',
+		'MXN',
+		'TWD',
+		'NZD',
+		'NOK',
+		'PHP',
+		'PLN',
+		'GBP',
+		'RUB',
+		'SGD',
+		'SEK',
+		'CHF',
+		'THB',
+		'USD',
+	];
 
 
-    /**
-     * Override the parent.
-     *
-     * @param EE_Payment|null $payment
-     * @param array|null      $billing_info
-     * @return EE_Payment
-     * @throws EE_Error|ReflectionException
-     */
-    public function do_direct_payment($payment, $billing_info = null)
-    {
-        $request         = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $post_parameters = $request->postParams();
-        // Check the payment.
-        $payment = $this->validatePayment($payment, $request);
-        if ($payment->details() === 'error' && $payment->status() === EEM_Payment::status_id_failed) {
-            return $payment;
-        }
-        $transaction    = $payment->transaction();
-        $payment_method = $transaction->payment_method();
-        // Get the order details.
-        $order_id = $request->getRequestParam('pp_order_id');
-        if (! $order_id) {
-            return EEG_PayPalCheckout::updatePaymentStatus(
-                $payment,
-                EEM_Payment::status_id_declined,
-                $post_parameters,
-                esc_html__('Can\'t charge the Order. The Order ID is missing.', 'event_espresso')
-            );
-        }
-        // Capture the order.
-        $capture_status = EED_PayPalCommerce::captureOrder($transaction, $payment_method, $order_id);
-        // Check the order status.
-        $order_status   = $this->isOrderCompleted($order_id, $transaction, $payment_method);
-        if (! $order_status['completed']) {
-            return EEG_PayPalCheckout::updatePaymentStatus(
-                $payment,
-                EEM_Payment::status_id_declined,
-                $order_status,
-                $order_status['message'] ?? ''
-            );
-        }
-        // Looks like all is good. Mark payment as a success.
-        $this->saveBillingDetails($payment, $transaction, $order_status['details'], $billing_info);
-        return EEG_PayPalCheckout::updatePaymentStatus($payment, EEM_Payment::status_id_approved, $capture_status);
-    }
+	/**
+	 * Override the parent.
+	 *
+	 * @param EE_Payment|null $payment
+	 * @param array|null      $billing_info
+	 * @return EE_Payment
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function do_direct_payment($payment, $billing_info = null)
+	{
+		$request         = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$post_parameters = $request->postParams();
+		// Check the payment.
+		$payment = $this->validatePayment($payment, $request);
+		if ($payment->details() === 'error' && $payment->status() === EEM_Payment::status_id_failed) {
+			return $payment;
+		}
+		$transaction    = $payment->transaction();
+		$payment_method = $transaction->payment_method();
+		// Get the order details.
+		$order_id = $request->getRequestParam('pp_order_id');
+		if (! $order_id) {
+			return EEG_PayPalCheckout::updatePaymentStatus(
+				$payment,
+				EEM_Payment::status_id_declined,
+				$post_parameters,
+				esc_html__('Can\'t charge the Order. The Order ID is missing.', 'event_espresso')
+			);
+		}
+		// Capture the order.
+		$capture_status = EED_PayPalCommerce::captureOrder($transaction, $payment_method, $order_id);
+		// Check the order status.
+		$order_status   = $this->isOrderCompleted($order_id, $transaction, $payment_method);
+		if (! $order_status['completed']) {
+			return EEG_PayPalCheckout::updatePaymentStatus(
+				$payment,
+				EEM_Payment::status_id_declined,
+				$order_status,
+				$order_status['message'] ?? ''
+			);
+		}
+		// Looks like all is good. Mark payment as a success.
+		$this->saveBillingDetails($payment, $transaction, $order_status['details'], $billing_info);
+		return EEG_PayPalCheckout::updatePaymentStatus($payment, EEM_Payment::status_id_approved, $capture_status);
+	}
 
 
-    /**
-     * Validate the Order.
-     *
-     * @param string            $order_id
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment_Method $payment_method
-     * @return array ['completed' => {boolean}, 'message' => {string}]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function isOrderCompleted(
-        string $order_id,
-        EE_Transaction $transaction,
-        EE_Payment_Method $payment_method
-    ): array
-    {
-        $order_details = EED_PayPalCommerce::getOrderDetails($order_id, $transaction, $payment_method);
-        $conclusion = [
-            'completed' => false,
-            'details'   => $order_details,
-        ];
-        if (! $order_details) {
-            $conclusion['message'] = esc_html__(
-                'Could not validate this payment. The Order details were empty.',
-                'event_espresso'
-            );
-        } elseif (! empty($order_details['error'])) {
-            $conclusion['message'] = $order_details['message'] ?? $order_details['error'];
-        } elseif (empty($order_details['status'])) {
-            $conclusion['message'] = esc_html__(
-                'There was an error with this payment. The status of the Order could not be determined.',
-                'event_espresso'
-            );
-        } elseif ($order_details['status'] !== 'COMPLETED') {
-            $conclusion['message'] = esc_html__(
-                'There was an error with this payment. Order was not approved.',
-                'event_espresso'
-            );
-        } elseif (empty($order_details['purchase_units'][0]['payments']['captures'][0]['status'])) {
-            $conclusion['message'] = esc_html__(
-                'There was an error with this payment. The status of the Payment could not be determined.',
-                'event_espresso'
-            );
-        } elseif ($order_details['purchase_units'][0]['payments']['captures'][0]['status'] !== 'COMPLETED') {
-            $conclusion['message'] = esc_html__(
-                'This payment was declined or failed validation. Please check the billing information you provided.',
-                'event_espresso'
-            );
-        } else {
-            // If we didn't fail on the above, the Order should be considered valid.
-            $conclusion['completed'] = true;
-            $conclusion['message']   = esc_html__('Order Valid.', 'event_espresso');
-        }
-        return $conclusion;
-    }
+	/**
+	 * Validate the Order.
+	 *
+	 * @param string            $order_id
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment_Method $payment_method
+	 * @return array ['completed' => {boolean}, 'message' => {string}]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function isOrderCompleted(
+		string $order_id,
+		EE_Transaction $transaction,
+		EE_Payment_Method $payment_method
+	): array
+	{
+		$order_details = EED_PayPalCommerce::getOrderDetails($order_id, $transaction, $payment_method);
+		$conclusion = [
+			'completed' => false,
+			'details'   => $order_details,
+		];
+		if (! $order_details) {
+			$conclusion['message'] = esc_html__(
+				'Could not validate this payment. The Order details were empty.',
+				'event_espresso'
+			);
+		} elseif (! empty($order_details['error'])) {
+			$conclusion['message'] = $order_details['message'] ?? $order_details['error'];
+		} elseif (empty($order_details['status'])) {
+			$conclusion['message'] = esc_html__(
+				'There was an error with this payment. The status of the Order could not be determined.',
+				'event_espresso'
+			);
+		} elseif ($order_details['status'] !== 'COMPLETED') {
+			$conclusion['message'] = esc_html__(
+				'There was an error with this payment. Order was not approved.',
+				'event_espresso'
+			);
+		} elseif (empty($order_details['purchase_units'][0]['payments']['captures'][0]['status'])) {
+			$conclusion['message'] = esc_html__(
+				'There was an error with this payment. The status of the Payment could not be determined.',
+				'event_espresso'
+			);
+		} elseif ($order_details['purchase_units'][0]['payments']['captures'][0]['status'] !== 'COMPLETED') {
+			$conclusion['message'] = esc_html__(
+				'This payment was declined or failed validation. Please check the billing information you provided.',
+				'event_espresso'
+			);
+		} else {
+			// If we didn't fail on the above, the Order should be considered valid.
+			$conclusion['completed'] = true;
+			$conclusion['message']   = esc_html__('Order Valid.', 'event_espresso');
+		}
+		return $conclusion;
+	}
 
 
-    /**
-     * Set a payment error and log the data.
-     *
-     * @param EE_Payment   $payment
-     * @param string       $status
-     * @param array|string $response_data
-     * @param string       $update_message
-     * @return EE_Payment
-     * @throws EE_Error|ReflectionException
-     */
-    public static function updatePaymentStatus(
-        EE_Payment $payment,
-        string $status,
-        $response_data,
-        string $update_message = ''
-    ): EE_Payment {
-        $paypal_pm = ! empty($payment->payment_method())
-            ? EEM_Payment_Method::instance()->get_one_by_slug($payment->payment_method()->name())
-            : null;
-        // Is this a successful payment ?
-        if ($status === EEM_Payment::status_id_approved) {
-            $default_message = esc_html__('Successful payment.', 'event_espresso');
-            $amount          = $response_data['purchase_units'][0]['payments']['captures'][0]['amount']['value'] ?? 0;
-            // Don't set the amount if there is no info on that with this order.
-            if (! empty($amount)) {
-                $payment->set_amount((float) $amount);
-            }
-            $payment->set_txn_id_chq_nmbr(
-                $response_data['purchase_units'][0]['payments']['captures'][0]['id'] ?? $response_data['id']
-            );
-        } else {
-            $default_message = sprintf(
-                esc_html__(
-                    'Your payment could not be processed successfully due to a technical issue.%1$sPlease try again or contact%2$s for assistance.',
-                    'event_espresso'
-                ),
-                '<br/>',
-                EE_Registry::instance()->CFG->organization->get_pretty('email')
-            );
-        }
-        $log_message = $update_message ?: $default_message;
-        PayPalLogger::errorLog($log_message, $response_data, $paypal_pm, false, $payment->transaction());
-        $payment->set_status($status);
-        $payment->set_details($log_message);
-        $payment->set_gateway_response($log_message);
-        $payment->save();
-        return $payment;
-    }
+	/**
+	 * Set a payment error and log the data.
+	 *
+	 * @param EE_Payment   $payment
+	 * @param string       $status
+	 * @param array|string $response_data
+	 * @param string       $update_message
+	 * @return EE_Payment
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function updatePaymentStatus(
+		EE_Payment $payment,
+		string $status,
+		$response_data,
+		string $update_message = ''
+	): EE_Payment {
+		$paypal_pm = ! empty($payment->payment_method())
+			? EEM_Payment_Method::instance()->get_one_by_slug($payment->payment_method()->name())
+			: null;
+		// Is this a successful payment ?
+		if ($status === EEM_Payment::status_id_approved) {
+			$default_message = esc_html__('Successful payment.', 'event_espresso');
+			$amount          = $response_data['purchase_units'][0]['payments']['captures'][0]['amount']['value'] ?? 0;
+			// Don't set the amount if there is no info on that with this order.
+			if (! empty($amount)) {
+				$payment->set_amount((float) $amount);
+			}
+			$payment->set_txn_id_chq_nmbr(
+				$response_data['purchase_units'][0]['payments']['captures'][0]['id'] ?? $response_data['id']
+			);
+		} else {
+			$default_message = sprintf(
+				esc_html__(
+					'Your payment could not be processed successfully due to a technical issue.%1$sPlease try again or contact%2$s for assistance.',
+					'event_espresso'
+				),
+				'<br/>',
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
+			);
+		}
+		$log_message = $update_message ?: $default_message;
+		PayPalLogger::errorLog($log_message, $response_data, $paypal_pm, false, $payment->transaction());
+		$payment->set_status($status);
+		$payment->set_details($log_message);
+		$payment->set_gateway_response($log_message);
+		$payment->save();
+		return $payment;
+	}
 
 
-    /**
-     * Validate the payment.
-     *
-     * @param EE_Payment|null  $payment
-     * @param RequestInterface $request
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function validatePayment(?EE_Payment $payment, RequestInterface $request): EE_Payment
-    {
-        $failed_status = $this->_pay_model->failed_status();
-        // Check the payment.
-        if (! $payment instanceof EE_Payment) {
-            $payment       = EE_Payment::new_instance();
-            $error_message = esc_html__('Error. No associated payment was found.', 'event_espresso');
-            return EEG_PayPalCheckout::updatePaymentStatus(
-                $payment,
-                $failed_status,
-                $request->postParams(),
-                $error_message
-            );
-        }
-        // Check the transaction.
-        $transaction = $payment->transaction();
-        if (! $transaction instanceof EE_Transaction) {
-            $error_message = esc_html__(
-                'Could not process this payment because it has no associated transaction.',
-                'event_espresso'
-            );
-            return EEG_PayPalCheckout::updatePaymentStatus(
-                $payment,
-                $failed_status,
-                $request->postParams(),
-                $error_message
-            );
-        }
-        return $payment;
-    }
+	/**
+	 * Validate the payment.
+	 *
+	 * @param EE_Payment|null  $payment
+	 * @param RequestInterface $request
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function validatePayment(?EE_Payment $payment, RequestInterface $request): EE_Payment
+	{
+		$failed_status = $this->_pay_model->failed_status();
+		// Check the payment.
+		if (! $payment instanceof EE_Payment) {
+			$payment       = EE_Payment::new_instance();
+			$error_message = esc_html__('Error. No associated payment was found.', 'event_espresso');
+			return EEG_PayPalCheckout::updatePaymentStatus(
+				$payment,
+				$failed_status,
+				$request->postParams(),
+				$error_message
+			);
+		}
+		// Check the transaction.
+		$transaction = $payment->transaction();
+		if (! $transaction instanceof EE_Transaction) {
+			$error_message = esc_html__(
+				'Could not process this payment because it has no associated transaction.',
+				'event_espresso'
+			);
+			return EEG_PayPalCheckout::updatePaymentStatus(
+				$payment,
+				$failed_status,
+				$request->postParams(),
+				$error_message
+			);
+		}
+		return $payment;
+	}
 
 
-    /**
-     * Save some transaction details, like billing information.
-     *
-     * @param EE_Payment     $payment
-     * @param EE_Transaction $transaction
-     * @param array          $order
-     * @param array          $billing
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function saveBillingDetails(
-        EE_Payment $payment,
-        EE_Transaction $transaction,
-        array $order,
-        array $billing
-    ): void {
-        $primary_reg = $transaction->primary_registration();
-        $att    = $primary_reg instanceof EE_Registration ? $primary_reg->attendee() : null;
-        if (! $att instanceof EE_Attendee) {
-            // I guess we are done here then. Just save what we have.
-            $payment->set_details($order);
-            return;
-        }
-        // Defaults:
-        $billing['credit_card'] = 'empty';
-        $billing['first_name']  = empty($billing['first_name']) ? ($att->fname() ?: 'empty') : $billing['first_name'];
-        $billing['last_name']   = empty($billing['last_name']) ? ($att->lname() ?: 'empty') : $billing['last_name'];
-        $billing['email']       = empty($billing['email']) ? ($att->email() ?: 'empty') : $billing['email'];
-        $billing['country']     = empty($billing['country']) ? ($att->country() ?: 'empty') : $billing['country'];
-        $billing['city']        = empty($billing['city']) ? ($att->city() ?: 'empty') : $billing['city'];
-        $billing['state']       = empty($billing['state']) ? ($att->state_name() ?: 'empty') : $billing['state'];
-        $billing['address']     = empty($billing['address']) ? ($att->address() ?: 'empty') : $billing['address'];
-        $billing['address2']    = empty($billing['address2']) ? ($att->address2() ?: 'empty') : $billing['address2'];
-        $billing['zip']         = empty($billing['zip']) ? ($att->zip() ?: 'empty') : $billing['zip'];
-        $billing['phone']       = empty($billing['phone']) ? ($att->phone() ?: 'empty') : $billing['phone'];
+	/**
+	 * Save some transaction details, like billing information.
+	 *
+	 * @param EE_Payment     $payment
+	 * @param EE_Transaction $transaction
+	 * @param array          $order
+	 * @param array          $billing
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function saveBillingDetails(
+		EE_Payment $payment,
+		EE_Transaction $transaction,
+		array $order,
+		array $billing
+	): void {
+		$primary_reg = $transaction->primary_registration();
+		$att    = $primary_reg instanceof EE_Registration ? $primary_reg->attendee() : null;
+		if (! $att instanceof EE_Attendee) {
+			// I guess we are done here then. Just save what we have.
+			$payment->set_details($order);
+			return;
+		}
+		// Defaults:
+		$billing['credit_card'] = 'empty';
+		$billing['first_name']  = empty($billing['first_name']) ? ($att->fname() ?: 'empty') : $billing['first_name'];
+		$billing['last_name']   = empty($billing['last_name']) ? ($att->lname() ?: 'empty') : $billing['last_name'];
+		$billing['email']       = empty($billing['email']) ? ($att->email() ?: 'empty') : $billing['email'];
+		$billing['country']     = empty($billing['country']) ? ($att->country() ?: 'empty') : $billing['country'];
+		$billing['city']        = empty($billing['city']) ? ($att->city() ?: 'empty') : $billing['city'];
+		$billing['state']       = empty($billing['state']) ? ($att->state_name() ?: 'empty') : $billing['state'];
+		$billing['address']     = empty($billing['address']) ? ($att->address() ?: 'empty') : $billing['address'];
+		$billing['address2']    = empty($billing['address2']) ? ($att->address2() ?: 'empty') : $billing['address2'];
+		$billing['zip']         = empty($billing['zip']) ? ($att->zip() ?: 'empty') : $billing['zip'];
+		$billing['phone']       = empty($billing['phone']) ? ($att->phone() ?: 'empty') : $billing['phone'];
 
-        // Try getting the payer information from the payment source (PayPal).
-        if (! empty($order['payment_source'])) {
-            // A card (ACDC) payment ?
-            if (! empty($order['payment_source']['card'])) {
-                $payer = $order['payment_source']['card'];
-            // Or maybe a PayPal Express payment ?
-            } elseif (! empty($order['payment_source']['paypal'])) {
-                $payer = $order['payment_source']['paypal'];
-            }
-            if (! empty($payer)) {
-                if (! empty($payer['name'])) {
-                    // Yup, payment_source card vs PayPal have different info about the payer. So need to differentiate.
-                    if (is_string($payer['name'])) {
-                        $full_name                  = explode(' ', $payer['name']);
-                        $billing['first_name'] = $full_name[0] ?? $billing['first_name'];
-                        $billing['last_name']  = $full_name[1] ?? $billing['last_name'];
-                    }
-                    // PayPal info on the Payment:
-                    if (is_array($payer['name'])) {
-                        $billing['first_name'] = $payer['name']['given_name'] ?? $billing['first_name'];
-                        $billing['last_name']  = $payer['name']['surname'] ?? $billing['last_name'];
-                    }
-                }
-                // Possible info on the payer.
-                $billing['credit_card'] = $payer['last_digits'] ?? $billing['credit_card'];
-                $billing['email']       = $payer['email_address'] ?? $billing['email'];
-                $billing['country']     = $payer['address']['country_code'] ?? $billing['country'];
-                $billing['city']        = $payer['address']['city'] ?? $billing['city'];
-                $billing['state']       = $payer['address']['state'] ?? $billing['state'];
-                $billing['address']     = $payer['address']['address'] ?? $billing['address'];
-                $billing['zip']         = $payer['address']['zip'] ?? $billing['zip'];
-            }
-        }
-        // Update attendee billing info in the transaction details.
-        $payment_method = $transaction->payment_method();
-        $post_meta_name = $payment_method->type_obj() instanceof EE_PMT_Base
-            ? 'billing_info_' . $payment_method->type_obj()->system_name()
-            : '';
-        update_post_meta($att->ID(), $post_meta_name, $billing);
-    }
+		// Try getting the payer information from the payment source (PayPal).
+		if (! empty($order['payment_source'])) {
+			// A card (ACDC) payment ?
+			if (! empty($order['payment_source']['card'])) {
+				$payer = $order['payment_source']['card'];
+			// Or maybe a PayPal Express payment ?
+			} elseif (! empty($order['payment_source']['paypal'])) {
+				$payer = $order['payment_source']['paypal'];
+			}
+			if (! empty($payer)) {
+				if (! empty($payer['name'])) {
+					// Yup, payment_source card vs PayPal have different info about the payer. So need to differentiate.
+					if (is_string($payer['name'])) {
+						$full_name                  = explode(' ', $payer['name']);
+						$billing['first_name'] = $full_name[0] ?? $billing['first_name'];
+						$billing['last_name']  = $full_name[1] ?? $billing['last_name'];
+					}
+					// PayPal info on the Payment:
+					if (is_array($payer['name'])) {
+						$billing['first_name'] = $payer['name']['given_name'] ?? $billing['first_name'];
+						$billing['last_name']  = $payer['name']['surname'] ?? $billing['last_name'];
+					}
+				}
+				// Possible info on the payer.
+				$billing['credit_card'] = $payer['last_digits'] ?? $billing['credit_card'];
+				$billing['email']       = $payer['email_address'] ?? $billing['email'];
+				$billing['country']     = $payer['address']['country_code'] ?? $billing['country'];
+				$billing['city']        = $payer['address']['city'] ?? $billing['city'];
+				$billing['state']       = $payer['address']['state'] ?? $billing['state'];
+				$billing['address']     = $payer['address']['address'] ?? $billing['address'];
+				$billing['zip']         = $payer['address']['zip'] ?? $billing['zip'];
+			}
+		}
+		// Update attendee billing info in the transaction details.
+		$payment_method = $transaction->payment_method();
+		$post_meta_name = $payment_method->type_obj() instanceof EE_PMT_Base
+			? 'billing_info_' . $payment_method->type_obj()->system_name()
+			: '';
+		update_post_meta($att->ID(), $post_meta_name, $billing);
+	}
 }

Spacing +16 added lines, -16 removed lines

@@ -68,7 +68,7 @@ 
         $payment_method = $transaction->payment_method();
         // Get the order details.
         $order_id = $request->getRequestParam('pp_order_id');
-        if (! $order_id) {
+        if ( ! $order_id) {
             return EEG_PayPalCheckout::updatePaymentStatus(
                 $payment,
                 EEM_Payment::status_id_declined,
@@ -80,7 +80,7 @@ 
         $capture_status = EED_PayPalCommerce::captureOrder($transaction, $payment_method, $order_id);
         // Check the order status.
         $order_status   = $this->isOrderCompleted($order_id, $transaction, $payment_method);
-        if (! $order_status['completed']) {
+        if ( ! $order_status['completed']) {
             return EEG_PayPalCheckout::updatePaymentStatus(
                 $payment,
                 EEM_Payment::status_id_declined,
@@ -115,12 +115,12 @@ 
             'completed' => false,
             'details'   => $order_details,
         ];
-        if (! $order_details) {
+        if ( ! $order_details) {
             $conclusion['message'] = esc_html__(
                 'Could not validate this payment. The Order details were empty.',
                 'event_espresso'
             );
-        } elseif (! empty($order_details['error'])) {
+        } elseif ( ! empty($order_details['error'])) {
             $conclusion['message'] = $order_details['message'] ?? $order_details['error'];
         } elseif (empty($order_details['status'])) {
             $conclusion['message'] = esc_html__(
@@ -175,7 +175,7 @@ 
             $default_message = esc_html__('Successful payment.', 'event_espresso');
             $amount          = $response_data['purchase_units'][0]['payments']['captures'][0]['amount']['value'] ?? 0;
             // Don't set the amount if there is no info on that with this order.
-            if (! empty($amount)) {
+            if ( ! empty($amount)) {
                 $payment->set_amount((float) $amount);
             }
             $payment->set_txn_id_chq_nmbr(
@@ -214,7 +214,7 @@ 
     {
         $failed_status = $this->_pay_model->failed_status();
         // Check the payment.
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             $payment       = EE_Payment::new_instance();
             $error_message = esc_html__('Error. No associated payment was found.', 'event_espresso');
             return EEG_PayPalCheckout::updatePaymentStatus(
@@ -226,7 +226,7 @@ 
         }
         // Check the transaction.
         $transaction = $payment->transaction();
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             $error_message = esc_html__(
                 'Could not process this payment because it has no associated transaction.',
                 'event_espresso'
@@ -260,8 +260,8 @@ 
         array $billing
     ): void {
         $primary_reg = $transaction->primary_registration();
-        $att    = $primary_reg instanceof EE_Registration ? $primary_reg->attendee() : null;
-        if (! $att instanceof EE_Attendee) {
+        $att = $primary_reg instanceof EE_Registration ? $primary_reg->attendee() : null;
+        if ( ! $att instanceof EE_Attendee) {
             // I guess we are done here then. Just save what we have.
             $payment->set_details($order);
             return;
@@ -280,19 +280,19 @@ 
         $billing['phone']       = empty($billing['phone']) ? ($att->phone() ?: 'empty') : $billing['phone'];
 
         // Try getting the payer information from the payment source (PayPal).
-        if (! empty($order['payment_source'])) {
+        if ( ! empty($order['payment_source'])) {
             // A card (ACDC) payment ?
-            if (! empty($order['payment_source']['card'])) {
+            if ( ! empty($order['payment_source']['card'])) {
                 $payer = $order['payment_source']['card'];
             // Or maybe a PayPal Express payment ?
-            } elseif (! empty($order['payment_source']['paypal'])) {
+            } elseif ( ! empty($order['payment_source']['paypal'])) {
                 $payer = $order['payment_source']['paypal'];
             }
-            if (! empty($payer)) {
-                if (! empty($payer['name'])) {
+            if ( ! empty($payer)) {
+                if ( ! empty($payer['name'])) {
                     // Yup, payment_source card vs PayPal have different info about the payer. So need to differentiate.
                     if (is_string($payer['name'])) {
-                        $full_name                  = explode(' ', $payer['name']);
+                        $full_name = explode(' ', $payer['name']);
                         $billing['first_name'] = $full_name[0] ?? $billing['first_name'];
                         $billing['last_name']  = $full_name[1] ?? $billing['last_name'];
                     }
@@ -315,7 +315,7 @@ 
         // Update attendee billing info in the transaction details.
         $payment_method = $transaction->payment_method();
         $post_meta_name = $payment_method->type_obj() instanceof EE_PMT_Base
-            ? 'billing_info_' . $payment_method->type_obj()->system_name()
+            ? 'billing_info_'.$payment_method->type_obj()->system_name()
             : '';
         update_post_meta($att->ID(), $post_meta_name, $billing);
     }

PaymentMethods/PayPalCommerce/tools/currency/CurrencyManager.php

Indentation +58 added lines, -58 removed lines

@@ -13,66 +13,66 @@
  */
 class CurrencyManager
 {
-    /**
-     * Gets the number of decimal places we expect a currency to have.
-     *
-     * @param string $currency Accepted currency.
-     * @return int
-     */
-    public static function getDecimalPlaces(string $currency = ''): int
-    {
-        if (! $currency) {
-            $currency = self::currencyCode();
-        }
-        switch (strtoupper($currency)) {
-            // Zero decimal currencies.
-            case 'BIF':
-            case 'CLP':
-            case 'DJF':
-            case 'GNF':
-            case 'JPY':
-            case 'KMF':
-            case 'KRW':
-            case 'MGA':
-            case 'PYG':
-            case 'RWF':
-            case 'UGX':
-            case 'VND':
-            case 'VUV':
-            case 'XAF':
-            case 'XOF':
-            case 'XPF':
-                return 0;
-            default:
-                return 2;
-        }
-    }
+	/**
+	 * Gets the number of decimal places we expect a currency to have.
+	 *
+	 * @param string $currency Accepted currency.
+	 * @return int
+	 */
+	public static function getDecimalPlaces(string $currency = ''): int
+	{
+		if (! $currency) {
+			$currency = self::currencyCode();
+		}
+		switch (strtoupper($currency)) {
+			// Zero decimal currencies.
+			case 'BIF':
+			case 'CLP':
+			case 'DJF':
+			case 'GNF':
+			case 'JPY':
+			case 'KMF':
+			case 'KRW':
+			case 'MGA':
+			case 'PYG':
+			case 'RWF':
+			case 'UGX':
+			case 'VND':
+			case 'VUV':
+			case 'XAF':
+			case 'XOF':
+			case 'XPF':
+				return 0;
+			default:
+				return 2;
+		}
+	}
 
 
-    /**
-     * Make sure the value is an absolute number with only two decimal places.
-     *
-     * @param float $amount
-     * @return float
-     */
-    public static function normalizeValue(float $amount): float
-    {
-        // Make sure we get a positive value.
-        // Don't use abs() because of the possible issues with rounding if 'serialize_precision' is not set to -1.
-        if ($amount < 0) {
-            $amount = $amount * -1;
-        }
-        return number_format($amount, self::getDecimalPlaces(), '.', '');
-    }
+	/**
+	 * Make sure the value is an absolute number with only two decimal places.
+	 *
+	 * @param float $amount
+	 * @return float
+	 */
+	public static function normalizeValue(float $amount): float
+	{
+		// Make sure we get a positive value.
+		// Don't use abs() because of the possible issues with rounding if 'serialize_precision' is not set to -1.
+		if ($amount < 0) {
+			$amount = $amount * -1;
+		}
+		return number_format($amount, self::getDecimalPlaces(), '.', '');
+	}
 
 
-    /**
-     * Get currency that's currently set in Event Espresso settings.
-     *
-     * @return string
-     */
-    public static function currencyCode(): string
-    {
-        return EE_Registry::instance()->CFG->currency->code;
-    }
+	/**
+	 * Get currency that's currently set in Event Espresso settings.
+	 *
+	 * @return string
+	 */
+	public static function currencyCode(): string
+	{
+		return EE_Registry::instance()->CFG->currency->code;
+	}
 }