eventespresso / event-espresso-core

core/services/payment_methods/gateways/GatewayDataFormatterInterface.php

Indentation +45 added lines, -45 removed lines

@@ -16,64 +16,64 @@
 interface GatewayDataFormatterInterface
 {
 
-    /**
-     * Gets the text to use for a gateway's line item name when this is a partial payment
-     *
-     * @param EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemName(EEI_Payment $payment): string;
+	/**
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
+	 *
+	 * @param EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemName(EEI_Payment $payment): string;
 
 
 
-    /**
-     * Gets the text to use for a gateway's line item description when this is a partial payment
-     *
-     * @param EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemDesc(EEI_Payment $payment): string;
+	/**
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
+	 *
+	 * @param EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemDesc(EEI_Payment $payment): string;
 
 
 
-    /**
-     * Gets the name to use for a line item when sending line items to the gateway
-     *
-     * @param EE_Line_Item $line_item
-     * @param EEI_Payment   $payment
-     * @return string
-     */
-    public function formatLineItemName(EE_Line_Item $line_item, EEI_Payment $payment): string;
+	/**
+	 * Gets the name to use for a line item when sending line items to the gateway
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param EEI_Payment   $payment
+	 * @return string
+	 */
+	public function formatLineItemName(EE_Line_Item $line_item, EEI_Payment $payment): string;
 
 
 
-    /**
-     * Gets the description to use for a line item when sending line items to the gateway
-     *
-     * @param EE_Line_Item $line_item
-     * @param EEI_Payment   $payment
-     * @return string
-     */
-    public function formatLineItemDesc(EE_Line_Item $line_item, EEI_Payment $payment): string;
+	/**
+	 * Gets the description to use for a line item when sending line items to the gateway
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param EEI_Payment   $payment
+	 * @return string
+	 */
+	public function formatLineItemDesc(EE_Line_Item $line_item, EEI_Payment $payment): string;
 
 
 
-    /**
-     * Gets the order description that should generally be sent to gateways
-     *
-     * @param EEI_Payment $payment
-     * @return string
-     */
-    public function formatOrderDescription(EEI_Payment $payment): string;
+	/**
+	 * Gets the order description that should generally be sent to gateways
+	 *
+	 * @param EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatOrderDescription(EEI_Payment $payment): string;
 
 
 
-    /**
-     * Formats the amount so it can generally be sent to gateways
-     *
-     * @param float $amount
-     * @param int   $precision
-     * @return string
-     */
-    public function formatCurrency(float $amount, int $precision = 2): string;
+	/**
+	 * Formats the amount so it can generally be sent to gateways
+	 *
+	 * @param float $amount
+	 * @param int   $precision
+	 * @return string
+	 */
+	public function formatCurrency(float $amount, int $precision = 2): string;
 }

core/services/payment_methods/gateways/GatewayDataFormatter.php

Indentation +107 added lines, -107 removed lines

@@ -19,121 +19,121 @@
 class GatewayDataFormatter implements GatewayDataFormatterInterface
 {
 
-    /**
-     * Gets the text to use for a gateway's line item name when this is a partial payment
-     *
-     * @param EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemName(EEI_Payment $payment): string
-    {
-        return apply_filters(
-            'EEG_Paypal_Pro__do_direct_payment__partial_amount_line_item_name',
-            $payment->get_first_event_name(),
-            $this,
-            $payment
-        );
-    }
+	/**
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
+	 *
+	 * @param EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemName(EEI_Payment $payment): string
+	{
+		return apply_filters(
+			'EEG_Paypal_Pro__do_direct_payment__partial_amount_line_item_name',
+			$payment->get_first_event_name(),
+			$this,
+			$payment
+		);
+	}
 
 
-    /**
-     * Gets the text to use for a gateway's line item description when this is a partial payment
-     *
-     * @param EEI_Payment $payment
-     * @return string
-     * @throws EE_Error
-     */
-    public function formatPartialPaymentLineItemDesc(EEI_Payment $payment): string
-    {
-        return apply_filters(
-            'FHEE__EE_Gateway___partial_payment_desc',
-            sprintf(
-                __('Payment of %1$s for %2$s', "event_espresso"),
-                $payment->get_pretty('PAY_amount', 'no_currency_code'),
-                $payment->get_first_event_name()
-            ),
-            $this,
-            $payment
-        );
-    }
+	/**
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
+	 *
+	 * @param EEI_Payment $payment
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function formatPartialPaymentLineItemDesc(EEI_Payment $payment): string
+	{
+		return apply_filters(
+			'FHEE__EE_Gateway___partial_payment_desc',
+			sprintf(
+				__('Payment of %1$s for %2$s', "event_espresso"),
+				$payment->get_pretty('PAY_amount', 'no_currency_code'),
+				$payment->get_first_event_name()
+			),
+			$this,
+			$payment
+		);
+	}
 
 
-    /**
-     * Gets the name to use for a line item when sending line items to the gateway
-     *
-     * @param EE_Line_Item $line_item
-     * @param EEI_Payment  $payment
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function formatLineItemName(EE_Line_Item $line_item, EEI_Payment $payment): string
-    {
-        return apply_filters(
-            'FHEE__EE_gateway___line_item_name',
-            sprintf(
-                _x('%1$s for %2$s', 'Ticket for Event', 'event_espresso'),
-                $line_item->name(),
-                $line_item->ticket_event_name()
-            ),
-            $this,
-            $line_item,
-            $payment
-        );
-    }
+	/**
+	 * Gets the name to use for a line item when sending line items to the gateway
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param EEI_Payment  $payment
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function formatLineItemName(EE_Line_Item $line_item, EEI_Payment $payment): string
+	{
+		return apply_filters(
+			'FHEE__EE_gateway___line_item_name',
+			sprintf(
+				_x('%1$s for %2$s', 'Ticket for Event', 'event_espresso'),
+				$line_item->name(),
+				$line_item->ticket_event_name()
+			),
+			$this,
+			$line_item,
+			$payment
+		);
+	}
 
 
-    /**
-     * Gets the description to use for a line item when sending line items to the gateway
-     *
-     * @param EE_Line_Item $line_item
-     * @param EEI_Payment  $payment
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function formatLineItemDesc(EE_Line_Item $line_item, EEI_Payment $payment): string
-    {
-        return apply_filters(
-            'FHEE__EE_Gateway___line_item_desc',
-            $line_item->desc(),
-            $this,
-            $line_item,
-            $payment
-        );
-    }
+	/**
+	 * Gets the description to use for a line item when sending line items to the gateway
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param EEI_Payment  $payment
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function formatLineItemDesc(EE_Line_Item $line_item, EEI_Payment $payment): string
+	{
+		return apply_filters(
+			'FHEE__EE_Gateway___line_item_desc',
+			$line_item->desc(),
+			$this,
+			$line_item,
+			$payment
+		);
+	}
 
 
-    /**
-     * Gets the order description that should generally be sent to gateways
-     *
-     * @param EEI_Payment $payment
-     * @return string
-     */
-    public function formatOrderDescription(EEI_Payment $payment): string
-    {
-        return apply_filters(
-            'FHEE__EE_Gateway___order_description',
-            sprintf(
-                __('Event Registrations from %1$s for %2$s', "event_espresso"),
-                wp_specialchars_decode(get_bloginfo(), ENT_QUOTES),
-                $payment->get_first_event_name()
-            ),
-            $this,
-            $payment
-        );
-    }
+	/**
+	 * Gets the order description that should generally be sent to gateways
+	 *
+	 * @param EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatOrderDescription(EEI_Payment $payment): string
+	{
+		return apply_filters(
+			'FHEE__EE_Gateway___order_description',
+			sprintf(
+				__('Event Registrations from %1$s for %2$s', "event_espresso"),
+				wp_specialchars_decode(get_bloginfo(), ENT_QUOTES),
+				$payment->get_first_event_name()
+			),
+			$this,
+			$payment
+		);
+	}
 
 
-    /**
-     * Formats the amount so it can generally be sent to gateways
-     *
-     * @param float $amount
-     * @param int $precision
-     * @return string
-     */
-    public function formatCurrency(float $amount, int $precision = 2): string
-    {
-        return number_format($amount, $precision, '.', '');
-    }
+	/**
+	 * Formats the amount so it can generally be sent to gateways
+	 *
+	 * @param float $amount
+	 * @param int $precision
+	 * @return string
+	 */
+	public function formatCurrency(float $amount, int $precision = 2): string
+	{
+		return number_format($amount, $precision, '.', '');
+	}
 }

core/services/calculators/LineItemCalculator.php

Indentation +719 added lines, -719 removed lines

