eventespresso / event-espresso-core

core/services/payments/RegistrationPayments.php

Indentation +160 added lines, -160 removed lines

@@ -23,174 +23,174 @@
 class RegistrationPayments
 {
 
-    /**
-     * update registrations REG_paid field after successful payment and link registrations with payment
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment        $payment
-     * @param EE_Registration[] $registrations
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function processRegistrationPayments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        array $registrations = []
-    ) {
-        // only process if payment was successful
-        if ($payment->status() !== EEM_Payment::status_id_approved) {
-            return;
-        }
-        $registrations = $this->loadRegistrationsIfMissing($transaction, $registrations);
-        // still nothing ??!??
-        if (empty($registrations)) {
-            return;
-        }
-        // todo: break out the following logic into a separate strategy class
-        // todo: named something like "Sequential_Reg_Payment_Strategy"
-        // todo: which would apply payments using the capitalist "first come first paid" approach
-        // todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
-        // todo: which would be the socialist "everybody gets a piece of pie" approach,
-        // todo: which would be better for deposits, where you want a bit of the payment applied to each registration
-        $available_payment_amount = $this->sequentialRegPaymentStrategy($payment, $registrations);
-        $this->remainderNotice($payment, $available_payment_amount, $registrations);
-    }
+	/**
+	 * update registrations REG_paid field after successful payment and link registrations with payment
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment        $payment
+	 * @param EE_Registration[] $registrations
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function processRegistrationPayments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		array $registrations = []
+	) {
+		// only process if payment was successful
+		if ($payment->status() !== EEM_Payment::status_id_approved) {
+			return;
+		}
+		$registrations = $this->loadRegistrationsIfMissing($transaction, $registrations);
+		// still nothing ??!??
+		if (empty($registrations)) {
+			return;
+		}
+		// todo: break out the following logic into a separate strategy class
+		// todo: named something like "Sequential_Reg_Payment_Strategy"
+		// todo: which would apply payments using the capitalist "first come first paid" approach
+		// todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
+		// todo: which would be the socialist "everybody gets a piece of pie" approach,
+		// todo: which would be better for deposits, where you want a bit of the payment applied to each registration
+		$available_payment_amount = $this->sequentialRegPaymentStrategy($payment, $registrations);
+		$this->remainderNotice($payment, $available_payment_amount, $registrations);
+	}
 
 
-    /**
-     * @param EE_Transaction $transaction
-     * @param array          $registrations
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function loadRegistrationsIfMissing(EE_Transaction $transaction, array $registrations = []): array
-    {
-        if (empty($registrations)) {
-            // find registrations with monies owing that can receive a payment
-            $registrations = $transaction->registrations(
-                [
-                    [
-                        // only these reg statuses can receive payments
-                        'STS_ID'           => ['IN', EEM_Registration::reg_statuses_that_allow_payment()],
-                        'REG_final_price'  => ['!=', 0],
-                        'REG_final_price*' => ['!=', 'REG_paid', true],
-                    ],
-                ]
-            );
-        }
-        return $registrations;
-    }
+	/**
+	 * @param EE_Transaction $transaction
+	 * @param array          $registrations
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function loadRegistrationsIfMissing(EE_Transaction $transaction, array $registrations = []): array
+	{
+		if (empty($registrations)) {
+			// find registrations with monies owing that can receive a payment
+			$registrations = $transaction->registrations(
+				[
+					[
+						// only these reg statuses can receive payments
+						'STS_ID'           => ['IN', EEM_Registration::reg_statuses_that_allow_payment()],
+						'REG_final_price'  => ['!=', 0],
+						'REG_final_price*' => ['!=', 'REG_paid', true],
+					],
+				]
+			);
+		}
+		return $registrations;
+	}
 
 
-    /**
-     * @param EE_Payment $payment
-     * @param array      $registrations
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function sequentialRegPaymentStrategy(EE_Payment $payment, array $registrations): float
-    {
-        $refund = $payment->is_a_refund();
-        // how much is available to apply to registrations?
-        $available_payment_amount = (float) abs($payment->amount());
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                // nothing left?
-                if ($available_payment_amount <= 0) {
-                    break;
-                }
-                if ($refund) {
-                    $available_payment_amount = $this->processRegistrationRefund(
-                        $registration,
-                        $payment,
-                        $available_payment_amount
-                    );
-                } else {
-                    $available_payment_amount = $this->processRegistrationPayment(
-                        $registration,
-                        $payment,
-                        $available_payment_amount
-                    );
-                }
-            }
-        }
-        return $available_payment_amount;
-    }
+	/**
+	 * @param EE_Payment $payment
+	 * @param array      $registrations
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function sequentialRegPaymentStrategy(EE_Payment $payment, array $registrations): float
+	{
+		$refund = $payment->is_a_refund();
+		// how much is available to apply to registrations?
+		$available_payment_amount = (float) abs($payment->amount());
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				// nothing left?
+				if ($available_payment_amount <= 0) {
+					break;
+				}
+				if ($refund) {
+					$available_payment_amount = $this->processRegistrationRefund(
+						$registration,
+						$payment,
+						$available_payment_amount
+					);
+				} else {
+					$available_payment_amount = $this->processRegistrationPayment(
+						$registration,
+						$payment,
+						$available_payment_amount
+					);
+				}
+			}
+		}
+		return $available_payment_amount;
+	}
 
 
-    /**
-     * @throws EE_Error
-     */
-    private function remainderNotice(EE_Payment $payment, float $available_payment_amount, array $registrations)
-    {
-        if (
-            $available_payment_amount > 0
-            && apply_filters(
-                'FHEE__EE_Payment_Processor__process_registration_payments__display_notifications',
-                false
-            )
-        ) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        'A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
-                        'event_espresso'
-                    ),
-                    EEH_Template::format_currency($available_payment_amount),
-                    implode(', ', array_keys($registrations)),
-                    '<br/>',
-                    EEH_Template::format_currency($payment->amount())
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
+	/**
+	 * @throws EE_Error
+	 */
+	private function remainderNotice(EE_Payment $payment, float $available_payment_amount, array $registrations)
+	{
+		if (
+			$available_payment_amount > 0
+			&& apply_filters(
+				'FHEE__EE_Payment_Processor__process_registration_payments__display_notifications',
+				false
+			)
+		) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
+						'event_espresso'
+					),
+					EEH_Template::format_currency($available_payment_amount),
+					implode(', ', array_keys($registrations)),
+					'<br/>',
+					EEH_Template::format_currency($payment->amount())
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
 
 
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration  $registration
-     * @param EE_Payment       $payment
-     * @param float            $available_payment_amount
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws ReflectionException
-     */
-    public function processRegistrationPayment(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        float $available_payment_amount = 0.00
-    ): float {
-        // update $available_payment_amount
-        $available_payment_amount -= $registration->applyPayment($payment, $available_payment_amount);
-        return $available_payment_amount;
-    }
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration  $registration
+	 * @param EE_Payment       $payment
+	 * @param float            $available_payment_amount
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	public function processRegistrationPayment(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		float $available_payment_amount = 0.00
+	): float {
+		// update $available_payment_amount
+		$available_payment_amount -= $registration->applyPayment($payment, $available_payment_amount);
+		return $available_payment_amount;
+	}
 
 
-    /**
-     * update registration REG_paid field after refund and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws ReflectionException
-     */
-    public function processRegistrationRefund(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        float $available_refund_amount = 0.00
-    ): float {
-        // update $available_payment_amount
-        $available_refund_amount -= $registration->applyPayment($payment, $available_refund_amount);
-        return $available_refund_amount;
-    }
+	/**
+	 * update registration REG_paid field after refund and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	public function processRegistrationRefund(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		float $available_refund_amount = 0.00
+	): float {
+		// update $available_payment_amount
+		$available_refund_amount -= $registration->applyPayment($payment, $available_refund_amount);
+		return $available_refund_amount;
+	}
 }

core/services/payments/IpnHandler.php

Indentation +374 added lines, -374 removed lines

@@ -32,379 +32,379 @@
  */
 class IpnHandler
 {
-    private EEM_Payment_Method $payment_method_model;
-
-    private EEM_Transaction $transaction_model;
-
-    private EE_Core_Config $core_config;
-
-    private EE_Organization_Config $organization;
-
-    private PaymentProcessor $payment_processor;
-
-
-    /**
-     * @param EEM_Payment_Method $payment_method_model
-     * @param EEM_Transaction $transaction_model
-     * @param EE_Core_Config $core_config
-     * @param EE_Organization_Config $organization
-     * @param PaymentProcessor $payment_processor
-     */
-    public function __construct(
-        EEM_Payment_Method $payment_method_model,
-        EEM_Transaction $transaction_model,
-        EE_Core_Config $core_config,
-        EE_Organization_Config $organization,
-        PaymentProcessor $payment_processor
-    ) {
-        $this->payment_method_model = $payment_method_model;
-        $this->transaction_model    = $transaction_model;
-        $this->core_config          = $core_config;
-        $this->organization         = $organization;
-        $this->payment_processor    = $payment_processor;
-    }
-
-
-    /**
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getIpnUrlForPaymentMethod(EE_Transaction $transaction, EE_Payment_Method $payment_method): string
-    {
-        $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Cannot get IPN URL for transaction with ID %d because it has no primary registration',
-                        'event_espresso'
-                    ),
-                    $transaction->ID()
-                )
-            );
-        }
-        $payment_method = $this->payment_method_model->ensure_is_obj(
-            $payment_method,
-            true
-        );
-        return add_query_arg(
-            [
-                'e_reg_url_link'    => $primary_reg->reg_url_link(),
-                'ee_payment_method' => $payment_method->slug(),
-            ],
-            $this->core_config->txn_page_url()
-        );
-    }
-
-
-    /**
-     * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
-     * we can easily find what registration the IPN is for and what payment method.
-     * However, if not, we'll give all payment methods a chance to claim it and process it.
-     * If a payment is found for the IPN info, it is saved.
-     *
-     * @param array                             $request_data         form post data
-     * @param EE_Transaction|int|null           $transaction          optional (or a transaction's id)
-     * @param EE_Payment_Method|int|string|null $payment_method       optional (or a slug or id of PM)
-     * @param bool                              $update_txn           whether to call
-     *                                                                EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param bool                              $separate_IPN_request whether the IPN uses a separate request (true,
-     *                                                                like PayPal) or is processed manually (false,
-     *                                                                like Authorize.net)
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function processIPN(
-        array $request_data,
-        $transaction = null,
-        $payment_method = null,
-        bool $update_txn = true,
-        bool $separate_IPN_request = true
-    ): EE_Payment {
-        $request_data = $this->removeUnusableCharactersFromArray($request_data);
-        EE_Processor_Base::set_IPN($separate_IPN_request);
-        ['log' => $log, 'object' => $log_object] = $this->logIPN($request_data, $transaction, $payment_method);
-
-        try {
-            if ($transaction && $payment_method) {
-                $payment = $this->processStandardIPN($request_data, $log, $log_object, $transaction, $payment_method);
-            } else {
-                ['payment' => $payment, 'payment_method' => $payment_method] = $this->processWaywardIPN(
-                    $request_data,
-                    $log_object
-                );
-            }
-            return $this->postIpnProcessing(
-                $payment,
-                $request_data,
-                $update_txn,
-                $separate_IPN_request,
-                $transaction,
-                $payment_method
-            );
-        } catch (EE_Error $exception) {
-            $this->invalidIpnException($exception, $transaction, $request_data);
-        }
-    }
-
-
-    /**
-     * @param array                             $request_data
-     * @param EE_Change_Log                     $log
-     * @param EE_Base_Class|null                $log_object
-     * @param EE_Transaction|int|null           $transaction    optional (model object or a transaction's id)
-     * @param EE_Payment_Method|int|string|null $payment_method optional (model object or a slug or id of PM)
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function processStandardIPN(
-        array $request_data,
-        EE_Change_Log $log,
-        ?EE_Base_Class $log_object,
-        $transaction = null,
-        $payment_method = null
-    ): ?EE_Payment {
-        /** @type EE_Transaction $transaction */
-        $transaction = $this->transaction_model->ensure_is_obj($transaction);
-        /** @type EE_Payment_Method $payment_method */
-        $payment_method = $this->payment_method_model->ensure_is_obj($payment_method);
-        if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
-            // not a payment
-            $this->invalidPaymentError();
-            return null;
-        }
-        try {
-            $payment = $payment_method->type_obj()->handle_ipn($request_data, $transaction);
-            $log->set_object($payment);
-            return $payment;
-        } catch (IpnException $exception) {
-            $payment = $this->logIpnException($exception, $log_object);
-        }
-        return $payment;
-    }
-
-
-    /**
-     * @param array              $request_data
-     * @param EE_Base_Class|null $log_object
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function processWaywardIPN(
-        array $request_data,
-        ?EE_Base_Class $log_object
-    ): array {
-        $payment        = null;
-        $payment_method = null;
-        // that's actually pretty ok. The IPN just wasn't able
-        // to identify which transaction or payment method this was for
-        // give all active payment methods a chance to claim it
-        $active_payment_methods = $this->payment_method_model->get_all_active();
-        foreach ($active_payment_methods as $payment_method) {
-            try {
-                $pm_type = $payment_method->type_obj();
-                $payment = $pm_type instanceof EE_PMT_Base ? $pm_type->handle_unclaimed_ipn($request_data) : $payment;
-                $this->logIpnData(['IPN data' => $request_data], $payment);
-                break;
-            } catch (IpnException $exception) {
-                $payment = $this->logIpnException($exception, $log_object);
-            } catch (EE_Error $e) {
-                // that's fine- it apparently couldn't handle the IPN
-            }
-        }
-        return [$payment, $payment_method];
-    }
-
-
-    /**
-     * @param EE_Payment|null                   $payment
-     * @param array                             $request_data
-     * @param bool                              $update_txn
-     * @param bool                              $separate_IPN_request
-     * @param EE_Transaction|int|null           $transaction    optional (model object or a transaction's id)
-     * @param EE_Payment_Method|int|string|null $payment_method optional (model object or a slug or id of PM)
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function postIpnProcessing(
-        ?EE_Payment $payment,
-        array $request_data,
-        bool $update_txn,
-        bool $separate_IPN_request,
-        $transaction = null,
-        $payment_method = null
-    ): ?EE_Payment {
-        if ($payment instanceof EE_Payment) {
-            $payment->save();
-            $this->payment_processor->updateTransactionBasedOnPayment(
-                $transaction,
-                $payment,
-                $update_txn,
-                $separate_IPN_request
-            );
-        } else {
-            // we couldn't find the payment for this IPN... let's try and log at least SOMETHING
-            if ($payment_method) {
-                $this->logIpnData(['IPN data' => $request_data], $payment_method);
-            } elseif ($transaction) {
-                $this->logIpnData(['IPN data' => $request_data], $transaction);
-            }
-        }
-        return $payment;
-    }
-
-
-    /**
-     * @param array                             $request_data
-     * @param EE_Transaction|int|null           $transaction    optional (model object or a transaction's id)
-     * @param EE_Payment_Method|int|string|null $payment_method optional (model object or a slug or id of PM)
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function logIPN(
-        array $request_data,
-        $transaction = null,
-        $payment_method = null
-    ): array {
-        $log_object = null;
-        if ($transaction instanceof EE_Transaction) {
-            $log_object = $transaction;
-            if ($payment_method instanceof EE_Payment_Method) {
-                $log_object = EEM_Payment::instance()->get_one(
-                    [
-                        ['TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()],
-                        'order_by' => ['PAY_timestamp' => 'desc'],
-                    ]
-                );
-            }
-        }
-        $log = $this->logIpnData(['IPN data received' => $request_data], $log_object);
-        return [
-            'log'    => $log,
-            'object' => $log_object,
-        ];
-    }
-
-
-    /**
-     * @param array              $data
-     * @param EE_Base_Class|null $log_object
-     * @return EE_Change_Log
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function logIpnData(array $data, ?EE_Base_Class $log_object): EE_Change_Log
-    {
-        return EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, $data, $log_object);
-    }
-
-
-    /**
-     * @param IpnException       $exception
-     * @param EE_Base_Class|null $log_object
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function logIpnException(IpnException $exception, ?EE_Base_Class $log_object): ?EE_Payment
-    {
-        $this->logIpnData(
-            [
-                'message'     => 'IPN Exception: ' . $exception->getMessage(),
-                'current_url' => EEH_URL::current_url(),
-                'payment'     => $exception->getPaymentProperties(),
-                'IPN_data'    => $exception->getIpnData(),
-            ],
-            $log_object
-        );
-        return $exception->getPayment();
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    private function invalidPaymentError()
-    {
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.',
-                    'event_espresso'
-                ),
-                '<br/>',
-                $this->organization->get_pretty('email')
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-    }
-
-
-    /**
-     * @param Exception $exception
-     * @param           $transaction
-     * @param           $request_data
-     * @return mixed
-     * @throws Exception
-     */
-    private function invalidIpnException(Exception $exception, $transaction, $request_data)
-    {
-        do_action(
-            'AHEE__log',
-            __FILE__,
-            __FUNCTION__,
-            sprintf(
-                esc_html__(
-                    'Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"',
-                    'event_espresso'
-                ),
-                print_r($transaction, true),
-                print_r($request_data, true),
-                $exception->getMessage()
-            )
-        );
-        throw $exception;
-    }
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param array $request_data
-     * @return array
-     */
-    private function removeUnusableCharactersFromArray(array $request_data): array
-    {
-        $return_data = [];
-        foreach ($request_data as $key => $value) {
-            $return_data[ $this->removeUnusableCharacters($key) ] = $this->removeUnusableCharacters($value);
-        }
-        return $return_data;
-    }
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param string $request_data
-     * @return string
-     */
-    private function removeUnusableCharacters(string $request_data): string
-    {
-        return preg_replace('/[^[:print:]]/', '', $request_data);
-    }
+	private EEM_Payment_Method $payment_method_model;
+
+	private EEM_Transaction $transaction_model;
+
+	private EE_Core_Config $core_config;
+
+	private EE_Organization_Config $organization;
+
+	private PaymentProcessor $payment_processor;
+
+
+	/**
+	 * @param EEM_Payment_Method $payment_method_model
+	 * @param EEM_Transaction $transaction_model
+	 * @param EE_Core_Config $core_config
+	 * @param EE_Organization_Config $organization
+	 * @param PaymentProcessor $payment_processor
+	 */
+	public function __construct(
+		EEM_Payment_Method $payment_method_model,
+		EEM_Transaction $transaction_model,
+		EE_Core_Config $core_config,
+		EE_Organization_Config $organization,
+		PaymentProcessor $payment_processor
+	) {
+		$this->payment_method_model = $payment_method_model;
+		$this->transaction_model    = $transaction_model;
+		$this->core_config          = $core_config;
+		$this->organization         = $organization;
+		$this->payment_processor    = $payment_processor;
+	}
+
+
+	/**
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getIpnUrlForPaymentMethod(EE_Transaction $transaction, EE_Payment_Method $payment_method): string
+	{
+		$primary_reg = $transaction->primary_registration();
+		if (! $primary_reg instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Cannot get IPN URL for transaction with ID %d because it has no primary registration',
+						'event_espresso'
+					),
+					$transaction->ID()
+				)
+			);
+		}
+		$payment_method = $this->payment_method_model->ensure_is_obj(
+			$payment_method,
+			true
+		);
+		return add_query_arg(
+			[
+				'e_reg_url_link'    => $primary_reg->reg_url_link(),
+				'ee_payment_method' => $payment_method->slug(),
+			],
+			$this->core_config->txn_page_url()
+		);
+	}
+
+
+	/**
+	 * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
+	 * we can easily find what registration the IPN is for and what payment method.
+	 * However, if not, we'll give all payment methods a chance to claim it and process it.
+	 * If a payment is found for the IPN info, it is saved.
+	 *
+	 * @param array                             $request_data         form post data
+	 * @param EE_Transaction|int|null           $transaction          optional (or a transaction's id)
+	 * @param EE_Payment_Method|int|string|null $payment_method       optional (or a slug or id of PM)
+	 * @param bool                              $update_txn           whether to call
+	 *                                                                EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param bool                              $separate_IPN_request whether the IPN uses a separate request (true,
+	 *                                                                like PayPal) or is processed manually (false,
+	 *                                                                like Authorize.net)
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function processIPN(
+		array $request_data,
+		$transaction = null,
+		$payment_method = null,
+		bool $update_txn = true,
+		bool $separate_IPN_request = true
+	): EE_Payment {
+		$request_data = $this->removeUnusableCharactersFromArray($request_data);
+		EE_Processor_Base::set_IPN($separate_IPN_request);
+		['log' => $log, 'object' => $log_object] = $this->logIPN($request_data, $transaction, $payment_method);
+
+		try {
+			if ($transaction && $payment_method) {
+				$payment = $this->processStandardIPN($request_data, $log, $log_object, $transaction, $payment_method);
+			} else {
+				['payment' => $payment, 'payment_method' => $payment_method] = $this->processWaywardIPN(
+					$request_data,
+					$log_object
+				);
+			}
+			return $this->postIpnProcessing(
+				$payment,
+				$request_data,
+				$update_txn,
+				$separate_IPN_request,
+				$transaction,
+				$payment_method
+			);
+		} catch (EE_Error $exception) {
+			$this->invalidIpnException($exception, $transaction, $request_data);
+		}
+	}
+
+
+	/**
+	 * @param array                             $request_data
+	 * @param EE_Change_Log                     $log
+	 * @param EE_Base_Class|null                $log_object
+	 * @param EE_Transaction|int|null           $transaction    optional (model object or a transaction's id)
+	 * @param EE_Payment_Method|int|string|null $payment_method optional (model object or a slug or id of PM)
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function processStandardIPN(
+		array $request_data,
+		EE_Change_Log $log,
+		?EE_Base_Class $log_object,
+		$transaction = null,
+		$payment_method = null
+	): ?EE_Payment {
+		/** @type EE_Transaction $transaction */
+		$transaction = $this->transaction_model->ensure_is_obj($transaction);
+		/** @type EE_Payment_Method $payment_method */
+		$payment_method = $this->payment_method_model->ensure_is_obj($payment_method);
+		if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
+			// not a payment
+			$this->invalidPaymentError();
+			return null;
+		}
+		try {
+			$payment = $payment_method->type_obj()->handle_ipn($request_data, $transaction);
+			$log->set_object($payment);
+			return $payment;
+		} catch (IpnException $exception) {
+			$payment = $this->logIpnException($exception, $log_object);
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * @param array              $request_data
+	 * @param EE_Base_Class|null $log_object
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function processWaywardIPN(
+		array $request_data,
+		?EE_Base_Class $log_object
+	): array {
+		$payment        = null;
+		$payment_method = null;
+		// that's actually pretty ok. The IPN just wasn't able
+		// to identify which transaction or payment method this was for
+		// give all active payment methods a chance to claim it
+		$active_payment_methods = $this->payment_method_model->get_all_active();
+		foreach ($active_payment_methods as $payment_method) {
+			try {
+				$pm_type = $payment_method->type_obj();
+				$payment = $pm_type instanceof EE_PMT_Base ? $pm_type->handle_unclaimed_ipn($request_data) : $payment;
+				$this->logIpnData(['IPN data' => $request_data], $payment);
+				break;
+			} catch (IpnException $exception) {
+				$payment = $this->logIpnException($exception, $log_object);
+			} catch (EE_Error $e) {
+				// that's fine- it apparently couldn't handle the IPN
+			}
+		}
+		return [$payment, $payment_method];
+	}
+
+
+	/**
+	 * @param EE_Payment|null                   $payment
+	 * @param array                             $request_data
+	 * @param bool                              $update_txn
+	 * @param bool                              $separate_IPN_request
+	 * @param EE_Transaction|int|null           $transaction    optional (model object or a transaction's id)
+	 * @param EE_Payment_Method|int|string|null $payment_method optional (model object or a slug or id of PM)
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function postIpnProcessing(
+		?EE_Payment $payment,
+		array $request_data,
+		bool $update_txn,
+		bool $separate_IPN_request,
+		$transaction = null,
+		$payment_method = null
+	): ?EE_Payment {
+		if ($payment instanceof EE_Payment) {
+			$payment->save();
+			$this->payment_processor->updateTransactionBasedOnPayment(
+				$transaction,
+				$payment,
+				$update_txn,
+				$separate_IPN_request
+			);
+		} else {
+			// we couldn't find the payment for this IPN... let's try and log at least SOMETHING
+			if ($payment_method) {
+				$this->logIpnData(['IPN data' => $request_data], $payment_method);
+			} elseif ($transaction) {
+				$this->logIpnData(['IPN data' => $request_data], $transaction);
+			}
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * @param array                             $request_data
+	 * @param EE_Transaction|int|null           $transaction    optional (model object or a transaction's id)
+	 * @param EE_Payment_Method|int|string|null $payment_method optional (model object or a slug or id of PM)
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function logIPN(
+		array $request_data,
+		$transaction = null,
+		$payment_method = null
+	): array {
+		$log_object = null;
+		if ($transaction instanceof EE_Transaction) {
+			$log_object = $transaction;
+			if ($payment_method instanceof EE_Payment_Method) {
+				$log_object = EEM_Payment::instance()->get_one(
+					[
+						['TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()],
+						'order_by' => ['PAY_timestamp' => 'desc'],
+					]
+				);
+			}
+		}
+		$log = $this->logIpnData(['IPN data received' => $request_data], $log_object);
+		return [
+			'log'    => $log,
+			'object' => $log_object,
+		];
+	}
+
+
+	/**
+	 * @param array              $data
+	 * @param EE_Base_Class|null $log_object
+	 * @return EE_Change_Log
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function logIpnData(array $data, ?EE_Base_Class $log_object): EE_Change_Log
+	{
+		return EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, $data, $log_object);
+	}
+
+
+	/**
+	 * @param IpnException       $exception
+	 * @param EE_Base_Class|null $log_object
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function logIpnException(IpnException $exception, ?EE_Base_Class $log_object): ?EE_Payment
+	{
+		$this->logIpnData(
+			[
+				'message'     => 'IPN Exception: ' . $exception->getMessage(),
+				'current_url' => EEH_URL::current_url(),
+				'payment'     => $exception->getPaymentProperties(),
+				'IPN_data'    => $exception->getIpnData(),
+			],
+			$log_object
+		);
+		return $exception->getPayment();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function invalidPaymentError()
+	{
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.',
+					'event_espresso'
+				),
+				'<br/>',
+				$this->organization->get_pretty('email')
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+	}
+
+
+	/**
+	 * @param Exception $exception
+	 * @param           $transaction
+	 * @param           $request_data
+	 * @return mixed
+	 * @throws Exception
+	 */
+	private function invalidIpnException(Exception $exception, $transaction, $request_data)
+	{
+		do_action(
+			'AHEE__log',
+			__FILE__,
+			__FUNCTION__,
+			sprintf(
+				esc_html__(
+					'Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"',
+					'event_espresso'
+				),
+				print_r($transaction, true),
+				print_r($request_data, true),
+				$exception->getMessage()
+			)
+		);
+		throw $exception;
+	}
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param array $request_data
+	 * @return array
+	 */
+	private function removeUnusableCharactersFromArray(array $request_data): array
+	{
+		$return_data = [];
+		foreach ($request_data as $key => $value) {
+			$return_data[ $this->removeUnusableCharacters($key) ] = $this->removeUnusableCharacters($value);
+		}
+		return $return_data;
+	}
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param string $request_data
+	 * @return string
+	 */
+	private function removeUnusableCharacters(string $request_data): string
+	{
+		return preg_replace('/[^[:print:]]/', '', $request_data);
+	}
 
 }

Spacing +4 added lines, -4 removed lines

@@ -75,7 +75,7 @@ 
     public function getIpnUrlForPaymentMethod(EE_Transaction $transaction, EE_Payment_Method $payment_method): string
     {
         $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg instanceof EE_Registration) {
+        if ( ! $primary_reg instanceof EE_Registration) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -173,7 +173,7 @@ 
         $transaction = $this->transaction_model->ensure_is_obj($transaction);
         /** @type EE_Payment_Method $payment_method */
         $payment_method = $this->payment_method_model->ensure_is_obj($payment_method);
-        if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
+        if ( ! $payment_method->type_obj() instanceof EE_PMT_Base) {
             // not a payment
             $this->invalidPaymentError();
             return null;
@@ -318,7 +318,7 @@ 
     {
         $this->logIpnData(
             [
-                'message'     => 'IPN Exception: ' . $exception->getMessage(),
+                'message'     => 'IPN Exception: '.$exception->getMessage(),
                 'current_url' => EEH_URL::current_url(),
                 'payment'     => $exception->getPaymentProperties(),
                 'IPN_data'    => $exception->getIpnData(),
@@ -389,7 +389,7 @@ 
     {
         $return_data = [];
         foreach ($request_data as $key => $value) {
-            $return_data[ $this->removeUnusableCharacters($key) ] = $this->removeUnusableCharacters($value);
+            $return_data[$this->removeUnusableCharacters($key)] = $this->removeUnusableCharacters($value);
         }
         return $return_data;
     }

core/services/payments/PaymentProcessor.php

Indentation +292 added lines, -292 removed lines

@@ -31,316 +31,316 @@
 {
 
 
-    private EEM_Payment_Method $payment_method_model;
+	private EEM_Payment_Method $payment_method_model;
 
-    private EEM_Transaction $transaction_model;
+	private EEM_Transaction $transaction_model;
 
-    private EE_Organization_Config $organization;
+	private EE_Organization_Config $organization;
 
-    private FeatureFlags $feature;
+	private FeatureFlags $feature;
 
-    private PaymentProcessorFees $payment_processor_fees;
+	private PaymentProcessorFees $payment_processor_fees;
 
-    private PostPaymentProcessor $post_payment_processor;
+	private PostPaymentProcessor $post_payment_processor;
 
-    private RegistrationPayments $registration_payments;
+	private RegistrationPayments $registration_payments;
 
 
-    /**
-     * @param EEM_Payment_Method     $payment_method_model
-     * @param EEM_Transaction        $transaction_model
-     * @param EE_Organization_Config $organization
-     * @param FeatureFlags           $feature
-     * @param PaymentProcessorFees   $payment_processor_fees
-     * @param PostPaymentProcessor   $post_payment_processor
-     * @param RegistrationPayments   $registration_payments
-     */
-    public function __construct(
-        EEM_Payment_Method $payment_method_model,
-        EEM_Transaction $transaction_model,
-        EE_Organization_Config $organization,
-        FeatureFlags $feature,
-        PaymentProcessorFees $payment_processor_fees,
-        PostPaymentProcessor $post_payment_processor,
-        RegistrationPayments $registration_payments
-    ) {
-        $this->payment_method_model   = $payment_method_model;
-        $this->transaction_model      = $transaction_model;
-        $this->organization           = $organization;
-        $this->feature                = $feature;
-        $this->payment_processor_fees = $payment_processor_fees;
-        $this->post_payment_processor = $post_payment_processor;
-        $this->registration_payments  = $registration_payments;
-    }
+	/**
+	 * @param EEM_Payment_Method     $payment_method_model
+	 * @param EEM_Transaction        $transaction_model
+	 * @param EE_Organization_Config $organization
+	 * @param FeatureFlags           $feature
+	 * @param PaymentProcessorFees   $payment_processor_fees
+	 * @param PostPaymentProcessor   $post_payment_processor
+	 * @param RegistrationPayments   $registration_payments
+	 */
+	public function __construct(
+		EEM_Payment_Method $payment_method_model,
+		EEM_Transaction $transaction_model,
+		EE_Organization_Config $organization,
+		FeatureFlags $feature,
+		PaymentProcessorFees $payment_processor_fees,
+		PostPaymentProcessor $post_payment_processor,
+		RegistrationPayments $registration_payments
+	) {
+		$this->payment_method_model   = $payment_method_model;
+		$this->transaction_model      = $transaction_model;
+		$this->organization           = $organization;
+		$this->feature                = $feature;
+		$this->payment_processor_fees = $payment_processor_fees;
+		$this->post_payment_processor = $post_payment_processor;
+		$this->registration_payments  = $registration_payments;
+	}
 
 
-    /**
-     * Using the selected gateway, processes the payment for that transaction, and updates the transaction
-     * appropriately. Saves the payment that is generated
-     *
-     * @param EE_Payment_Method         $payment_method
-     * @param EE_Transaction            $transaction
-     * @param EE_Billing_Info_Form|null $billing_form  (or probably null, if it's an offline or offsite payment
-     *                                                 method).
-     *                                                 Receive_form_submission() should have
-     *                                                 already been called on the billing form
-     *                                                 (ie, its inputs should have their normalized values set).
-     * @param float                     $amount        if only part of the transaction is to be paid for, how much.
-     *                                                 Leave null if payment is for the full amount owing
-     * @param bool                      $by_admin      TRUE if payment is being attempted from the admin
-     * @param bool                      $update_txn    whether to call EE_Transaction_Processor
-     *                                                 ::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param string                    $return_url    string used mostly by offsite gateways to specify
-     *                                                 where to go AFTER the offsite gateway
-     * @param string                    $cancel_url    URL to return to if off-site payments are cancelled
-     * @param string                    $method        like 'CART', indicates who the client who called this was
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws Exception
-     * @throws ReflectionException
-     */
-    public function processPayment(
-        EE_Payment_Method $payment_method,
-        EE_Transaction $transaction,
-        ?EE_Billing_Info_Form $billing_form = null,
-        float $amount = 0.00,
-        bool $by_admin = false,
-        bool $update_txn = true,
-        string $return_url = '',
-        string $cancel_url = '',
-        string $method = 'CART'
-    ): ?EE_Payment {
-        $this->validatePaymentAmount($transaction, $amount);
-        // verify payment method
-        $payment_method = $this->payment_method_model->ensure_is_obj(
-            $payment_method,
-            true
-        );
-        // verify transaction
-        $this->transaction_model->ensure_is_obj($transaction);
-        $transaction->set_payment_method_ID($payment_method->ID());
-        // make sure we don't overcharge
-        $amount = min($amount, $transaction->remaining());
-        // TODO: add some extra logic to PaymentProcessorFees to designate where/when partner fees are applied based on the PM being used.
-        // if (
-        //     $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
-        //     && apply_filters(
-        //         'FHEE__EE_Payment_Processor__apply_gateway_partner_fees',
-        //         true,
-        //         $transaction,
-        //         $payment_method,
-        //         $amount
-        //     )
-        // ) {
-        //     $amount = $this->payment_processor_fees->applyGatewayPartnerFees(
-        //         $transaction,
-        //         $payment_method->name(),
-        //         $amount
-        //     );
-        // }
-        // verify payment method type
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            $payment = $payment_method->type_obj()->process_payment(
-                $transaction,
-                $amount,
-                $billing_form,
-                $return_url,
-                add_query_arg(['ee_cancel_payment' => true], $cancel_url),
-                $method,
-                $by_admin
-            );
-            // check if payment method uses an off-site gateway
-            if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
-                // don't process payments for off-site gateways yet because no payment has occurred yet
-                $this->updateTransactionBasedOnPayment($transaction, $payment, $update_txn);
-            }
-            return $payment;
-        }
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
-                    'event_espresso'
-                ),
-                '<br/>',
-                $this->organization->get_pretty('email')
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return null;
-    }
+	/**
+	 * Using the selected gateway, processes the payment for that transaction, and updates the transaction
+	 * appropriately. Saves the payment that is generated
+	 *
+	 * @param EE_Payment_Method         $payment_method
+	 * @param EE_Transaction            $transaction
+	 * @param EE_Billing_Info_Form|null $billing_form  (or probably null, if it's an offline or offsite payment
+	 *                                                 method).
+	 *                                                 Receive_form_submission() should have
+	 *                                                 already been called on the billing form
+	 *                                                 (ie, its inputs should have their normalized values set).
+	 * @param float                     $amount        if only part of the transaction is to be paid for, how much.
+	 *                                                 Leave null if payment is for the full amount owing
+	 * @param bool                      $by_admin      TRUE if payment is being attempted from the admin
+	 * @param bool                      $update_txn    whether to call EE_Transaction_Processor
+	 *                                                 ::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param string                    $return_url    string used mostly by offsite gateways to specify
+	 *                                                 where to go AFTER the offsite gateway
+	 * @param string                    $cancel_url    URL to return to if off-site payments are cancelled
+	 * @param string                    $method        like 'CART', indicates who the client who called this was
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @throws ReflectionException
+	 */
+	public function processPayment(
+		EE_Payment_Method $payment_method,
+		EE_Transaction $transaction,
+		?EE_Billing_Info_Form $billing_form = null,
+		float $amount = 0.00,
+		bool $by_admin = false,
+		bool $update_txn = true,
+		string $return_url = '',
+		string $cancel_url = '',
+		string $method = 'CART'
+	): ?EE_Payment {
+		$this->validatePaymentAmount($transaction, $amount);
+		// verify payment method
+		$payment_method = $this->payment_method_model->ensure_is_obj(
+			$payment_method,
+			true
+		);
+		// verify transaction
+		$this->transaction_model->ensure_is_obj($transaction);
+		$transaction->set_payment_method_ID($payment_method->ID());
+		// make sure we don't overcharge
+		$amount = min($amount, $transaction->remaining());
+		// TODO: add some extra logic to PaymentProcessorFees to designate where/when partner fees are applied based on the PM being used.
+		// if (
+		//     $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
+		//     && apply_filters(
+		//         'FHEE__EE_Payment_Processor__apply_gateway_partner_fees',
+		//         true,
+		//         $transaction,
+		//         $payment_method,
+		//         $amount
+		//     )
+		// ) {
+		//     $amount = $this->payment_processor_fees->applyGatewayPartnerFees(
+		//         $transaction,
+		//         $payment_method->name(),
+		//         $amount
+		//     );
+		// }
+		// verify payment method type
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			$payment = $payment_method->type_obj()->process_payment(
+				$transaction,
+				$amount,
+				$billing_form,
+				$return_url,
+				add_query_arg(['ee_cancel_payment' => true], $cancel_url),
+				$method,
+				$by_admin
+			);
+			// check if payment method uses an off-site gateway
+			if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
+				// don't process payments for off-site gateways yet because no payment has occurred yet
+				$this->updateTransactionBasedOnPayment($transaction, $payment, $update_txn);
+			}
+			return $payment;
+		}
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
+					'event_espresso'
+				),
+				'<br/>',
+				$this->organization->get_pretty('email')
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return null;
+	}
 
 
-    /**
-     * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
-     *
-     * @param EE_Payment_Method|null $payment_method
-     * @param EE_Payment             $payment_to_refund
-     * @param array                  $refund_info
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function processRefund(
-        ?EE_Payment_Method $payment_method,
-        EE_Payment $payment_to_refund,
-        array $refund_info = []
-    ): EE_Payment {
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
-            $payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
-            $this->updateTransactionBasedOnPayment(
-                $payment_to_refund->transaction(),
-                $payment_to_refund
-            );
-        }
-        return $payment_to_refund;
-    }
+	/**
+	 * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
+	 *
+	 * @param EE_Payment_Method|null $payment_method
+	 * @param EE_Payment             $payment_to_refund
+	 * @param array                  $refund_info
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function processRefund(
+		?EE_Payment_Method $payment_method,
+		EE_Payment $payment_to_refund,
+		array $refund_info = []
+	): EE_Payment {
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
+			$payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
+			$this->updateTransactionBasedOnPayment(
+				$payment_to_refund->transaction(),
+				$payment_to_refund
+			);
+		}
+		return $payment_to_refund;
+	}
 
 
-    /**
-     * This should be called each time there may have been an update to a
-     * payment on a transaction (ie, we asked for a payment to process a
-     * payment for a transaction, or we told a payment method about an IPN, or
-     * we told a payment method to
-     * "finalize_payment_for" (a transaction), or we told a payment method to
-     * process a refund. This should handle firing the correct hooks to
-     * indicate
-     * what exactly happened and updating the transaction appropriately). This
-     * could be integrated directly into EE_Transaction upon save, but we want
-     * this logic to be separate from 'normal' plain-jane saving and updating
-     * of transactions and payments, and to be tied to payment processing.
-     * Note: this method DOES NOT save the payment passed into it. It is the responsibility
-     * of previous code to decide whether to save (because the payment passed into
-     * this method might be a temporary, never-to-be-saved payment from an offline gateway,
-     * in which case we only want that payment object for some temporary usage during this request,
-     * but we don't want it to be saved).
-     *
-     * @param EE_Transaction  $transaction
-     * @param EE_Payment|null $payment
-     * @param bool            $update_txn whether to call EE_Transaction_Processor::
-     *                                    update_transaction_and_registrations_after_checkout_or_payment()
-     *                                    (you can save 1 DB query if you know you're going
-     *                                    to save it later instead)
-     * @param bool            $IPN
-     *                                    if processing IPNs or other similar payment
-     *                                    related activities that occur in alternate
-     *                                    requests than the main one that is processing the
-     *                                    TXN, then set this to true to check whether the
-     *                                    TXN is locked before updating
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function updateTransactionBasedOnPayment(
-        EE_Transaction $transaction,
-        ?EE_Payment $payment,
-        bool $update_txn = true,
-        bool $IPN = false
-    ) {
-        $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
-        /** @type EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        // can we freely update the TXN at this moment?
-        if ($IPN && $transaction->is_locked()) {
-            // don't update the transaction at this exact moment
-            // because the TXN is active in another request
-            EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                time(),
-                $transaction->ID(),
-                $payment->ID()
-            );
-        } else {
-            // verify payment and that it has been saved
-            if ($payment instanceof EE_Payment) {
-                $do_action = $this->processRegistrationPayments($transaction, $payment, $do_action);
-                $this->updateTransactionAndPayment($transaction, $payment, $update_txn, $IPN);
-            }
-            // granular hook for others to use.
-            do_action($do_action, $transaction, $payment);
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
-            // global hook for others to use.
-            do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
-        }
-    }
+	/**
+	 * This should be called each time there may have been an update to a
+	 * payment on a transaction (ie, we asked for a payment to process a
+	 * payment for a transaction, or we told a payment method about an IPN, or
+	 * we told a payment method to
+	 * "finalize_payment_for" (a transaction), or we told a payment method to
+	 * process a refund. This should handle firing the correct hooks to
+	 * indicate
+	 * what exactly happened and updating the transaction appropriately). This
+	 * could be integrated directly into EE_Transaction upon save, but we want
+	 * this logic to be separate from 'normal' plain-jane saving and updating
+	 * of transactions and payments, and to be tied to payment processing.
+	 * Note: this method DOES NOT save the payment passed into it. It is the responsibility
+	 * of previous code to decide whether to save (because the payment passed into
+	 * this method might be a temporary, never-to-be-saved payment from an offline gateway,
+	 * in which case we only want that payment object for some temporary usage during this request,
+	 * but we don't want it to be saved).
+	 *
+	 * @param EE_Transaction  $transaction
+	 * @param EE_Payment|null $payment
+	 * @param bool            $update_txn whether to call EE_Transaction_Processor::
+	 *                                    update_transaction_and_registrations_after_checkout_or_payment()
+	 *                                    (you can save 1 DB query if you know you're going
+	 *                                    to save it later instead)
+	 * @param bool            $IPN
+	 *                                    if processing IPNs or other similar payment
+	 *                                    related activities that occur in alternate
+	 *                                    requests than the main one that is processing the
+	 *                                    TXN, then set this to true to check whether the
+	 *                                    TXN is locked before updating
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function updateTransactionBasedOnPayment(
+		EE_Transaction $transaction,
+		?EE_Payment $payment,
+		bool $update_txn = true,
+		bool $IPN = false
+	) {
+		$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
+		/** @type EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		// can we freely update the TXN at this moment?
+		if ($IPN && $transaction->is_locked()) {
+			// don't update the transaction at this exact moment
+			// because the TXN is active in another request
+			EE_Cron_Tasks::schedule_update_transaction_with_payment(
+				time(),
+				$transaction->ID(),
+				$payment->ID()
+			);
+		} else {
+			// verify payment and that it has been saved
+			if ($payment instanceof EE_Payment) {
+				$do_action = $this->processRegistrationPayments($transaction, $payment, $do_action);
+				$this->updateTransactionAndPayment($transaction, $payment, $update_txn, $IPN);
+			}
+			// granular hook for others to use.
+			do_action($do_action, $transaction, $payment);
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
+			// global hook for others to use.
+			do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
+		}
+	}
 
 
-    /**
-     * @param EE_Transaction  $transaction
-     * @param EE_Payment $payment
-     * @param string          $do_action
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function processRegistrationPayments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        string $do_action
-    ): string {
-        if ($payment->ID()) {
-            if (
-                $payment->payment_method() instanceof EE_Payment_Method
-                && $payment->payment_method()->type_obj() instanceof EE_PMT_Base
-            ) {
-                $payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
-                // update TXN registrations with payment info
-                $this->registration_payments->processRegistrationPayments($transaction, $payment);
-            }
-            return $payment->just_approved()
-                ? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
-                : $do_action;
-        }
-        // send out notifications
-        add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-        return 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
-    }
+	/**
+	 * @param EE_Transaction  $transaction
+	 * @param EE_Payment $payment
+	 * @param string          $do_action
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function processRegistrationPayments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		string $do_action
+	): string {
+		if ($payment->ID()) {
+			if (
+				$payment->payment_method() instanceof EE_Payment_Method
+				&& $payment->payment_method()->type_obj() instanceof EE_PMT_Base
+			) {
+				$payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
+				// update TXN registrations with payment info
+				$this->registration_payments->processRegistrationPayments($transaction, $payment);
+			}
+			return $payment->just_approved()
+				? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
+				: $do_action;
+		}
+		// send out notifications
+		add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+		return 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
+	}
 
 
-    /**
-     * @param EE_Transaction $transaction
-     * @param EE_Payment     $payment
-     * @param bool           $update_txn
-     * @param bool           $IPN
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateTransactionAndPayment(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        bool $update_txn,
-        bool $IPN
-    ) {
-        if ($payment->status() !== EEM_Payment::status_id_failed) {
-            /** @type EE_Transaction_Payments $transaction_payments */
-            $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-            // set new value for total paid
-            $transaction_payments->calculate_total_payments_and_update_status($transaction);
-            if ($update_txn) {
-                $this->post_payment_processor->updateTransactionAndPayment($transaction, $payment, $IPN);
-            }
-        }
-    }
+	/**
+	 * @param EE_Transaction $transaction
+	 * @param EE_Payment     $payment
+	 * @param bool           $update_txn
+	 * @param bool           $IPN
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateTransactionAndPayment(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		bool $update_txn,
+		bool $IPN
+	) {
+		if ($payment->status() !== EEM_Payment::status_id_failed) {
+			/** @type EE_Transaction_Payments $transaction_payments */
+			$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+			// set new value for total paid
+			$transaction_payments->calculate_total_payments_and_update_status($transaction);
+			if ($update_txn) {
+				$this->post_payment_processor->updateTransactionAndPayment($transaction, $payment, $IPN);
+			}
+		}
+	}
 
 
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function validatePaymentAmount(EE_Transaction $transaction, float $amount)
-    {
-        if ($amount < 0) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
-                        'event_espresso'
-                    ),
-                    $amount,
-                    $transaction->ID()
-                )
-            );
-        }
-    }
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function validatePaymentAmount(EE_Transaction $transaction, float $amount)
+	{
+		if ($amount < 0) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
+						'event_espresso'
+					),
+					$amount,
+					$transaction->ID()
+				)
+			);
+		}
+	}
 }

core/services/payments/PostPaymentProcessor.php

Indentation +97 added lines, -97 removed lines

@@ -21,107 +21,107 @@
  */
 class PostPaymentProcessor
 {
-    private EE_Transaction_Processor $transaction_processor;
+	private EE_Transaction_Processor $transaction_processor;
 
 
-    /**
-     * @param EE_Transaction_Processor $transaction_processor
-     */
-    public function __construct(EE_Transaction_Processor $transaction_processor)
-    {
-        $this->transaction_processor = $transaction_processor;
-    }
+	/**
+	 * @param EE_Transaction_Processor $transaction_processor
+	 */
+	public function __construct(EE_Transaction_Processor $transaction_processor)
+	{
+		$this->transaction_processor = $transaction_processor;
+	}
 
 
-    /**
-     * Process payments and transaction after payment process completed.
-     * ultimately this will send the TXN and payment details off so that notifications can be sent out.
-     * if this request happens to be processing an IPN,
-     * then we will also set the Payment Options Reg Step to completed,
-     * and attempt to completely finalize the TXN if all the other Reg Steps are completed as well.
-     *
-     * @param EE_Transaction $transaction
-     * @param EE_Payment     $payment
-     * @param bool           $IPN
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function updateTransactionAndPayment(EE_Transaction $transaction, EE_Payment $payment, bool $IPN = false)
-    {
-        // is the Payment Options Reg Step completed ?
-        $payment_options_step_completed = $transaction->reg_step_completed('payment_options');
-        // if the Payment Options Reg Step is completed...
-        // then this is kinda sorta a revisit with regard to payments at least
-        $this->transaction_processor->set_revisit($payment_options_step_completed === true);
-        // if this is an IPN, let's consider the Payment Options Reg Step completed if not already
-        if (
-            $IPN
-            && $payment_options_step_completed !== true
-            && ($payment->is_approved() || $payment->is_pending())
-        ) {
-            $payment_options_step_completed = $transaction->set_reg_step_completed(
-                'payment_options'
-            );
-        }
-        // maybe update status, but don't save transaction just yet
-        $transaction->update_status_based_on_total_paid(false);
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        //  if this is an IPN and the final step has not been initiated
-        if ($IPN && $payment_options_step_completed && $finalized === false) {
-            // and if it hasn't already been set as being started...
-            $finalized = $transaction->set_reg_step_initiated('finalize_registration');
-        }
-        $transaction->save();
-        // because the above will return false if the final step was not fully completed, we need to check again...
-        if ($IPN && $finalized !== false) {
-            // and if we are all good to go, then send out notifications
-            add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-            // ok, now process the transaction according to the payment
-            $this->transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-                $transaction,
-                $payment
-            );
-        }
-        // DEBUG LOG
-        $this->debugLog($transaction, $payment, $IPN, $finalized);
-    }
+	/**
+	 * Process payments and transaction after payment process completed.
+	 * ultimately this will send the TXN and payment details off so that notifications can be sent out.
+	 * if this request happens to be processing an IPN,
+	 * then we will also set the Payment Options Reg Step to completed,
+	 * and attempt to completely finalize the TXN if all the other Reg Steps are completed as well.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param EE_Payment     $payment
+	 * @param bool           $IPN
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function updateTransactionAndPayment(EE_Transaction $transaction, EE_Payment $payment, bool $IPN = false)
+	{
+		// is the Payment Options Reg Step completed ?
+		$payment_options_step_completed = $transaction->reg_step_completed('payment_options');
+		// if the Payment Options Reg Step is completed...
+		// then this is kinda sorta a revisit with regard to payments at least
+		$this->transaction_processor->set_revisit($payment_options_step_completed === true);
+		// if this is an IPN, let's consider the Payment Options Reg Step completed if not already
+		if (
+			$IPN
+			&& $payment_options_step_completed !== true
+			&& ($payment->is_approved() || $payment->is_pending())
+		) {
+			$payment_options_step_completed = $transaction->set_reg_step_completed(
+				'payment_options'
+			);
+		}
+		// maybe update status, but don't save transaction just yet
+		$transaction->update_status_based_on_total_paid(false);
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		//  if this is an IPN and the final step has not been initiated
+		if ($IPN && $payment_options_step_completed && $finalized === false) {
+			// and if it hasn't already been set as being started...
+			$finalized = $transaction->set_reg_step_initiated('finalize_registration');
+		}
+		$transaction->save();
+		// because the above will return false if the final step was not fully completed, we need to check again...
+		if ($IPN && $finalized !== false) {
+			// and if we are all good to go, then send out notifications
+			add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+			// ok, now process the transaction according to the payment
+			$this->transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+				$transaction,
+				$payment
+			);
+		}
+		// DEBUG LOG
+		$this->debugLog($transaction, $payment, $IPN, $finalized);
+	}
 
 
-    /**
-     * @param EE_Transaction $transaction
-     * @param EE_Payment     $payment
-     * @param bool           $IPN
-     * @param bool           $finalized
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function debugLog(EE_Transaction $transaction, EE_Payment $payment, bool $IPN, bool $finalized)
-    {
-        $payment_method = $payment->payment_method();
-        if ($payment_method instanceof EE_Payment_Method) {
-            $payment_method_type_obj = $payment_method->type_obj();
-            if ($payment_method_type_obj instanceof EE_PMT_Base) {
-                $gateway = $payment_method_type_obj->get_gateway();
-                if ($gateway instanceof EE_Gateway) {
-                    $gateway->log(
-                        [
-                            'message'               => esc_html__(
-                                'Post Payment Transaction Details',
-                                'event_espresso'
-                            ),
-                            'transaction'           => $transaction->model_field_array(),
-                            'finalized'             => $finalized,
-                            'IPN'                   => $IPN,
-                            'deliver_notifications' => has_filter(
-                                'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-                            ),
-                        ],
-                        $payment
-                    );
-                }
-            }
-        }
-    }
+	/**
+	 * @param EE_Transaction $transaction
+	 * @param EE_Payment     $payment
+	 * @param bool           $IPN
+	 * @param bool           $finalized
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function debugLog(EE_Transaction $transaction, EE_Payment $payment, bool $IPN, bool $finalized)
+	{
+		$payment_method = $payment->payment_method();
+		if ($payment_method instanceof EE_Payment_Method) {
+			$payment_method_type_obj = $payment_method->type_obj();
+			if ($payment_method_type_obj instanceof EE_PMT_Base) {
+				$gateway = $payment_method_type_obj->get_gateway();
+				if ($gateway instanceof EE_Gateway) {
+					$gateway->log(
+						[
+							'message'               => esc_html__(
+								'Post Payment Transaction Details',
+								'event_espresso'
+							),
+							'transaction'           => $transaction->model_field_array(),
+							'finalized'             => $finalized,
+							'IPN'                   => $IPN,
+							'deliver_notifications' => has_filter(
+								'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+							),
+						],
+						$payment
+					);
+				}
+			}
+		}
+	}
 }

core/services/payments/PaymentProcessorFees.php

Indentation +158 added lines, -158 removed lines

@@ -28,162 +28,162 @@
  */
 class PaymentProcessorFees
 {
-    public const  GATEWAY_PAYPAL  = 'PayPal Commerce';
-
-    public const  GATEWAY_SQUARE  = 'Square';
-
-    public const  GATEWAY_STRIPE  = 'Stripe';
-
-    private GracePeriod $grace_period;
-
-    private LicenseData $license_data;
-
-    /**
-     * @var float[][] $gateway_fees
-     */
-    private array $gateway_fees = [
-        LicenseData::LICENSE_ACTIVE  => [
-            PaymentProcessorFees::GATEWAY_PAYPAL => 0.00,
-            PaymentProcessorFees::GATEWAY_SQUARE => 0.00,
-            PaymentProcessorFees::GATEWAY_STRIPE => 0.00,
-        ],
-        LicenseData::LICENSE_EXPIRED => [
-            PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
-            PaymentProcessorFees::GATEWAY_SQUARE => 2.50,
-            PaymentProcessorFees::GATEWAY_STRIPE => 2.50,
-        ],
-        LicenseData::LICENSE_DECAF   => [
-            PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
-            PaymentProcessorFees::GATEWAY_SQUARE => 2.50,
-            PaymentProcessorFees::GATEWAY_STRIPE => 2.50,
-        ],
-    ];
-
-    private array $partner_gateways = [
-        PaymentProcessorFees::GATEWAY_PAYPAL,
-        PaymentProcessorFees::GATEWAY_SQUARE,
-        PaymentProcessorFees::GATEWAY_STRIPE,
-    ];
-
-
-    /**
-     * @param GracePeriod $grace_period
-     * @param LicenseData $license_data
-     */
-    public function __construct(GracePeriod $grace_period, LicenseData $license_data)
-    {
-        $this->grace_period = $grace_period;
-        $this->license_data = $license_data;
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @param string         $payment_method_name
-     * @param float          $amount
-     * @return float
-     * @throws EE_Error|ReflectionException|RuntimeException
-     * @throws Exception
-     */
-    public function applyGatewayPartnerFees(
-        EE_Transaction $transaction,
-        string $payment_method_name,
-        float $amount = 0.00
-    ): float {
-        $processing_fee = $this->forPaymentMethod($payment_method_name);
-        if ($processing_fee <= 0.00) {
-            return $amount;
-        }
-        $grand_total = $transaction->total_line_item(false);
-        if (
-            ! $grand_total instanceof EE_Line_Item
-            || ! $grand_total->is_total()
-            || $grand_total->TXN_ID() !== $transaction->ID()
-        ) {
-            // throw RuntimeException if total_line_item is not a total line item
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__(
-                        'Invalid or missing grand total line item for transaction %1$d.',
-                        'event_espresso'
-                    ),
-                    $transaction->ID()
-                )
-            );
-        }
-        $line_item = EEH_Line_Item::add_percentage_based_item(
-            EEH_Line_Item::get_pre_tax_subtotal($grand_total),
-            esc_html__('Payment Processing Fee', 'event_espresso'),
-            $processing_fee,
-            '',
-            false,
-            sanitize_key(
-                sprintf(
-                    '%1$s-fee-%2$d',
-                    $payment_method_name,
-                    $transaction->ID()
-                )
-            ),
-            true
-        );
-        $line_item->save();
-        return $grand_total->recalculate_total_including_taxes();
-    }
-
-
-    /**
-     * Returns the fee for a specific payment method based on the license status.
-     *
-     * @param string $payment_method_name
-     * @return float
-     * @throws Exception|OutOfBoundsException|RuntimeException
-     */
-    public function forPaymentMethod(string $payment_method_name): float
-    {
-        if (! $this->isPartnerGateway($payment_method_name)) {
-            return 0.0;
-        }
-        $license_status = $this->license_data->licenseStatus();
-        $license_expires = $this->license_data->licenseExpiry();
-        // decaf, new activations, or expired licenses are allowed a grace period
-        if ($this->grace_period->withinGracePeriod($license_status, $license_expires)) {
-            return 0.0;
-        }
-        return $this->getGatewayFee($payment_method_name, $license_status);
-    }
-
-
-    /**
-     * Checks if a gateway is a partner gateway.
-     *
-     * @param string $payment_method_name
-     * @return bool
-     */
-    private function isPartnerGateway(string $payment_method_name): bool
-    {
-        return in_array($payment_method_name, $this->partner_gateways, true);
-    }
-
-
-    /**
-     * Returns the fee for a specific payment method based on the license status.
-     *
-     * @param string $payment_method_name
-     * @param string $license_status
-     * @return float
-     * @throws OutOfBoundsException
-     */
-    private function getGatewayFee(string $payment_method_name, string $license_status): float
-    {
-        if (isset($this->gateway_fees[ $license_status ][ $payment_method_name ] )) {
-            return $this->gateway_fees[ $license_status ][ $payment_method_name ];
-        }
-        throw new OutOfBoundsException(
-            sprintf(
-                esc_html__('A partner fee for %1$s with %2$s license is not defined.', 'event_espresso'),
-                $payment_method_name,
-                $license_status
-            )
-        );
-    }
+	public const  GATEWAY_PAYPAL  = 'PayPal Commerce';
+
+	public const  GATEWAY_SQUARE  = 'Square';
+
+	public const  GATEWAY_STRIPE  = 'Stripe';
+
+	private GracePeriod $grace_period;
+
+	private LicenseData $license_data;
+
+	/**
+	 * @var float[][] $gateway_fees
+	 */
+	private array $gateway_fees = [
+		LicenseData::LICENSE_ACTIVE  => [
+			PaymentProcessorFees::GATEWAY_PAYPAL => 0.00,
+			PaymentProcessorFees::GATEWAY_SQUARE => 0.00,
+			PaymentProcessorFees::GATEWAY_STRIPE => 0.00,
+		],
+		LicenseData::LICENSE_EXPIRED => [
+			PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
+			PaymentProcessorFees::GATEWAY_SQUARE => 2.50,
+			PaymentProcessorFees::GATEWAY_STRIPE => 2.50,
+		],
+		LicenseData::LICENSE_DECAF   => [
+			PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
+			PaymentProcessorFees::GATEWAY_SQUARE => 2.50,
+			PaymentProcessorFees::GATEWAY_STRIPE => 2.50,
+		],
+	];
+
+	private array $partner_gateways = [
+		PaymentProcessorFees::GATEWAY_PAYPAL,
+		PaymentProcessorFees::GATEWAY_SQUARE,
+		PaymentProcessorFees::GATEWAY_STRIPE,
+	];
+
+
+	/**
+	 * @param GracePeriod $grace_period
+	 * @param LicenseData $license_data
+	 */
+	public function __construct(GracePeriod $grace_period, LicenseData $license_data)
+	{
+		$this->grace_period = $grace_period;
+		$this->license_data = $license_data;
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @param string         $payment_method_name
+	 * @param float          $amount
+	 * @return float
+	 * @throws EE_Error|ReflectionException|RuntimeException
+	 * @throws Exception
+	 */
+	public function applyGatewayPartnerFees(
+		EE_Transaction $transaction,
+		string $payment_method_name,
+		float $amount = 0.00
+	): float {
+		$processing_fee = $this->forPaymentMethod($payment_method_name);
+		if ($processing_fee <= 0.00) {
+			return $amount;
+		}
+		$grand_total = $transaction->total_line_item(false);
+		if (
+			! $grand_total instanceof EE_Line_Item
+			|| ! $grand_total->is_total()
+			|| $grand_total->TXN_ID() !== $transaction->ID()
+		) {
+			// throw RuntimeException if total_line_item is not a total line item
+			throw new RuntimeException(
+				sprintf(
+					esc_html__(
+						'Invalid or missing grand total line item for transaction %1$d.',
+						'event_espresso'
+					),
+					$transaction->ID()
+				)
+			);
+		}
+		$line_item = EEH_Line_Item::add_percentage_based_item(
+			EEH_Line_Item::get_pre_tax_subtotal($grand_total),
+			esc_html__('Payment Processing Fee', 'event_espresso'),
+			$processing_fee,
+			'',
+			false,
+			sanitize_key(
+				sprintf(
+					'%1$s-fee-%2$d',
+					$payment_method_name,
+					$transaction->ID()
+				)
+			),
+			true
+		);
+		$line_item->save();
+		return $grand_total->recalculate_total_including_taxes();
+	}
+
+
+	/**
+	 * Returns the fee for a specific payment method based on the license status.
+	 *
+	 * @param string $payment_method_name
+	 * @return float
+	 * @throws Exception|OutOfBoundsException|RuntimeException
+	 */
+	public function forPaymentMethod(string $payment_method_name): float
+	{
+		if (! $this->isPartnerGateway($payment_method_name)) {
+			return 0.0;
+		}
+		$license_status = $this->license_data->licenseStatus();
+		$license_expires = $this->license_data->licenseExpiry();
+		// decaf, new activations, or expired licenses are allowed a grace period
+		if ($this->grace_period->withinGracePeriod($license_status, $license_expires)) {
+			return 0.0;
+		}
+		return $this->getGatewayFee($payment_method_name, $license_status);
+	}
+
+
+	/**
+	 * Checks if a gateway is a partner gateway.
+	 *
+	 * @param string $payment_method_name
+	 * @return bool
+	 */
+	private function isPartnerGateway(string $payment_method_name): bool
+	{
+		return in_array($payment_method_name, $this->partner_gateways, true);
+	}
+
+
+	/**
+	 * Returns the fee for a specific payment method based on the license status.
+	 *
+	 * @param string $payment_method_name
+	 * @param string $license_status
+	 * @return float
+	 * @throws OutOfBoundsException
+	 */
+	private function getGatewayFee(string $payment_method_name, string $license_status): float
+	{
+		if (isset($this->gateway_fees[ $license_status ][ $payment_method_name ] )) {
+			return $this->gateway_fees[ $license_status ][ $payment_method_name ];
+		}
+		throw new OutOfBoundsException(
+			sprintf(
+				esc_html__('A partner fee for %1$s with %2$s license is not defined.', 'event_espresso'),
+				$payment_method_name,
+				$license_status
+			)
+		);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -140,7 +140,7 @@ 
      */
     public function forPaymentMethod(string $payment_method_name): float
     {
-        if (! $this->isPartnerGateway($payment_method_name)) {
+        if ( ! $this->isPartnerGateway($payment_method_name)) {
             return 0.0;
         }
         $license_status = $this->license_data->licenseStatus();
@@ -175,8 +175,8 @@ 
      */
     private function getGatewayFee(string $payment_method_name, string $license_status): float
     {
-        if (isset($this->gateway_fees[ $license_status ][ $payment_method_name ] )) {
-            return $this->gateway_fees[ $license_status ][ $payment_method_name ];
+        if (isset($this->gateway_fees[$license_status][$payment_method_name])) {
+            return $this->gateway_fees[$license_status][$payment_method_name];
         }
         throw new OutOfBoundsException(
             sprintf(

core/services/licensing/LicenseKeyData.php

Indentation +60 added lines, -60 removed lines

@@ -16,74 +16,74 @@
  */
 class LicenseKeyData extends WordPressOption
 {
-    /**
-     * The name of the WordPress option where license data is stored.
-     */
-    const OPTION_NAME = 'event-espresso-license-keys';
+	/**
+	 * The name of the WordPress option where license data is stored.
+	 */
+	const OPTION_NAME = 'event-espresso-license-keys';
 
 
-    public function __construct()
-    {
-        parent::__construct(LicenseKeyData::OPTION_NAME, [], true);
-    }
+	public function __construct()
+	{
+		parent::__construct(LicenseKeyData::OPTION_NAME, [], true);
+	}
 
 
-    /**
-     * Retrieves the license data for a specific plugin.
-     *
-     * @param string $plugin The plugin identifier.
-     * @return stdClass An object containing the license data for the specified plugin.
-     *                       Returns a default structure if no data exists.
-     */
-    public function getLicenseDataForPlugin(string $plugin): stdCLass
-    {
-        $licenses     = $this->loadOption();
-        $license_data = $licenses[ $plugin ] ?? ['license' => 'none', 'success' => false, 'error' => true];
-        return (object) $license_data;
-    }
+	/**
+	 * Retrieves the license data for a specific plugin.
+	 *
+	 * @param string $plugin The plugin identifier.
+	 * @return stdClass An object containing the license data for the specified plugin.
+	 *                       Returns a default structure if no data exists.
+	 */
+	public function getLicenseDataForPlugin(string $plugin): stdCLass
+	{
+		$licenses     = $this->loadOption();
+		$license_data = $licenses[ $plugin ] ?? ['license' => 'none', 'success' => false, 'error' => true];
+		return (object) $license_data;
+	}
 
 
-    /**
-     * Retrieves all stored license data for all plugins.
-     *
-     * @return array An associative array of all license data, keyed by plugin identifier.
-     */
-    public function getAllLicenses(): array
-    {
-        return $this->loadOption();
-    }
+	/**
+	 * Retrieves all stored license data for all plugins.
+	 *
+	 * @return array An associative array of all license data, keyed by plugin identifier.
+	 */
+	public function getAllLicenses(): array
+	{
+		return $this->loadOption();
+	}
 
 
-    /**
-     * Updates or adds the license data for a specific plugin.
-     *
-     * @param stdClass $license_data The new license data to store.
-     * @param string   $plugin       The plugin identifier.
-     * @param bool     $force_update Whether to force the update operation.
-     * @return int The result of the update operation.
-     */
-    public function updateLicenseDataForPlugin(stdCLass $license_data, string $plugin, bool $force_update = false): int
-    {
-        $licenses = $this->loadOption();
-        // convert objects to array and merge new data with old
-        $licenses[ $plugin ] = (array) $license_data;
-        // then sort by key and convert back to stdCLass
-        ksort($licenses[ $plugin ]);
-        $licenses[ $plugin ] = (object) $licenses[ $plugin ];
-        return $this->updateOption($licenses, $force_update);
-    }
+	/**
+	 * Updates or adds the license data for a specific plugin.
+	 *
+	 * @param stdClass $license_data The new license data to store.
+	 * @param string   $plugin       The plugin identifier.
+	 * @param bool     $force_update Whether to force the update operation.
+	 * @return int The result of the update operation.
+	 */
+	public function updateLicenseDataForPlugin(stdCLass $license_data, string $plugin, bool $force_update = false): int
+	{
+		$licenses = $this->loadOption();
+		// convert objects to array and merge new data with old
+		$licenses[ $plugin ] = (array) $license_data;
+		// then sort by key and convert back to stdCLass
+		ksort($licenses[ $plugin ]);
+		$licenses[ $plugin ] = (object) $licenses[ $plugin ];
+		return $this->updateOption($licenses, $force_update);
+	}
 
 
-    /**
-     * Removes the license data for a specific plugin.
-     *
-     * @param string $plugin The plugin identifier.
-     * @return int The result of the remove operation.
-     */
-    public function removeLicenseDataForPlugin(string $plugin): int
-    {
-        $licenses = $this->loadOption();
-        unset($licenses[ $plugin ]);
-        return $this->updateOption($licenses);
-    }
+	/**
+	 * Removes the license data for a specific plugin.
+	 *
+	 * @param string $plugin The plugin identifier.
+	 * @return int The result of the remove operation.
+	 */
+	public function removeLicenseDataForPlugin(string $plugin): int
+	{
+		$licenses = $this->loadOption();
+		unset($licenses[ $plugin ]);
+		return $this->updateOption($licenses);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -38,7 +38,7 @@ 
     public function getLicenseDataForPlugin(string $plugin): stdCLass
     {
         $licenses     = $this->loadOption();
-        $license_data = $licenses[ $plugin ] ?? ['license' => 'none', 'success' => false, 'error' => true];
+        $license_data = $licenses[$plugin] ?? ['license' => 'none', 'success' => false, 'error' => true];
         return (object) $license_data;
     }
 
@@ -66,10 +66,10 @@ 
     {
         $licenses = $this->loadOption();
         // convert objects to array and merge new data with old
-        $licenses[ $plugin ] = (array) $license_data;
+        $licenses[$plugin] = (array) $license_data;
         // then sort by key and convert back to stdCLass
-        ksort($licenses[ $plugin ]);
-        $licenses[ $plugin ] = (object) $licenses[ $plugin ];
+        ksort($licenses[$plugin]);
+        $licenses[$plugin] = (object) $licenses[$plugin];
         return $this->updateOption($licenses, $force_update);
     }
 
@@ -83,7 +83,7 @@ 
     public function removeLicenseDataForPlugin(string $plugin): int
     {
         $licenses = $this->loadOption();
-        unset($licenses[ $plugin ]);
+        unset($licenses[$plugin]);
         return $this->updateOption($licenses);
     }
 }

core/services/licensing/PluginLicense.php

Indentation +242 added lines, -242 removed lines

@@ -14,246 +14,246 @@
  */
 class PluginLicense
 {
-    private ?LicenseKeyData $license_key_data = null;
-
-    private ?PluginUpdater $updater = null;
-
-    private string $license_key = '';
-
-    private string $mainfile;
-
-    private string $min_core_version;
-
-    private string $plugin_id;
-
-    private string $plugin_name;
-
-    private string $plugin_slug;
-
-    private string $version;
-
-    private bool $beta;
-
-    private bool $wp_override;
-
-    private static array $slug_prefixes = ['ee-', 'eea-', 'eep-', 'espresso-', 'ee_', 'eea_', 'eep_', 'espresso_'];
-
-
-    public function __construct(
-        string $mainfile,
-        string $plugin_id,
-        string $plugin_name,
-        string $plugin_slug,
-        string $version,
-        bool $beta = false,
-        bool $wp_override = false,
-        string $min_core_version = ''
-    ) {
-        $this->mainfile         = $mainfile;
-        $this->plugin_id        = $plugin_id;
-        $this->plugin_name      = $plugin_name;
-        $this->version          = $version;
-        $this->beta             = $beta;
-        $this->wp_override      = $wp_override;
-        $this->plugin_slug      = $this->removePluginSlugPrefixes($plugin_slug);
-        $this->min_core_version = $min_core_version;
-
-        add_action('init', [$this, 'loadPluginUpdater']);
-        add_action(
-            'AHEE__EventEspresso_core_services_licensing_PluginLicenseCollection__loadPluginLicenses',
-            [$this, 'loadPluginLicense']
-        );
-        add_filter(
-            'FHEE__LicenseKeysAdminForm__generate__form_subsections',
-            [$this, 'addLicenseKeyFormSection']
-        );
-        add_filter(
-            'edd_sl_plugin_updater_api_params',
-            [$this, 'addCustomApiParams'],
-            10,
-            2
-        );
-    }
-
-
-    /**
-     * removes unnecessary prefixes from plugin slugs
-     *
-     * @param string $plugin_slug
-     * @return string
-     */
-    private function removePluginSlugPrefixes(string $plugin_slug): string
-    {
-        foreach (self::$slug_prefixes as $slug_prefix) {
-            if (strpos($plugin_slug, $slug_prefix) === 0) {
-                $plugin_slug = str_replace($slug_prefix, '', $plugin_slug);
-            }
-        }
-        return $plugin_slug;
-    }
-
-
-    /**
-     * @return PluginUpdater|null
-     */
-    public function updater(): ?PluginUpdater
-    {
-        return $this->updater;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function itemID(): string
-    {
-        return $this->plugin_id;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function itemName(): string
-    {
-        return $this->plugin_name;
-    }
-
-
-    private function getLicenseKeyData(): stdClass
-    {
-        if (! $this->license_key_data instanceof LicenseKeyData) {
-            $this->license_key_data = LoaderFactory::getShared(LicenseKeyData::class);
-        }
-        return $this->license_key_data->getLicenseDataForPlugin($this->pluginSlug());
-    }
-
-
-    /**
-     * @return string
-     */
-    public function licenseKey(): string
-    {
-        return $this->license_key;
-    }
-
-
-    /**
-     * @param string $license_key
-     */
-    public function updateLicenseKey(string $license_key): void
-    {
-        $this->license_key = sanitize_text_field($license_key);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function mainfile(): string
-    {
-        return $this->mainfile;
-    }
-
-
-    /**
-     * @return string
-     * @since 5.0.20.p
-     */
-    public function minCoreVersion(): string
-    {
-        return $this->min_core_version;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function pluginSlug(): string
-    {
-        return $this->plugin_slug;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function version(): string
-    {
-        return $this->version;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isBeta(): bool
-    {
-        return $this->beta;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWpOverride(): bool
-    {
-        return $this->wp_override;
-    }
-
-
-    public function loadPluginUpdater()
-    {
-        // To support auto-updates, this needs to run during the wp_version_check cron job for privileged users.
-        if (! current_user_can('manage_options') && ! (defined('DOING_CRON') && DOING_CRON)) {
-            return;
-        }
-
-        $license_key_data = $this->getLicenseKeyData();
-        $license_key      = $license_key_data->license_key ?? '';
-        if ($license_key) {
-            $this->updateLicenseKey($license_key);
-        }
-
-        $this->updater = new PluginUpdater(
-            LicenseAPI::url(),
-            $this->mainfile(),
-            [
-                'author'      => LicenseAPI::AUTHOR,
-                'beta'        => $this->isBeta(),
-                'item_id'     => $this->itemID(),
-                'item_name'   => $this->itemName(),
-                'license'     => $this->licenseKey(),
-                'version'     => $this->version(),
-                'wp_override' => $this->isWpOverride(),
-            ]
-        );
-    }
-
-
-    public function loadPluginLicense(PluginLicenseCollection $plugin_license_collection)
-    {
-        $plugin_license_collection->add($this, $this->pluginSlug());
-    }
-
-
-    public function addLicenseKeyFormSection(array $license_keys_form_subsections): array
-    {
-        if (is_main_site()) {
-            $license_keys_form_subsections[ $this->pluginSlug() ] = LoaderFactory::getNew(
-                LicenseKeyFormInput::class,
-                [$this]
-            );
-        }
-        return $license_keys_form_subsections;
-    }
-
-
-    public function addCustomApiParams($api_params, $api_data)
-    {
-        if ($api_data['item_name'] === $this->itemName()) {
-            $api_params['event_espresso_core_version'] = EVENT_ESPRESSO_VERSION;
-        }
-        return $api_params;
-    }
+	private ?LicenseKeyData $license_key_data = null;
+
+	private ?PluginUpdater $updater = null;
+
+	private string $license_key = '';
+
+	private string $mainfile;
+
+	private string $min_core_version;
+
+	private string $plugin_id;
+
+	private string $plugin_name;
+
+	private string $plugin_slug;
+
+	private string $version;
+
+	private bool $beta;
+
+	private bool $wp_override;
+
+	private static array $slug_prefixes = ['ee-', 'eea-', 'eep-', 'espresso-', 'ee_', 'eea_', 'eep_', 'espresso_'];
+
+
+	public function __construct(
+		string $mainfile,
+		string $plugin_id,
+		string $plugin_name,
+		string $plugin_slug,
+		string $version,
+		bool $beta = false,
+		bool $wp_override = false,
+		string $min_core_version = ''
+	) {
+		$this->mainfile         = $mainfile;
+		$this->plugin_id        = $plugin_id;
+		$this->plugin_name      = $plugin_name;
+		$this->version          = $version;
+		$this->beta             = $beta;
+		$this->wp_override      = $wp_override;
+		$this->plugin_slug      = $this->removePluginSlugPrefixes($plugin_slug);
+		$this->min_core_version = $min_core_version;
+
+		add_action('init', [$this, 'loadPluginUpdater']);
+		add_action(
+			'AHEE__EventEspresso_core_services_licensing_PluginLicenseCollection__loadPluginLicenses',
+			[$this, 'loadPluginLicense']
+		);
+		add_filter(
+			'FHEE__LicenseKeysAdminForm__generate__form_subsections',
+			[$this, 'addLicenseKeyFormSection']
+		);
+		add_filter(
+			'edd_sl_plugin_updater_api_params',
+			[$this, 'addCustomApiParams'],
+			10,
+			2
+		);
+	}
+
+
+	/**
+	 * removes unnecessary prefixes from plugin slugs
+	 *
+	 * @param string $plugin_slug
+	 * @return string
+	 */
+	private function removePluginSlugPrefixes(string $plugin_slug): string
+	{
+		foreach (self::$slug_prefixes as $slug_prefix) {
+			if (strpos($plugin_slug, $slug_prefix) === 0) {
+				$plugin_slug = str_replace($slug_prefix, '', $plugin_slug);
+			}
+		}
+		return $plugin_slug;
+	}
+
+
+	/**
+	 * @return PluginUpdater|null
+	 */
+	public function updater(): ?PluginUpdater
+	{
+		return $this->updater;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function itemID(): string
+	{
+		return $this->plugin_id;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function itemName(): string
+	{
+		return $this->plugin_name;
+	}
+
+
+	private function getLicenseKeyData(): stdClass
+	{
+		if (! $this->license_key_data instanceof LicenseKeyData) {
+			$this->license_key_data = LoaderFactory::getShared(LicenseKeyData::class);
+		}
+		return $this->license_key_data->getLicenseDataForPlugin($this->pluginSlug());
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function licenseKey(): string
+	{
+		return $this->license_key;
+	}
+
+
+	/**
+	 * @param string $license_key
+	 */
+	public function updateLicenseKey(string $license_key): void
+	{
+		$this->license_key = sanitize_text_field($license_key);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function mainfile(): string
+	{
+		return $this->mainfile;
+	}
+
+
+	/**
+	 * @return string
+	 * @since 5.0.20.p
+	 */
+	public function minCoreVersion(): string
+	{
+		return $this->min_core_version;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginSlug(): string
+	{
+		return $this->plugin_slug;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function version(): string
+	{
+		return $this->version;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBeta(): bool
+	{
+		return $this->beta;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWpOverride(): bool
+	{
+		return $this->wp_override;
+	}
+
+
+	public function loadPluginUpdater()
+	{
+		// To support auto-updates, this needs to run during the wp_version_check cron job for privileged users.
+		if (! current_user_can('manage_options') && ! (defined('DOING_CRON') && DOING_CRON)) {
+			return;
+		}
+
+		$license_key_data = $this->getLicenseKeyData();
+		$license_key      = $license_key_data->license_key ?? '';
+		if ($license_key) {
+			$this->updateLicenseKey($license_key);
+		}
+
+		$this->updater = new PluginUpdater(
+			LicenseAPI::url(),
+			$this->mainfile(),
+			[
+				'author'      => LicenseAPI::AUTHOR,
+				'beta'        => $this->isBeta(),
+				'item_id'     => $this->itemID(),
+				'item_name'   => $this->itemName(),
+				'license'     => $this->licenseKey(),
+				'version'     => $this->version(),
+				'wp_override' => $this->isWpOverride(),
+			]
+		);
+	}
+
+
+	public function loadPluginLicense(PluginLicenseCollection $plugin_license_collection)
+	{
+		$plugin_license_collection->add($this, $this->pluginSlug());
+	}
+
+
+	public function addLicenseKeyFormSection(array $license_keys_form_subsections): array
+	{
+		if (is_main_site()) {
+			$license_keys_form_subsections[ $this->pluginSlug() ] = LoaderFactory::getNew(
+				LicenseKeyFormInput::class,
+				[$this]
+			);
+		}
+		return $license_keys_form_subsections;
+	}
+
+
+	public function addCustomApiParams($api_params, $api_data)
+	{
+		if ($api_data['item_name'] === $this->itemName()) {
+			$api_params['event_espresso_core_version'] = EVENT_ESPRESSO_VERSION;
+		}
+		return $api_params;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -122,7 +122,7 @@ 
 
     private function getLicenseKeyData(): stdClass
     {
-        if (! $this->license_key_data instanceof LicenseKeyData) {
+        if ( ! $this->license_key_data instanceof LicenseKeyData) {
             $this->license_key_data = LoaderFactory::getShared(LicenseKeyData::class);
         }
         return $this->license_key_data->getLicenseDataForPlugin($this->pluginSlug());
@@ -205,7 +205,7 @@ 
     public function loadPluginUpdater()
     {
         // To support auto-updates, this needs to run during the wp_version_check cron job for privileged users.
-        if (! current_user_can('manage_options') && ! (defined('DOING_CRON') && DOING_CRON)) {
+        if ( ! current_user_can('manage_options') && ! (defined('DOING_CRON') && DOING_CRON)) {
             return;
         }
 
@@ -240,7 +240,7 @@ 
     public function addLicenseKeyFormSection(array $license_keys_form_subsections): array
     {
         if (is_main_site()) {
-            $license_keys_form_subsections[ $this->pluginSlug() ] = LoaderFactory::getNew(
+            $license_keys_form_subsections[$this->pluginSlug()] = LoaderFactory::getNew(
                 LicenseKeyFormInput::class,
                 [$this]
             );

core/services/licensing/LicenseManager.php

Indentation +113 added lines, -113 removed lines

@@ -6,117 +6,117 @@
 
 class LicenseManager
 {
-    private LicenseAPI $license_api;
-
-    private LicenseKeyData $license_key_data;
-
-    private PluginLicenseCollection $plugin_license_collection;
-
-
-    public function __construct(
-        LicenseAPI $license_api,
-        LicenseKeyData $license_key_data,
-        PluginLicenseCollection $plugin_license_collection
-    ) {
-        $this->license_api               = $license_api;
-        $this->license_key_data          = $license_key_data;
-        $this->plugin_license_collection = $plugin_license_collection;
-    }
-
-
-    public function activateLicense(
-        string $license_key,
-        string $item_id,
-        string $item_name,
-        string $plugin_slug,
-        string $plugin_version,
-        string $min_core_version = ''
-    ): stdCLass {
-        $license_data              = $this->license_api->postRequest(
-            LicenseAPI::ACTION_ACTIVATE,
-            $license_key,
-            $item_id,
-            $item_name,
-            $plugin_version,
-            $min_core_version
-        );
-        $license_data->license_key = $license_data->license === 'valid' ? $license_key : '';
-        $this->license_key_data->updateLicenseDataForPlugin($license_data, $plugin_slug);
-        return $license_data;
-    }
-
-
-    public function deactivateLicense(
-        string $license_key,
-        string $item_id,
-        string $item_name,
-        string $plugin_slug,
-        string $plugin_version,
-        string $min_core_version = ''
-    ): stdCLass {
-        $license_data = $this->license_api->postRequest(
-            LicenseAPI::ACTION_DEACTIVATE,
-            $license_key,
-            $item_id,
-            $item_name,
-            $plugin_version,
-            $min_core_version
-        );
-        $this->license_key_data->removeLicenseDataForPlugin($plugin_slug);
-        return $license_data;
-    }
-
-
-    public function resetLicenseKey(string $plugin_slug): stdCLass
-    {
-        $license_data              = $this->getLicenseData($plugin_slug);
-        $license_data->license_key = '';
-        $this->license_key_data->updateLicenseDataForPlugin($license_data, $plugin_slug, true);
-        return $license_data;
-    }
-
-
-    public function checkLicense(
-        string $license_key,
-        string $item_id,
-        string $item_name,
-        string $plugin_slug,
-        string $plugin_version,
-        string $min_core_version = ''
-    ): stdCLass {
-        $existing_license_data = $this->getLicenseData($plugin_slug);
-        $license_data          = $this->license_api->postRequest(
-            LicenseAPI::ACTION_CHECK,
-            $license_key,
-            $item_id,
-            $item_name,
-            $plugin_version,
-            $min_core_version
-        );
-        $license_data          = (array) $license_data + (array) $existing_license_data;
-        return (object) $license_data;
-    }
-
-
-    public function getLicenseData(string $plugin_slug): stdClass
-    {
-        return $this->license_key_data->getLicenseDataForPlugin($plugin_slug);
-    }
-
-
-    public function getVersionInfo(): stdClass
-    {
-        $products = [];
-        foreach ($this->plugin_license_collection as $plugin_license) {
-            if (! $plugin_license instanceof PluginLicense) {
-                continue;
-            }
-            $products[ $plugin_license->pluginSlug() ] = [
-                'item_id' => $plugin_license->itemId(),
-                'license' => $plugin_license->licenseKey(),
-                'url'     => LicenseAPI::url(),
-            ];
-        }
-        return $this->license_api->getProductVersions($products);
-    }
+	private LicenseAPI $license_api;
+
+	private LicenseKeyData $license_key_data;
+
+	private PluginLicenseCollection $plugin_license_collection;
+
+
+	public function __construct(
+		LicenseAPI $license_api,
+		LicenseKeyData $license_key_data,
+		PluginLicenseCollection $plugin_license_collection
+	) {
+		$this->license_api               = $license_api;
+		$this->license_key_data          = $license_key_data;
+		$this->plugin_license_collection = $plugin_license_collection;
+	}
+
+
+	public function activateLicense(
+		string $license_key,
+		string $item_id,
+		string $item_name,
+		string $plugin_slug,
+		string $plugin_version,
+		string $min_core_version = ''
+	): stdCLass {
+		$license_data              = $this->license_api->postRequest(
+			LicenseAPI::ACTION_ACTIVATE,
+			$license_key,
+			$item_id,
+			$item_name,
+			$plugin_version,
+			$min_core_version
+		);
+		$license_data->license_key = $license_data->license === 'valid' ? $license_key : '';
+		$this->license_key_data->updateLicenseDataForPlugin($license_data, $plugin_slug);
+		return $license_data;
+	}
+
+
+	public function deactivateLicense(
+		string $license_key,
+		string $item_id,
+		string $item_name,
+		string $plugin_slug,
+		string $plugin_version,
+		string $min_core_version = ''
+	): stdCLass {
+		$license_data = $this->license_api->postRequest(
+			LicenseAPI::ACTION_DEACTIVATE,
+			$license_key,
+			$item_id,
+			$item_name,
+			$plugin_version,
+			$min_core_version
+		);
+		$this->license_key_data->removeLicenseDataForPlugin($plugin_slug);
+		return $license_data;
+	}
+
+
+	public function resetLicenseKey(string $plugin_slug): stdCLass
+	{
+		$license_data              = $this->getLicenseData($plugin_slug);
+		$license_data->license_key = '';
+		$this->license_key_data->updateLicenseDataForPlugin($license_data, $plugin_slug, true);
+		return $license_data;
+	}
+
+
+	public function checkLicense(
+		string $license_key,
+		string $item_id,
+		string $item_name,
+		string $plugin_slug,
+		string $plugin_version,
+		string $min_core_version = ''
+	): stdCLass {
+		$existing_license_data = $this->getLicenseData($plugin_slug);
+		$license_data          = $this->license_api->postRequest(
+			LicenseAPI::ACTION_CHECK,
+			$license_key,
+			$item_id,
+			$item_name,
+			$plugin_version,
+			$min_core_version
+		);
+		$license_data          = (array) $license_data + (array) $existing_license_data;
+		return (object) $license_data;
+	}
+
+
+	public function getLicenseData(string $plugin_slug): stdClass
+	{
+		return $this->license_key_data->getLicenseDataForPlugin($plugin_slug);
+	}
+
+
+	public function getVersionInfo(): stdClass
+	{
+		$products = [];
+		foreach ($this->plugin_license_collection as $plugin_license) {
+			if (! $plugin_license instanceof PluginLicense) {
+				continue;
+			}
+			$products[ $plugin_license->pluginSlug() ] = [
+				'item_id' => $plugin_license->itemId(),
+				'license' => $plugin_license->licenseKey(),
+				'url'     => LicenseAPI::url(),
+			];
+		}
+		return $this->license_api->getProductVersions($products);
+	}
 }

core/services/database/WordPressOption.php

Indentation +172 added lines, -172 removed lines

@@ -17,176 +17,176 @@
  */
 abstract class WordPressOption
 {
-    public const NOT_SET_YET = 'wordpress-option-value-not-yet-set';
-
-    /**
-     * WordPress makes it difficult to determine if an option successfully saved or not,
-     * which is sometimes really important to know, especially if the information you are saving is critical.
-     * The following options allow us to have a better chance of knowing when an update actually failed
-     * or when everything is OK but it just didn't update because the value hasn't changed.
-     */
-    public const UPDATE_SUCCESS = 1;
-
-    public const UPDATE_NONE    = 0;
-
-    public const UPDATE_ERROR   = -1;
-
-    private bool $autoload = false;
-
-    /**
-     * @var mixed
-     */
-    private $default_value = null;
-
-    private string $option_name = '';
-
-    /**
-     * @var mixed
-     */
-    private $value = WordPressOption::NOT_SET_YET;
-
-    private OptionEngine $option_engine;
-
-
-    /**
-     * WordPressOption constructor.
-     *
-     * @param string $option_name
-     * @param mixed  $default_value
-     * @param bool   $autoload          if true, will load the option on EVERY request
-     * @param bool   $is_network_option if true, will save the option to the network as opposed to the current blog
-     */
-    public function __construct(
-        string $option_name,
-        $default_value,
-        bool $autoload = false,
-        bool $is_network_option = false
-    ) {
-        $this->setAutoload($autoload);
-        $this->setDefaultValue($default_value);
-        $this->setOptionName($option_name);
-        $this->option_engine = new OptionEngine($is_network_option);
-    }
-
-
-    /**
-     * @param bool|string $autoload
-     */
-    public function setAutoload($autoload): void
-    {
-        $this->autoload = filter_var($autoload, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param mixed $default_value
-     */
-    public function setDefaultValue($default_value): void
-    {
-        $this->default_value = $default_value;
-    }
-
-
-    /**
-     * @param string $option_name
-     */
-    public function setOptionName(string $option_name): void
-    {
-        $this->option_name = sanitize_key($option_name);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function optionExists(): string
-    {
-        return $this->option_engine->getOption(
-            $this->getOptionName(),
-            WordPressOption::NOT_SET_YET
-        ) !== WordPressOption::NOT_SET_YET;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getOptionName(): string
-    {
-        return $this->option_name;
-    }
-
-
-    /**
-     * @return false|mixed|void
-     */
-    public function loadOption()
-    {
-        if ($this->value === WordPressOption::NOT_SET_YET) {
-            $this->value = $this->option_engine->getOption($this->getOptionName(), $this->default_value);
-        }
-        return $this->value;
-    }
-
-
-    /**
-     * @param $value
-     * @param bool $force_update
-     * @return int
-     */
-    public function updateOption($value, bool $force_update = false): int
-    {
-        // don't update if value has not changed since last update
-        if (! $force_update && $this->valueIsUnchanged($value)) {
-            return WordPressOption::UPDATE_NONE;
-        }
-        if ($force_update) {
-            $this->option_engine->updateOption($this->getOptionName(), null);
-        }
-        $this->value = $value;
-        // because the options for updating differ when adding an option for the first time
-        // we use the WordPressOption::NOT_SET_YET to determine if things already exist in the db
-        $updated = $this->optionExists()
-            ? $this->option_engine->updateOption($this->getOptionName(), $this->value)
-            : $this->option_engine->addOption($this->getOptionName(), $this->value, $this->autoload());
-
-        if ($updated) {
-            return WordPressOption::UPDATE_SUCCESS;
-        }
-        return WordPressOption::UPDATE_ERROR;
-    }
-
-
-    private function valueIsUnchanged($value): bool
-    {
-        if (is_array($value) && is_array($this->value)) {
-            $diff = EEH_Array::array_diff_recursive($value, $this->value);
-            // $diff = array_diff($value, $this->value);
-            return empty($diff);
-        }
-        // emulate WP's method for checking equality
-        return $value === $this->value && maybe_serialize($value) === maybe_serialize($this->value);
-    }
-
-
-    /**
-     * @return string
-     */
-    private function autoload(): string
-    {
-        return $this->autoload ? 'yes' : 'no';
-    }
-
-
-    /**
-     * Deletes the option from the database
-     * for the rest of the request
-     *
-     * @return bool
-     * @since  5.0.0.p
-     */
-    public function deleteOption(): bool
-    {
-        return $this->option_engine->deleteOption($this->getOptionName());
-    }
+	public const NOT_SET_YET = 'wordpress-option-value-not-yet-set';
+
+	/**
+	 * WordPress makes it difficult to determine if an option successfully saved or not,
+	 * which is sometimes really important to know, especially if the information you are saving is critical.
+	 * The following options allow us to have a better chance of knowing when an update actually failed
+	 * or when everything is OK but it just didn't update because the value hasn't changed.
+	 */
+	public const UPDATE_SUCCESS = 1;
+
+	public const UPDATE_NONE    = 0;
+
+	public const UPDATE_ERROR   = -1;
+
+	private bool $autoload = false;
+
+	/**
+	 * @var mixed
+	 */
+	private $default_value = null;
+
+	private string $option_name = '';
+
+	/**
+	 * @var mixed
+	 */
+	private $value = WordPressOption::NOT_SET_YET;
+
+	private OptionEngine $option_engine;
+
+
+	/**
+	 * WordPressOption constructor.
+	 *
+	 * @param string $option_name
+	 * @param mixed  $default_value
+	 * @param bool   $autoload          if true, will load the option on EVERY request
+	 * @param bool   $is_network_option if true, will save the option to the network as opposed to the current blog
+	 */
+	public function __construct(
+		string $option_name,
+		$default_value,
+		bool $autoload = false,
+		bool $is_network_option = false
+	) {
+		$this->setAutoload($autoload);
+		$this->setDefaultValue($default_value);
+		$this->setOptionName($option_name);
+		$this->option_engine = new OptionEngine($is_network_option);
+	}
+
+
+	/**
+	 * @param bool|string $autoload
+	 */
+	public function setAutoload($autoload): void
+	{
+		$this->autoload = filter_var($autoload, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param mixed $default_value
+	 */
+	public function setDefaultValue($default_value): void
+	{
+		$this->default_value = $default_value;
+	}
+
+
+	/**
+	 * @param string $option_name
+	 */
+	public function setOptionName(string $option_name): void
+	{
+		$this->option_name = sanitize_key($option_name);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function optionExists(): string
+	{
+		return $this->option_engine->getOption(
+			$this->getOptionName(),
+			WordPressOption::NOT_SET_YET
+		) !== WordPressOption::NOT_SET_YET;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getOptionName(): string
+	{
+		return $this->option_name;
+	}
+
+
+	/**
+	 * @return false|mixed|void
+	 */
+	public function loadOption()
+	{
+		if ($this->value === WordPressOption::NOT_SET_YET) {
+			$this->value = $this->option_engine->getOption($this->getOptionName(), $this->default_value);
+		}
+		return $this->value;
+	}
+
+
+	/**
+	 * @param $value
+	 * @param bool $force_update
+	 * @return int
+	 */
+	public function updateOption($value, bool $force_update = false): int
+	{
+		// don't update if value has not changed since last update
+		if (! $force_update && $this->valueIsUnchanged($value)) {
+			return WordPressOption::UPDATE_NONE;
+		}
+		if ($force_update) {
+			$this->option_engine->updateOption($this->getOptionName(), null);
+		}
+		$this->value = $value;
+		// because the options for updating differ when adding an option for the first time
+		// we use the WordPressOption::NOT_SET_YET to determine if things already exist in the db
+		$updated = $this->optionExists()
+			? $this->option_engine->updateOption($this->getOptionName(), $this->value)
+			: $this->option_engine->addOption($this->getOptionName(), $this->value, $this->autoload());
+
+		if ($updated) {
+			return WordPressOption::UPDATE_SUCCESS;
+		}
+		return WordPressOption::UPDATE_ERROR;
+	}
+
+
+	private function valueIsUnchanged($value): bool
+	{
+		if (is_array($value) && is_array($this->value)) {
+			$diff = EEH_Array::array_diff_recursive($value, $this->value);
+			// $diff = array_diff($value, $this->value);
+			return empty($diff);
+		}
+		// emulate WP's method for checking equality
+		return $value === $this->value && maybe_serialize($value) === maybe_serialize($this->value);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	private function autoload(): string
+	{
+		return $this->autoload ? 'yes' : 'no';
+	}
+
+
+	/**
+	 * Deletes the option from the database
+	 * for the rest of the request
+	 *
+	 * @return bool
+	 * @since  5.0.0.p
+	 */
+	public function deleteOption(): bool
+	{
+		return $this->option_engine->deleteOption($this->getOptionName());
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -137,7 +137,7 @@
     public function updateOption($value, bool $force_update = false): int
     {
         // don't update if value has not changed since last update
-        if (! $force_update && $this->valueIsUnchanged($value)) {
+        if ( ! $force_update && $this->valueIsUnchanged($value)) {
             return WordPressOption::UPDATE_NONE;
         }
         if ($force_update) {