@@ -21,723 +21,723 @@
 class LineItemCalculator
 {
 
-    /**
-     * @var DecimalValues
-     */
-    protected $decimal_values;
-
-    /**
-     * @var array
-     */
-    protected $default_query_params = [
-        ['LIN_type' => ['!=', EEM_Line_Item::type_cancellation]]
-    ];
-
-
-    /**
-     * @param DecimalValues $decimal_values
-     */
-    public function __construct(DecimalValues $decimal_values)
-    {
-        $this->decimal_values = $decimal_values;
-    }
-
-
-    /**
-     * Gets the final total on this item, taking taxes into account.
-     * Has the side-effect of setting the sub-total as it was just calculated.
-     * If this is used on a grand-total line item, also updates the transaction's
-     * TXN_total (provided this line item is allowed to persist, otherwise we don't
-     * want to change a persistable transaction with info from a non-persistent line item)
-     *
-     * @param EE_Line_Item $line_item
-     * @param bool         $update_txn_status
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function recalculateTotalIncludingTaxes(EE_Line_Item $line_item, bool $update_txn_status = false): float
-    {
-        $this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
-        $ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
-        if (empty($ticket_line_items)) {
-            return 0;
-        }
-        [, $pretax_total] = $this->recalculateLineItemTotals($line_item);
-        // EEH_Line_Item::visualize($line_item);
-        $total_tax = $this->recalculateTaxesAndTaxTotal($line_item);
-        // no negative totals plz
-        $grand_total  = max($pretax_total + $total_tax, 0);
-        $this->updatePreTaxTotal($line_item, $pretax_total, true);
-        $grand_total  = $this->updateTotal($line_item, $grand_total, true);
-        $this->updateTransaction($line_item, $grand_total, $update_txn_status);
-        return $grand_total;
-    }
-
-
-    /**
-     * Recursively goes through all the children and recalculates sub-totals EXCEPT for
-     * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its
-     * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and
-     * when this is called on the grand total
-     *
-     * @param EE_Line_Item $line_item
-     * @param float        $total
-     * @param float        $pretax_total
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function recalculateLineItemTotals(
-        EE_Line_Item $line_item,
-        float $total = 0,
-        float $pretax_total = 0
-    ): array {
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_total:
-            case EEM_Line_Item::type_sub_total:
-                [$total, $pretax_total] = $this->recalculateSubTotal($line_item);
-                break;
-
-            case EEM_Line_Item::type_line_item:
-                [$total, $pretax_total] = $this->recalculateLineItem($line_item, $total, $pretax_total);
-                break;
-
-            case EEM_Line_Item::type_sub_line_item:
-                // sub line items operate on the total and update both the total AND the pre-tax total
-                [$total, $pretax_total] = $this->recalculateSubLineItem($line_item, $total, $pretax_total);
-                break;
-
-            case EEM_Line_Item::type_sub_tax:
-                // sub line item taxes ONLY operate on the pre-tax total and ONLY update the total
-                [$total, $pretax_total] = $this->recalculateSubTax($line_item, $pretax_total);
-                break;
-
-            case EEM_Line_Item::type_tax_sub_total:
-            case EEM_Line_Item::type_tax:
-            case EEM_Line_Item::type_cancellation:
-                // completely ignore tax totals, tax sub-totals, and cancelled line items
-                // when calculating the pre-tax-total
-                $total = $pretax_total = 0;
-                break;
-        }
-        return [$total, $pretax_total];
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateSubTotal(EE_Line_Item $line_item): array
-    {
-        // reset the total and pretax total to zero since we are recalculating them
-        $total = $pretax_total = 0;
-        if ($line_item->is_total()) {
-            // if this is the grand total line item
-            // then first update ALL of the line item quantities (if need be)
-            $this->updateLineItemQuantities($line_item);
-        }
-        // recursively loop through children and recalculate their totals
-        $children = $line_item->children($this->default_query_params);
-        if (empty($children)) {
-            return [$total, $pretax_total];
-        }
-        foreach ($children as $child_line_item) {
-            [$child_total, $child_pretax_total] = $this->recalculateLineItemTotals(
-                $child_line_item,
-                $total,
-                $pretax_total
-            );
-            $total += $child_total;
-            $pretax_total += $child_pretax_total;
-        }
-        // update the unit price and pretax total
-        $this->updateUnitPrice($line_item, $pretax_total);
-        $pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true);
-        // for the actual pre-tax sub total line item, we want to save the pretax value for everything
-        if ($line_item->is_sub_total() && $line_item->name() === esc_html__('Pre-Tax Subtotal', 'event_espresso')) {
-            $this->updateTotal($line_item, $pretax_total, true);
-        } elseif (! $line_item->is_total()) {
-            // we don't update the total for the total line item, because that will need to include taxes
-            $total = $this->updateTotal($line_item, $total, true);
-        }
-        return [$total, $pretax_total];
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $total
-     * @param float        $pretax_total
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateLineItem(
-        EE_Line_Item $line_item,
-        float $total = 0,
-        float $pretax_total = 0
-    ): array {
-        if ($line_item->is_percent()) {
-            $total = $this->calculatePercentage($total, $line_item->percent());
-            $pretax_total = $this->calculatePercentage($pretax_total, $line_item->percent());
-        } else {
-            // recursively loop through children and recalculate their totals
-            $children = $line_item->children($this->default_query_params);
-            if (! empty($children)) {
-                // reset the total and pretax total to zero since we are recalculating them
-                $total = $pretax_total = 0;
-                foreach ($children as $child_line_item) {
-                    [$child_total, $child_pretax_total] = $this->recalculateLineItemTotals(
-                        $child_line_item,
-                        $total,
-                        $pretax_total
-                    );
-                    $total        += $child_total;
-                    $pretax_total += $child_pretax_total;
-                }
-            } else {
-                // no child line items, so recalculate the total from the unit price and quantity
-                // and set the pretax total to match since their are obviously no sub-taxes
-                $pretax_total = $total = $this->calculateTotalForQuantity($line_item);
-            }
-        }
-        $total  = $this->updateTotal($line_item, $total, true);
-        $pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true);
-
-        // need to also adjust unit price too if the pretax total or quantity has been updated
-        $this->updateUnitPrice($line_item, $pretax_total);
-        return [$total, $pretax_total];
-    }
-
-
-    /**
-     * @param EE_Line_Item $sub_line_item
-     * @param float|int    $total
-     * @param float|int    $pretax_total
-     * @return float[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateSubLineItem(EE_Line_Item $sub_line_item, float $total = 0, float $pretax_total = 0): array
-    {
-        if ($sub_line_item->is_percent()) {
-            $new_total = $this->calculatePercentage($total, $sub_line_item->percent());
-            $new_pretax_total = $this->calculatePercentage($pretax_total, $sub_line_item->percent());
-        } else {
-            $new_total = $new_pretax_total = $this->calculateTotalForQuantity($sub_line_item);
-        }
-        $total = $this->updateTotal($sub_line_item, $new_total);
-        $pretax_total = $this->updatePreTaxTotal($sub_line_item, $new_pretax_total);
-        // need to also adjust unit price too if the pretax total or quantity has been updated
-        $this->updateUnitPrice($sub_line_item, $pretax_total);
-        return [$total, $pretax_total];
-    }
-
-
-    /**
-     * @param EE_Line_Item $sub_line_item
-     * @param float|int    $pretax_total
-     * @return float[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateSubTax(EE_Line_Item $sub_line_item, float $pretax_total = 0): array
-    {
-        $total_tax = $this->calculatePercentage($pretax_total, $sub_line_item->percent());
-        $total_tax = $this->updateTotal($sub_line_item, $total_tax);
-        return [$total_tax, 0];
-    }
-
-
-    /**
-     * recursively loops through the entire line item tree updating line item quantities accordingly.
-     * this needs to be done prior to running any other calculations for reasons that are hopefully obvious :p
-     *
-     * @param EE_Line_Item $line_item
-     * @param int          $quantity
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateLineItemQuantities(EE_Line_Item $line_item, int $quantity = 1): int
-    {
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_total:
-            case EEM_Line_Item::type_sub_total:
-            case EEM_Line_Item::type_tax_sub_total:
-                // first, loop through children and set their quantities
-                $count = 0;
-                $children = $line_item->children($this->default_query_params);
-                foreach ($children as $child_line_item) {
-                    $count += $this->updateLineItemQuantities($child_line_item);
-                }
-                // totals and subtotals should have a quantity of 1
-                // unless their children have all been removed, in which case we can set them to 0
-                $quantity = $count > 0 ? 1 : 0;
-                $this->updateQuantity($line_item, $quantity);
-                return $quantity;
-
-            case EEM_Line_Item::type_line_item:
-                // line items should ALREADY have accurate quantities set, if not, then somebody done goofed!
-                // but if this is a percentage based line item, then ensure its quantity is 1
-                if ($line_item->is_percent()) {
-                    $this->updateQuantity($line_item, 1);
-                }
-                // and we also need to loop through all of the sub items and ensure those quantities match this parent.
-                $children = $line_item->children($this->default_query_params);
-                $quantity = $line_item->quantity();
-                foreach ($children as $child_line_item) {
-                    $this->updateLineItemQuantities($child_line_item, $quantity);
-                }
-                // percentage line items should not increment their parent's count, so they return 0
-                return ! $line_item->is_percent() ? $quantity : 0;
-
-            case EEM_Line_Item::type_sub_line_item:
-                // percentage based items need their quantity set to 1,
-                // all others use the incoming value from the parent line item
-                $quantity = $line_item->is_percent() ? 1 : $quantity;
-                $this->updateQuantity($line_item, $quantity);
-                // percentage line items should not increment their parent's count, so they return 0
-                return ! $line_item->is_percent() ? $quantity : 0;
-
-            case EEM_Line_Item::type_tax:
-            case EEM_Line_Item::type_sub_tax:
-                // taxes should have a quantity of 1
-                $this->updateQuantity($line_item, 1);
-                return 1;
-
-            case EEM_Line_Item::type_cancellation:
-                // cancellations will be ignored for all calculations
-                // because their parent quantities should have already been adjusted when they were added
-                // so assume that things are already set correctly
-                return 0;
-        }
-        return 0;
-    }
-
-
-    /**
-     * @param float $total
-     * @param float $percent
-     * @param bool  $round
-     * @return float
-     */
-    private function calculatePercentage(float $total, float $percent, bool $round = false): float
-    {
-        $amount = $total * $percent / 100;
-        return $this->decimal_values->roundDecimalValue($amount, $round);
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function calculateTotalForQuantity(EE_Line_Item $line_item): float
-    {
-        $total = $line_item->unit_price() * $line_item->quantity();
-        return $this->decimal_values->roundDecimalValue($total);
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $percent
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updatePercent(EE_Line_Item $line_item, float $percent)
-    {
-        // update and save new percent only if incoming value does not match existing value
-        if ($line_item->percent() !== $percent) {
-            $line_item->set_percent($percent);
-            $line_item->maybe_save();
-        }
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $pretax_total
-     * @param bool         $round
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updatePreTaxTotal(EE_Line_Item $line_item, float $pretax_total, bool $round = false): float
-    {
-        $pretax_total = $this->decimal_values->roundDecimalValue($pretax_total, $round);
-        // update and save new total only if incoming value does not match existing value
-        if ($line_item->preTaxTotal() !== $pretax_total) {
-            $line_item->setPreTaxTotal($pretax_total);
-            $line_item->maybe_save();
-        }
-        return $pretax_total;
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param int          $quantity
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateQuantity(EE_Line_Item $line_item, int $quantity)
-    {
-        // update and save new quantity only if incoming value does not match existing value
-        if ($line_item->quantity() !== $quantity) {
-            $line_item->set_quantity($quantity);
-            $line_item->maybe_save();
-        }
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $total
-     * @param bool         $round
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateTotal(EE_Line_Item $line_item, float $total, bool $round = false): float
-    {
-        $total = $this->decimal_values->roundDecimalValue($total, $round);
-        // update and save new total only if incoming value does not match existing value
-        if ($line_item->total() !== $total) {
-            $line_item->set_total($total);
-            $line_item->maybe_save();
-        }
-        return $total;
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $total
-     * @param bool         $update_status
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateTransaction(EE_Line_Item $line_item, float $total, bool $update_status)
-    {
-        // only update the related transaction's total
-        // if we intend to save this line item and its a grand total
-        if ($line_item->allow_persist()) {
-            $transaction = $line_item->transaction();
-            if ($transaction instanceof EE_Transaction) {
-                $transaction->set_total($total);
-                if ($update_status) {
-                    // don't save the TXN because that will be done below
-                    // and the following method only saves if the status changes
-                    $transaction->update_status_based_on_total_paid(false);
-                }
-                if ($transaction->ID()) {
-                    $transaction->save();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $pretax_total
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateUnitPrice(EE_Line_Item $line_item, float $pretax_total)
-    {
-        $quantity = $line_item->quantity();
-        // don't divide by zero else you'll create a singularity and implode the interweb
-        // we also don't set unit prices for percentage based line items
-        if ($quantity === 0 || $line_item->is_percent()) {
-            return;
-        }
-        $new_unit_price = $pretax_total / $quantity;
-        $new_unit_price = $this->decimal_values->roundDecimalValue($new_unit_price);
-        // update and save new total only if incoming value does not match existing value
-        if ($line_item->unit_price() !== $new_unit_price) {
-            $line_item->set_unit_price($new_unit_price);
-            $line_item->maybe_save();
-        }
-    }
-
-
-    /**
-     * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets
-     * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items
-     * and tax sub-total if already in the DB
-     *
-     * @param EE_Line_Item $total_line_item
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function recalculateTaxesAndTaxTotal(EE_Line_Item $total_line_item): float
-    {
-        $this->validateLineItemAndType($total_line_item, EEM_Line_Item::type_total);
-        // calculate the total taxable amount for globally applied taxes
-        $taxable_total = $this->taxableAmountForGlobalTaxes($total_line_item);
-        $global_taxes     = $this->applyGlobalTaxes($total_line_item, $taxable_total);
-        $non_global_taxes = $this->calculateNonGlobalTaxes($total_line_item);
-        $all_tax_total        = $this->applyNonGlobalTaxes($total_line_item, $global_taxes, $non_global_taxes);
-        $this->recalculateTaxSubTotal($total_line_item);
-        return $all_tax_total;
-    }
-
-
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @param float        $taxable_total
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function applyGlobalTaxes(EE_Line_Item $total_line_item, float $taxable_total): float
-    {
-        $this->validateLineItemAndType($total_line_item, EEM_Line_Item::type_total);
-        $total_tax = 0;
-        // loop through all global taxes all taxes
-        $global_taxes = $total_line_item->tax_descendants();
-        foreach ($global_taxes as $tax) {
-            $tax_total = $this->calculatePercentage($taxable_total, $tax->percent());
-            $tax_total = $this->updateTotal($tax, $tax_total, true);
-            $total_tax += $tax_total;
-        }
-        return $this->decimal_values->roundDecimalValue($total_tax, true);
-    }
-
-
-    /**
-     * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated
-     *
-     * @param EE_Line_Item $line_item
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateTaxSubTotal(EE_Line_Item $line_item)
-    {
-        $this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
-        foreach ($line_item->children() as $maybe_tax_subtotal) {
-            if (
-                $this->validateLineItemAndType($maybe_tax_subtotal)
-                && $maybe_tax_subtotal->is_tax_sub_total()
-            ) {
-                $total         = 0;
-                $total_percent = 0;
-                // simply loop through all its children (which should be taxes) and sum their total
-                foreach ($maybe_tax_subtotal->children() as $child_tax) {
-                    if ($this->validateLineItemAndType($child_tax) && $child_tax->isGlobalTax()) {
-                        $total         += $child_tax->total();
-                        $total_percent += $child_tax->percent();
-                    }
-                }
-                $this->updateTotal($maybe_tax_subtotal, $total, true);
-                $this->updatePercent($maybe_tax_subtotal, $total_percent);
-            }
-        }
-    }
-
-
-    /**
-     * returns an array of tax details like:
-     *  [
-     *      'GST_7' => [
-     *          'name'  => 'GST',
-     *          'rate'  => float(7),
-     *          'total' => float(4.9),
-     *      ]
-     *  ]
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param array        $non_global_taxes
-     * @param float        $line_item_total
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function calculateNonGlobalTaxes(
-        EE_Line_Item $total_line_item,
-        array $non_global_taxes = [],
-        float $line_item_total = 0
-    ): array {
-        foreach ($total_line_item->children() as $line_item) {
-            if ($this->validateLineItemAndType($line_item)) {
-                if ($line_item->is_sub_total()) {
-                    $non_global_taxes = $this->calculateNonGlobalTaxes($line_item, $non_global_taxes);
-                } elseif ($line_item->is_line_item()) {
-                    $non_global_taxes = $this->calculateNonGlobalTaxes(
-                        $line_item,
-                        $non_global_taxes,
-                        $line_item->pretaxTotal()
-                    );
-                } elseif ($line_item->isSubTax()) {
-                    $tax_ID = $line_item->name() . '_' . $line_item->percent();
-                    if (! isset($non_global_taxes[ $tax_ID ])) {
-                        $non_global_taxes[ $tax_ID ] = [
-                            'name'  => $line_item->name(),
-                            'rate'  => $line_item->percent(),
-                            'total' => 0,
-                            'obj'   => $line_item->OBJ_type(),
-                            'objID' => $line_item->OBJ_ID(),
-                        ];
-                    }
-                    $tax = $this->calculatePercentage($line_item_total, $line_item->percent());
-                    $non_global_taxes[ $tax_ID ]['total'] += $tax;
-                }
-            }
-        }
-        return $non_global_taxes;
-    }
-
-
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @param float        $tax_total
-     * @param array        $non_global_taxes array of tax details generated by calculateNonGlobalTaxes()
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function applyNonGlobalTaxes(
-        EE_Line_Item $total_line_item,
-        float $tax_total,
-        array $non_global_taxes
-    ): float {
-        $global_taxes   = $total_line_item->tax_descendants();
-        $taxes_subtotal = EEH_Line_Item::get_taxes_subtotal($total_line_item);
-        foreach ($non_global_taxes as $non_global_tax) {
-            $found = false;
-            foreach ($global_taxes as $global_tax) {
-                if (
-                    $this->validateLineItemAndType($global_tax)
-                    && $non_global_tax['obj'] === $global_tax->OBJ_type()
-                    && $non_global_tax['objID'] === $global_tax->OBJ_ID()
-                ) {
-                    $found = true;
-                    $new_total = $global_tax->total() + $non_global_tax['total'];
-                    // add non global tax to matching global tax AND the tax total
-                    $global_tax->set_total($new_total);
-                    $global_tax->maybe_save();
-                    $tax_total += $non_global_tax['total'];
-                }
-            }
-            if (! $found) {
-                // add a new line item for this non global tax
-                $taxes_subtotal->add_child_line_item(
-                    EE_Line_Item::new_instance(
-                        [
-                            'LIN_name'       => $non_global_tax['name'],
-                            'LIN_percent'    => $non_global_tax['rate'],
-                            'LIN_is_taxable' => false,
-                            'LIN_total'      => $non_global_tax['total'],
-                            'LIN_type'       => EEM_Line_Item::type_tax,
-                            'OBJ_type'       => $non_global_tax['obj'],
-                            'OBJ_ID'         => $non_global_tax['objID'],
-                        ]
-                    )
-                );
-                $tax_total += $non_global_tax['total'];
-            }
-        }
-        return $this->decimal_values->roundDecimalValue($tax_total, true);
-    }
-
-
-    /**
-     * Gets the total tax on this line item. Assumes taxes have already been calculated using
-     * recalculate_taxes_and_total
-     *
-     * @param EE_Line_Item $line_item
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getTotalTax(EE_Line_Item $line_item): float
-    {
-        $this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
-        $this->recalculateTaxSubTotal($line_item);
-        $total = 0;
-        foreach ($line_item->tax_descendants() as $tax_line_item) {
-            if ($this->validateLineItemAndType($tax_line_item)) {
-                $total += $tax_line_item->total();
-            }
-        }
-        return $this->decimal_values->roundDecimalValue($total, true);
-    }
-
-
-    /**
-     * Returns the amount taxable among this line item's children (or if it has no children,
-     * how much of it is taxable). Does not recalculate totals or subtotals.
-     * If the taxable total is negative, (eg, if none of the tickets were taxable,
-     * but there is a "Taxable" discount), returns 0.
-     *
-     * @param EE_Line_Item|null $line_item
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function taxableAmountForGlobalTaxes(?EE_Line_Item $line_item): float
-    {
-        $total      = 0;
-        $child_line_items = $line_item->children($this->default_query_params);
-        foreach ($child_line_items as $child_line_item) {
-            $this->validateLineItemAndType($child_line_item);
-            if ($child_line_item->is_sub_total()) {
-                $total += $this->taxableAmountForGlobalTaxes($child_line_item);
-            } elseif ($child_line_item->is_line_item() && $child_line_item->is_taxable()) {
-                // if it's a percent item, only take into account
-                // the percentage that's taxable (the taxable total so far)
-                if ($child_line_item->is_percent()) {
-                    $total += $this->calculatePercentage($total, $child_line_item->percent(), true);
-                } else {
-                    // pretax total will be equal to the total for line items with globally applied taxes
-                    $pretax_total = $this->calculateTotalForQuantity($child_line_item);
-                    $total += $this->updatePreTaxTotal($child_line_item, $pretax_total);
-                }
-            }
-        }
-        return max($total, 0);
-    }
-
-
-    /**
-     * @param EE_Line_Item|null $line_item
-     * @param string|null       $type
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function validateLineItemAndType(?EE_Line_Item $line_item, ?string $type = null): bool
-    {
-        if (! $line_item instanceof EE_Line_Item) {
-            throw new DomainException(
-                esc_html__('Invalid or missing Line Item supplied .', 'event_espresso')
-            );
-        }
-        if ($type && $line_item->type() !== $type) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'Invalid Line Item type supplied. Received "%1$s" but expected "%2$s".',
-                        'event_espresso'
-                    ),
-                    $line_item->type(),
-                    $type
-                )
-            );
-        }
-        return true;
-    }
+	/**
+	 * @var DecimalValues
+	 */
+	protected $decimal_values;
+
+	/**
+	 * @var array
+	 */
+	protected $default_query_params = [
+		['LIN_type' => ['!=', EEM_Line_Item::type_cancellation]]
+	];
+
+
+	/**
+	 * @param DecimalValues $decimal_values
+	 */
+	public function __construct(DecimalValues $decimal_values)
+	{
+		$this->decimal_values = $decimal_values;
+	}
+
+
+	/**
+	 * Gets the final total on this item, taking taxes into account.
+	 * Has the side-effect of setting the sub-total as it was just calculated.
+	 * If this is used on a grand-total line item, also updates the transaction's
+	 * TXN_total (provided this line item is allowed to persist, otherwise we don't
+	 * want to change a persistable transaction with info from a non-persistent line item)
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param bool         $update_txn_status
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function recalculateTotalIncludingTaxes(EE_Line_Item $line_item, bool $update_txn_status = false): float
+	{
+		$this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
+		$ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
+		if (empty($ticket_line_items)) {
+			return 0;
+		}
+		[, $pretax_total] = $this->recalculateLineItemTotals($line_item);
+		// EEH_Line_Item::visualize($line_item);
+		$total_tax = $this->recalculateTaxesAndTaxTotal($line_item);
+		// no negative totals plz
+		$grand_total  = max($pretax_total + $total_tax, 0);
+		$this->updatePreTaxTotal($line_item, $pretax_total, true);
+		$grand_total  = $this->updateTotal($line_item, $grand_total, true);
+		$this->updateTransaction($line_item, $grand_total, $update_txn_status);
+		return $grand_total;
+	}
+
+
+	/**
+	 * Recursively goes through all the children and recalculates sub-totals EXCEPT for
+	 * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its
+	 * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and
+	 * when this is called on the grand total
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param float        $total
+	 * @param float        $pretax_total
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function recalculateLineItemTotals(
+		EE_Line_Item $line_item,
+		float $total = 0,
+		float $pretax_total = 0
+	): array {
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_total:
+			case EEM_Line_Item::type_sub_total:
+				[$total, $pretax_total] = $this->recalculateSubTotal($line_item);
+				break;
+
+			case EEM_Line_Item::type_line_item:
+				[$total, $pretax_total] = $this->recalculateLineItem($line_item, $total, $pretax_total);
+				break;
+
+			case EEM_Line_Item::type_sub_line_item:
+				// sub line items operate on the total and update both the total AND the pre-tax total
+				[$total, $pretax_total] = $this->recalculateSubLineItem($line_item, $total, $pretax_total);
+				break;
+
+			case EEM_Line_Item::type_sub_tax:
+				// sub line item taxes ONLY operate on the pre-tax total and ONLY update the total
+				[$total, $pretax_total] = $this->recalculateSubTax($line_item, $pretax_total);
+				break;
+
+			case EEM_Line_Item::type_tax_sub_total:
+			case EEM_Line_Item::type_tax:
+			case EEM_Line_Item::type_cancellation:
+				// completely ignore tax totals, tax sub-totals, and cancelled line items
+				// when calculating the pre-tax-total
+				$total = $pretax_total = 0;
+				break;
+		}
+		return [$total, $pretax_total];
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateSubTotal(EE_Line_Item $line_item): array
+	{
+		// reset the total and pretax total to zero since we are recalculating them
+		$total = $pretax_total = 0;
+		if ($line_item->is_total()) {
+			// if this is the grand total line item
+			// then first update ALL of the line item quantities (if need be)
+			$this->updateLineItemQuantities($line_item);
+		}
+		// recursively loop through children and recalculate their totals
+		$children = $line_item->children($this->default_query_params);
+		if (empty($children)) {
+			return [$total, $pretax_total];
+		}
+		foreach ($children as $child_line_item) {
+			[$child_total, $child_pretax_total] = $this->recalculateLineItemTotals(
+				$child_line_item,
+				$total,
+				$pretax_total
+			);
+			$total += $child_total;
+			$pretax_total += $child_pretax_total;
+		}
+		// update the unit price and pretax total
+		$this->updateUnitPrice($line_item, $pretax_total);
+		$pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true);
+		// for the actual pre-tax sub total line item, we want to save the pretax value for everything
+		if ($line_item->is_sub_total() && $line_item->name() === esc_html__('Pre-Tax Subtotal', 'event_espresso')) {
+			$this->updateTotal($line_item, $pretax_total, true);
+		} elseif (! $line_item->is_total()) {
+			// we don't update the total for the total line item, because that will need to include taxes
+			$total = $this->updateTotal($line_item, $total, true);
+		}
+		return [$total, $pretax_total];
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $total
+	 * @param float        $pretax_total
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateLineItem(
+		EE_Line_Item $line_item,
+		float $total = 0,
+		float $pretax_total = 0
+	): array {
+		if ($line_item->is_percent()) {
+			$total = $this->calculatePercentage($total, $line_item->percent());
+			$pretax_total = $this->calculatePercentage($pretax_total, $line_item->percent());
+		} else {
+			// recursively loop through children and recalculate their totals
+			$children = $line_item->children($this->default_query_params);
+			if (! empty($children)) {
+				// reset the total and pretax total to zero since we are recalculating them
+				$total = $pretax_total = 0;
+				foreach ($children as $child_line_item) {
+					[$child_total, $child_pretax_total] = $this->recalculateLineItemTotals(
+						$child_line_item,
+						$total,
+						$pretax_total
+					);
+					$total        += $child_total;
+					$pretax_total += $child_pretax_total;
+				}
+			} else {
+				// no child line items, so recalculate the total from the unit price and quantity
+				// and set the pretax total to match since their are obviously no sub-taxes
+				$pretax_total = $total = $this->calculateTotalForQuantity($line_item);
+			}
+		}
+		$total  = $this->updateTotal($line_item, $total, true);
+		$pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true);
+
+		// need to also adjust unit price too if the pretax total or quantity has been updated
+		$this->updateUnitPrice($line_item, $pretax_total);
+		return [$total, $pretax_total];
+	}
+
+
+	/**
+	 * @param EE_Line_Item $sub_line_item
+	 * @param float|int    $total
+	 * @param float|int    $pretax_total
+	 * @return float[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateSubLineItem(EE_Line_Item $sub_line_item, float $total = 0, float $pretax_total = 0): array
+	{
+		if ($sub_line_item->is_percent()) {
+			$new_total = $this->calculatePercentage($total, $sub_line_item->percent());
+			$new_pretax_total = $this->calculatePercentage($pretax_total, $sub_line_item->percent());
+		} else {
+			$new_total = $new_pretax_total = $this->calculateTotalForQuantity($sub_line_item);
+		}
+		$total = $this->updateTotal($sub_line_item, $new_total);
+		$pretax_total = $this->updatePreTaxTotal($sub_line_item, $new_pretax_total);
+		// need to also adjust unit price too if the pretax total or quantity has been updated
+		$this->updateUnitPrice($sub_line_item, $pretax_total);
+		return [$total, $pretax_total];
+	}
+
+
+	/**
+	 * @param EE_Line_Item $sub_line_item
+	 * @param float|int    $pretax_total
+	 * @return float[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateSubTax(EE_Line_Item $sub_line_item, float $pretax_total = 0): array
+	{
+		$total_tax = $this->calculatePercentage($pretax_total, $sub_line_item->percent());
+		$total_tax = $this->updateTotal($sub_line_item, $total_tax);
+		return [$total_tax, 0];
+	}
+
+
+	/**
+	 * recursively loops through the entire line item tree updating line item quantities accordingly.
+	 * this needs to be done prior to running any other calculations for reasons that are hopefully obvious :p
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int          $quantity
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateLineItemQuantities(EE_Line_Item $line_item, int $quantity = 1): int
+	{
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_total:
+			case EEM_Line_Item::type_sub_total:
+			case EEM_Line_Item::type_tax_sub_total:
+				// first, loop through children and set their quantities
+				$count = 0;
+				$children = $line_item->children($this->default_query_params);
+				foreach ($children as $child_line_item) {
+					$count += $this->updateLineItemQuantities($child_line_item);
+				}
+				// totals and subtotals should have a quantity of 1
+				// unless their children have all been removed, in which case we can set them to 0
+				$quantity = $count > 0 ? 1 : 0;
+				$this->updateQuantity($line_item, $quantity);
+				return $quantity;
+
+			case EEM_Line_Item::type_line_item:
+				// line items should ALREADY have accurate quantities set, if not, then somebody done goofed!
+				// but if this is a percentage based line item, then ensure its quantity is 1
+				if ($line_item->is_percent()) {
+					$this->updateQuantity($line_item, 1);
+				}
+				// and we also need to loop through all of the sub items and ensure those quantities match this parent.
+				$children = $line_item->children($this->default_query_params);
+				$quantity = $line_item->quantity();
+				foreach ($children as $child_line_item) {
+					$this->updateLineItemQuantities($child_line_item, $quantity);
+				}
+				// percentage line items should not increment their parent's count, so they return 0
+				return ! $line_item->is_percent() ? $quantity : 0;
+
+			case EEM_Line_Item::type_sub_line_item:
+				// percentage based items need their quantity set to 1,
+				// all others use the incoming value from the parent line item
+				$quantity = $line_item->is_percent() ? 1 : $quantity;
+				$this->updateQuantity($line_item, $quantity);
+				// percentage line items should not increment their parent's count, so they return 0
+				return ! $line_item->is_percent() ? $quantity : 0;
+
+			case EEM_Line_Item::type_tax:
+			case EEM_Line_Item::type_sub_tax:
+				// taxes should have a quantity of 1
+				$this->updateQuantity($line_item, 1);
+				return 1;
+
+			case EEM_Line_Item::type_cancellation:
+				// cancellations will be ignored for all calculations
+				// because their parent quantities should have already been adjusted when they were added
+				// so assume that things are already set correctly
+				return 0;
+		}
+		return 0;
+	}
+
+
+	/**
+	 * @param float $total
+	 * @param float $percent
+	 * @param bool  $round
+	 * @return float
+	 */
+	private function calculatePercentage(float $total, float $percent, bool $round = false): float
+	{
+		$amount = $total * $percent / 100;
+		return $this->decimal_values->roundDecimalValue($amount, $round);
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function calculateTotalForQuantity(EE_Line_Item $line_item): float
+	{
+		$total = $line_item->unit_price() * $line_item->quantity();
+		return $this->decimal_values->roundDecimalValue($total);
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $percent
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updatePercent(EE_Line_Item $line_item, float $percent)
+	{
+		// update and save new percent only if incoming value does not match existing value
+		if ($line_item->percent() !== $percent) {
+			$line_item->set_percent($percent);
+			$line_item->maybe_save();
+		}
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $pretax_total
+	 * @param bool         $round
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updatePreTaxTotal(EE_Line_Item $line_item, float $pretax_total, bool $round = false): float
+	{
+		$pretax_total = $this->decimal_values->roundDecimalValue($pretax_total, $round);
+		// update and save new total only if incoming value does not match existing value
+		if ($line_item->preTaxTotal() !== $pretax_total) {
+			$line_item->setPreTaxTotal($pretax_total);
+			$line_item->maybe_save();
+		}
+		return $pretax_total;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param int          $quantity
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateQuantity(EE_Line_Item $line_item, int $quantity)
+	{
+		// update and save new quantity only if incoming value does not match existing value
+		if ($line_item->quantity() !== $quantity) {
+			$line_item->set_quantity($quantity);
+			$line_item->maybe_save();
+		}
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $total
+	 * @param bool         $round
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateTotal(EE_Line_Item $line_item, float $total, bool $round = false): float
+	{
+		$total = $this->decimal_values->roundDecimalValue($total, $round);
+		// update and save new total only if incoming value does not match existing value
+		if ($line_item->total() !== $total) {
+			$line_item->set_total($total);
+			$line_item->maybe_save();
+		}
+		return $total;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $total
+	 * @param bool         $update_status
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateTransaction(EE_Line_Item $line_item, float $total, bool $update_status)
+	{
+		// only update the related transaction's total
+		// if we intend to save this line item and its a grand total
+		if ($line_item->allow_persist()) {
+			$transaction = $line_item->transaction();
+			if ($transaction instanceof EE_Transaction) {
+				$transaction->set_total($total);
+				if ($update_status) {
+					// don't save the TXN because that will be done below
+					// and the following method only saves if the status changes
+					$transaction->update_status_based_on_total_paid(false);
+				}
+				if ($transaction->ID()) {
+					$transaction->save();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $pretax_total
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateUnitPrice(EE_Line_Item $line_item, float $pretax_total)
+	{
+		$quantity = $line_item->quantity();
+		// don't divide by zero else you'll create a singularity and implode the interweb
+		// we also don't set unit prices for percentage based line items
+		if ($quantity === 0 || $line_item->is_percent()) {
+			return;
+		}
+		$new_unit_price = $pretax_total / $quantity;
+		$new_unit_price = $this->decimal_values->roundDecimalValue($new_unit_price);
+		// update and save new total only if incoming value does not match existing value
+		if ($line_item->unit_price() !== $new_unit_price) {
+			$line_item->set_unit_price($new_unit_price);
+			$line_item->maybe_save();
+		}
+	}
+
+
+	/**
+	 * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets
+	 * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items
+	 * and tax sub-total if already in the DB
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function recalculateTaxesAndTaxTotal(EE_Line_Item $total_line_item): float
+	{
+		$this->validateLineItemAndType($total_line_item, EEM_Line_Item::type_total);
+		// calculate the total taxable amount for globally applied taxes
+		$taxable_total = $this->taxableAmountForGlobalTaxes($total_line_item);
+		$global_taxes     = $this->applyGlobalTaxes($total_line_item, $taxable_total);
+		$non_global_taxes = $this->calculateNonGlobalTaxes($total_line_item);
+		$all_tax_total        = $this->applyNonGlobalTaxes($total_line_item, $global_taxes, $non_global_taxes);
+		$this->recalculateTaxSubTotal($total_line_item);
+		return $all_tax_total;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @param float        $taxable_total
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function applyGlobalTaxes(EE_Line_Item $total_line_item, float $taxable_total): float
+	{
+		$this->validateLineItemAndType($total_line_item, EEM_Line_Item::type_total);
+		$total_tax = 0;
+		// loop through all global taxes all taxes
+		$global_taxes = $total_line_item->tax_descendants();
+		foreach ($global_taxes as $tax) {
+			$tax_total = $this->calculatePercentage($taxable_total, $tax->percent());
+			$tax_total = $this->updateTotal($tax, $tax_total, true);
+			$total_tax += $tax_total;
+		}
+		return $this->decimal_values->roundDecimalValue($total_tax, true);
+	}
+
+
+	/**
+	 * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateTaxSubTotal(EE_Line_Item $line_item)
+	{
+		$this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
+		foreach ($line_item->children() as $maybe_tax_subtotal) {
+			if (
+				$this->validateLineItemAndType($maybe_tax_subtotal)
+				&& $maybe_tax_subtotal->is_tax_sub_total()
+			) {
+				$total         = 0;
+				$total_percent = 0;
+				// simply loop through all its children (which should be taxes) and sum their total
+				foreach ($maybe_tax_subtotal->children() as $child_tax) {
+					if ($this->validateLineItemAndType($child_tax) && $child_tax->isGlobalTax()) {
+						$total         += $child_tax->total();
+						$total_percent += $child_tax->percent();
+					}
+				}
+				$this->updateTotal($maybe_tax_subtotal, $total, true);
+				$this->updatePercent($maybe_tax_subtotal, $total_percent);
+			}
+		}
+	}
+
+
+	/**
+	 * returns an array of tax details like:
+	 *  [
+	 *      'GST_7' => [
+	 *          'name'  => 'GST',
+	 *          'rate'  => float(7),
+	 *          'total' => float(4.9),
+	 *      ]
+	 *  ]
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param array        $non_global_taxes
+	 * @param float        $line_item_total
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function calculateNonGlobalTaxes(
+		EE_Line_Item $total_line_item,
+		array $non_global_taxes = [],
+		float $line_item_total = 0
+	): array {
+		foreach ($total_line_item->children() as $line_item) {
+			if ($this->validateLineItemAndType($line_item)) {
+				if ($line_item->is_sub_total()) {
+					$non_global_taxes = $this->calculateNonGlobalTaxes($line_item, $non_global_taxes);
+				} elseif ($line_item->is_line_item()) {
+					$non_global_taxes = $this->calculateNonGlobalTaxes(
+						$line_item,
+						$non_global_taxes,
+						$line_item->pretaxTotal()
+					);
+				} elseif ($line_item->isSubTax()) {
+					$tax_ID = $line_item->name() . '_' . $line_item->percent();
+					if (! isset($non_global_taxes[ $tax_ID ])) {
+						$non_global_taxes[ $tax_ID ] = [
+							'name'  => $line_item->name(),
+							'rate'  => $line_item->percent(),
+							'total' => 0,
+							'obj'   => $line_item->OBJ_type(),
+							'objID' => $line_item->OBJ_ID(),
+						];
+					}
+					$tax = $this->calculatePercentage($line_item_total, $line_item->percent());
+					$non_global_taxes[ $tax_ID ]['total'] += $tax;
+				}
+			}
+		}
+		return $non_global_taxes;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @param float        $tax_total
+	 * @param array        $non_global_taxes array of tax details generated by calculateNonGlobalTaxes()
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function applyNonGlobalTaxes(
+		EE_Line_Item $total_line_item,
+		float $tax_total,
+		array $non_global_taxes
+	): float {
+		$global_taxes   = $total_line_item->tax_descendants();
+		$taxes_subtotal = EEH_Line_Item::get_taxes_subtotal($total_line_item);
+		foreach ($non_global_taxes as $non_global_tax) {
+			$found = false;
+			foreach ($global_taxes as $global_tax) {
+				if (
+					$this->validateLineItemAndType($global_tax)
+					&& $non_global_tax['obj'] === $global_tax->OBJ_type()
+					&& $non_global_tax['objID'] === $global_tax->OBJ_ID()
+				) {
+					$found = true;
+					$new_total = $global_tax->total() + $non_global_tax['total'];
+					// add non global tax to matching global tax AND the tax total
+					$global_tax->set_total($new_total);
+					$global_tax->maybe_save();
+					$tax_total += $non_global_tax['total'];
+				}
+			}
+			if (! $found) {
+				// add a new line item for this non global tax
+				$taxes_subtotal->add_child_line_item(
+					EE_Line_Item::new_instance(
+						[
+							'LIN_name'       => $non_global_tax['name'],
+							'LIN_percent'    => $non_global_tax['rate'],
+							'LIN_is_taxable' => false,
+							'LIN_total'      => $non_global_tax['total'],
+							'LIN_type'       => EEM_Line_Item::type_tax,
+							'OBJ_type'       => $non_global_tax['obj'],
+							'OBJ_ID'         => $non_global_tax['objID'],
+						]
+					)
+				);
+				$tax_total += $non_global_tax['total'];
+			}
+		}
+		return $this->decimal_values->roundDecimalValue($tax_total, true);
+	}
+
+
+	/**
+	 * Gets the total tax on this line item. Assumes taxes have already been calculated using
+	 * recalculate_taxes_and_total
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getTotalTax(EE_Line_Item $line_item): float
+	{
+		$this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
+		$this->recalculateTaxSubTotal($line_item);
+		$total = 0;
+		foreach ($line_item->tax_descendants() as $tax_line_item) {
+			if ($this->validateLineItemAndType($tax_line_item)) {
+				$total += $tax_line_item->total();
+			}
+		}
+		return $this->decimal_values->roundDecimalValue($total, true);
+	}
+
+
+	/**
+	 * Returns the amount taxable among this line item's children (or if it has no children,
+	 * how much of it is taxable). Does not recalculate totals or subtotals.
+	 * If the taxable total is negative, (eg, if none of the tickets were taxable,
+	 * but there is a "Taxable" discount), returns 0.
+	 *
+	 * @param EE_Line_Item|null $line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function taxableAmountForGlobalTaxes(?EE_Line_Item $line_item): float
+	{
+		$total      = 0;
+		$child_line_items = $line_item->children($this->default_query_params);
+		foreach ($child_line_items as $child_line_item) {
+			$this->validateLineItemAndType($child_line_item);
+			if ($child_line_item->is_sub_total()) {
+				$total += $this->taxableAmountForGlobalTaxes($child_line_item);
+			} elseif ($child_line_item->is_line_item() && $child_line_item->is_taxable()) {
+				// if it's a percent item, only take into account
+				// the percentage that's taxable (the taxable total so far)
+				if ($child_line_item->is_percent()) {
+					$total += $this->calculatePercentage($total, $child_line_item->percent(), true);
+				} else {
+					// pretax total will be equal to the total for line items with globally applied taxes
+					$pretax_total = $this->calculateTotalForQuantity($child_line_item);
+					$total += $this->updatePreTaxTotal($child_line_item, $pretax_total);
+				}
+			}
+		}
+		return max($total, 0);
+	}
+
+
+	/**
+	 * @param EE_Line_Item|null $line_item
+	 * @param string|null       $type
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function validateLineItemAndType(?EE_Line_Item $line_item, ?string $type = null): bool
+	{
+		if (! $line_item instanceof EE_Line_Item) {
+			throw new DomainException(
+				esc_html__('Invalid or missing Line Item supplied .', 'event_espresso')
+			);
+		}
+		if ($type && $line_item->type() !== $type) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'Invalid Line Item type supplied. Received "%1$s" but expected "%2$s".',
+						'event_espresso'
+					),
+					$line_item->type(),
+					$type
+				)
+			);
+		}
+		return true;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -160,7 +160,7 @@ 
         // for the actual pre-tax sub total line item, we want to save the pretax value for everything
         if ($line_item->is_sub_total() && $line_item->name() === esc_html__('Pre-Tax Subtotal', 'event_espresso')) {
             $this->updateTotal($line_item, $pretax_total, true);
-        } elseif (! $line_item->is_total()) {
+        } elseif ( ! $line_item->is_total()) {
             // we don't update the total for the total line item, because that will need to include taxes
             $total = $this->updateTotal($line_item, $total, true);
         }
@@ -187,7 +187,7 @@ 
         } else {
             // recursively loop through children and recalculate their totals
             $children = $line_item->children($this->default_query_params);
-            if (! empty($children)) {
+            if ( ! empty($children)) {
                 // reset the total and pretax total to zero since we are recalculating them
                 $total = $pretax_total = 0;
                 foreach ($children as $child_line_item) {
@@ -205,7 +205,7 @@ 
                 $pretax_total = $total = $this->calculateTotalForQuantity($line_item);
             }
         }
-        $total  = $this->updateTotal($line_item, $total, true);
+        $total = $this->updateTotal($line_item, $total, true);
         $pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true);
 
         // need to also adjust unit price too if the pretax total or quantity has been updated
@@ -489,7 +489,7 @@ 
         $taxable_total = $this->taxableAmountForGlobalTaxes($total_line_item);
         $global_taxes     = $this->applyGlobalTaxes($total_line_item, $taxable_total);
         $non_global_taxes = $this->calculateNonGlobalTaxes($total_line_item);
-        $all_tax_total        = $this->applyNonGlobalTaxes($total_line_item, $global_taxes, $non_global_taxes);
+        $all_tax_total = $this->applyNonGlobalTaxes($total_line_item, $global_taxes, $non_global_taxes);
         $this->recalculateTaxSubTotal($total_line_item);
         return $all_tax_total;
     }
@@ -582,9 +582,9 @@ 
                         $line_item->pretaxTotal()
                     );
                 } elseif ($line_item->isSubTax()) {
-                    $tax_ID = $line_item->name() . '_' . $line_item->percent();
-                    if (! isset($non_global_taxes[ $tax_ID ])) {
-                        $non_global_taxes[ $tax_ID ] = [
+                    $tax_ID = $line_item->name().'_'.$line_item->percent();
+                    if ( ! isset($non_global_taxes[$tax_ID])) {
+                        $non_global_taxes[$tax_ID] = [
                             'name'  => $line_item->name(),
                             'rate'  => $line_item->percent(),
                             'total' => 0,
@@ -593,7 +593,7 @@ 
                         ];
                     }
                     $tax = $this->calculatePercentage($line_item_total, $line_item->percent());
-                    $non_global_taxes[ $tax_ID ]['total'] += $tax;
+                    $non_global_taxes[$tax_ID]['total'] += $tax;
                 }
             }
         }
@@ -632,7 +632,7 @@ 
                     $tax_total += $non_global_tax['total'];
                 }
             }
-            if (! $found) {
+            if ( ! $found) {
                 // add a new line item for this non global tax
                 $taxes_subtotal->add_child_line_item(
                     EE_Line_Item::new_instance(
@@ -690,7 +690,7 @@ 
      */
     public function taxableAmountForGlobalTaxes(?EE_Line_Item $line_item): float
     {
-        $total      = 0;
+        $total = 0;
         $child_line_items = $line_item->children($this->default_query_params);
         foreach ($child_line_items as $child_line_item) {
             $this->validateLineItemAndType($child_line_item);
@@ -721,7 +721,7 @@ 
      */
     private function validateLineItemAndType(?EE_Line_Item $line_item, ?string $type = null): bool
     {
-        if (! $line_item instanceof EE_Line_Item) {
+        if ( ! $line_item instanceof EE_Line_Item) {
             throw new DomainException(
                 esc_html__('Invalid or missing Line Item supplied .', 'event_espresso')
             );

core/libraries/payment_methods/EE_Gateway.lib.php

Indentation +500 added lines, -500 removed lines

@@ -23,504 +23,504 @@
  */
 abstract class EE_Gateway
 {
-    /**
-     * a constant used as a possible value for $_currencies_supported to indicate
-     * that ALL currencies are supported by this gateway
-     */
-    const all_currencies_supported = 'all_currencies_supported';
-    /**
-     * Where values are 3-letter currency codes
-     *
-     * @var array
-     */
-    protected $_currencies_supported = array();
-    /**
-     * Whether or not this gateway can support SENDING a refund request (ie, initiated by
-     * admin in EE's wp-admin page)
-     *
-     * @var boolean
-     */
-    protected $_supports_sending_refunds = false;
-
-    /**
-     * Whether or not this gateway can support RECEIVING a refund request from the payment
-     * provider (ie, initiated by admin on the payment prover's website who sends an IPN to EE)
-     *
-     * @var boolean
-     */
-    protected $_supports_receiving_refunds = false;
-    /**
-     * Model for querying for existing payments
-     *
-     * @var EEMI_Payment
-     */
-    protected $_pay_model;
-
-    /**
-     * Model used for adding to the payments log
-     *
-     * @var EEMI_Payment_Log
-     */
-    protected $_pay_log;
-
-    /**
-     * Used for formatting some input to gateways
-     *
-     * @var EEHI_Template
-     */
-    protected $_template;
-
-    /**
-     * Concrete class that implements EEHI_Money, used by most gateways
-     *
-     * @var EEHI_Money
-     */
-    protected $_money;
-
-    /**
-     * Concrete class that implements EEHI_Line_Item, used for manipulating the line item tree
-     *
-     * @var EEHI_Line_Item
-     */
-    protected $_line_item;
-
-    /**
-     * @var GatewayDataFormatterInterface
-     */
-    protected $_gateway_data_formatter;
-
-    /**
-     * @var FormatterInterface
-     */
-    protected $_unsupported_character_remover;
-
-    /**
-     * The ID of the payment method using this gateway
-     *
-     * @var int
-     */
-    protected $_ID;
-
-    /**
-     * @var $_debug_mode boolean whether to send requests to teh sandbox site or not
-     */
-    protected $_debug_mode;
-    /**
-     *
-     * @var string $_name name to show for this payment method
-     */
-    protected $_name;
-    /**
-     *
-     * @var string name to show fir this payment method to admin-type users
-     */
-    protected $_admin_name;
-
-    /**
-     * EE_Gateway constructor
-     */
-    public function __construct()
-    {
-    }
-
-    /**
-     * We don't want to serialize models as they often have circular structures
-     * (eg a payment model has a reference to each payment model object; and most
-     * payments have a transaction, most transactions have a payment method;
-     * most payment methods have a payment method type; most payment method types
-     * have a gateway. And if a gateway serializes its models, we start at the
-     * beginning again)
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties = get_object_vars($this);
-        unset($properties['_pay_model'], $properties['_pay_log']);
-        return array_keys($properties);
-    }
-
-    /**
-     * Returns whether or not this gateway should support SENDING refunds
-     * see $_supports_sending_refunds
-     *
-     * @return boolean
-     */
-    public function supports_sending_refunds()
-    {
-        return $this->_supports_sending_refunds;
-    }
-
-    /**
-     * Returns whether or not this gateway should support RECEIVING refunds
-     * see $_supports_receiving_refunds
-     *
-     * @return boolean
-     */
-    public function supports_receiving_refunds()
-    {
-        return $this->_supports_receiving_refunds;
-    }
-
-
-    /**
-     * Tries to refund the payment specified, taking into account the extra
-     * refund info. Note that if the gateway's _supports_sending_refunds is false,
-     * this should just throw an exception.
-     *
-     * @param EE_Payment $payment
-     * @param array      $refund_info
-     * @return EE_Payment for the refund
-     * @throws EE_Error
-     */
-    public function do_direct_refund(EE_Payment $payment, $refund_info = null)
-    {
-        return null;
-    }
-
-
-    /**
-     * Sets the payment method's settings so the gateway knows where to send the request
-     * etc
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        foreach ($settings_array as $name => $value) {
-            $property_name = "_" . $name;
-            $this->{$property_name} = $value;
-        }
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEMI_Payment $payment_model
-     */
-    public function set_payment_model($payment_model)
-    {
-        $this->_pay_model = $payment_model;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEMI_Payment_Log $payment_log_model
-     */
-    public function set_payment_log($payment_log_model)
-    {
-        $this->_pay_log = $payment_log_model;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Template $template_helper
-     */
-    public function set_template_helper($template_helper)
-    {
-        $this->_template = $template_helper;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Line_Item $line_item_helper
-     */
-    public function set_line_item_helper($line_item_helper)
-    {
-        $this->_line_item = $line_item_helper;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Money $money_helper
-     */
-    public function set_money_helper($money_helper)
-    {
-        $this->_money = $money_helper;
-    }
-
-
-    /**
-     * Sets the gateway data formatter helper
-     *
-     * @param GatewayDataFormatterInterface $gateway_data_formatter
-     * @throws InvalidEntityException if it's not set properly
-     */
-    public function set_gateway_data_formatter(GatewayDataFormatterInterface $gateway_data_formatter)
-    {
-        if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($gateway_data_formatter)
-                    ? get_class($gateway_data_formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
-            );
-        }
-        $this->_gateway_data_formatter = $gateway_data_formatter;
-    }
-
-    /**
-     * Gets the gateway data formatter
-     *
-     * @return GatewayDataFormatterInterface
-     * @throws InvalidEntityException if it's not set properly
-     */
-    protected function _get_gateway_formatter()
-    {
-        if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($this->_gateway_data_formatter)
-                    ? get_class($this->_gateway_data_formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
-            );
-        }
-        return $this->_gateway_data_formatter;
-    }
-
-
-    /**
-     * Sets the helper which will remove unsupported characters for most gateways
-     *
-     * @param FormatterInterface $formatter
-     * @return FormatterInterface
-     * @throws InvalidEntityException
-     */
-    public function set_unsupported_character_remover(FormatterInterface $formatter)
-    {
-        if (! $formatter instanceof FormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($formatter)
-                    ? get_class($formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
-            );
-        }
-        $this->_unsupported_character_remover = $formatter;
-    }
-
-    /**
-     * Gets the helper which removes characters which gateways might not support, like emojis etc.
-     *
-     * @return FormatterInterface
-     * @throws InvalidEntityException
-     */
-    protected function _get_unsupported_character_remover()
-    {
-        if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($this->_unsupported_character_remover)
-                    ? get_class($this->_unsupported_character_remover)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
-            );
-        }
-        return $this->_unsupported_character_remover;
-    }
-
-
-    /**
-     * @param $message
-     * @param $payment
-     */
-    public function log($message, $object_logged)
-    {
-        if ($object_logged instanceof EEI_Payment) {
-            $type = 'Payment';
-            $id = $object_logged->ID();
-        } elseif ($object_logged instanceof EEI_Transaction) {
-            $type = 'Transaction';
-            $id = $object_logged->ID();
-        } else {
-            $type = 'Payment_Method';
-            $id = $this->_ID;
-        }
-        // only log if we're going to store it for longer than the minimum time
-        $reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
-        if ($reg_config->gateway_log_lifespan !== '1 second') {
-            $this->_pay_log->gateway_log($message, $id, $type);
-        }
-    }
-
-    /**
-     * Formats the amount so it can generally be sent to gateways
-     *
-     * @param float $amount
-     * @return string
-     * @deprecated since 4.9.31 insetad use
-     *             EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatter::format_currency()
-     */
-    public function format_currency($amount)
-    {
-        return $this->_get_gateway_formatter()->formatCurrency($amount);
-    }
-
-    /**
-     * Returns either an array of all the currency codes supported,
-     * or a string indicating they're all supported (EE_gateway::all_currencies_supported)
-     *
-     * @return mixed array or string
-     */
-    public function currencies_supported()
-    {
-        return $this->_currencies_supported;
-    }
-
-    /**
-     * Returns what a simple summing of items and taxes for this transaction. This
-     * can be used to determine if some more complex line items, like promotions,
-     * surcharges, or cancellations occurred (in which case we might want to forget
-     * about creating an itemized list of purchases and instead only send the total due)
-     *
-     * @param EE_Transaction $transaction
-     * @return float
-     */
-    protected function _sum_items_and_taxes(EE_Transaction $transaction)
-    {
-        $total_line_item = $transaction->total_line_item();
-        $total = 0;
-        foreach ($total_line_item->get_items() as $item_line_item) {
-            $total += max($item_line_item->total(), 0);
-        }
-        foreach ($total_line_item->tax_descendants() as $tax_line_item) {
-            $total += max($tax_line_item->total(), 0);
-        }
-        return $total;
-    }
-
-    /**
-     * Determines whether or not we can easily itemize the transaction using only
-     * items and taxes (ie, no promotions or surcharges or cancellations needed)
-     *
-     * @param EEI_Payment $payment
-     * @return boolean
-     */
-    protected function _can_easily_itemize_transaction_for(EEI_Payment $payment)
-    {
-        return $this->_money->compare_floats(
-            $this->_sum_items_and_taxes($payment->transaction()),
-            $payment->transaction()->total()
-        )
-               && $this->_money->compare_floats(
-                   $payment->amount(),
-                   $payment->transaction()->total()
-               );
-    }
-
-    /**
-     * Handles updating the transaction and any other related data based on the payment.
-     * You may be tempted to do this as part of do_direct_payment or handle_payment_update,
-     * but doing so on those functions might be too early. It's possible that the changes
-     * you make to teh transaction or registration or line items may just get overwritten
-     * at that point. Instead, you should store any info you need on the payment during those
-     * functions, and use that information at this step, which client code will decide
-     * for you when it should be called.
-     *
-     * @param EE_Payment $payment
-     * @return void
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        // maybe update the transaction or line items or registrations
-        // but most gateways don't need to do this, because they only update the payment
-    }
-
-    /**
-     * Gets the first event for this payment (it's possible that it could be for multiple)
-     *
-     * @param EEI_Payment $payment
-     * @return EEI_Event|null
-     * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event()
-     */
-    protected function _get_first_event_for_payment(EEI_Payment $payment)
-    {
-        return $payment->get_first_event();
-    }
-
-    /**
-     * Gets the name of the first event for which is being paid
-     *
-     * @param EEI_Payment $payment
-     * @return string
-     * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event_name()
-     */
-    protected function _get_first_event_name_for_payment(EEI_Payment $payment)
-    {
-        return $payment->get_first_event_name();
-    }
-
-    /**
-     * Gets the text to use for a gateway's line item name when this is a partial payment
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment)
-     * @param EE_Payment $payment
-     * @return string
-     */
-    protected function _format_partial_payment_line_item_name(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment);
-    }
-
-    /**
-     * Gets the text to use for a gateway's line item description when this is a partial payment
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc()
-     * @param EEI_Payment $payment
-     * @return string
-     */
-    protected function _format_partial_payment_line_item_desc(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc($payment);
-    }
-
-    /**
-     * Gets the name to use for a line item when sending line items to the gateway
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemName($line_item,$payment)
-     * @param EE_Line_Item $line_item
-     * @param EEI_Payment   $payment
-     * @return string
-     */
-    protected function _format_line_item_name(EE_Line_Item $line_item, EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatLineItemName($line_item, $payment);
-    }
-
-    /**
-     * Gets the description to use for a line item when sending line items to the gateway
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment))
-     * @param EE_Line_Item $line_item
-     * @param EEI_Payment   $payment
-     * @return string
-     */
-    protected function _format_line_item_desc(EE_Line_Item $line_item, EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment);
-    }
-
-    /**
-     * Gets the order description that should generlly be sent to gateways
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatOrderDescription($payment)
-     * @param EEI_Payment $payment
-     * @return type
-     */
-    protected function _format_order_description(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatOrderDescription($payment);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isInSandboxMode(): bool
-    {
-        return $this->_debug_mode;
-    }
+	/**
+	 * a constant used as a possible value for $_currencies_supported to indicate
+	 * that ALL currencies are supported by this gateway
+	 */
+	const all_currencies_supported = 'all_currencies_supported';
+	/**
+	 * Where values are 3-letter currency codes
+	 *
+	 * @var array
+	 */
+	protected $_currencies_supported = array();
+	/**
+	 * Whether or not this gateway can support SENDING a refund request (ie, initiated by
+	 * admin in EE's wp-admin page)
+	 *
+	 * @var boolean
+	 */
+	protected $_supports_sending_refunds = false;
+
+	/**
+	 * Whether or not this gateway can support RECEIVING a refund request from the payment
+	 * provider (ie, initiated by admin on the payment prover's website who sends an IPN to EE)
+	 *
+	 * @var boolean
+	 */
+	protected $_supports_receiving_refunds = false;
+	/**
+	 * Model for querying for existing payments
+	 *
+	 * @var EEMI_Payment
+	 */
+	protected $_pay_model;
+
+	/**
+	 * Model used for adding to the payments log
+	 *
+	 * @var EEMI_Payment_Log
+	 */
+	protected $_pay_log;
+
+	/**
+	 * Used for formatting some input to gateways
+	 *
+	 * @var EEHI_Template
+	 */
+	protected $_template;
+
+	/**
+	 * Concrete class that implements EEHI_Money, used by most gateways
+	 *
+	 * @var EEHI_Money
+	 */
+	protected $_money;
+
+	/**
+	 * Concrete class that implements EEHI_Line_Item, used for manipulating the line item tree
+	 *
+	 * @var EEHI_Line_Item
+	 */
+	protected $_line_item;
+
+	/**
+	 * @var GatewayDataFormatterInterface
+	 */
+	protected $_gateway_data_formatter;
+
+	/**
+	 * @var FormatterInterface
+	 */
+	protected $_unsupported_character_remover;
+
+	/**
+	 * The ID of the payment method using this gateway
+	 *
+	 * @var int
+	 */
+	protected $_ID;
+
+	/**
+	 * @var $_debug_mode boolean whether to send requests to teh sandbox site or not
+	 */
+	protected $_debug_mode;
+	/**
+	 *
+	 * @var string $_name name to show for this payment method
+	 */
+	protected $_name;
+	/**
+	 *
+	 * @var string name to show fir this payment method to admin-type users
+	 */
+	protected $_admin_name;
+
+	/**
+	 * EE_Gateway constructor
+	 */
+	public function __construct()
+	{
+	}
+
+	/**
+	 * We don't want to serialize models as they often have circular structures
+	 * (eg a payment model has a reference to each payment model object; and most
+	 * payments have a transaction, most transactions have a payment method;
+	 * most payment methods have a payment method type; most payment method types
+	 * have a gateway. And if a gateway serializes its models, we start at the
+	 * beginning again)
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties = get_object_vars($this);
+		unset($properties['_pay_model'], $properties['_pay_log']);
+		return array_keys($properties);
+	}
+
+	/**
+	 * Returns whether or not this gateway should support SENDING refunds
+	 * see $_supports_sending_refunds
+	 *
+	 * @return boolean
+	 */
+	public function supports_sending_refunds()
+	{
+		return $this->_supports_sending_refunds;
+	}
+
+	/**
+	 * Returns whether or not this gateway should support RECEIVING refunds
+	 * see $_supports_receiving_refunds
+	 *
+	 * @return boolean
+	 */
+	public function supports_receiving_refunds()
+	{
+		return $this->_supports_receiving_refunds;
+	}
+
+
+	/**
+	 * Tries to refund the payment specified, taking into account the extra
+	 * refund info. Note that if the gateway's _supports_sending_refunds is false,
+	 * this should just throw an exception.
+	 *
+	 * @param EE_Payment $payment
+	 * @param array      $refund_info
+	 * @return EE_Payment for the refund
+	 * @throws EE_Error
+	 */
+	public function do_direct_refund(EE_Payment $payment, $refund_info = null)
+	{
+		return null;
+	}
+
+
+	/**
+	 * Sets the payment method's settings so the gateway knows where to send the request
+	 * etc
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		foreach ($settings_array as $name => $value) {
+			$property_name = "_" . $name;
+			$this->{$property_name} = $value;
+		}
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEMI_Payment $payment_model
+	 */
+	public function set_payment_model($payment_model)
+	{
+		$this->_pay_model = $payment_model;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEMI_Payment_Log $payment_log_model
+	 */
+	public function set_payment_log($payment_log_model)
+	{
+		$this->_pay_log = $payment_log_model;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Template $template_helper
+	 */
+	public function set_template_helper($template_helper)
+	{
+		$this->_template = $template_helper;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Line_Item $line_item_helper
+	 */
+	public function set_line_item_helper($line_item_helper)
+	{
+		$this->_line_item = $line_item_helper;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Money $money_helper
+	 */
+	public function set_money_helper($money_helper)
+	{
+		$this->_money = $money_helper;
+	}
+
+
+	/**
+	 * Sets the gateway data formatter helper
+	 *
+	 * @param GatewayDataFormatterInterface $gateway_data_formatter
+	 * @throws InvalidEntityException if it's not set properly
+	 */
+	public function set_gateway_data_formatter(GatewayDataFormatterInterface $gateway_data_formatter)
+	{
+		if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($gateway_data_formatter)
+					? get_class($gateway_data_formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
+			);
+		}
+		$this->_gateway_data_formatter = $gateway_data_formatter;
+	}
+
+	/**
+	 * Gets the gateway data formatter
+	 *
+	 * @return GatewayDataFormatterInterface
+	 * @throws InvalidEntityException if it's not set properly
+	 */
+	protected function _get_gateway_formatter()
+	{
+		if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($this->_gateway_data_formatter)
+					? get_class($this->_gateway_data_formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
+			);
+		}
+		return $this->_gateway_data_formatter;
+	}
+
+
+	/**
+	 * Sets the helper which will remove unsupported characters for most gateways
+	 *
+	 * @param FormatterInterface $formatter
+	 * @return FormatterInterface
+	 * @throws InvalidEntityException
+	 */
+	public function set_unsupported_character_remover(FormatterInterface $formatter)
+	{
+		if (! $formatter instanceof FormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($formatter)
+					? get_class($formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
+			);
+		}
+		$this->_unsupported_character_remover = $formatter;
+	}
+
+	/**
+	 * Gets the helper which removes characters which gateways might not support, like emojis etc.
+	 *
+	 * @return FormatterInterface
+	 * @throws InvalidEntityException
+	 */
+	protected function _get_unsupported_character_remover()
+	{
+		if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($this->_unsupported_character_remover)
+					? get_class($this->_unsupported_character_remover)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
+			);
+		}
+		return $this->_unsupported_character_remover;
+	}
+
+
+	/**
+	 * @param $message
+	 * @param $payment
+	 */
+	public function log($message, $object_logged)
+	{
+		if ($object_logged instanceof EEI_Payment) {
+			$type = 'Payment';
+			$id = $object_logged->ID();
+		} elseif ($object_logged instanceof EEI_Transaction) {
+			$type = 'Transaction';
+			$id = $object_logged->ID();
+		} else {
+			$type = 'Payment_Method';
+			$id = $this->_ID;
+		}
+		// only log if we're going to store it for longer than the minimum time
+		$reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
+		if ($reg_config->gateway_log_lifespan !== '1 second') {
+			$this->_pay_log->gateway_log($message, $id, $type);
+		}
+	}
+
+	/**
+	 * Formats the amount so it can generally be sent to gateways
+	 *
+	 * @param float $amount
+	 * @return string
+	 * @deprecated since 4.9.31 insetad use
+	 *             EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatter::format_currency()
+	 */
+	public function format_currency($amount)
+	{
+		return $this->_get_gateway_formatter()->formatCurrency($amount);
+	}
+
+	/**
+	 * Returns either an array of all the currency codes supported,
+	 * or a string indicating they're all supported (EE_gateway::all_currencies_supported)
+	 *
+	 * @return mixed array or string
+	 */
+	public function currencies_supported()
+	{
+		return $this->_currencies_supported;
+	}
+
+	/**
+	 * Returns what a simple summing of items and taxes for this transaction. This
+	 * can be used to determine if some more complex line items, like promotions,
+	 * surcharges, or cancellations occurred (in which case we might want to forget
+	 * about creating an itemized list of purchases and instead only send the total due)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return float
+	 */
+	protected function _sum_items_and_taxes(EE_Transaction $transaction)
+	{
+		$total_line_item = $transaction->total_line_item();
+		$total = 0;
+		foreach ($total_line_item->get_items() as $item_line_item) {
+			$total += max($item_line_item->total(), 0);
+		}
+		foreach ($total_line_item->tax_descendants() as $tax_line_item) {
+			$total += max($tax_line_item->total(), 0);
+		}
+		return $total;
+	}
+
+	/**
+	 * Determines whether or not we can easily itemize the transaction using only
+	 * items and taxes (ie, no promotions or surcharges or cancellations needed)
+	 *
+	 * @param EEI_Payment $payment
+	 * @return boolean
+	 */
+	protected function _can_easily_itemize_transaction_for(EEI_Payment $payment)
+	{
+		return $this->_money->compare_floats(
+			$this->_sum_items_and_taxes($payment->transaction()),
+			$payment->transaction()->total()
+		)
+			   && $this->_money->compare_floats(
+				   $payment->amount(),
+				   $payment->transaction()->total()
+			   );
+	}
+
+	/**
+	 * Handles updating the transaction and any other related data based on the payment.
+	 * You may be tempted to do this as part of do_direct_payment or handle_payment_update,
+	 * but doing so on those functions might be too early. It's possible that the changes
+	 * you make to teh transaction or registration or line items may just get overwritten
+	 * at that point. Instead, you should store any info you need on the payment during those
+	 * functions, and use that information at this step, which client code will decide
+	 * for you when it should be called.
+	 *
+	 * @param EE_Payment $payment
+	 * @return void
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		// maybe update the transaction or line items or registrations
+		// but most gateways don't need to do this, because they only update the payment
+	}
+
+	/**
+	 * Gets the first event for this payment (it's possible that it could be for multiple)
+	 *
+	 * @param EEI_Payment $payment
+	 * @return EEI_Event|null
+	 * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event()
+	 */
+	protected function _get_first_event_for_payment(EEI_Payment $payment)
+	{
+		return $payment->get_first_event();
+	}
+
+	/**
+	 * Gets the name of the first event for which is being paid
+	 *
+	 * @param EEI_Payment $payment
+	 * @return string
+	 * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event_name()
+	 */
+	protected function _get_first_event_name_for_payment(EEI_Payment $payment)
+	{
+		return $payment->get_first_event_name();
+	}
+
+	/**
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment)
+	 * @param EE_Payment $payment
+	 * @return string
+	 */
+	protected function _format_partial_payment_line_item_name(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment);
+	}
+
+	/**
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc()
+	 * @param EEI_Payment $payment
+	 * @return string
+	 */
+	protected function _format_partial_payment_line_item_desc(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc($payment);
+	}
+
+	/**
+	 * Gets the name to use for a line item when sending line items to the gateway
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemName($line_item,$payment)
+	 * @param EE_Line_Item $line_item
+	 * @param EEI_Payment   $payment
+	 * @return string
+	 */
+	protected function _format_line_item_name(EE_Line_Item $line_item, EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatLineItemName($line_item, $payment);
+	}
+
+	/**
+	 * Gets the description to use for a line item when sending line items to the gateway
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment))
+	 * @param EE_Line_Item $line_item
+	 * @param EEI_Payment   $payment
+	 * @return string
+	 */
+	protected function _format_line_item_desc(EE_Line_Item $line_item, EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment);
+	}
+
+	/**
+	 * Gets the order description that should generlly be sent to gateways
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatOrderDescription($payment)
+	 * @param EEI_Payment $payment
+	 * @return type
+	 */
+	protected function _format_order_description(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatOrderDescription($payment);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isInSandboxMode(): bool
+	{
+		return $this->_debug_mode;
+	}
 }

core/libraries/payment_methods/EE_Offsite_Gateway.lib.php

Indentation +102 added lines, -102 removed lines

@@ -15,117 +15,117 @@
 abstract class EE_Offsite_Gateway extends EE_Gateway
 {
 
-    /**
-     * whether or not the gateway uses an IPN
-     * that is sent in a separate request than the returning registrant.
-     * if false, then we need to process the payment results manually
-     * as soon as the registrant returns from the off-site gateway
-     *
-     * @type bool
-     */
-    protected $_uses_separate_IPN_request = false;
+	/**
+	 * whether or not the gateway uses an IPN
+	 * that is sent in a separate request than the returning registrant.
+	 * if false, then we need to process the payment results manually
+	 * as soon as the registrant returns from the off-site gateway
+	 *
+	 * @type bool
+	 */
+	protected $_uses_separate_IPN_request = false;
 
 
-    /**
-     * EE_Offsite_Gateway constructor
-     */
-    public function __construct()
-    {
-        $this->_supports_receiving_refunds = true;
-        parent::__construct();
-    }
+	/**
+	 * EE_Offsite_Gateway constructor
+	 */
+	public function __construct()
+	{
+		$this->_supports_receiving_refunds = true;
+		parent::__construct();
+	}
 
 
-    /**
-     * Adds information into the payment object's redirect_url and redirect_args so
-     * client code can use that payment to know where (and with what information)
-     * to redirect the user to in order to make the payment on the offsite gateway's website.
-     * Saving the payment from within this method is unnecessary,
-     * as it is the responsibility of client code to save it.
-     *
-     * @param EE_Payment $payment    to process
-     * @param array      $billing_info
-     * @param string     $return_url URL to send the user to after a successful payment on the payment provider's
-     *                               website
-     * @param string     $notify_url URL to send the instant payment notification
-     * @param string     $cancel_url URL to send the user to after a cancelled payment attempt on teh payment
-     *                               provider's website
-     * @return EE_Payment
-     */
-    abstract public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    );
+	/**
+	 * Adds information into the payment object's redirect_url and redirect_args so
+	 * client code can use that payment to know where (and with what information)
+	 * to redirect the user to in order to make the payment on the offsite gateway's website.
+	 * Saving the payment from within this method is unnecessary,
+	 * as it is the responsibility of client code to save it.
+	 *
+	 * @param EE_Payment $payment    to process
+	 * @param array      $billing_info
+	 * @param string     $return_url URL to send the user to after a successful payment on the payment provider's
+	 *                               website
+	 * @param string     $notify_url URL to send the instant payment notification
+	 * @param string     $cancel_url URL to send the user to after a cancelled payment attempt on teh payment
+	 *                               provider's website
+	 * @return EE_Payment
+	 */
+	abstract public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	);
 
 
-    /**
-     * Often used for IPNs. But applies the info in $update_info to the payment.
-     * What is $update_info? Often the contents of $_REQUEST, but not necessarily. Whatever
-     * the payment method passes in. Saving the payment from within this method is unnecessary,
-     * as it is the responsibility of client code to save it.
-     *
-     * @param array           $update_info of whatever
-     * @param EEI_Transaction $transaction
-     * @return EEI_Payment updated
-     */
-    abstract public function handle_payment_update($update_info, $transaction);
+	/**
+	 * Often used for IPNs. But applies the info in $update_info to the payment.
+	 * What is $update_info? Often the contents of $_REQUEST, but not necessarily. Whatever
+	 * the payment method passes in. Saving the payment from within this method is unnecessary,
+	 * as it is the responsibility of client code to save it.
+	 *
+	 * @param array           $update_info of whatever
+	 * @param EEI_Transaction $transaction
+	 * @return EEI_Payment updated
+	 */
+	abstract public function handle_payment_update($update_info, $transaction);
 
 
-    /**
-     * uses_separate_IPN_request
-     *
-     * return true or false for whether or not the gateway uses an IPN
-     * that is sent in a separate request than the returning registrant.
-     * if false, then we need to process the payment results manually
-     * as soon as the registrant returns from the off-site gateway
-     *
-     * @deprecated since version 4.8.39.rc.001 please use handle_IPN_in_this_request() instead
-     *
-     * @return bool
-     */
-    public function uses_separate_IPN_request()
-    {
-        return $this->_uses_separate_IPN_request;
-    }
+	/**
+	 * uses_separate_IPN_request
+	 *
+	 * return true or false for whether or not the gateway uses an IPN
+	 * that is sent in a separate request than the returning registrant.
+	 * if false, then we need to process the payment results manually
+	 * as soon as the registrant returns from the off-site gateway
+	 *
+	 * @deprecated since version 4.8.39.rc.001 please use handle_IPN_in_this_request() instead
+	 *
+	 * @return bool
+	 */
+	public function uses_separate_IPN_request()
+	{
+		return $this->_uses_separate_IPN_request;
+	}
 
 
-    /**
-     * set_uses_separate_IPN_request
-     *
-     * @access protected
-     * @param boolean $uses_separate_IPN_request
-     */
-    protected function set_uses_separate_IPN_request($uses_separate_IPN_request)
-    {
-        $this->_uses_separate_IPN_request = filter_var($uses_separate_IPN_request, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * set_uses_separate_IPN_request
+	 *
+	 * @access protected
+	 * @param boolean $uses_separate_IPN_request
+	 */
+	protected function set_uses_separate_IPN_request($uses_separate_IPN_request)
+	{
+		$this->_uses_separate_IPN_request = filter_var($uses_separate_IPN_request, FILTER_VALIDATE_BOOLEAN);
+	}
 
-    /**
-     * Allows gateway to dynamically decide whether or not to handle a payment update
-     * by overriding this method. By default, if this is a "true" IPN (meaning
-     * it's a separate request from when the user returns from the offsite gateway)
-     * and this gateway class is setup to handle IPNs in separate "true" IPNs, then
-     * this will return true, otherwise it will return false.
-     * If however, this is a request when the user is returning
-     * from an offsite gateway, and this gateway class is setup to process the payment
-     * data when the user returns, then this will return true.
-     *
-     * @param array   $request_data
-     * @param boolean $separate_IPN_request
-     * @return boolean
-     */
-    public function handle_IPN_in_this_request($request_data, $separate_IPN_request)
-    {
-        if ($separate_IPN_request) {
-            // payment data being sent in a request separate from the user
-            // it is this other request that will update the TXN and payment info
-            return $this->_uses_separate_IPN_request;
-        } else {
-            // it's a request where the user returned from an offsite gateway WITH the payment data
-            return ! $this->_uses_separate_IPN_request;
-        }
-    }
+	/**
+	 * Allows gateway to dynamically decide whether or not to handle a payment update
+	 * by overriding this method. By default, if this is a "true" IPN (meaning
+	 * it's a separate request from when the user returns from the offsite gateway)
+	 * and this gateway class is setup to handle IPNs in separate "true" IPNs, then
+	 * this will return true, otherwise it will return false.
+	 * If however, this is a request when the user is returning
+	 * from an offsite gateway, and this gateway class is setup to process the payment
+	 * data when the user returns, then this will return true.
+	 *
+	 * @param array   $request_data
+	 * @param boolean $separate_IPN_request
+	 * @return boolean
+	 */
+	public function handle_IPN_in_this_request($request_data, $separate_IPN_request)
+	{
+		if ($separate_IPN_request) {
+			// payment data being sent in a request separate from the user
+			// it is this other request that will update the TXN and payment info
+			return $this->_uses_separate_IPN_request;
+		} else {
+			// it's a request where the user returned from an offsite gateway WITH the payment data
+			return ! $this->_uses_separate_IPN_request;
+		}
+	}
 }

payment_methods/Paypal_Express/EEG_Paypal_Express.gateway.php

Indentation +544 added lines, -544 removed lines

@@ -13,548 +13,548 @@
 class EEG_Paypal_Express extends EE_Offsite_Gateway
 {
 
-    /**
-     * Merchant API Username.
-     *
-     * @var string
-     */
-    protected $_api_username;
-
-    /**
-     * Merchant API Password.
-     *
-     * @var string
-     */
-    protected $_api_password;
-
-    /**
-     * API Signature.
-     *
-     * @var string
-     */
-    protected $_api_signature;
-
-    /**
-     * Request Shipping address on PP checkout page.
-     *
-     * @var string
-     */
-    protected $_request_shipping_addr;
-
-    /**
-     * Business/personal logo.
-     *
-     * @var string
-     */
-    protected $_image_url = '';
-
-    /**
-     * gateway URL variable
-     *
-     * @var string
-     */
-    protected $_base_gateway_url = '';
-
-
-    /**
-     * number of decimal places to round numbers to when performing calculations
-     *
-     * @var integer
-     */
-    protected $decimal_precision = 6;
-
-    /**
-     * @var ItemizedOrder
-     * @since $VID:$
-     */
-    protected $itemized_order;
-
-    /**
-     * @var TokenRequest
-     * @since $VID:$
-     */
-    protected $token_request;
-
-
-    /**
-     * EEG_Paypal_Express constructor.
-     */
-    public function __construct()
-    {
-        require_once 'polyfills.php';
-        $this->_currencies_supported = [
-            'USD',
-            'AUD',
-            'BRL',
-            'CAD',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MYR',
-            'MXN',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'GBP',
-            'RUB',
-            'SGD',
-            'SEK',
-            'CHF',
-            'TWD',
-            'THB',
-            'TRY',
-            'INR',
-        ];
-        parent::__construct();
-        $this->decimal_precision = EE_Registry::instance()->CFG->currency->dec_plc;
-    }
-
-
-    /**
-     * Sets the gateway URL variable based on whether debug mode is enabled or not.
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        parent::set_settings($settings_array);
-        // Redirect URL.
-        $this->_base_gateway_url = $this->_debug_mode
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
-    }
-
-
-    /**
-     * @param EEI_Payment $payment
-     * @param array       $billing_info
-     * @param string      $return_url
-     * @param string      $notify_url
-     * @param string      $cancel_url
-     * @return EE_Payment|EEI_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function set_redirection_info(
-        $payment,
-        $billing_info = [],
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    ) {
-        if (! $this->validatePayment($payment)) {
-            return $payment;
-        }
-        if (! $this->validateTransaction($payment)) {
-            return $payment;
-        }
-        $this->token_request = new TokenRequest($this->_get_gateway_formatter());
-        $token_request_details = apply_filters(
-            'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
-            $this->token_request->generateDetails(
-                $payment,
-                $this->getOrderItems($payment),
-                $return_url ?? '',
-                $cancel_url ?? '',
-                $this->_image_url ?? '',
-                $this->_request_shipping_addr ?? ''
-            ),
-            $this
-        );
-        // Request PayPal token.
-        $token_request_response = $this->_ppExpress_request($token_request_details, 'Payment Token', $payment);
-        $token_request_status   = $this->_ppExpress_check_response($token_request_response);
-        $this->token_request->processResponse($payment, $token_request_status, $this->isInSandboxMode());
-
-        return $payment;
-    }
-
-
-    /**
-     * @param array           $update_info {
-     * @type string           $gateway_txn_id
-     * @type string           $status      an EEMI_Payment status
-     *                                     }
-     * @param EEI_Transaction $transaction
-     * @return EEI_Payment
-     * @throws Exception
-     */
-    public function handle_payment_update($update_info, $transaction): EEI_Payment
-    {
-        // if the supplied transaction is valid, we'll retrieve the actual payment object from it
-        // but we'll use a temporary payment for now that we can return with errors if things go wrong
-        $payment = EE_Payment::new_instance();
-        if (! $this->validateTransaction($payment, $transaction)) {
-            return $payment;
-        }
-        $payment = $transaction->last_payment();
-        if (! $this->validatePayment($payment)) {
-            return $payment;
-        }
-        // payment appears to be good... so far
-        $this->log(['Return from Authorization' => $update_info], $payment);
-        $payment_token = $this->getPaymentToken($payment);
-        $customer_details = $this->requestCustomerDetails($payment, $payment_token);
-        // We got the PayerID so now we can Complete the transaction.
-        $this->processPayment($payment, $payment_token, $customer_details);
-
-        return $payment;
-    }
-
-
-    /**
-     * @throws Exception
-     */
-    private function getOrderItems(EE_Payment $payment, array $request_response_args = []): array
-    {
-        $this->itemized_order = new ItemizedOrder($this->_get_gateway_formatter());
-        try {
-            $itemized_order = $this->itemized_order->getExistingItemizedOrder($request_response_args);
-        } catch (Exception $exception) {
-            if (WP_DEBUG) {
-                throw $exception;
-            }
-            // Reset the list and log an error, maybe allow to try and generate a new list (below).
-            $itemized_order = [];
-            $this->log(
-                [
-                    esc_html__(
-                        'Could not generate a proper item list with:',
-                        'event_espresso'
-                    ) => $request_response_args,
-                ],
-                $payment
-            );
-        }
-        if (empty($itemized_order)) {
-            $itemized_order = $this->itemized_order->generateItemizedOrder($payment);
-        }
-        return $itemized_order;
-    }
-
-
-    /**
-     *  Make the Express checkout request.
-     *
-     * @param array       $request_params
-     * @param string      $request_text
-     * @param EEI_Payment $payment
-     * @return array|WP_Error
-     */
-    public function _ppExpress_request(array $request_params, string $request_text, EEI_Payment $payment)
-    {
-        $request_dtls = [
-            'VERSION'      => '204.0',
-            'USER'         => $this->_api_username,
-            'PWD'          => $this->_api_password,
-            'SIGNATURE'    => $this->_api_signature,
-            // EE will blow up if you change this
-            'BUTTONSOURCE' => 'EventEspresso_SP',
-        ];
-        $dtls         = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
-        // Request Customer Details.
-        $request_response = wp_remote_post(
-            $this->_base_gateway_url,
-            [
-                'method'      => 'POST',
-                'timeout'     => 45,
-                'httpversion' => '1.1',
-                'cookies'     => [],
-                'headers'     => [],
-                'body'        => http_build_query($dtls),
-            ]
-        );
-        // Log the response.
-        $this->log([$request_text . ' Response' => $request_response], $payment);
-        return $request_response;
-    }
-
-
-    /**
-     *  Check the response status.
-     *
-     * @param mixed $request_response
-     * @return array
-     */
-    public function _ppExpress_check_response($request_response): array
-    {
-        if (is_wp_error($request_response) || empty($request_response['body'])) {
-            // If we got here then there was an error in this request.
-            return ['status' => false, 'args' => $request_response];
-        }
-        $response_args = [];
-        parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
-            return ['status' => false, 'args' => $request_response];
-        }
-        if (
-            (
-                isset($response_args['PAYERID'])
-                || isset($response_args['TOKEN'])
-                || isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                || (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
-            )
-            && in_array($response_args['ACK'], ['Success', 'SuccessWithWarning'], true)
-        ) {
-            // Response status OK, return response parameters for further processing.
-            return ['status' => true, 'args' => $response_args];
-        }
-        $errors = $this->_get_errors($response_args);
-        return ['status' => false, 'args' => $errors];
-    }
-
-
-    /**
-     *  Log a "Cleared" request.
-     *
-     * @param array       $request
-     * @param EEI_Payment $payment
-     * @param string      $info
-     * @return void
-     */
-    private function _log_clean_request(array $request, EEI_Payment $payment, string $info)
-    {
-        $cleaned_request_data = $request;
-        unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
-        $this->log([$info => $cleaned_request_data], $payment);
-    }
-
-
-    /**
-     *  Get error from the response data.
-     *
-     * @param array $data_array
-     * @return array
-     */
-    private function _get_errors(array $data_array): array
-    {
-        $errors = [];
-        $n      = 0;
-        while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
-            $l_error_code    = $data_array[ "L_ERRORCODE{$n}" ] ?? '';
-            $l_severity_code = $data_array[ "L_SEVERITYCODE{$n}" ] ?? '';
-            $l_short_message = $data_array[ "L_SHORTMESSAGE{$n}" ] ?? '';
-            $l_long_message  = $data_array[ "L_LONGMESSAGE{$n}" ] ?? '';
-            if ($n === 0) {
-                $errors = [
-                    'L_ERRORCODE'    => $l_error_code,
-                    'L_SHORTMESSAGE' => $l_short_message,
-                    'L_LONGMESSAGE'  => $l_long_message,
-                    'L_SEVERITYCODE' => $l_severity_code,
-                ];
-            } else {
-                $errors['L_ERRORCODE']    .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE']  .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
-            }
-            $n++;
-        }
-        return $errors;
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @return mixed|null
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function getPaymentToken(EE_Payment $payment)
-    {
-        $payment_details = $payment->details();
-        // Check if we still have the token.
-        if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
-            $payment->set_status($this->_pay_model->failed_status());
-            return null;
-        }
-        return $payment_details['TOKEN'];
-    }
-
-    /**
-     * @param EE_Payment $payment
-     * @param array      $checkout_response
-     * @param array      $customer_data
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   $VID:$
-     */
-    private function paymentApproved(EE_Payment $payment, array $checkout_response, array $customer_data)
-    {
-        $primary_registrant = $payment->transaction()->primary_registration();
-        $primary_registration_code = $primary_registrant instanceof EE_Registration ?
-            $primary_registrant->reg_code()
-            : '';
-        $payment->set_extra_accntng($primary_registration_code);
-        $payment_amount = $checkout_response['PAYMENTINFO_0_AMT'] ?? 0;
-        $payment->set_amount((float) $payment_amount);
-        $payment->set_txn_id_chq_nmbr($checkout_response['PAYMENTINFO_0_TRANSACTIONID'] ?? null);
-        $payment->set_details($customer_data);
-        $payment->set_gateway_response($checkout_response['PAYMENTINFO_0_ACK'] ?? '');
-        $payment->set_status($this->_pay_model->approved_status());
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @param array      $checkout_response
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function paymentDeclined(EE_Payment $payment, array $checkout_response)
-    {
-        $gateway_response = isset($checkout_response['L_ERRORCODE'])
-            ? $checkout_response['L_ERRORCODE'] . '; ' . $checkout_response['L_SHORTMESSAGE']
-            : esc_html__('Error occurred while trying to Capture the funds.', 'event_espresso');
-
-        $payment->set_gateway_response($gateway_response);
-        $payment->set_details($checkout_response);
-        $payment->set_status($this->_pay_model->declined_status());
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @param array $customer_data
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function paymentFailed(EE_Payment $payment, array $customer_data)
-    {
-        $gateway_response = isset($customer_data['L_ERRORCODE'])
-            ? $customer_data['L_ERRORCODE'] . '; ' . $customer_data['L_SHORTMESSAGE']
-            : esc_html__('Error occurred while trying to get payment Details from PayPal.', 'event_espresso');
-
-        $payment->set_gateway_response($gateway_response);
-        $payment->set_details($customer_data);
-        $payment->set_status($this->_pay_model->failed_status());
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @param string     $payment_token
-     * @param array      $customer_details
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     * @since   $VID:$
-     */
-    private function processPayment(EE_Payment $payment, string $payment_token, array $customer_details)
-    {
-        $checkout_request_dtls = [
-            'METHOD'                         => 'DoExpressCheckoutPayment',
-            'PAYERID'                        => $customer_details['PAYERID'],
-            'TOKEN'                          => $payment_token,
-            'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-            'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-            'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-        ];
-        // Include itemized list.
-        $itemized_list         = $this->getOrderItems($payment, $customer_details);
-        $checkout_request_dtls = array_merge($checkout_request_dtls, $itemized_list);
-        // Payment Checkout/Capture.
-        $checkout_request_response = $this->_ppExpress_request(
-            $checkout_request_dtls,
-            'Do Payment',
-            $payment
-        );
-        $checkout_request_status   = $this->_ppExpress_check_response($checkout_request_response);
-        $checkout_response         =
-            isset($checkout_request_status['args']) && is_array($checkout_request_status['args'])
-                ? $checkout_request_status['args']
-                : [];
-        if ($checkout_request_status['status']) {
-            // All is well, payment approved.
-            $this->paymentApproved($payment, $checkout_response, $customer_details);
-        } else {
-            $this->paymentDeclined($payment, $checkout_response);
-        }
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @param string $payment_token
-     * @return array
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function requestCustomerDetails(EE_Payment $payment, string $payment_token): array
-    {
-        $customer_details_request_dtls = [
-            'METHOD' => 'GetExpressCheckoutDetails',
-            'TOKEN'  => $payment_token,
-        ];
-        // Request Customer Details.
-        $customer_details_request_response = $this->_ppExpress_request(
-            $customer_details_request_dtls,
-            'Customer Details',
-            $payment
-        );
-        $customer_details_rstatus          = $this->_ppExpress_check_response($customer_details_request_response);
-        $customer_details = isset($customer_details_rstatus['args']) && is_array($customer_details_rstatus['args'])
-            ? $customer_details_rstatus['args']
-            : [];
-        if (! $customer_details_rstatus['status']) {
-            $this->paymentFailed($payment, $customer_details);
-        }
-        return $customer_details;
-    }
-
-
-
-    /**
-     * @param EE_Payment|null $payment
-     * @return bool
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function validatePayment(?EE_Payment $payment): bool
-    {
-        if (! $payment instanceof EE_Payment) {
-            $payment = EE_Payment::new_instance();
-            $payment->set_gateway_response(
-                esc_html__(
-                    'An error occurred while trying to process the payment.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * @param EE_Payment          $payment
-     * @param EE_Transaction|null $transaction
-     * @return bool
-     * @throws EE_Error
-     * @since   $VID:$
-     */
-    private function validateTransaction(EE_Payment $payment, ?EE_Transaction $transaction = null): bool
-    {
-        $transaction = $transaction ?? $payment->transaction();
-        if (! $transaction instanceof EE_Transaction) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Could not process this payment because it has no associated transaction.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * Merchant API Username.
+	 *
+	 * @var string
+	 */
+	protected $_api_username;
+
+	/**
+	 * Merchant API Password.
+	 *
+	 * @var string
+	 */
+	protected $_api_password;
+
+	/**
+	 * API Signature.
+	 *
+	 * @var string
+	 */
+	protected $_api_signature;
+
+	/**
+	 * Request Shipping address on PP checkout page.
+	 *
+	 * @var string
+	 */
+	protected $_request_shipping_addr;
+
+	/**
+	 * Business/personal logo.
+	 *
+	 * @var string
+	 */
+	protected $_image_url = '';
+
+	/**
+	 * gateway URL variable
+	 *
+	 * @var string
+	 */
+	protected $_base_gateway_url = '';
+
+
+	/**
+	 * number of decimal places to round numbers to when performing calculations
+	 *
+	 * @var integer
+	 */
+	protected $decimal_precision = 6;
+
+	/**
+	 * @var ItemizedOrder
+	 * @since $VID:$
+	 */
+	protected $itemized_order;
+
+	/**
+	 * @var TokenRequest
+	 * @since $VID:$
+	 */
+	protected $token_request;
+
+
+	/**
+	 * EEG_Paypal_Express constructor.
+	 */
+	public function __construct()
+	{
+		require_once 'polyfills.php';
+		$this->_currencies_supported = [
+			'USD',
+			'AUD',
+			'BRL',
+			'CAD',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MYR',
+			'MXN',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'GBP',
+			'RUB',
+			'SGD',
+			'SEK',
+			'CHF',
+			'TWD',
+			'THB',
+			'TRY',
+			'INR',
+		];
+		parent::__construct();
+		$this->decimal_precision = EE_Registry::instance()->CFG->currency->dec_plc;
+	}
+
+
+	/**
+	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		parent::set_settings($settings_array);
+		// Redirect URL.
+		$this->_base_gateway_url = $this->_debug_mode
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
+	}
+
+
+	/**
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info
+	 * @param string      $return_url
+	 * @param string      $notify_url
+	 * @param string      $cancel_url
+	 * @return EE_Payment|EEI_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function set_redirection_info(
+		$payment,
+		$billing_info = [],
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	) {
+		if (! $this->validatePayment($payment)) {
+			return $payment;
+		}
+		if (! $this->validateTransaction($payment)) {
+			return $payment;
+		}
+		$this->token_request = new TokenRequest($this->_get_gateway_formatter());
+		$token_request_details = apply_filters(
+			'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
+			$this->token_request->generateDetails(
+				$payment,
+				$this->getOrderItems($payment),
+				$return_url ?? '',
+				$cancel_url ?? '',
+				$this->_image_url ?? '',
+				$this->_request_shipping_addr ?? ''
+			),
+			$this
+		);
+		// Request PayPal token.
+		$token_request_response = $this->_ppExpress_request($token_request_details, 'Payment Token', $payment);
+		$token_request_status   = $this->_ppExpress_check_response($token_request_response);
+		$this->token_request->processResponse($payment, $token_request_status, $this->isInSandboxMode());
+
+		return $payment;
+	}
+
+
+	/**
+	 * @param array           $update_info {
+	 * @type string           $gateway_txn_id
+	 * @type string           $status      an EEMI_Payment status
+	 *                                     }
+	 * @param EEI_Transaction $transaction
+	 * @return EEI_Payment
+	 * @throws Exception
+	 */
+	public function handle_payment_update($update_info, $transaction): EEI_Payment
+	{
+		// if the supplied transaction is valid, we'll retrieve the actual payment object from it
+		// but we'll use a temporary payment for now that we can return with errors if things go wrong
+		$payment = EE_Payment::new_instance();
+		if (! $this->validateTransaction($payment, $transaction)) {
+			return $payment;
+		}
+		$payment = $transaction->last_payment();
+		if (! $this->validatePayment($payment)) {
+			return $payment;
+		}
+		// payment appears to be good... so far
+		$this->log(['Return from Authorization' => $update_info], $payment);
+		$payment_token = $this->getPaymentToken($payment);
+		$customer_details = $this->requestCustomerDetails($payment, $payment_token);
+		// We got the PayerID so now we can Complete the transaction.
+		$this->processPayment($payment, $payment_token, $customer_details);
+
+		return $payment;
+	}
+
+
+	/**
+	 * @throws Exception
+	 */
+	private function getOrderItems(EE_Payment $payment, array $request_response_args = []): array
+	{
+		$this->itemized_order = new ItemizedOrder($this->_get_gateway_formatter());
+		try {
+			$itemized_order = $this->itemized_order->getExistingItemizedOrder($request_response_args);
+		} catch (Exception $exception) {
+			if (WP_DEBUG) {
+				throw $exception;
+			}
+			// Reset the list and log an error, maybe allow to try and generate a new list (below).
+			$itemized_order = [];
+			$this->log(
+				[
+					esc_html__(
+						'Could not generate a proper item list with:',
+						'event_espresso'
+					) => $request_response_args,
+				],
+				$payment
+			);
+		}
+		if (empty($itemized_order)) {
+			$itemized_order = $this->itemized_order->generateItemizedOrder($payment);
+		}
+		return $itemized_order;
+	}
+
+
+	/**
+	 *  Make the Express checkout request.
+	 *
+	 * @param array       $request_params
+	 * @param string      $request_text
+	 * @param EEI_Payment $payment
+	 * @return array|WP_Error
+	 */
+	public function _ppExpress_request(array $request_params, string $request_text, EEI_Payment $payment)
+	{
+		$request_dtls = [
+			'VERSION'      => '204.0',
+			'USER'         => $this->_api_username,
+			'PWD'          => $this->_api_password,
+			'SIGNATURE'    => $this->_api_signature,
+			// EE will blow up if you change this
+			'BUTTONSOURCE' => 'EventEspresso_SP',
+		];
+		$dtls         = array_merge($request_dtls, $request_params);
+		$this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+		// Request Customer Details.
+		$request_response = wp_remote_post(
+			$this->_base_gateway_url,
+			[
+				'method'      => 'POST',
+				'timeout'     => 45,
+				'httpversion' => '1.1',
+				'cookies'     => [],
+				'headers'     => [],
+				'body'        => http_build_query($dtls),
+			]
+		);
+		// Log the response.
+		$this->log([$request_text . ' Response' => $request_response], $payment);
+		return $request_response;
+	}
+
+
+	/**
+	 *  Check the response status.
+	 *
+	 * @param mixed $request_response
+	 * @return array
+	 */
+	public function _ppExpress_check_response($request_response): array
+	{
+		if (is_wp_error($request_response) || empty($request_response['body'])) {
+			// If we got here then there was an error in this request.
+			return ['status' => false, 'args' => $request_response];
+		}
+		$response_args = [];
+		parse_str(urldecode($request_response['body']), $response_args);
+		if (! isset($response_args['ACK'])) {
+			return ['status' => false, 'args' => $request_response];
+		}
+		if (
+			(
+				isset($response_args['PAYERID'])
+				|| isset($response_args['TOKEN'])
+				|| isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
+				|| (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
+			)
+			&& in_array($response_args['ACK'], ['Success', 'SuccessWithWarning'], true)
+		) {
+			// Response status OK, return response parameters for further processing.
+			return ['status' => true, 'args' => $response_args];
+		}
+		$errors = $this->_get_errors($response_args);
+		return ['status' => false, 'args' => $errors];
+	}
+
+
+	/**
+	 *  Log a "Cleared" request.
+	 *
+	 * @param array       $request
+	 * @param EEI_Payment $payment
+	 * @param string      $info
+	 * @return void
+	 */
+	private function _log_clean_request(array $request, EEI_Payment $payment, string $info)
+	{
+		$cleaned_request_data = $request;
+		unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
+		$this->log([$info => $cleaned_request_data], $payment);
+	}
+
+
+	/**
+	 *  Get error from the response data.
+	 *
+	 * @param array $data_array
+	 * @return array
+	 */
+	private function _get_errors(array $data_array): array
+	{
+		$errors = [];
+		$n      = 0;
+		while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
+			$l_error_code    = $data_array[ "L_ERRORCODE{$n}" ] ?? '';
+			$l_severity_code = $data_array[ "L_SEVERITYCODE{$n}" ] ?? '';
+			$l_short_message = $data_array[ "L_SHORTMESSAGE{$n}" ] ?? '';
+			$l_long_message  = $data_array[ "L_LONGMESSAGE{$n}" ] ?? '';
+			if ($n === 0) {
+				$errors = [
+					'L_ERRORCODE'    => $l_error_code,
+					'L_SHORTMESSAGE' => $l_short_message,
+					'L_LONGMESSAGE'  => $l_long_message,
+					'L_SEVERITYCODE' => $l_severity_code,
+				];
+			} else {
+				$errors['L_ERRORCODE']    .= ', ' . $l_error_code;
+				$errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
+				$errors['L_LONGMESSAGE']  .= ', ' . $l_long_message;
+				$errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+			}
+			$n++;
+		}
+		return $errors;
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @return mixed|null
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function getPaymentToken(EE_Payment $payment)
+	{
+		$payment_details = $payment->details();
+		// Check if we still have the token.
+		if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+			$payment->set_status($this->_pay_model->failed_status());
+			return null;
+		}
+		return $payment_details['TOKEN'];
+	}
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param array      $checkout_response
+	 * @param array      $customer_data
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   $VID:$
+	 */
+	private function paymentApproved(EE_Payment $payment, array $checkout_response, array $customer_data)
+	{
+		$primary_registrant = $payment->transaction()->primary_registration();
+		$primary_registration_code = $primary_registrant instanceof EE_Registration ?
+			$primary_registrant->reg_code()
+			: '';
+		$payment->set_extra_accntng($primary_registration_code);
+		$payment_amount = $checkout_response['PAYMENTINFO_0_AMT'] ?? 0;
+		$payment->set_amount((float) $payment_amount);
+		$payment->set_txn_id_chq_nmbr($checkout_response['PAYMENTINFO_0_TRANSACTIONID'] ?? null);
+		$payment->set_details($customer_data);
+		$payment->set_gateway_response($checkout_response['PAYMENTINFO_0_ACK'] ?? '');
+		$payment->set_status($this->_pay_model->approved_status());
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param array      $checkout_response
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function paymentDeclined(EE_Payment $payment, array $checkout_response)
+	{
+		$gateway_response = isset($checkout_response['L_ERRORCODE'])
+			? $checkout_response['L_ERRORCODE'] . '; ' . $checkout_response['L_SHORTMESSAGE']
+			: esc_html__('Error occurred while trying to Capture the funds.', 'event_espresso');
+
+		$payment->set_gateway_response($gateway_response);
+		$payment->set_details($checkout_response);
+		$payment->set_status($this->_pay_model->declined_status());
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param array $customer_data
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function paymentFailed(EE_Payment $payment, array $customer_data)
+	{
+		$gateway_response = isset($customer_data['L_ERRORCODE'])
+			? $customer_data['L_ERRORCODE'] . '; ' . $customer_data['L_SHORTMESSAGE']
+			: esc_html__('Error occurred while trying to get payment Details from PayPal.', 'event_espresso');
+
+		$payment->set_gateway_response($gateway_response);
+		$payment->set_details($customer_data);
+		$payment->set_status($this->_pay_model->failed_status());
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param string     $payment_token
+	 * @param array      $customer_details
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 * @since   $VID:$
+	 */
+	private function processPayment(EE_Payment $payment, string $payment_token, array $customer_details)
+	{
+		$checkout_request_dtls = [
+			'METHOD'                         => 'DoExpressCheckoutPayment',
+			'PAYERID'                        => $customer_details['PAYERID'],
+			'TOKEN'                          => $payment_token,
+			'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+			'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+			'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+		];
+		// Include itemized list.
+		$itemized_list         = $this->getOrderItems($payment, $customer_details);
+		$checkout_request_dtls = array_merge($checkout_request_dtls, $itemized_list);
+		// Payment Checkout/Capture.
+		$checkout_request_response = $this->_ppExpress_request(
+			$checkout_request_dtls,
+			'Do Payment',
+			$payment
+		);
+		$checkout_request_status   = $this->_ppExpress_check_response($checkout_request_response);
+		$checkout_response         =
+			isset($checkout_request_status['args']) && is_array($checkout_request_status['args'])
+				? $checkout_request_status['args']
+				: [];
+		if ($checkout_request_status['status']) {
+			// All is well, payment approved.
+			$this->paymentApproved($payment, $checkout_response, $customer_details);
+		} else {
+			$this->paymentDeclined($payment, $checkout_response);
+		}
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param string $payment_token
+	 * @return array
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function requestCustomerDetails(EE_Payment $payment, string $payment_token): array
+	{
+		$customer_details_request_dtls = [
+			'METHOD' => 'GetExpressCheckoutDetails',
+			'TOKEN'  => $payment_token,
+		];
+		// Request Customer Details.
+		$customer_details_request_response = $this->_ppExpress_request(
+			$customer_details_request_dtls,
+			'Customer Details',
+			$payment
+		);
+		$customer_details_rstatus          = $this->_ppExpress_check_response($customer_details_request_response);
+		$customer_details = isset($customer_details_rstatus['args']) && is_array($customer_details_rstatus['args'])
+			? $customer_details_rstatus['args']
+			: [];
+		if (! $customer_details_rstatus['status']) {
+			$this->paymentFailed($payment, $customer_details);
+		}
+		return $customer_details;
+	}
+
+
+
+	/**
+	 * @param EE_Payment|null $payment
+	 * @return bool
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function validatePayment(?EE_Payment $payment): bool
+	{
+		if (! $payment instanceof EE_Payment) {
+			$payment = EE_Payment::new_instance();
+			$payment->set_gateway_response(
+				esc_html__(
+					'An error occurred while trying to process the payment.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param EE_Payment          $payment
+	 * @param EE_Transaction|null $transaction
+	 * @return bool
+	 * @throws EE_Error
+	 * @since   $VID:$
+	 */
+	private function validateTransaction(EE_Payment $payment, ?EE_Transaction $transaction = null): bool
+	{
+		$transaction = $transaction ?? $payment->transaction();
+		if (! $transaction instanceof EE_Transaction) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Could not process this payment because it has no associated transaction.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return false;
+		}
+		return true;
+	}
 }

Spacing +24 added lines, -24 removed lines

@@ -148,10 +148,10 @@ 
         $notify_url = null,
         $cancel_url = null
     ) {
-        if (! $this->validatePayment($payment)) {
+        if ( ! $this->validatePayment($payment)) {
             return $payment;
         }
-        if (! $this->validateTransaction($payment)) {
+        if ( ! $this->validateTransaction($payment)) {
             return $payment;
         }
         $this->token_request = new TokenRequest($this->_get_gateway_formatter());
@@ -190,11 +190,11 @@ 
         // if the supplied transaction is valid, we'll retrieve the actual payment object from it
         // but we'll use a temporary payment for now that we can return with errors if things go wrong
         $payment = EE_Payment::new_instance();
-        if (! $this->validateTransaction($payment, $transaction)) {
+        if ( ! $this->validateTransaction($payment, $transaction)) {
             return $payment;
         }
         $payment = $transaction->last_payment();
-        if (! $this->validatePayment($payment)) {
+        if ( ! $this->validatePayment($payment)) {
             return $payment;
         }
         // payment appears to be good... so far
@@ -257,8 +257,8 @@ 
             // EE will blow up if you change this
             'BUTTONSOURCE' => 'EventEspresso_SP',
         ];
-        $dtls         = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+        $dtls = array_merge($request_dtls, $request_params);
+        $this->_log_clean_request($dtls, $payment, $request_text.' Request');
         // Request Customer Details.
         $request_response = wp_remote_post(
             $this->_base_gateway_url,
@@ -272,7 +272,7 @@ 
             ]
         );
         // Log the response.
-        $this->log([$request_text . ' Response' => $request_response], $payment);
+        $this->log([$request_text.' Response' => $request_response], $payment);
         return $request_response;
     }
 
@@ -291,7 +291,7 @@ 
         }
         $response_args = [];
         parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
+        if ( ! isset($response_args['ACK'])) {
             return ['status' => false, 'args' => $request_response];
         }
         if (
@@ -337,11 +337,11 @@ 
     {
         $errors = [];
         $n      = 0;
-        while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
-            $l_error_code    = $data_array[ "L_ERRORCODE{$n}" ] ?? '';
-            $l_severity_code = $data_array[ "L_SEVERITYCODE{$n}" ] ?? '';
-            $l_short_message = $data_array[ "L_SHORTMESSAGE{$n}" ] ?? '';
-            $l_long_message  = $data_array[ "L_LONGMESSAGE{$n}" ] ?? '';
+        while (isset($data_array["L_ERRORCODE{$n}"])) {
+            $l_error_code    = $data_array["L_ERRORCODE{$n}"] ?? '';
+            $l_severity_code = $data_array["L_SEVERITYCODE{$n}"] ?? '';
+            $l_short_message = $data_array["L_SHORTMESSAGE{$n}"] ?? '';
+            $l_long_message  = $data_array["L_LONGMESSAGE{$n}"] ?? '';
             if ($n === 0) {
                 $errors = [
                     'L_ERRORCODE'    => $l_error_code,
@@ -350,10 +350,10 @@ 
                     'L_SEVERITYCODE' => $l_severity_code,
                 ];
             } else {
-                $errors['L_ERRORCODE']    .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE']  .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+                $errors['L_ERRORCODE']    .= ', '.$l_error_code;
+                $errors['L_SHORTMESSAGE'] .= ', '.$l_short_message;
+                $errors['L_LONGMESSAGE']  .= ', '.$l_long_message;
+                $errors['L_SEVERITYCODE'] .= ', '.$l_severity_code;
             }
             $n++;
         }
@@ -371,7 +371,7 @@ 
     {
         $payment_details = $payment->details();
         // Check if we still have the token.
-        if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+        if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
             $payment->set_status($this->_pay_model->failed_status());
             return null;
         }
@@ -411,7 +411,7 @@ 
     private function paymentDeclined(EE_Payment $payment, array $checkout_response)
     {
         $gateway_response = isset($checkout_response['L_ERRORCODE'])
-            ? $checkout_response['L_ERRORCODE'] . '; ' . $checkout_response['L_SHORTMESSAGE']
+            ? $checkout_response['L_ERRORCODE'].'; '.$checkout_response['L_SHORTMESSAGE']
             : esc_html__('Error occurred while trying to Capture the funds.', 'event_espresso');
 
         $payment->set_gateway_response($gateway_response);
@@ -429,7 +429,7 @@ 
     private function paymentFailed(EE_Payment $payment, array $customer_data)
     {
         $gateway_response = isset($customer_data['L_ERRORCODE'])
-            ? $customer_data['L_ERRORCODE'] . '; ' . $customer_data['L_SHORTMESSAGE']
+            ? $customer_data['L_ERRORCODE'].'; '.$customer_data['L_SHORTMESSAGE']
             : esc_html__('Error occurred while trying to get payment Details from PayPal.', 'event_espresso');
 
         $payment->set_gateway_response($gateway_response);
@@ -500,11 +500,11 @@ 
             'Customer Details',
             $payment
         );
-        $customer_details_rstatus          = $this->_ppExpress_check_response($customer_details_request_response);
+        $customer_details_rstatus = $this->_ppExpress_check_response($customer_details_request_response);
         $customer_details = isset($customer_details_rstatus['args']) && is_array($customer_details_rstatus['args'])
             ? $customer_details_rstatus['args']
             : [];
-        if (! $customer_details_rstatus['status']) {
+        if ( ! $customer_details_rstatus['status']) {
             $this->paymentFailed($payment, $customer_details);
         }
         return $customer_details;
@@ -520,7 +520,7 @@ 
      */
     private function validatePayment(?EE_Payment $payment): bool
     {
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             $payment = EE_Payment::new_instance();
             $payment->set_gateway_response(
                 esc_html__(
@@ -545,7 +545,7 @@ 
     private function validateTransaction(EE_Payment $payment, ?EE_Transaction $transaction = null): bool
     {
         $transaction = $transaction ?? $payment->transaction();
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             $payment->set_gateway_response(
                 esc_html__(
                     'Could not process this payment because it has no associated transaction.',

payment_methods/Paypal_Express/ItemizedOrder.php

Indentation +265 added lines, -265 removed lines

@@ -16,292 +16,292 @@
 {
 
 
-    /**
-     * number of decimal places to round numbers to when performing calculations
-     *
-     * @var integer
-     */
-    protected $decimal_precision = 6;
+	/**
+	 * number of decimal places to round numbers to when performing calculations
+	 *
+	 * @var integer
+	 */
+	protected $decimal_precision = 6;
 
-    /**
-     * @var GatewayDataFormatterInterface
-     */
-    protected $gateway_data_formatter;
+	/**
+	 * @var GatewayDataFormatterInterface
+	 */
+	protected $gateway_data_formatter;
 
-    /**
-     * keeps track of exactly how much the itemized order amount equals
-     *
-     * @var float
-     */
-    private $itemized_order_sum = 0.00;
+	/**
+	 * keeps track of exactly how much the itemized order amount equals
+	 *
+	 * @var float
+	 */
+	private $itemized_order_sum = 0.00;
 
-    /**
-     * @var array
-     */
-    private $order_items;
+	/**
+	 * @var array
+	 */
+	private $order_items;
 
-    /**
-     * the payment being processed
-     *
-     * @var EE_Payment
-     */
-    protected $payment;
+	/**
+	 * the payment being processed
+	 *
+	 * @var EE_Payment
+	 */
+	protected $payment;
 
-    /**
-     * @var EE_Transaction
-     */
-    private $transaction;
+	/**
+	 * @var EE_Transaction
+	 */
+	private $transaction;
 
 
-    /**
-     * @param GatewayDataFormatterInterface $gateway_data_formatter
-     */
-    public function __construct(GatewayDataFormatterInterface $gateway_data_formatter)
-    {
-        $this->decimal_precision      = EE_Registry::instance()->CFG->currency->dec_plc;
-        $this->gateway_data_formatter = $gateway_data_formatter;
-        $this->order_items            = [];
-    }
+	/**
+	 * @param GatewayDataFormatterInterface $gateway_data_formatter
+	 */
+	public function __construct(GatewayDataFormatterInterface $gateway_data_formatter)
+	{
+		$this->decimal_precision      = EE_Registry::instance()->CFG->currency->dec_plc;
+		$this->gateway_data_formatter = $gateway_data_formatter;
+		$this->order_items            = [];
+	}
 
 
-    /**
-     * @param array $request_response_args
-     * @return array
-     */
-    public function getExistingItemizedOrder(array $request_response_args): array
-    {
-        // If we have data from a previous communication with PP (on this transaction) we may use that for our list...
-        if (
-            ! empty($request_response_args)
-            && array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args)
-            && array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args)
-        ) {
-            foreach ($request_response_args as $arg_key => $arg_val) {
-                if (
-                    strpos($arg_key, 'PAYMENTREQUEST_') !== false
-                    && strpos($arg_key, 'NOTIFYURL') === false
-                ) {
-                    $this->order_items[ $arg_key ] = $arg_val;
-                }
-            }
-            // If we only get a few Items then something is not right.
-            if (count($this->order_items) < 3) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__(
-                            'Unable to continue with the checkout because a proper purchase list could not be generated. The purchased list we could have sent was %1$s',
-                            'event_espresso'
-                        ),
-                        wp_json_encode($this->order_items)
-                    )
-                );
-            }
-        }
-        return $this->order_items;
-    }
+	/**
+	 * @param array $request_response_args
+	 * @return array
+	 */
+	public function getExistingItemizedOrder(array $request_response_args): array
+	{
+		// If we have data from a previous communication with PP (on this transaction) we may use that for our list...
+		if (
+			! empty($request_response_args)
+			&& array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args)
+			&& array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args)
+		) {
+			foreach ($request_response_args as $arg_key => $arg_val) {
+				if (
+					strpos($arg_key, 'PAYMENTREQUEST_') !== false
+					&& strpos($arg_key, 'NOTIFYURL') === false
+				) {
+					$this->order_items[ $arg_key ] = $arg_val;
+				}
+			}
+			// If we only get a few Items then something is not right.
+			if (count($this->order_items) < 3) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__(
+							'Unable to continue with the checkout because a proper purchase list could not be generated. The purchased list we could have sent was %1$s',
+							'event_espresso'
+						),
+						wp_json_encode($this->order_items)
+					)
+				);
+			}
+		}
+		return $this->order_items;
+	}
 
 
-    /**
-     *  Make a list of items that are in the giver transaction.
-     *
-     * @param EE_Payment $payment
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generateItemizedOrder(EE_Payment $payment): array
-    {
-        $this->payment     = $payment;
-        $this->transaction = $this->payment->transaction();
-        // reset order items
-        $this->order_items = [];
-        if ($this->paymentIsForTransactionTotal()) {
-            $this->itemizeOrderForFullPayment();
-        } else {
-            $this->handlePartialPayment();
-        }
-        return $this->order_items;
-    }
+	/**
+	 *  Make a list of items that are in the giver transaction.
+	 *
+	 * @param EE_Payment $payment
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generateItemizedOrder(EE_Payment $payment): array
+	{
+		$this->payment     = $payment;
+		$this->transaction = $this->payment->transaction();
+		// reset order items
+		$this->order_items = [];
+		if ($this->paymentIsForTransactionTotal()) {
+			$this->itemizeOrderForFullPayment();
+		} else {
+			$this->handlePartialPayment();
+		}
+		return $this->order_items;
+	}
 
 
-    /**
-     * @return bool
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    private function paymentIsForTransactionTotal(): bool
-    {
-        return EEH_Money::compare_floats($this->payment->amount(), $this->transaction->total(), '==');
-    }
+	/**
+	 * @return bool
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	private function paymentIsForTransactionTotal(): bool
+	{
+		return EEH_Money::compare_floats($this->payment->amount(), $this->transaction->total(), '==');
+	}
 
 
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function itemizeOrderForFullPayment()
-    {
-        $item_num        = 0;
-        $total_line_item = $this->transaction->total_line_item();
-        $item_num        = $this->addOrderItemsForLineItems($total_line_item, $item_num);
-        $this->addOrderItemsForAdditionalCharges($total_line_item);
-        $this->handleItemizedOrderSumDifference($total_line_item, $item_num);
-    }
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function itemizeOrderForFullPayment()
+	{
+		$item_num        = 0;
+		$total_line_item = $this->transaction->total_line_item();
+		$item_num        = $this->addOrderItemsForLineItems($total_line_item, $item_num);
+		$this->addOrderItemsForAdditionalCharges($total_line_item);
+		$this->handleItemizedOrderSumDifference($total_line_item, $item_num);
+	}
 
 
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    private function handlePartialPayment()
-    {
-        // Item Name.
-        $this->order_items['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
-            $this->gateway_data_formatter->formatPartialPaymentLineItemName($this->payment),
-            0,
-            127
-        );
-        // Item description.
-        $this->order_items['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
-            $this->gateway_data_formatter->formatPartialPaymentLineItemDesc($this->payment),
-            0,
-            127
-        );
-        // Cost of individual item.
-        $this->order_items['L_PAYMENTREQUEST_0_AMT0'] = $this->gateway_data_formatter->formatCurrency(
-            $this->payment->amount(),
-            $this->decimal_precision
-        );
-        // Item Number.
-        $this->order_items['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
-        // Item quantity.
-        $this->order_items['L_PAYMENTREQUEST_0_QTY0'] = 1;
-        // Digital item is sold.
-        $this->order_items['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
-        // Item's sales S/H and tax amount.
-        $this->order_items['PAYMENTREQUEST_0_ITEMAMT']     = $this->gateway_data_formatter->formatCurrency(
-            $this->payment->amount(),
-            $this->decimal_precision
-        );
-        $this->order_items['PAYMENTREQUEST_0_TAXAMT']      = '0';
-        $this->order_items['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-        $this->order_items['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-    }
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function handlePartialPayment()
+	{
+		// Item Name.
+		$this->order_items['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
+			$this->gateway_data_formatter->formatPartialPaymentLineItemName($this->payment),
+			0,
+			127
+		);
+		// Item description.
+		$this->order_items['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
+			$this->gateway_data_formatter->formatPartialPaymentLineItemDesc($this->payment),
+			0,
+			127
+		);
+		// Cost of individual item.
+		$this->order_items['L_PAYMENTREQUEST_0_AMT0'] = $this->gateway_data_formatter->formatCurrency(
+			$this->payment->amount(),
+			$this->decimal_precision
+		);
+		// Item Number.
+		$this->order_items['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
+		// Item quantity.
+		$this->order_items['L_PAYMENTREQUEST_0_QTY0'] = 1;
+		// Digital item is sold.
+		$this->order_items['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
+		// Item's sales S/H and tax amount.
+		$this->order_items['PAYMENTREQUEST_0_ITEMAMT']     = $this->gateway_data_formatter->formatCurrency(
+			$this->payment->amount(),
+			$this->decimal_precision
+		);
+		$this->order_items['PAYMENTREQUEST_0_TAXAMT']      = '0';
+		$this->order_items['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+		$this->order_items['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+	}
 
 
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @param int          $item_num
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function addOrderItemsForLineItems(EE_Line_Item $total_line_item, int $item_num): int
-    {
-        // Go through each item in the list.
-        foreach ($total_line_item->get_items() as $line_item) {
-            if ($line_item instanceof EE_Line_Item) {
-                // PayPal doesn't like line items with 0.00 amount, so we may skip those.
-                if (EEH_Money::compare_floats($line_item->pretaxTotal(), '0.00', '==')) {
-                    continue;
-                }
-                $unit_price         = $this->gateway_data_formatter->formatCurrency(
-                    $line_item->unit_price(),
-                    $this->decimal_precision
-                );
-                $line_item_quantity = $line_item->quantity();
-                // This is a discount.
-                if ($line_item->is_percent()) {
-                    $unit_price         = $line_item->pretaxTotal();
-                    $line_item_quantity = 1;
-                }
-                // Item Name.
-                $this->order_items[ "L_PAYMENTREQUEST_0_NAME{$item_num}" ] = mb_strcut(
-                    $this->gateway_data_formatter->formatLineItemName($line_item, $this->payment),
-                    0,
-                    127
-                );
-                // Item description.
-                $this->order_items[ "L_PAYMENTREQUEST_0_DESC{$item_num}" ] = mb_strcut(
-                    $this->gateway_data_formatter->formatLineItemDesc($line_item, $this->payment),
-                    0,
-                    127
-                );
-                // Cost of individual item.
-                $this->order_items[ "L_PAYMENTREQUEST_0_AMT{$item_num}" ] = $unit_price;
-                // Item Number.
-                $this->order_items[ "L_PAYMENTREQUEST_0_NUMBER{$item_num}" ] = $item_num + 1;
-                // Item quantity.
-                $this->order_items[ "L_PAYMENTREQUEST_0_QTY{$item_num}" ] = $line_item_quantity;
-                // Digital item is sold.
-                $this->order_items[ "L_PAYMENTREQUEST_0_ITEMCATEGORY{$item_num}" ] = 'Physical';
-                // add item total to order sum
-                $this->itemized_order_sum += $unit_price * $line_item_quantity;
-                ++$item_num;
-            }
-        }
-        return $item_num;
-    }
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @param int          $item_num
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function addOrderItemsForLineItems(EE_Line_Item $total_line_item, int $item_num): int
+	{
+		// Go through each item in the list.
+		foreach ($total_line_item->get_items() as $line_item) {
+			if ($line_item instanceof EE_Line_Item) {
+				// PayPal doesn't like line items with 0.00 amount, so we may skip those.
+				if (EEH_Money::compare_floats($line_item->pretaxTotal(), '0.00', '==')) {
+					continue;
+				}
+				$unit_price         = $this->gateway_data_formatter->formatCurrency(
+					$line_item->unit_price(),
+					$this->decimal_precision
+				);
+				$line_item_quantity = $line_item->quantity();
+				// This is a discount.
+				if ($line_item->is_percent()) {
+					$unit_price         = $line_item->pretaxTotal();
+					$line_item_quantity = 1;
+				}
+				// Item Name.
+				$this->order_items[ "L_PAYMENTREQUEST_0_NAME{$item_num}" ] = mb_strcut(
+					$this->gateway_data_formatter->formatLineItemName($line_item, $this->payment),
+					0,
+					127
+				);
+				// Item description.
+				$this->order_items[ "L_PAYMENTREQUEST_0_DESC{$item_num}" ] = mb_strcut(
+					$this->gateway_data_formatter->formatLineItemDesc($line_item, $this->payment),
+					0,
+					127
+				);
+				// Cost of individual item.
+				$this->order_items[ "L_PAYMENTREQUEST_0_AMT{$item_num}" ] = $unit_price;
+				// Item Number.
+				$this->order_items[ "L_PAYMENTREQUEST_0_NUMBER{$item_num}" ] = $item_num + 1;
+				// Item quantity.
+				$this->order_items[ "L_PAYMENTREQUEST_0_QTY{$item_num}" ] = $line_item_quantity;
+				// Digital item is sold.
+				$this->order_items[ "L_PAYMENTREQUEST_0_ITEMCATEGORY{$item_num}" ] = 'Physical';
+				// add item total to order sum
+				$this->itemized_order_sum += $unit_price * $line_item_quantity;
+				++$item_num;
+			}
+		}
+		return $item_num;
+	}
 
 
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function addOrderItemsForAdditionalCharges(EE_Line_Item $total_line_item)
-    {
-        // Item's sales S/H and tax amount.
-        $this->order_items['PAYMENTREQUEST_0_ITEMAMT']     = $total_line_item->get_items_total();
-        $this->order_items['PAYMENTREQUEST_0_TAXAMT']      = $total_line_item->get_total_tax();
-        $this->order_items['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-        $this->order_items['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-    }
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function addOrderItemsForAdditionalCharges(EE_Line_Item $total_line_item)
+	{
+		// Item's sales S/H and tax amount.
+		$this->order_items['PAYMENTREQUEST_0_ITEMAMT']     = $total_line_item->get_items_total();
+		$this->order_items['PAYMENTREQUEST_0_TAXAMT']      = $total_line_item->get_total_tax();
+		$this->order_items['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+		$this->order_items['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+	}
 
 
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @param int          $item_num
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function handleItemizedOrderSumDifference(EE_Line_Item $total_line_item, int $item_num)
-    {
-        // calculate the difference between the TXN total and the itemized order sum
-        $itemized_order_sum_difference = round(
-            $this->transaction->total()
-            - $this->itemized_order_sum
-            - $total_line_item->get_total_tax(),
-            $this->decimal_precision
-        );
-        // If we were not able to recognize some item like promotion, surcharge or cancellation,
-        // add the difference as an extra line item.
-        if (EEH_Money::compare_floats($itemized_order_sum_difference, 0, '!=')) {
-            // Item Name.
-            $this->order_items[ "L_PAYMENTREQUEST_0_NAME{$item_num}" ] = mb_strcut(
-                esc_html__(
-                    'Other (promotion/surcharge/cancellation)',
-                    'event_espresso'
-                ),
-                0,
-                127
-            );
-            // Item description.
-            $this->order_items[ "L_PAYMENTREQUEST_0_DESC{$item_num}" ] = '';
-            // Cost of individual item.
-            $this->order_items[ "L_PAYMENTREQUEST_0_AMT{$item_num}" ] = $this->gateway_data_formatter->formatCurrency(
-                $itemized_order_sum_difference,
-                $this->decimal_precision
-            );
-            // Item Number.
-            $this->order_items[ "L_PAYMENTREQUEST_0_NUMBER{$item_num}" ] = $item_num + 1;
-            // Item quantity.
-            $this->order_items[ "L_PAYMENTREQUEST_0_QTY{$item_num}" ] = 1;
-            // Digital item is sold.
-            $this->order_items[ "L_PAYMENTREQUEST_0_ITEMCATEGORY{$item_num}" ] = 'Physical';
-        }
-    }
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @param int          $item_num
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function handleItemizedOrderSumDifference(EE_Line_Item $total_line_item, int $item_num)
+	{
+		// calculate the difference between the TXN total and the itemized order sum
+		$itemized_order_sum_difference = round(
+			$this->transaction->total()
+			- $this->itemized_order_sum
+			- $total_line_item->get_total_tax(),
+			$this->decimal_precision
+		);
+		// If we were not able to recognize some item like promotion, surcharge or cancellation,
+		// add the difference as an extra line item.
+		if (EEH_Money::compare_floats($itemized_order_sum_difference, 0, '!=')) {
+			// Item Name.
+			$this->order_items[ "L_PAYMENTREQUEST_0_NAME{$item_num}" ] = mb_strcut(
+				esc_html__(
+					'Other (promotion/surcharge/cancellation)',
+					'event_espresso'
+				),
+				0,
+				127
+			);
+			// Item description.
+			$this->order_items[ "L_PAYMENTREQUEST_0_DESC{$item_num}" ] = '';
+			// Cost of individual item.
+			$this->order_items[ "L_PAYMENTREQUEST_0_AMT{$item_num}" ] = $this->gateway_data_formatter->formatCurrency(
+				$itemized_order_sum_difference,
+				$this->decimal_precision
+			);
+			// Item Number.
+			$this->order_items[ "L_PAYMENTREQUEST_0_NUMBER{$item_num}" ] = $item_num + 1;
+			// Item quantity.
+			$this->order_items[ "L_PAYMENTREQUEST_0_QTY{$item_num}" ] = 1;
+			// Digital item is sold.
+			$this->order_items[ "L_PAYMENTREQUEST_0_ITEMCATEGORY{$item_num}" ] = 'Physical';
+		}
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -81,7 +81,7 @@ 
                     strpos($arg_key, 'PAYMENTREQUEST_') !== false
                     && strpos($arg_key, 'NOTIFYURL') === false
                 ) {
-                    $this->order_items[ $arg_key ] = $arg_val;
+                    $this->order_items[$arg_key] = $arg_val;
                 }
             }
             // If we only get a few Items then something is not right.
@@ -180,7 +180,7 @@ 
         // Digital item is sold.
         $this->order_items['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
         // Item's sales S/H and tax amount.
-        $this->order_items['PAYMENTREQUEST_0_ITEMAMT']     = $this->gateway_data_formatter->formatCurrency(
+        $this->order_items['PAYMENTREQUEST_0_ITEMAMT'] = $this->gateway_data_formatter->formatCurrency(
             $this->payment->amount(),
             $this->decimal_precision
         );
@@ -206,7 +206,7 @@ 
                 if (EEH_Money::compare_floats($line_item->pretaxTotal(), '0.00', '==')) {
                     continue;
                 }
-                $unit_price         = $this->gateway_data_formatter->formatCurrency(
+                $unit_price = $this->gateway_data_formatter->formatCurrency(
                     $line_item->unit_price(),
                     $this->decimal_precision
                 );
@@ -217,25 +217,25 @@ 
                     $line_item_quantity = 1;
                 }
                 // Item Name.
-                $this->order_items[ "L_PAYMENTREQUEST_0_NAME{$item_num}" ] = mb_strcut(
+                $this->order_items["L_PAYMENTREQUEST_0_NAME{$item_num}"] = mb_strcut(
                     $this->gateway_data_formatter->formatLineItemName($line_item, $this->payment),
                     0,
                     127
                 );
                 // Item description.
-                $this->order_items[ "L_PAYMENTREQUEST_0_DESC{$item_num}" ] = mb_strcut(
+                $this->order_items["L_PAYMENTREQUEST_0_DESC{$item_num}"] = mb_strcut(
                     $this->gateway_data_formatter->formatLineItemDesc($line_item, $this->payment),
                     0,
                     127
                 );
                 // Cost of individual item.
-                $this->order_items[ "L_PAYMENTREQUEST_0_AMT{$item_num}" ] = $unit_price;
+                $this->order_items["L_PAYMENTREQUEST_0_AMT{$item_num}"] = $unit_price;
                 // Item Number.
-                $this->order_items[ "L_PAYMENTREQUEST_0_NUMBER{$item_num}" ] = $item_num + 1;
+                $this->order_items["L_PAYMENTREQUEST_0_NUMBER{$item_num}"] = $item_num + 1;
                 // Item quantity.
-                $this->order_items[ "L_PAYMENTREQUEST_0_QTY{$item_num}" ] = $line_item_quantity;
+                $this->order_items["L_PAYMENTREQUEST_0_QTY{$item_num}"] = $line_item_quantity;
                 // Digital item is sold.
-                $this->order_items[ "L_PAYMENTREQUEST_0_ITEMCATEGORY{$item_num}" ] = 'Physical';
+                $this->order_items["L_PAYMENTREQUEST_0_ITEMCATEGORY{$item_num}"] = 'Physical';
                 // add item total to order sum
                 $this->itemized_order_sum += $unit_price * $line_item_quantity;
                 ++$item_num;
@@ -281,7 +281,7 @@ 
         // add the difference as an extra line item.
         if (EEH_Money::compare_floats($itemized_order_sum_difference, 0, '!=')) {
             // Item Name.
-            $this->order_items[ "L_PAYMENTREQUEST_0_NAME{$item_num}" ] = mb_strcut(
+            $this->order_items["L_PAYMENTREQUEST_0_NAME{$item_num}"] = mb_strcut(
                 esc_html__(
                     'Other (promotion/surcharge/cancellation)',
                     'event_espresso'
@@ -290,18 +290,18 @@ 
                 127
             );
             // Item description.
-            $this->order_items[ "L_PAYMENTREQUEST_0_DESC{$item_num}" ] = '';
+            $this->order_items["L_PAYMENTREQUEST_0_DESC{$item_num}"] = '';
             // Cost of individual item.
-            $this->order_items[ "L_PAYMENTREQUEST_0_AMT{$item_num}" ] = $this->gateway_data_formatter->formatCurrency(
+            $this->order_items["L_PAYMENTREQUEST_0_AMT{$item_num}"] = $this->gateway_data_formatter->formatCurrency(
                 $itemized_order_sum_difference,
                 $this->decimal_precision
             );
             // Item Number.
-            $this->order_items[ "L_PAYMENTREQUEST_0_NUMBER{$item_num}" ] = $item_num + 1;
+            $this->order_items["L_PAYMENTREQUEST_0_NUMBER{$item_num}"] = $item_num + 1;
             // Item quantity.
-            $this->order_items[ "L_PAYMENTREQUEST_0_QTY{$item_num}" ] = 1;
+            $this->order_items["L_PAYMENTREQUEST_0_QTY{$item_num}"] = 1;
             // Digital item is sold.
-            $this->order_items[ "L_PAYMENTREQUEST_0_ITEMCATEGORY{$item_num}" ] = 'Physical';
+            $this->order_items["L_PAYMENTREQUEST_0_ITEMCATEGORY{$item_num}"] = 'Physical';
         }
     }
 }

payment_methods/Paypal_Express/TokenRequest.php

Indentation +113 added lines, -113 removed lines

@@ -13,124 +13,124 @@
 class TokenRequest
 {
 
-    /**
-     * @var GatewayDataFormatterInterface
-     */
-    protected $gateway_data_formatter;
+	/**
+	 * @var GatewayDataFormatterInterface
+	 */
+	protected $gateway_data_formatter;
 
 
-    /**
-     * @param GatewayDataFormatterInterface $gateway_data_formatter
-     */
-    public function __construct(GatewayDataFormatterInterface $gateway_data_formatter)
-    {
-        $this->gateway_data_formatter = $gateway_data_formatter;
-    }
+	/**
+	 * @param GatewayDataFormatterInterface $gateway_data_formatter
+	 */
+	public function __construct(GatewayDataFormatterInterface $gateway_data_formatter)
+	{
+		$this->gateway_data_formatter = $gateway_data_formatter;
+	}
 
 
-    /**
-     * @param EE_Payment $payment
-     * @param array      $itemized_order
-     * @param string     $return_url
-     * @param string     $cancel_url
-     * @param string     $logo_image_url
-     * @param bool       $request_shipping_address
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generateDetails(
-        EE_Payment $payment,
-        array $itemized_order = [],
-        string $return_url = '',
-        string $cancel_url = '',
-        string $logo_image_url = '',
-        bool $request_shipping_address = false
-    ): array {
-        $locale = explode('-', get_bloginfo('language'));
-        // Gather request parameters.
-        $token_request_details = [
-            'METHOD'                         => 'SetExpressCheckout',
-            'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-            'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-            'PAYMENTREQUEST_0_DESC'          => mb_strcut(
-                $this->gateway_data_formatter->formatOrderDescription($payment),
-                0,
-                127
-            ),
-            'RETURNURL'                      => $return_url,
-            'CANCELURL'                      => $cancel_url,
-            'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-            // Buyer does not need to create a PayPal account to check out.
-            // This is referred to as PayPal Account Optional.
-            'SOLUTIONTYPE'                   => 'Sole',
-            // Locale of the pages displayed by PayPal during Express Checkout.
-            'LOCALECODE'                     => $locale[1],
-        ];
-        $token_request_details = array_merge($token_request_details, $itemized_order);
-        if (! $request_shipping_address) {
-            // Do not request shipping details on the PP Checkout page.
-            $token_request_details['NOSHIPPING']         = '1';
-            $token_request_details['REQCONFIRMSHIPPING'] = '0';
-        } else {
-            // Automatically filling out shipping and contact information.
-            $transaction          = $payment->transaction();
-            $primary_registration = $transaction->primary_registration();
-            $primary_attendee     = $primary_registration instanceof EE_Registration
-                ? $primary_registration->attendee()
-                : false;
-            if ($primary_attendee instanceof EE_Attendee) {
-                // If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
-                $token_request_details['NOSHIPPING']                         = '2';
-                $token_request_details['PAYMENTREQUEST_0_SHIPTOSTREET']      = $primary_attendee->address();
-                $token_request_details['PAYMENTREQUEST_0_SHIPTOSTREET2']     = $primary_attendee->address2();
-                $token_request_details['PAYMENTREQUEST_0_SHIPTOCITY']        = $primary_attendee->city();
-                $token_request_details['PAYMENTREQUEST_0_SHIPTOSTATE']       = $primary_attendee->state_abbrev();
-                $token_request_details['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
-                $token_request_details['PAYMENTREQUEST_0_SHIPTOZIP']         = $primary_attendee->zip();
-                $token_request_details['PAYMENTREQUEST_0_EMAIL']             = $primary_attendee->email();
-                $token_request_details['PAYMENTREQUEST_0_SHIPTOPHONENUM']    = $primary_attendee->phone();
-            }
-        }
-        // Used a business/personal logo on the PayPal page.
-        if (! empty($logo_image_url)) {
-            $token_request_details['LOGOIMG'] = $logo_image_url;
-        }
-        return $token_request_details;
-    }
+	/**
+	 * @param EE_Payment $payment
+	 * @param array      $itemized_order
+	 * @param string     $return_url
+	 * @param string     $cancel_url
+	 * @param string     $logo_image_url
+	 * @param bool       $request_shipping_address
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generateDetails(
+		EE_Payment $payment,
+		array $itemized_order = [],
+		string $return_url = '',
+		string $cancel_url = '',
+		string $logo_image_url = '',
+		bool $request_shipping_address = false
+	): array {
+		$locale = explode('-', get_bloginfo('language'));
+		// Gather request parameters.
+		$token_request_details = [
+			'METHOD'                         => 'SetExpressCheckout',
+			'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+			'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+			'PAYMENTREQUEST_0_DESC'          => mb_strcut(
+				$this->gateway_data_formatter->formatOrderDescription($payment),
+				0,
+				127
+			),
+			'RETURNURL'                      => $return_url,
+			'CANCELURL'                      => $cancel_url,
+			'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+			// Buyer does not need to create a PayPal account to check out.
+			// This is referred to as PayPal Account Optional.
+			'SOLUTIONTYPE'                   => 'Sole',
+			// Locale of the pages displayed by PayPal during Express Checkout.
+			'LOCALECODE'                     => $locale[1],
+		];
+		$token_request_details = array_merge($token_request_details, $itemized_order);
+		if (! $request_shipping_address) {
+			// Do not request shipping details on the PP Checkout page.
+			$token_request_details['NOSHIPPING']         = '1';
+			$token_request_details['REQCONFIRMSHIPPING'] = '0';
+		} else {
+			// Automatically filling out shipping and contact information.
+			$transaction          = $payment->transaction();
+			$primary_registration = $transaction->primary_registration();
+			$primary_attendee     = $primary_registration instanceof EE_Registration
+				? $primary_registration->attendee()
+				: false;
+			if ($primary_attendee instanceof EE_Attendee) {
+				// If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
+				$token_request_details['NOSHIPPING']                         = '2';
+				$token_request_details['PAYMENTREQUEST_0_SHIPTOSTREET']      = $primary_attendee->address();
+				$token_request_details['PAYMENTREQUEST_0_SHIPTOSTREET2']     = $primary_attendee->address2();
+				$token_request_details['PAYMENTREQUEST_0_SHIPTOCITY']        = $primary_attendee->city();
+				$token_request_details['PAYMENTREQUEST_0_SHIPTOSTATE']       = $primary_attendee->state_abbrev();
+				$token_request_details['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
+				$token_request_details['PAYMENTREQUEST_0_SHIPTOZIP']         = $primary_attendee->zip();
+				$token_request_details['PAYMENTREQUEST_0_EMAIL']             = $primary_attendee->email();
+				$token_request_details['PAYMENTREQUEST_0_SHIPTOPHONENUM']    = $primary_attendee->phone();
+			}
+		}
+		// Used a business/personal logo on the PayPal page.
+		if (! empty($logo_image_url)) {
+			$token_request_details['LOGOIMG'] = $logo_image_url;
+		}
+		return $token_request_details;
+	}
 
 
-    /**
-     * @param EE_Payment $payment
-     * @param array      $token_request_status
-     * @param bool       $is_in_sandbox_mode
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function processResponse(EE_Payment $payment, array $token_request_status, bool $is_in_sandbox_mode)
-    {
-        $response_args = (isset($token_request_status['args']) && is_array($token_request_status['args']))
-            ? $token_request_status['args']
-            : [];
-        if ($token_request_status['status']) {
-            // We got the Token so we may continue with the payment and redirect the client.
-            $payment->set_details($response_args);
-            $gateway_url = $is_in_sandbox_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
-            $token       = $response_args['TOKEN'];
-            $payment->set_redirect_url(
-                "{$gateway_url}/checkoutnow?useraction=commit&cmd=_express-checkout&token={$token}"
-            );
-            return;
-        }
-        $gateway_response = isset($response_args['L_ERRORCODE'])
-            ? $response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']
-            : esc_html__(
-                'Error occurred while trying to setup the Express Checkout.',
-                'event_espresso'
-            );
+	/**
+	 * @param EE_Payment $payment
+	 * @param array      $token_request_status
+	 * @param bool       $is_in_sandbox_mode
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function processResponse(EE_Payment $payment, array $token_request_status, bool $is_in_sandbox_mode)
+	{
+		$response_args = (isset($token_request_status['args']) && is_array($token_request_status['args']))
+			? $token_request_status['args']
+			: [];
+		if ($token_request_status['status']) {
+			// We got the Token so we may continue with the payment and redirect the client.
+			$payment->set_details($response_args);
+			$gateway_url = $is_in_sandbox_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
+			$token       = $response_args['TOKEN'];
+			$payment->set_redirect_url(
+				"{$gateway_url}/checkoutnow?useraction=commit&cmd=_express-checkout&token={$token}"
+			);
+			return;
+		}
+		$gateway_response = isset($response_args['L_ERRORCODE'])
+			? $response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']
+			: esc_html__(
+				'Error occurred while trying to setup the Express Checkout.',
+				'event_espresso'
+			);
 
-        $payment->set_gateway_response($gateway_response);
-        $payment->set_details($response_args);
-        $payment->set_status(EEM_Payment::instance()->failed_status());
-    }
+		$payment->set_gateway_response($gateway_response);
+		$payment->set_details($response_args);
+		$payment->set_status(EEM_Payment::instance()->failed_status());
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -68,7 +68,7 @@ 
             'LOCALECODE'                     => $locale[1],
         ];
         $token_request_details = array_merge($token_request_details, $itemized_order);
-        if (! $request_shipping_address) {
+        if ( ! $request_shipping_address) {
             // Do not request shipping details on the PP Checkout page.
             $token_request_details['NOSHIPPING']         = '1';
             $token_request_details['REQCONFIRMSHIPPING'] = '0';
@@ -93,7 +93,7 @@ 
             }
         }
         // Used a business/personal logo on the PayPal page.
-        if (! empty($logo_image_url)) {
+        if ( ! empty($logo_image_url)) {
             $token_request_details['LOGOIMG'] = $logo_image_url;
         }
         return $token_request_details;
@@ -123,7 +123,7 @@ 
             return;
         }
         $gateway_response = isset($response_args['L_ERRORCODE'])
-            ? $response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']
+            ? $response_args['L_ERRORCODE'].'; '.$response_args['L_SHORTMESSAGE']
             : esc_html__(
                 'Error occurred while trying to setup the Express Checkout.',
                 'event_espresso'

payment_methods/Paypal_Express/polyfills.php

Indentation +14 added lines, -14 removed lines

@@ -1,18 +1,18 @@
 <?php
 
 if (! function_exists('mb_strcut')) {
-    /**
-     * Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
-     * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
-     * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
-     *
-     * @param $string
-     * @param $start
-     * @param $length
-     * @return string
-     */
-    function mb_strcut($string, $start, $length = null): string
-    {
-        return mb_substr($string, $start, $length);
-    }
+	/**
+	 * Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
+	 * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
+	 * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
+	 *
+	 * @param $string
+	 * @param $start
+	 * @param $length
+	 * @return string
+	 */
+	function mb_strcut($string, $start, $length = null): string
+	{
+		return mb_substr($string, $start, $length);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -1,6 +1,6 @@
 <?php
 
-if (! function_exists('mb_strcut')) {
+if ( ! function_exists('mb_strcut')) {
     /**
      * Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
      * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr