eventespresso / event-espresso-core

payment_methods/Paypal_Express/ItemizedOrder.php

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';
         }
     }
 }

Indentation +265 added lines, -265 removed lines

@@ -14,292 +14,292 @@
 
 class ItemizedOrder
 {
-    /**
-     * 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';
+		}
+	}
 }

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

payment_methods/Paypal_Standard/EEG_Paypal_Standard.gateway.php

Spacing +6 added lines, -6 removed lines

@@ -229,12 +229,12 @@ 
             }
         }
         $payment = $this->_pay_model->get_payment_by_txn_id_chq_nmbr($update_info['txn_id']);
-        if (! $payment instanceof EEI_Payment) {
+        if ( ! $payment instanceof EEI_Payment) {
             $payment = $transaction->last_payment();
         }
         // ok, then validate the IPN. Even if we've already processed this payment,
         // let PayPal know we don't want to hear from them anymore!
-        if (! $this->validate_ipn($update_info, $payment)) {
+        if ( ! $this->validate_ipn($update_info, $payment)) {
             return $payment;
         }
         // kill request here if this is a refund, we don't support them yet (we'd need to adjust the transaction,
@@ -374,7 +374,7 @@ 
         foreach ($raw_post_array as $keyval) {
             $keyval = explode('=', $keyval);
             if (count($keyval) === 2) {
-                $update_info[ $keyval[0] ] = urldecode($keyval[1]);
+                $update_info[$keyval[0]] = urldecode($keyval[1]);
             }
         }
         // read the IPN message sent from PayPal and prepend 'cmd=_notify-validate'
@@ -393,7 +393,7 @@ 
                 'timeout'           => 60,
                 // make sure to set a site specific unique "user-agent" string since the WordPres default gets declined by PayPal
                 // plz see: https://github.com/websharks/s2member/issues/610
-                'user-agent'        => 'Event Espresso v' . EVENT_ESPRESSO_VERSION . '; ' . home_url(),
+                'user-agent'        => 'Event Espresso v'.EVENT_ESPRESSO_VERSION.'; '.home_url(),
                 'httpversion'       => '1.1'
             )
         );
@@ -471,7 +471,7 @@ 
         /** @var EE_Transaction $transaction */
         $transaction = $payment->transaction();
         $payment_was_itemized = $payment->get_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true, false);
-        if (! $transaction) {
+        if ( ! $transaction) {
             $this->log(
                 esc_html__(
                     // @codingStandardsIgnoreStart
@@ -546,7 +546,7 @@ 
                 esc_html__('Shipping charges calculated by Paypal', 'event_espresso'),
                 1,
                 false,
-                'paypal_shipping_' . $transaction->ID()
+                'paypal_shipping_'.$transaction->ID()
             );
             $grand_total_needs_resaving = true;
         }

Indentation +550 added lines, -550 removed lines

@@ -19,554 +19,554 @@
  */
 class EEG_Paypal_Standard extends EE_Offsite_Gateway
 {
-    /**
-     * Name for the wp option used to save the itemized payment
-     */
-    const itemized_payment_option_name = '_itemized_payment';
-
-    protected $_paypal_id;
-
-    protected $_image_url;
-
-    protected $_shipping_details;
-
-    protected $_paypal_shipping;
-
-    protected $_paypal_taxes;
-
-    protected $_gateway_url;
-
-    protected $_currencies_supported = array(
-        'USD',
-        'GBP',
-        'CAD',
-        'AUD',
-        'BRL',
-        'CHF',
-        'CZK',
-        'DKK',
-        'EUR',
-        'HKD',
-        'HUF',
-        'ILS',
-        'JPY',
-        'MXN',
-        'MYR',
-        'NOK',
-        'NZD',
-        'PHP',
-        'PLN',
-        'SEK',
-        'SGD',
-        'THB',
-        'TRY',
-        'TWD',
-        'RUB'
-    );
-
-    /**
-     * @var ItemizedOrder
-     * @since $VID:$
-     */
-    protected $itemized_order;
-
-
-    /**
-     * EEG_Paypal_Standard constructor.
-     */
-    public function __construct()
-    {
-        $this->set_uses_separate_IPN_request(true);
-        parent::__construct();
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function gatewayUrl()
-    {
-        return $this->_gateway_url;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function imageUrl()
-    {
-        return $this->_image_url;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function paypalId()
-    {
-        return $this->_paypal_id;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function paypalShipping()
-    {
-        return $this->_paypal_shipping;
-    }
-
-
-
-    /**
-     * @return mixed
-     */
-    public function paypalTaxes()
-    {
-        return $this->_paypal_taxes;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function shippingDetails()
-    {
-        return $this->_shipping_details;
-    }
-
-
-    /**
-     * Also sets the gateway url class 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);
-        $this->_gateway_url = $this->_debug_mode
-            ? 'https://www.sandbox.paypal.com/cgi-bin/webscr'
-            : 'https://www.paypal.com/cgi-bin/webscr';
-    }
-
-
-    /**
-     * @param EEI_Payment $payment      the payment to process
-     * @param array       $billing_info but should be empty for this gateway
-     * @param string      $return_url   URL to send the user to after 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 the payment provider's website
-     * @return EEI_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    ) {
-        $this->itemized_order = new ItemizedOrder($this->_get_gateway_formatter(), $this);
-        $redirect_args = apply_filters(
-            "FHEE__EEG_Paypal_Standard__set_redirection_info__arguments",
-            $this->itemized_order->generateItemizedOrderForPayment(
-                $payment,
-                $return_url,
-                $notify_url,
-                $cancel_url
-            ),
-            $this
-        );
-
-        $payment->set_redirect_url($this->_gateway_url);
-        $payment->set_redirect_args($redirect_args);
-        // log the results
-        $this->log(
-            [
-                'message'     => esc_html__('PayPal payment request initiated.', 'event_espresso'),
-                'transaction' => $payment->transaction()->model_field_array(),
-            ],
-            $payment
-        );
-        return $payment;
-    }
-
-
-    /**
-     * 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.
-     *
-     * @param array $update_info like $_POST
-     * @param EEI_Transaction $transaction
-     * @return EEI_Payment updated
-     * @throws EE_Error, IpnException
-     */
-    public function handle_payment_update($update_info, $transaction)
-    {
-        // verify there's payment data that's been sent
-        if (empty($update_info['payment_status']) || empty($update_info['txn_id'])) {
-            // log the results
-            $this->log(
-                array(
-                    'message'     => esc_html__(
-                        'PayPal IPN response is missing critical payment data. This may indicate a PDT request and require your PayPal account settings to be corrected.',
-                        'event_espresso'
-                    ),
-                    'update_info' => $update_info,
-                ),
-                $transaction
-            );
-            // waaaait... is this a PDT request? (see https://developer.paypal.com/docs/classic/products/payment-data-transfer/)
-            // indicated by the "tx" argument? If so, we don't need it. We'll just use the IPN data when it comes
-            if (isset($update_info['tx'])) {
-                return $transaction->last_payment();
-            } else {
-                return null;
-            }
-        }
-        $payment = $this->_pay_model->get_payment_by_txn_id_chq_nmbr($update_info['txn_id']);
-        if (! $payment instanceof EEI_Payment) {
-            $payment = $transaction->last_payment();
-        }
-        // ok, then validate the IPN. Even if we've already processed this payment,
-        // let PayPal know we don't want to hear from them anymore!
-        if (! $this->validate_ipn($update_info, $payment)) {
-            return $payment;
-        }
-        // kill request here if this is a refund, we don't support them yet (we'd need to adjust the transaction,
-        // registrations, ticket counts, etc)
-        if (
-            (
-                $update_info['payment_status'] === 'Refunded'
-                || $update_info['payment_status'] === 'Partially_Refunded'
-            )
-            && apply_filters('FHEE__EEG_Paypal_Standard__handle_payment_update__kill_refund_request', true)
-        ) {
-            throw new EventEspresso\core\exceptions\IpnException(
-                sprintf(
-                    esc_html__('Event Espresso does not yet support %1$s IPNs from PayPal', 'event_espresso'),
-                    $update_info['payment_status']
-                ),
-                EventEspresso\core\exceptions\IpnException::UNSUPPORTED,
-                null,
-                $payment,
-                $update_info
-            );
-        }
-        // ok, well let's process this payment then!
-        switch ($update_info['payment_status']) {
-            case 'Completed':
-                $status = $this->_pay_model->approved_status();
-                $gateway_response = esc_html__('The payment is approved.', 'event_espresso');
-                break;
-
-            case 'Pending':
-                $status = $this->_pay_model->pending_status();
-                $gateway_response = esc_html__(
-                    'The payment is in progress. Another message will be sent when payment is approved.',
-                    'event_espresso'
-                );
-                break;
-
-            case 'Denied':
-                $status = $this->_pay_model->declined_status();
-                $gateway_response = esc_html__('The payment has been declined.', 'event_espresso');
-                break;
-
-            case 'Expired':
-            case 'Failed':
-                $status = $this->_pay_model->failed_status();
-                $gateway_response = esc_html__('The payment failed for technical reasons or expired.', 'event_espresso');
-                break;
-
-            case 'Refunded':
-            case 'Partially_Refunded':
-                // even though it's a refund, we consider the payment as approved, it just has a negative value
-                $status = $this->_pay_model->approved_status();
-                $gateway_response = esc_html__(
-                    'The payment has been refunded. Please update registrations accordingly.',
-                    'event_espresso'
-                );
-                break;
-
-            case 'Voided':
-            case 'Reversed':
-            case 'Canceled_Reversal':
-            default:
-                $status = $this->_pay_model->cancelled_status();
-                $gateway_response = esc_html__(
-                    'The payment was cancelled, reversed, or voided. Please update registrations accordingly.',
-                    'event_espresso'
-                );
-                break;
-        }
-
-        // check if we've already processed this payment
-        if ($payment instanceof EEI_Payment) {
-            // payment exists. if this has the exact same status and amount, don't bother updating. just return
-            if ($payment->status() === $status && $payment->amount() === (float) $update_info['mc_gross']) {
-                // DUPLICATED IPN! don't bother updating transaction
-                throw new IpnException(
-                    sprintf(
-                        esc_html__(
-                            'It appears we have received a duplicate IPN from PayPal for payment %d',
-                            'event_espresso'
-                        ),
-                        $payment->ID()
-                    ),
-                    IpnException::DUPLICATE,
-                    null,
-                    $payment,
-                    $update_info
-                );
-            } else {
-                // new payment yippee !!!
-                $payment->set_status($status);
-                $payment->set_amount((float) $update_info['mc_gross']);
-                $payment->set_gateway_response($gateway_response);
-                $payment->set_details($update_info);
-                $payment->set_txn_id_chq_nmbr($update_info['txn_id']);
-                $this->log(
-                    array(
-                        'message'  => esc_html__(
-                            'Updated payment either from IPN or as part of POST from PayPal',
-                            'event_espresso'
-                        ),
-                        'url'      => $this->_process_response_url(),
-                        'payment'  => $payment->model_field_array(),
-                        'IPN_data' => $update_info
-                    ),
-                    $payment
-                );
-            }
-        }
-        do_action('FHEE__EEG_Paypal_Standard__handle_payment_update__payment_processed', $payment, $this);
-        return $payment;
-    }
-
-
-    /**
-     * Validate the IPN notification.
-     *
-     * @param array                  $update_info like $_REQUEST
-     * @param EE_Payment|EEI_Payment $payment
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function validate_ipn($update_info, $payment)
-    {
-        // allow us to skip validating IPNs with PayPal (useful for testing)
-        if (apply_filters('FHEE__EEG_Paypal_Standard__validate_ipn__skip', false)) {
-            return true;
-        }
-        // ...otherwise, we actually don't care what the $update_info is, we need to look
-        // at the request directly because we can't use $update_info because it has issues with quotes
-        // Reading POSTed data directly from $_POST causes serialization issues with array data in the POST.
-        // Instead, read raw POST data from the input stream.
-        // @see https://gist.github.com/xcommerce-gists/3440401
-        $raw_post_data = file_get_contents('php://input');
-        $raw_post_array = explode('&', $raw_post_data);
-        $update_info = array();
-        foreach ($raw_post_array as $keyval) {
-            $keyval = explode('=', $keyval);
-            if (count($keyval) === 2) {
-                $update_info[ $keyval[0] ] = urldecode($keyval[1]);
-            }
-        }
-        // read the IPN message sent from PayPal and prepend 'cmd=_notify-validate'
-        $req = 'cmd=_notify-validate';
-        $uses_get_magic_quotes = function_exists('get_magic_quotes_gpc') && get_magic_quotes_gpc() === 1;
-        foreach ($update_info as $key => $value) {
-            $value = $uses_get_magic_quotes ? urlencode(stripslashes($value)) : urlencode($value);
-            $req .= "&$key=$value";
-        }
-        // HTTP POST the complete, unaltered IPN back to PayPal
-        $response = wp_remote_post(
-            $this->_gateway_url,
-            array(
-                'body'              => $req,
-                'sslverify'         => false,
-                'timeout'           => 60,
-                // make sure to set a site specific unique "user-agent" string since the WordPres default gets declined by PayPal
-                // plz see: https://github.com/websharks/s2member/issues/610
-                'user-agent'        => 'Event Espresso v' . EVENT_ESPRESSO_VERSION . '; ' . home_url(),
-                'httpversion'       => '1.1'
-            )
-        );
-        // then check the response
-        if (
-            array_key_exists('body', $response)
-            && ! is_wp_error($response)
-            && strcmp($response['body'], "VERIFIED") === 0
-        ) {
-            return true;
-        }
-        // huh, something's wack... the IPN didn't validate. We must have replied to the IPN incorrectly,
-        // or their API must have changed: http://www.paypalobjects.com/en_US/ebook/PP_OrderManagement_IntegrationGuide/ipn.html
-        if ($response instanceof WP_Error) {
-            $error_msg = sprintf(
-                esc_html__('WP Error. Code: "%1$s", Message: "%2$s", Data: "%3$s"', 'event_espresso'),
-                $response->get_error_code(),
-                $response->get_error_message(),
-                print_r($response->get_error_data(), true)
-            );
-        } elseif (is_array($response) && isset($response['body'])) {
-            $error_msg = $response['body'];
-        } else {
-            $error_msg = print_r($response, true);
-        }
-        $payment->set_gateway_response(
-            sprintf(
-                esc_html__("IPN Validation failed! Paypal responded with '%s'", "event_espresso"),
-                $error_msg
-            )
-        );
-        $payment->set_details(array('REQUEST' => $update_info, 'VALIDATION_RESPONSE' => $response));
-        $payment->set_status(EEM_Payment::status_id_failed);
-        // log the results
-        $this->log(
-            array(
-                'url'     => $this->_process_response_url(),
-                'message' => $payment->gateway_response(),
-                'details' => $payment->details(),
-            ),
-            $payment
-        );
-        return false;
-    }
-
-
-    /**
-     * _process_response_url
-     * @return string
-     */
-    protected function _process_response_url(): string
-    {
-        if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
-            $url = is_ssl() ? 'https://' : 'http://';
-            $url .= EEH_URL::filter_input_server_url('HTTP_HOST');
-            $url .= EEH_URL::filter_input_server_url();
-        } else {
-            $url = 'unknown';
-        }
-        return $url;
-    }
-
-
-    /**
-     * Updates the transaction and line items based on the payment IPN data from PayPal,
-     * like the taxes or shipping
-     *
-     * @param EEI_Payment $payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        $update_info = $payment->details();
-        /** @var EE_Transaction $transaction */
-        $transaction = $payment->transaction();
-        $payment_was_itemized = $payment->get_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true, false);
-        if (! $transaction) {
-            $this->log(
-                esc_html__(
-                    // @codingStandardsIgnoreStart
-                    'Payment with ID %d has no related transaction, and so update_txn_based_on_payment couldn\'t be executed properly',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $payment
-            );
-            return;
-        }
-        if (
-            ! is_array($update_info)
-            || ! isset($update_info['mc_shipping'])
-            || ! isset($update_info['tax'])
-        ) {
-            $this->log(
-                array(
-                    'message' => esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'Could not update transaction based on payment because the payment details have not yet been put on the payment. This normally happens during the IPN or returning from PayPal',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    'url'     => $this->_process_response_url(),
-                    'payment' => $payment->model_field_array()
-                ),
-                $payment
-            );
-            return;
-        }
-        if ($payment->status() !== $this->_pay_model->approved_status()) {
-            $this->log(
-                array(
-                    'message' => esc_html__(
-                        'We shouldn\'t update transactions taxes or shipping data from non-approved payments',
-                        'event_espresso'
-                    ),
-                    'url'     => $this->_process_response_url(),
-                    'payment' => $payment->model_field_array()
-                ),
-                $payment
-            );
-            return;
-        }
-        $grand_total_needs_resaving = false;
-        /** @var EE_Line_Item $transaction_total_line_item */
-        $transaction_total_line_item = $transaction->total_line_item();
-
-        // might paypal have changed the taxes?
-        if ($this->_paypal_taxes && $payment_was_itemized) {
-            // note that we're doing this BEFORE adding shipping;
-            // we actually want PayPal's shipping to remain non-taxable
-            $this->_line_item->set_line_items_taxable($transaction_total_line_item, true, 'paypal_shipping');
-            $this->_line_item->set_total_tax_to(
-                $transaction_total_line_item,
-                (float) $update_info['tax'],
-                esc_html__('Taxes', 'event_espresso'),
-                esc_html__('Calculated by Paypal', 'event_espresso'),
-                'paypal_tax'
-            );
-            $grand_total_needs_resaving = true;
-        }
-
-        $shipping_amount = (float) $update_info['mc_shipping'];
-        // might paypal have added shipping?
-        if ($this->_paypal_shipping && $shipping_amount && $payment_was_itemized) {
-            $this->_line_item->add_unrelated_item(
-                $transaction_total_line_item,
-                sprintf(esc_html__('Shipping for transaction %1$s', 'event_espresso'), $transaction->ID()),
-                $shipping_amount,
-                esc_html__('Shipping charges calculated by Paypal', 'event_espresso'),
-                1,
-                false,
-                'paypal_shipping_' . $transaction->ID()
-            );
-            $grand_total_needs_resaving = true;
-        }
-
-        if ($grand_total_needs_resaving) {
-            $transaction_total_line_item->save_this_and_descendants_to_txn($transaction->ID());
-            /** @var EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $registration_processor->update_registration_final_prices($transaction);
-        }
-        $this->log(
-            array(
-                'message'                     => esc_html__('Updated transaction related to payment', 'event_espresso'),
-                'url'                         => $this->_process_response_url(),
-                'transaction (updated)'       => $transaction->model_field_array(),
-                'payment (updated)'           => $payment->model_field_array(),
-                'use_paypal_shipping'         => $this->_paypal_shipping,
-                'use_paypal_tax'              => $this->_paypal_taxes,
-                'grand_total_needed_resaving' => $grand_total_needs_resaving,
-            ),
-            $payment
-        );
-    }
+	/**
+	 * Name for the wp option used to save the itemized payment
+	 */
+	const itemized_payment_option_name = '_itemized_payment';
+
+	protected $_paypal_id;
+
+	protected $_image_url;
+
+	protected $_shipping_details;
+
+	protected $_paypal_shipping;
+
+	protected $_paypal_taxes;
+
+	protected $_gateway_url;
+
+	protected $_currencies_supported = array(
+		'USD',
+		'GBP',
+		'CAD',
+		'AUD',
+		'BRL',
+		'CHF',
+		'CZK',
+		'DKK',
+		'EUR',
+		'HKD',
+		'HUF',
+		'ILS',
+		'JPY',
+		'MXN',
+		'MYR',
+		'NOK',
+		'NZD',
+		'PHP',
+		'PLN',
+		'SEK',
+		'SGD',
+		'THB',
+		'TRY',
+		'TWD',
+		'RUB'
+	);
+
+	/**
+	 * @var ItemizedOrder
+	 * @since $VID:$
+	 */
+	protected $itemized_order;
+
+
+	/**
+	 * EEG_Paypal_Standard constructor.
+	 */
+	public function __construct()
+	{
+		$this->set_uses_separate_IPN_request(true);
+		parent::__construct();
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function gatewayUrl()
+	{
+		return $this->_gateway_url;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function imageUrl()
+	{
+		return $this->_image_url;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function paypalId()
+	{
+		return $this->_paypal_id;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function paypalShipping()
+	{
+		return $this->_paypal_shipping;
+	}
+
+
+
+	/**
+	 * @return mixed
+	 */
+	public function paypalTaxes()
+	{
+		return $this->_paypal_taxes;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function shippingDetails()
+	{
+		return $this->_shipping_details;
+	}
+
+
+	/**
+	 * Also sets the gateway url class 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);
+		$this->_gateway_url = $this->_debug_mode
+			? 'https://www.sandbox.paypal.com/cgi-bin/webscr'
+			: 'https://www.paypal.com/cgi-bin/webscr';
+	}
+
+
+	/**
+	 * @param EEI_Payment $payment      the payment to process
+	 * @param array       $billing_info but should be empty for this gateway
+	 * @param string      $return_url   URL to send the user to after 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 the payment provider's website
+	 * @return EEI_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	) {
+		$this->itemized_order = new ItemizedOrder($this->_get_gateway_formatter(), $this);
+		$redirect_args = apply_filters(
+			"FHEE__EEG_Paypal_Standard__set_redirection_info__arguments",
+			$this->itemized_order->generateItemizedOrderForPayment(
+				$payment,
+				$return_url,
+				$notify_url,
+				$cancel_url
+			),
+			$this
+		);
+
+		$payment->set_redirect_url($this->_gateway_url);
+		$payment->set_redirect_args($redirect_args);
+		// log the results
+		$this->log(
+			[
+				'message'     => esc_html__('PayPal payment request initiated.', 'event_espresso'),
+				'transaction' => $payment->transaction()->model_field_array(),
+			],
+			$payment
+		);
+		return $payment;
+	}
+
+
+	/**
+	 * 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.
+	 *
+	 * @param array $update_info like $_POST
+	 * @param EEI_Transaction $transaction
+	 * @return EEI_Payment updated
+	 * @throws EE_Error, IpnException
+	 */
+	public function handle_payment_update($update_info, $transaction)
+	{
+		// verify there's payment data that's been sent
+		if (empty($update_info['payment_status']) || empty($update_info['txn_id'])) {
+			// log the results
+			$this->log(
+				array(
+					'message'     => esc_html__(
+						'PayPal IPN response is missing critical payment data. This may indicate a PDT request and require your PayPal account settings to be corrected.',
+						'event_espresso'
+					),
+					'update_info' => $update_info,
+				),
+				$transaction
+			);
+			// waaaait... is this a PDT request? (see https://developer.paypal.com/docs/classic/products/payment-data-transfer/)
+			// indicated by the "tx" argument? If so, we don't need it. We'll just use the IPN data when it comes
+			if (isset($update_info['tx'])) {
+				return $transaction->last_payment();
+			} else {
+				return null;
+			}
+		}
+		$payment = $this->_pay_model->get_payment_by_txn_id_chq_nmbr($update_info['txn_id']);
+		if (! $payment instanceof EEI_Payment) {
+			$payment = $transaction->last_payment();
+		}
+		// ok, then validate the IPN. Even if we've already processed this payment,
+		// let PayPal know we don't want to hear from them anymore!
+		if (! $this->validate_ipn($update_info, $payment)) {
+			return $payment;
+		}
+		// kill request here if this is a refund, we don't support them yet (we'd need to adjust the transaction,
+		// registrations, ticket counts, etc)
+		if (
+			(
+				$update_info['payment_status'] === 'Refunded'
+				|| $update_info['payment_status'] === 'Partially_Refunded'
+			)
+			&& apply_filters('FHEE__EEG_Paypal_Standard__handle_payment_update__kill_refund_request', true)
+		) {
+			throw new EventEspresso\core\exceptions\IpnException(
+				sprintf(
+					esc_html__('Event Espresso does not yet support %1$s IPNs from PayPal', 'event_espresso'),
+					$update_info['payment_status']
+				),
+				EventEspresso\core\exceptions\IpnException::UNSUPPORTED,
+				null,
+				$payment,
+				$update_info
+			);
+		}
+		// ok, well let's process this payment then!
+		switch ($update_info['payment_status']) {
+			case 'Completed':
+				$status = $this->_pay_model->approved_status();
+				$gateway_response = esc_html__('The payment is approved.', 'event_espresso');
+				break;
+
+			case 'Pending':
+				$status = $this->_pay_model->pending_status();
+				$gateway_response = esc_html__(
+					'The payment is in progress. Another message will be sent when payment is approved.',
+					'event_espresso'
+				);
+				break;
+
+			case 'Denied':
+				$status = $this->_pay_model->declined_status();
+				$gateway_response = esc_html__('The payment has been declined.', 'event_espresso');
+				break;
+
+			case 'Expired':
+			case 'Failed':
+				$status = $this->_pay_model->failed_status();
+				$gateway_response = esc_html__('The payment failed for technical reasons or expired.', 'event_espresso');
+				break;
+
+			case 'Refunded':
+			case 'Partially_Refunded':
+				// even though it's a refund, we consider the payment as approved, it just has a negative value
+				$status = $this->_pay_model->approved_status();
+				$gateway_response = esc_html__(
+					'The payment has been refunded. Please update registrations accordingly.',
+					'event_espresso'
+				);
+				break;
+
+			case 'Voided':
+			case 'Reversed':
+			case 'Canceled_Reversal':
+			default:
+				$status = $this->_pay_model->cancelled_status();
+				$gateway_response = esc_html__(
+					'The payment was cancelled, reversed, or voided. Please update registrations accordingly.',
+					'event_espresso'
+				);
+				break;
+		}
+
+		// check if we've already processed this payment
+		if ($payment instanceof EEI_Payment) {
+			// payment exists. if this has the exact same status and amount, don't bother updating. just return
+			if ($payment->status() === $status && $payment->amount() === (float) $update_info['mc_gross']) {
+				// DUPLICATED IPN! don't bother updating transaction
+				throw new IpnException(
+					sprintf(
+						esc_html__(
+							'It appears we have received a duplicate IPN from PayPal for payment %d',
+							'event_espresso'
+						),
+						$payment->ID()
+					),
+					IpnException::DUPLICATE,
+					null,
+					$payment,
+					$update_info
+				);
+			} else {
+				// new payment yippee !!!
+				$payment->set_status($status);
+				$payment->set_amount((float) $update_info['mc_gross']);
+				$payment->set_gateway_response($gateway_response);
+				$payment->set_details($update_info);
+				$payment->set_txn_id_chq_nmbr($update_info['txn_id']);
+				$this->log(
+					array(
+						'message'  => esc_html__(
+							'Updated payment either from IPN or as part of POST from PayPal',
+							'event_espresso'
+						),
+						'url'      => $this->_process_response_url(),
+						'payment'  => $payment->model_field_array(),
+						'IPN_data' => $update_info
+					),
+					$payment
+				);
+			}
+		}
+		do_action('FHEE__EEG_Paypal_Standard__handle_payment_update__payment_processed', $payment, $this);
+		return $payment;
+	}
+
+
+	/**
+	 * Validate the IPN notification.
+	 *
+	 * @param array                  $update_info like $_REQUEST
+	 * @param EE_Payment|EEI_Payment $payment
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function validate_ipn($update_info, $payment)
+	{
+		// allow us to skip validating IPNs with PayPal (useful for testing)
+		if (apply_filters('FHEE__EEG_Paypal_Standard__validate_ipn__skip', false)) {
+			return true;
+		}
+		// ...otherwise, we actually don't care what the $update_info is, we need to look
+		// at the request directly because we can't use $update_info because it has issues with quotes
+		// Reading POSTed data directly from $_POST causes serialization issues with array data in the POST.
+		// Instead, read raw POST data from the input stream.
+		// @see https://gist.github.com/xcommerce-gists/3440401
+		$raw_post_data = file_get_contents('php://input');
+		$raw_post_array = explode('&', $raw_post_data);
+		$update_info = array();
+		foreach ($raw_post_array as $keyval) {
+			$keyval = explode('=', $keyval);
+			if (count($keyval) === 2) {
+				$update_info[ $keyval[0] ] = urldecode($keyval[1]);
+			}
+		}
+		// read the IPN message sent from PayPal and prepend 'cmd=_notify-validate'
+		$req = 'cmd=_notify-validate';
+		$uses_get_magic_quotes = function_exists('get_magic_quotes_gpc') && get_magic_quotes_gpc() === 1;
+		foreach ($update_info as $key => $value) {
+			$value = $uses_get_magic_quotes ? urlencode(stripslashes($value)) : urlencode($value);
+			$req .= "&$key=$value";
+		}
+		// HTTP POST the complete, unaltered IPN back to PayPal
+		$response = wp_remote_post(
+			$this->_gateway_url,
+			array(
+				'body'              => $req,
+				'sslverify'         => false,
+				'timeout'           => 60,
+				// make sure to set a site specific unique "user-agent" string since the WordPres default gets declined by PayPal
+				// plz see: https://github.com/websharks/s2member/issues/610
+				'user-agent'        => 'Event Espresso v' . EVENT_ESPRESSO_VERSION . '; ' . home_url(),
+				'httpversion'       => '1.1'
+			)
+		);
+		// then check the response
+		if (
+			array_key_exists('body', $response)
+			&& ! is_wp_error($response)
+			&& strcmp($response['body'], "VERIFIED") === 0
+		) {
+			return true;
+		}
+		// huh, something's wack... the IPN didn't validate. We must have replied to the IPN incorrectly,
+		// or their API must have changed: http://www.paypalobjects.com/en_US/ebook/PP_OrderManagement_IntegrationGuide/ipn.html
+		if ($response instanceof WP_Error) {
+			$error_msg = sprintf(
+				esc_html__('WP Error. Code: "%1$s", Message: "%2$s", Data: "%3$s"', 'event_espresso'),
+				$response->get_error_code(),
+				$response->get_error_message(),
+				print_r($response->get_error_data(), true)
+			);
+		} elseif (is_array($response) && isset($response['body'])) {
+			$error_msg = $response['body'];
+		} else {
+			$error_msg = print_r($response, true);
+		}
+		$payment->set_gateway_response(
+			sprintf(
+				esc_html__("IPN Validation failed! Paypal responded with '%s'", "event_espresso"),
+				$error_msg
+			)
+		);
+		$payment->set_details(array('REQUEST' => $update_info, 'VALIDATION_RESPONSE' => $response));
+		$payment->set_status(EEM_Payment::status_id_failed);
+		// log the results
+		$this->log(
+			array(
+				'url'     => $this->_process_response_url(),
+				'message' => $payment->gateway_response(),
+				'details' => $payment->details(),
+			),
+			$payment
+		);
+		return false;
+	}
+
+
+	/**
+	 * _process_response_url
+	 * @return string
+	 */
+	protected function _process_response_url(): string
+	{
+		if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
+			$url = is_ssl() ? 'https://' : 'http://';
+			$url .= EEH_URL::filter_input_server_url('HTTP_HOST');
+			$url .= EEH_URL::filter_input_server_url();
+		} else {
+			$url = 'unknown';
+		}
+		return $url;
+	}
+
+
+	/**
+	 * Updates the transaction and line items based on the payment IPN data from PayPal,
+	 * like the taxes or shipping
+	 *
+	 * @param EEI_Payment $payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		$update_info = $payment->details();
+		/** @var EE_Transaction $transaction */
+		$transaction = $payment->transaction();
+		$payment_was_itemized = $payment->get_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true, false);
+		if (! $transaction) {
+			$this->log(
+				esc_html__(
+					// @codingStandardsIgnoreStart
+					'Payment with ID %d has no related transaction, and so update_txn_based_on_payment couldn\'t be executed properly',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$payment
+			);
+			return;
+		}
+		if (
+			! is_array($update_info)
+			|| ! isset($update_info['mc_shipping'])
+			|| ! isset($update_info['tax'])
+		) {
+			$this->log(
+				array(
+					'message' => esc_html__(
+						// @codingStandardsIgnoreStart
+						'Could not update transaction based on payment because the payment details have not yet been put on the payment. This normally happens during the IPN or returning from PayPal',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					'url'     => $this->_process_response_url(),
+					'payment' => $payment->model_field_array()
+				),
+				$payment
+			);
+			return;
+		}
+		if ($payment->status() !== $this->_pay_model->approved_status()) {
+			$this->log(
+				array(
+					'message' => esc_html__(
+						'We shouldn\'t update transactions taxes or shipping data from non-approved payments',
+						'event_espresso'
+					),
+					'url'     => $this->_process_response_url(),
+					'payment' => $payment->model_field_array()
+				),
+				$payment
+			);
+			return;
+		}
+		$grand_total_needs_resaving = false;
+		/** @var EE_Line_Item $transaction_total_line_item */
+		$transaction_total_line_item = $transaction->total_line_item();
+
+		// might paypal have changed the taxes?
+		if ($this->_paypal_taxes && $payment_was_itemized) {
+			// note that we're doing this BEFORE adding shipping;
+			// we actually want PayPal's shipping to remain non-taxable
+			$this->_line_item->set_line_items_taxable($transaction_total_line_item, true, 'paypal_shipping');
+			$this->_line_item->set_total_tax_to(
+				$transaction_total_line_item,
+				(float) $update_info['tax'],
+				esc_html__('Taxes', 'event_espresso'),
+				esc_html__('Calculated by Paypal', 'event_espresso'),
+				'paypal_tax'
+			);
+			$grand_total_needs_resaving = true;
+		}
+
+		$shipping_amount = (float) $update_info['mc_shipping'];
+		// might paypal have added shipping?
+		if ($this->_paypal_shipping && $shipping_amount && $payment_was_itemized) {
+			$this->_line_item->add_unrelated_item(
+				$transaction_total_line_item,
+				sprintf(esc_html__('Shipping for transaction %1$s', 'event_espresso'), $transaction->ID()),
+				$shipping_amount,
+				esc_html__('Shipping charges calculated by Paypal', 'event_espresso'),
+				1,
+				false,
+				'paypal_shipping_' . $transaction->ID()
+			);
+			$grand_total_needs_resaving = true;
+		}
+
+		if ($grand_total_needs_resaving) {
+			$transaction_total_line_item->save_this_and_descendants_to_txn($transaction->ID());
+			/** @var EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$registration_processor->update_registration_final_prices($transaction);
+		}
+		$this->log(
+			array(
+				'message'                     => esc_html__('Updated transaction related to payment', 'event_espresso'),
+				'url'                         => $this->_process_response_url(),
+				'transaction (updated)'       => $transaction->model_field_array(),
+				'payment (updated)'           => $payment->model_field_array(),
+				'use_paypal_shipping'         => $this->_paypal_shipping,
+				'use_paypal_tax'              => $this->_paypal_taxes,
+				'grand_total_needed_resaving' => $grand_total_needs_resaving,
+			),
+			$payment
+		);
+	}
 }

payment_methods/Paypal_Standard/ItemizedOrder.php

Indentation +251 added lines, -251 removed lines

@@ -14,282 +14,282 @@
 
 class ItemizedOrder
 {
-    /**
-     * @var float
-     */
-    private $existing_shipping_charges = 0.00;
+	/**
+	 * @var float
+	 */
+	private $existing_shipping_charges = 0.00;
 
-    /**
-     * 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 GatewayDataFormatterInterface
-     */
-    protected $gateway_data_formatter;
+	/**
+	 * @var GatewayDataFormatterInterface
+	 */
+	protected $gateway_data_formatter;
 
-    /**
-     * @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 EEG_Paypal_Standard
-     */
-    protected $paypal_gateway;
+	/**
+	 * @var EEG_Paypal_Standard
+	 */
+	protected $paypal_gateway;
 
-    /**
-     * @var float
-     */
-    private $total_discounts = 0.00;
+	/**
+	 * @var float
+	 */
+	private $total_discounts = 0.00;
 
-    /**
-     * @var EE_Transaction
-     */
-    private $transaction;
+	/**
+	 * @var EE_Transaction
+	 */
+	private $transaction;
 
 
-    /**
-     * @param GatewayDataFormatterInterface $gateway_data_formatter
-     * @param EEG_Paypal_Standard           $paypal_gateway
-     */
-    public function __construct(GatewayDataFormatterInterface $gateway_data_formatter, EEG_Paypal_Standard $paypal_gateway)
-    {
-        $this->gateway_data_formatter = $gateway_data_formatter;
-        $this->paypal_gateway = $paypal_gateway;
-    }
+	/**
+	 * @param GatewayDataFormatterInterface $gateway_data_formatter
+	 * @param EEG_Paypal_Standard           $paypal_gateway
+	 */
+	public function __construct(GatewayDataFormatterInterface $gateway_data_formatter, EEG_Paypal_Standard $paypal_gateway)
+	{
+		$this->gateway_data_formatter = $gateway_data_formatter;
+		$this->paypal_gateway = $paypal_gateway;
+	}
 
 
-    /**
-     * @param EE_Payment $payment
-     * @param string     $return_url    URL to send the user to after 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 the payment provider's website
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generateItemizedOrderForPayment(
-        EE_Payment $payment,
-        string $return_url = '',
-        string $notify_url = '',
-        string $cancel_url = ''
-    ): array {
-        $this->payment         = $payment;
-        $this->transaction     = $this->payment->transaction();
-        $this->total_discounts = $this->transaction->paid();
-        $total_line_item       = $this->transaction->total_line_item();
+	/**
+	 * @param EE_Payment $payment
+	 * @param string     $return_url    URL to send the user to after 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 the payment provider's website
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generateItemizedOrderForPayment(
+		EE_Payment $payment,
+		string $return_url = '',
+		string $notify_url = '',
+		string $cancel_url = ''
+	): array {
+		$this->payment         = $payment;
+		$this->transaction     = $this->payment->transaction();
+		$this->total_discounts = $this->transaction->paid();
+		$total_line_item       = $this->transaction->total_line_item();
 
-        // only itemize the order if we're paying for the rest of the order's amount
-        $item_num = 1;
-        $item_num = $this->paymentIsForTransactionTotal()
-            ? $this->itemizeOrderForFullPayment($total_line_item, $item_num)
-            : $this->handlePartialPayment($item_num);
+		// only itemize the order if we're paying for the rest of the order's amount
+		$item_num = 1;
+		$item_num = $this->paymentIsForTransactionTotal()
+			? $this->itemizeOrderForFullPayment($total_line_item, $item_num)
+			: $this->handlePartialPayment($item_num);
 
-        if ($this->paypal_gateway->isInSandboxMode()) {
-            $this->addSandboxModeArgs($item_num, $notify_url, $return_url);
-        }
-        $this->addGeneralOrderItems($cancel_url, $notify_url, $return_url);
-        return $this->order_items;
-    }
+		if ($this->paypal_gateway->isInSandboxMode()) {
+			$this->addSandboxModeArgs($item_num, $notify_url, $return_url);
+		}
+		$this->addGeneralOrderItems($cancel_url, $notify_url, $return_url);
+		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(), '==');
+	}
 
 
-    /**
-     * if the payment is for the remaining transaction amount,
-     * keep track of exactly how much the itemized order amount equals
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param int          $item_num
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function itemizeOrderForFullPayment(EE_Line_Item $total_line_item, int $item_num): int
-    {
-        $this->payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true);
-        // this payment is for the remaining transaction amount, so let's show all the line items
-        $item_num = $this->addOrderItemsForLineItems($total_line_item, $item_num);
-        // and make adjustments as needed
-        $item_num = $this->handleItemizedOrderSumDifference($total_line_item, $item_num);
-        // add our taxes to the order if we're NOT using PayPal's
-        if (! $this->paypal_gateway->paypalTaxes()) {
-            $this->order_items['tax_cart'] = $total_line_item->get_total_tax();
-        }
-        return $item_num;
-    }
+	/**
+	 * if the payment is for the remaining transaction amount,
+	 * keep track of exactly how much the itemized order amount equals
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param int          $item_num
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function itemizeOrderForFullPayment(EE_Line_Item $total_line_item, int $item_num): int
+	{
+		$this->payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true);
+		// this payment is for the remaining transaction amount, so let's show all the line items
+		$item_num = $this->addOrderItemsForLineItems($total_line_item, $item_num);
+		// and make adjustments as needed
+		$item_num = $this->handleItemizedOrderSumDifference($total_line_item, $item_num);
+		// add our taxes to the order if we're NOT using PayPal's
+		if (! $this->paypal_gateway->paypalTaxes()) {
+			$this->order_items['tax_cart'] = $total_line_item->get_total_tax();
+		}
+		return $item_num;
+	}
 
 
-    /**
-     * @param int $item_num
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function handlePartialPayment(int $item_num): int
-    {
-        $this->payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, false);
-        // partial payment that's not for the remaining amount, so we can't send an itemized list
-        $this->order_items[ "item_name_{$item_num}" ] = substr(
-            $this->gateway_data_formatter->formatPartialPaymentLineItemName($this->payment),
-            0,
-            127
-        );
-        $this->order_items[ "amount_{$item_num}" ]    = $this->payment->amount();
-        $this->order_items[ "shipping_{$item_num}" ]  = '0';
-        $this->order_items[ "shipping2_{$item_num}" ] = '0';
-        $this->order_items['tax_cart']              = '0';
-        $item_num++;
-        return $item_num;
-    }
+	/**
+	 * @param int $item_num
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function handlePartialPayment(int $item_num): int
+	{
+		$this->payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, false);
+		// partial payment that's not for the remaining amount, so we can't send an itemized list
+		$this->order_items[ "item_name_{$item_num}" ] = substr(
+			$this->gateway_data_formatter->formatPartialPaymentLineItemName($this->payment),
+			0,
+			127
+		);
+		$this->order_items[ "amount_{$item_num}" ]    = $this->payment->amount();
+		$this->order_items[ "shipping_{$item_num}" ]  = '0';
+		$this->order_items[ "shipping2_{$item_num}" ] = '0';
+		$this->order_items['tax_cart']              = '0';
+		$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
-    {
-        foreach ($total_line_item->get_items() as $line_item) {
-            if ($line_item instanceof EE_Line_Item) {
-                // it's some kind of discount
-                if (EEH_Money::compare_floats($line_item->pretaxTotal(), 0.00, '<')) {
-                    $this->total_discounts    += abs($line_item->pretaxTotal());
-                    $this->itemized_order_sum += $line_item->pretaxTotal();
-                    continue;
-                }
-                // dont include shipping again.
-                if (strpos($line_item->code(), 'paypal_shipping_') === 0) {
-                    $this->existing_shipping_charges = $line_item->pretaxTotal();
-                    continue;
-                }
-                $this->order_items[ "item_name_{$item_num}" ] = substr(
-                    $this->gateway_data_formatter->formatLineItemName($line_item, $this->payment),
-                    0,
-                    127
-                );
-                $this->order_items[ "amount_{$item_num}" ]    = $line_item->unit_price();
-                $this->order_items[ "quantity_{$item_num}" ]  = $line_item->quantity();
-                // if we're not letting PayPal calculate shipping, tell them its 0
-                if (! $this->paypal_gateway->paypalShipping()) {
-                    $this->order_items[ "shipping_{$item_num}" ]  = '0';
-                    $this->order_items[ "shipping2_{$item_num}" ] = '0';
-                }
-                $this->itemized_order_sum += $line_item->pretaxTotal();
-                $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
+	{
+		foreach ($total_line_item->get_items() as $line_item) {
+			if ($line_item instanceof EE_Line_Item) {
+				// it's some kind of discount
+				if (EEH_Money::compare_floats($line_item->pretaxTotal(), 0.00, '<')) {
+					$this->total_discounts    += abs($line_item->pretaxTotal());
+					$this->itemized_order_sum += $line_item->pretaxTotal();
+					continue;
+				}
+				// dont include shipping again.
+				if (strpos($line_item->code(), 'paypal_shipping_') === 0) {
+					$this->existing_shipping_charges = $line_item->pretaxTotal();
+					continue;
+				}
+				$this->order_items[ "item_name_{$item_num}" ] = substr(
+					$this->gateway_data_formatter->formatLineItemName($line_item, $this->payment),
+					0,
+					127
+				);
+				$this->order_items[ "amount_{$item_num}" ]    = $line_item->unit_price();
+				$this->order_items[ "quantity_{$item_num}" ]  = $line_item->quantity();
+				// if we're not letting PayPal calculate shipping, tell them its 0
+				if (! $this->paypal_gateway->paypalShipping()) {
+					$this->order_items[ "shipping_{$item_num}" ]  = '0';
+					$this->order_items[ "shipping2_{$item_num}" ] = '0';
+				}
+				$this->itemized_order_sum += $line_item->pretaxTotal();
+				$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 handleItemizedOrderSumDifference(EE_Line_Item $total_line_item, int $item_num): int
-    {
-        $taxes_li = EEH_Line_Item::get_taxes_subtotal($total_line_item);
-        // calculate the difference between the TXN total and the itemized order sum
-        $itemized_order_sum_difference = round(
-            $this->transaction->total()
-            - $this->itemized_order_sum
-            - $taxes_li->total()
-            - $this->existing_shipping_charges,
-            2
-        );
-        // ideally the itemized order sum equals the transaction total, but if not (which is weird),
-        // and the itemized sum is LESS than the transaction total...
-        if (EEH_Money::compare_floats($itemized_order_sum_difference, 0.00, '<')) {
-            // add the difference to the discounts
-            $this->total_discounts += abs($itemized_order_sum_difference);
-        } elseif (EEH_Money::compare_floats($itemized_order_sum_difference, 0.00, '>')) {
-            // the itemized order sum is MORE than the transaction total
-            $this->order_items[ "item_name_{$item_num}" ] = substr(
-                esc_html__('additional charges', 'event_espresso'),
-                0,
-                127
-            );
-            $this->order_items[ "amount_{$item_num}" ]    = $this->gateway_data_formatter->formatCurrency(
-                $itemized_order_sum_difference
-            );
-            $this->order_items[ "quantity_{$item_num}" ]  = 1;
-            $item_num++;
-        }
-        if (EEH_Money::compare_floats($this->total_discounts, 0.00, '>')) {
-            $this->order_items['discount_amount_cart'] = $this->gateway_data_formatter->formatCurrency(
-                $this->total_discounts
-            );
-        }
-        return $item_num;
-    }
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @param int          $item_num
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function handleItemizedOrderSumDifference(EE_Line_Item $total_line_item, int $item_num): int
+	{
+		$taxes_li = EEH_Line_Item::get_taxes_subtotal($total_line_item);
+		// calculate the difference between the TXN total and the itemized order sum
+		$itemized_order_sum_difference = round(
+			$this->transaction->total()
+			- $this->itemized_order_sum
+			- $taxes_li->total()
+			- $this->existing_shipping_charges,
+			2
+		);
+		// ideally the itemized order sum equals the transaction total, but if not (which is weird),
+		// and the itemized sum is LESS than the transaction total...
+		if (EEH_Money::compare_floats($itemized_order_sum_difference, 0.00, '<')) {
+			// add the difference to the discounts
+			$this->total_discounts += abs($itemized_order_sum_difference);
+		} elseif (EEH_Money::compare_floats($itemized_order_sum_difference, 0.00, '>')) {
+			// the itemized order sum is MORE than the transaction total
+			$this->order_items[ "item_name_{$item_num}" ] = substr(
+				esc_html__('additional charges', 'event_espresso'),
+				0,
+				127
+			);
+			$this->order_items[ "amount_{$item_num}" ]    = $this->gateway_data_formatter->formatCurrency(
+				$itemized_order_sum_difference
+			);
+			$this->order_items[ "quantity_{$item_num}" ]  = 1;
+			$item_num++;
+		}
+		if (EEH_Money::compare_floats($this->total_discounts, 0.00, '>')) {
+			$this->order_items['discount_amount_cart'] = $this->gateway_data_formatter->formatCurrency(
+				$this->total_discounts
+			);
+		}
+		return $item_num;
+	}
 
 
-    /**
-     * @param int    $item_num
-     * @param string $notify_url
-     * @param string $return_url
-     */
-    private function addSandboxModeArgs(int $item_num, string $notify_url, string $return_url)
-    {
-        $this->order_items[ "item_name_{$item_num}" ] = 'DEBUG INFO (this item only added in sandbox mode';
-        $this->order_items[ "amount_{$item_num}" ]    = 0;
-        $this->order_items[ "on0_{$item_num}" ]       = 'NOTIFY URL';
-        $this->order_items[ "os0_{$item_num}" ]       = $notify_url;
-        $this->order_items[ "on1_{$item_num}" ]       = 'RETURN URL';
-        $this->order_items[ "os1_{$item_num}" ]       = $return_url;
-        $this->order_items[ "shipping_{$item_num}" ]  = '0';
-        $this->order_items[ "shipping2_{$item_num}" ] = '0';
-        // $this->order_items['option_index_' . $item_num] = 1; // <-- dunno if this is needed ?
-    }
+	/**
+	 * @param int    $item_num
+	 * @param string $notify_url
+	 * @param string $return_url
+	 */
+	private function addSandboxModeArgs(int $item_num, string $notify_url, string $return_url)
+	{
+		$this->order_items[ "item_name_{$item_num}" ] = 'DEBUG INFO (this item only added in sandbox mode';
+		$this->order_items[ "amount_{$item_num}" ]    = 0;
+		$this->order_items[ "on0_{$item_num}" ]       = 'NOTIFY URL';
+		$this->order_items[ "os0_{$item_num}" ]       = $notify_url;
+		$this->order_items[ "on1_{$item_num}" ]       = 'RETURN URL';
+		$this->order_items[ "os1_{$item_num}" ]       = $return_url;
+		$this->order_items[ "shipping_{$item_num}" ]  = '0';
+		$this->order_items[ "shipping2_{$item_num}" ] = '0';
+		// $this->order_items['option_index_' . $item_num] = 1; // <-- dunno if this is needed ?
+	}
 
 
-    /**
-     * @param string $cancel_url
-     * @param string $notify_url
-     * @param string $return_url
-     */
-    private function addGeneralOrderItems(string $cancel_url, string $notify_url, string $return_url)
-    {
-        $this->order_items['business']      = $this->paypal_gateway->paypalId();
-        $this->order_items['return']        = $return_url;
-        $this->order_items['cancel_return'] = $cancel_url;
-        $this->order_items['notify_url']    = $notify_url;
-        $this->order_items['cmd']           = '_cart';
-        $this->order_items['upload']        = 1;
-        $this->order_items['currency_code'] = $this->payment->currency_code();
-        $this->order_items['rm']            = 2;// makes the user return with method=POST
-        $this->order_items['no_shipping']   = $this->paypal_gateway->shippingDetails();
-        $this->order_items['bn']            = 'EventEspresso_SP';// EE will blow up if you change this
-        if ($this->paypal_gateway->imageUrl()) {
-            $this->order_items['image_url'] = $this->paypal_gateway->imageUrl();
-        }
-    }
+	/**
+	 * @param string $cancel_url
+	 * @param string $notify_url
+	 * @param string $return_url
+	 */
+	private function addGeneralOrderItems(string $cancel_url, string $notify_url, string $return_url)
+	{
+		$this->order_items['business']      = $this->paypal_gateway->paypalId();
+		$this->order_items['return']        = $return_url;
+		$this->order_items['cancel_return'] = $cancel_url;
+		$this->order_items['notify_url']    = $notify_url;
+		$this->order_items['cmd']           = '_cart';
+		$this->order_items['upload']        = 1;
+		$this->order_items['currency_code'] = $this->payment->currency_code();
+		$this->order_items['rm']            = 2;// makes the user return with method=POST
+		$this->order_items['no_shipping']   = $this->paypal_gateway->shippingDetails();
+		$this->order_items['bn']            = 'EventEspresso_SP';// EE will blow up if you change this
+		if ($this->paypal_gateway->imageUrl()) {
+			$this->order_items['image_url'] = $this->paypal_gateway->imageUrl();
+		}
+	}
 }

Spacing +25 added lines, -25 removed lines

@@ -134,7 +134,7 @@ 
         // and make adjustments as needed
         $item_num = $this->handleItemizedOrderSumDifference($total_line_item, $item_num);
         // add our taxes to the order if we're NOT using PayPal's
-        if (! $this->paypal_gateway->paypalTaxes()) {
+        if ( ! $this->paypal_gateway->paypalTaxes()) {
             $this->order_items['tax_cart'] = $total_line_item->get_total_tax();
         }
         return $item_num;
@@ -151,15 +151,15 @@ 
     {
         $this->payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, false);
         // partial payment that's not for the remaining amount, so we can't send an itemized list
-        $this->order_items[ "item_name_{$item_num}" ] = substr(
+        $this->order_items["item_name_{$item_num}"] = substr(
             $this->gateway_data_formatter->formatPartialPaymentLineItemName($this->payment),
             0,
             127
         );
-        $this->order_items[ "amount_{$item_num}" ]    = $this->payment->amount();
-        $this->order_items[ "shipping_{$item_num}" ]  = '0';
-        $this->order_items[ "shipping2_{$item_num}" ] = '0';
-        $this->order_items['tax_cart']              = '0';
+        $this->order_items["amount_{$item_num}"]    = $this->payment->amount();
+        $this->order_items["shipping_{$item_num}"]  = '0';
+        $this->order_items["shipping2_{$item_num}"] = '0';
+        $this->order_items['tax_cart'] = '0';
         $item_num++;
         return $item_num;
     }
@@ -187,17 +187,17 @@ 
                     $this->existing_shipping_charges = $line_item->pretaxTotal();
                     continue;
                 }
-                $this->order_items[ "item_name_{$item_num}" ] = substr(
+                $this->order_items["item_name_{$item_num}"] = substr(
                     $this->gateway_data_formatter->formatLineItemName($line_item, $this->payment),
                     0,
                     127
                 );
-                $this->order_items[ "amount_{$item_num}" ]    = $line_item->unit_price();
-                $this->order_items[ "quantity_{$item_num}" ]  = $line_item->quantity();
+                $this->order_items["amount_{$item_num}"]    = $line_item->unit_price();
+                $this->order_items["quantity_{$item_num}"]  = $line_item->quantity();
                 // if we're not letting PayPal calculate shipping, tell them its 0
-                if (! $this->paypal_gateway->paypalShipping()) {
-                    $this->order_items[ "shipping_{$item_num}" ]  = '0';
-                    $this->order_items[ "shipping2_{$item_num}" ] = '0';
+                if ( ! $this->paypal_gateway->paypalShipping()) {
+                    $this->order_items["shipping_{$item_num}"]  = '0';
+                    $this->order_items["shipping2_{$item_num}"] = '0';
                 }
                 $this->itemized_order_sum += $line_item->pretaxTotal();
                 $item_num++;
@@ -232,15 +232,15 @@ 
             $this->total_discounts += abs($itemized_order_sum_difference);
         } elseif (EEH_Money::compare_floats($itemized_order_sum_difference, 0.00, '>')) {
             // the itemized order sum is MORE than the transaction total
-            $this->order_items[ "item_name_{$item_num}" ] = substr(
+            $this->order_items["item_name_{$item_num}"] = substr(
                 esc_html__('additional charges', 'event_espresso'),
                 0,
                 127
             );
-            $this->order_items[ "amount_{$item_num}" ]    = $this->gateway_data_formatter->formatCurrency(
+            $this->order_items["amount_{$item_num}"]    = $this->gateway_data_formatter->formatCurrency(
                 $itemized_order_sum_difference
             );
-            $this->order_items[ "quantity_{$item_num}" ]  = 1;
+            $this->order_items["quantity_{$item_num}"]  = 1;
             $item_num++;
         }
         if (EEH_Money::compare_floats($this->total_discounts, 0.00, '>')) {
@@ -259,14 +259,14 @@ 
      */
     private function addSandboxModeArgs(int $item_num, string $notify_url, string $return_url)
     {
-        $this->order_items[ "item_name_{$item_num}" ] = 'DEBUG INFO (this item only added in sandbox mode';
-        $this->order_items[ "amount_{$item_num}" ]    = 0;
-        $this->order_items[ "on0_{$item_num}" ]       = 'NOTIFY URL';
-        $this->order_items[ "os0_{$item_num}" ]       = $notify_url;
-        $this->order_items[ "on1_{$item_num}" ]       = 'RETURN URL';
-        $this->order_items[ "os1_{$item_num}" ]       = $return_url;
-        $this->order_items[ "shipping_{$item_num}" ]  = '0';
-        $this->order_items[ "shipping2_{$item_num}" ] = '0';
+        $this->order_items["item_name_{$item_num}"] = 'DEBUG INFO (this item only added in sandbox mode';
+        $this->order_items["amount_{$item_num}"]    = 0;
+        $this->order_items["on0_{$item_num}"]       = 'NOTIFY URL';
+        $this->order_items["os0_{$item_num}"]       = $notify_url;
+        $this->order_items["on1_{$item_num}"]       = 'RETURN URL';
+        $this->order_items["os1_{$item_num}"]       = $return_url;
+        $this->order_items["shipping_{$item_num}"]  = '0';
+        $this->order_items["shipping2_{$item_num}"] = '0';
         // $this->order_items['option_index_' . $item_num] = 1; // <-- dunno if this is needed ?
     }
 
@@ -285,9 +285,9 @@ 
         $this->order_items['cmd']           = '_cart';
         $this->order_items['upload']        = 1;
         $this->order_items['currency_code'] = $this->payment->currency_code();
-        $this->order_items['rm']            = 2;// makes the user return with method=POST
+        $this->order_items['rm']            = 2; // makes the user return with method=POST
         $this->order_items['no_shipping']   = $this->paypal_gateway->shippingDetails();
-        $this->order_items['bn']            = 'EventEspresso_SP';// EE will blow up if you change this
+        $this->order_items['bn']            = 'EventEspresso_SP'; // EE will blow up if you change this
         if ($this->paypal_gateway->imageUrl()) {
             $this->order_items['image_url'] = $this->paypal_gateway->imageUrl();
         }

caffeinated/modules/ticket_selector_caff/templates/ticket_selector_price_details.template.php

Spacing +7 added lines, -7 removed lines

@@ -6,17 +6,17 @@ 
  * @var EE_Ticket $ticket
  */
 
-if (! function_exists('espressoSubtotalRow')) {
+if ( ! function_exists('espressoSubtotalRow')) {
     function espressoSubtotalRow(float $running_total, bool $show = true): string
     {
         return $show
             ? '
                 <tr>
                     <td colspan="2" class="jst-rght small-text sbttl">
-                        <b>' . esc_html__('subtotal', 'event_espresso') . '</b>
+                        <b>' . esc_html__('subtotal', 'event_espresso').'</b>
                     </td>
-                    <td data-th="' . esc_html__('subtotal', 'event_espresso') . '" class="jst-rght small-text">
-                        <b>' . EEH_Template::format_currency($running_total) . '</b>
+                    <td data-th="' . esc_html__('subtotal', 'event_espresso').'" class="jst-rght small-text">
+                        <b>' . EEH_Template::format_currency($running_total).'</b>
                     </td>
                 </tr>
             '
@@ -80,9 +80,9 @@ 
                         $new_sub_total = $price_mod->is_discount()
                             ? $new_sub_total * -1
                             : $new_sub_total;
-                        $description   = $price_mod->desc() . ' ';
-                        $description   .= $price_mod->is_percent()
-                            ? $price_mod->amount() . '%'
+                        $description   = $price_mod->desc().' ';
+                        $description .= $price_mod->is_percent()
+                            ? $price_mod->amount().'%'
                             : EEH_Template::format_currency($price_mod->amount());
                         ?>
                         <tr>

Indentation +58 added lines, -58 removed lines

@@ -10,10 +10,10 @@ 
  */
 
 if (! function_exists('espressoSubtotalRow')) {
-    function espressoSubtotalRow(float $running_total, bool $show = true): string
-    {
-        return $show
-            ? '
+	function espressoSubtotalRow(float $running_total, bool $show = true): string
+	{
+		return $show
+			? '
                 <tr>
                     <td colspan="2" class="jst-rght small-text sbttl">
                         <b>' . esc_html__('subtotal', 'event_espresso') . '</b>
@@ -23,18 +23,18 @@ 
                     </td>
                 </tr>
             '
-            : '';
-    }
+			: '';
+	}
 }
 
 if ($display_ticket_price) { ?>
     <section class="tckt-slctr-tkt-price-sctn">
         <h5><?php echo esc_html(
-            apply_filters(
-                'FHEE__ticket_selector_chart_template__ticket_details_price_breakdown_heading',
-                __('Price', 'event_espresso')
-            )
-        ); ?></h5>
+			apply_filters(
+				'FHEE__ticket_selector_chart_template__ticket_details_price_breakdown_heading',
+				__('Price', 'event_espresso')
+			)
+		); ?></h5>
         <div class="tckt-slctr-tkt-details-tbl-wrap-dv">
             <table class="tckt-slctr-tkt-details-tbl">
                 <thead>
@@ -54,7 +54,7 @@ 
                 </thead>
                 <tbody>
                     <?php
-                    if ($ticket->base_price() instanceof EE_Price) { ?>
+					if ($ticket->base_price() instanceof EE_Price) { ?>
                         <tr>
                             <td data-th="<?php esc_html_e('Name', 'event_espresso'); ?>" class="small-text" colspan="2">
                                 <b>
@@ -66,31 +66,31 @@ 
                             </td>
                         </tr>
                         <?php
-                        $running_total = $ticket->base_price()->amount();
-                    } else {
-                        $running_total = 0;
-                    }
-                    $pretax_total     = $running_total;
-                    $display_subtotal = true;
-                    // now add price modifiers
-                    foreach ($ticket->price_modifiers() as $price_mod) {
-                        if ($price_mod->is_tax()) {
-                            echo espressoSubtotalRow($running_total, $display_subtotal);
-                            $display_subtotal = false;
-                            $new_sub_total    = $pretax_total * ($price_mod->amount() / 100);
-                        } elseif ($price_mod->is_percent()) {
-                            $new_sub_total = $running_total * ($price_mod->amount() / 100);
-                        } else {
-                            $new_sub_total = $price_mod->amount();
-                        }
-                        $new_sub_total = $price_mod->is_discount()
-                            ? $new_sub_total * -1
-                            : $new_sub_total;
-                        $description   = $price_mod->desc() . ' ';
-                        $description   .= $price_mod->is_percent()
-                            ? $price_mod->amount() . '%'
-                            : EEH_Template::format_currency($price_mod->amount());
-                        ?>
+						$running_total = $ticket->base_price()->amount();
+					} else {
+						$running_total = 0;
+					}
+					$pretax_total     = $running_total;
+					$display_subtotal = true;
+					// now add price modifiers
+					foreach ($ticket->price_modifiers() as $price_mod) {
+						if ($price_mod->is_tax()) {
+							echo espressoSubtotalRow($running_total, $display_subtotal);
+							$display_subtotal = false;
+							$new_sub_total    = $pretax_total * ($price_mod->amount() / 100);
+						} elseif ($price_mod->is_percent()) {
+							$new_sub_total = $running_total * ($price_mod->amount() / 100);
+						} else {
+							$new_sub_total = $price_mod->amount();
+						}
+						$new_sub_total = $price_mod->is_discount()
+							? $new_sub_total * -1
+							: $new_sub_total;
+						$description   = $price_mod->desc() . ' ';
+						$description   .= $price_mod->is_percent()
+							? $price_mod->amount() . '%'
+							: EEH_Template::format_currency($price_mod->amount());
+						?>
                         <tr>
                             <td data-th="<?php esc_html_e('Name', 'event_espresso'); ?>"
                                 class="jst-rght small-text"
@@ -102,17 +102,17 @@ 
                             </td>
                             <td data-th="<?php esc_html_e('Amount', 'event_espresso'); ?>" class="jst-rght small-text">
                                 <?php echo wp_kses(
-                                    EEH_Template::format_currency($new_sub_total),
-                                    AllowedTags::getAllowedTags()
-                                ); ?>
+									EEH_Template::format_currency($new_sub_total),
+									AllowedTags::getAllowedTags()
+								); ?>
                             </td>
                             <?php $pretax_total += ! $price_mod->is_tax() ? $new_sub_total : 0; ?>
                             <?php $running_total += $new_sub_total; ?>
                         </tr>
                     <?php } ?>
                     <?php if ($ticket->taxable()) {
-                        echo espressoSubtotalRow($running_total);
-                        foreach ($ticket->get_ticket_taxes_for_admin() as $tax) { ?>
+						echo espressoSubtotalRow($running_total);
+						foreach ($ticket->get_ticket_taxes_for_admin() as $tax) { ?>
                             <tr>
                                 <td data-th="<?php esc_html_e('Name', 'event_espresso'); ?>"
                                     class="jst-rght small-text"
@@ -129,9 +129,9 @@ 
                                     class="jst-rght small-text"
                                 >
                                     <?php echo wp_kses(
-                                        EEH_Template::format_currency($tax_amount),
-                                        AllowedTags::getAllowedTags()
-                                    ); ?>
+										EEH_Template::format_currency($tax_amount),
+										AllowedTags::getAllowedTags()
+									); ?>
                                 </td>
                                 <?php $running_total += $tax_amount; ?>
                             </tr>
@@ -141,24 +141,24 @@ 
                         <td colspan="2" class="jst-rght small-text ttl-lbl-td">
                             <b>
                                 <?php echo esc_html(
-                                    apply_filters(
-                                        'FHEE__ticket_selector_chart_template__ticket_details_total_price',
-                                        __('Total', 'event_espresso')
-                                    )
-                                ); ?>
+									apply_filters(
+										'FHEE__ticket_selector_chart_template__ticket_details_total_price',
+										__('Total', 'event_espresso')
+									)
+								); ?>
                             </b>
                         </td>
                         <td data-th="<?php echo esc_html(
-                            apply_filters(
-                                'FHEE__ticket_selector_chart_template__ticket_details_total_price',
-                                __('Total', 'event_espresso')
-                            )
-                        ); ?>" class="jst-rght small-text"
+							apply_filters(
+								'FHEE__ticket_selector_chart_template__ticket_details_total_price',
+								__('Total', 'event_espresso')
+							)
+						); ?>" class="jst-rght small-text"
                         >
                             <b><?php  wp_kses(
-                                EEH_Template::format_currency($running_total),
-                                AllowedTags::getAllowedTags()
-                            ); ?></b>
+								EEH_Template::format_currency($running_total),
+								AllowedTags::getAllowedTags()
+							); ?></b>
                         </td>
                     </tr>
                 </tbody>

modules/ticket_selector/TicketSelector.php

Spacing +7 added lines, -7 removed lines

@@ -118,13 +118,13 @@
     public function getHiddenInputs()
     {
         $html = '<input type="hidden" name="noheader" value="true"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-return-url-' . $this->event->ID() . '"';
-        $html .= ' value="' . EEH_URL::current_url() . $this->template_args['anchor_id'] . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-rows-' . $this->event->ID();
-        $html .= '" value="' . $this->ticket_rows . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-max-atndz-' . $this->event->ID();
-        $html .= '" value="' . $this->template_args['max_atndz'] . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-event-id" value="' . $this->event->ID() . '"/>';
+        $html .= '<input type="hidden" name="tkt-slctr-return-url-'.$this->event->ID().'"';
+        $html .= ' value="'.EEH_URL::current_url().$this->template_args['anchor_id'].'"/>';
+        $html .= '<input type="hidden" name="tkt-slctr-rows-'.$this->event->ID();
+        $html .= '" value="'.$this->ticket_rows.'"/>';
+        $html .= '<input type="hidden" name="tkt-slctr-max-atndz-'.$this->event->ID();
+        $html .= '" value="'.$this->template_args['max_atndz'].'"/>';
+        $html .= '<input type="hidden" name="tkt-slctr-event-id" value="'.$this->event->ID().'"/>';
         return $html;
     }
 }

Indentation +107 added lines, -107 removed lines

@@ -19,111 +19,111 @@
  */
 abstract class TicketSelector
 {
-    /**
-     * @var EE_Event
-     */
-    protected $event;
-
-    /**
-     * @var EE_Ticket[]
-     */
-    protected $tickets;
-
-    /**
-     * @var int
-     */
-    protected $max_attendees;
-
-    /**
-     * @var array
-     */
-    protected $template_args;
-
-    /**
-     * @var int
-     */
-    protected $ticket_rows = 0;
-
-
-    /**
-     * TicketSelectorSimple constructor.
-     *
-     * @param EE_Event    $event
-     * @param EE_Ticket[] $tickets
-     * @param int          $max_attendees
-     * @param array        $template_args
-     */
-    public function __construct(EE_Event $event, array $tickets, $max_attendees, array $template_args)
-    {
-        $this->event = $event;
-        $this->tickets = $tickets;
-        $this->max_attendees = $max_attendees;
-        $this->template_args = $template_args;
-        $this->addTemplateArgs();
-    }
-
-
-    /**
-     * sets any and all template args that are required for this Ticket Selector
-     *
-     * @return void
-     */
-    abstract protected function addTemplateArgs();
-
-
-    /**
-     * loadTicketSelectorTemplate
-     *
-     * @return string
-     */
-    protected function loadTicketSelectorTemplate()
-    {
-        try {
-            $this->template_args['hidden_inputs'] = $this->getHiddenInputs();
-            return EEH_Template::locate_template(
-                apply_filters(
-                    'FHEE__EE_Ticket_Selector__display_ticket_selector__template_path',
-                    $this->template_args['template_path'],
-                    $this->event
-                ),
-                $this->template_args
-            );
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return '';
-    }
-
-
-    /**
-     * The __toString method allows a class to decide how it will react when it is converted to a string.
-     *
-     * @return string
-     * @link http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.tostring
-     */
-    public function __toString()
-    {
-        return $this->loadTicketSelectorTemplate();
-    }
-
-
-    /**
-     * getHiddenInputs
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getHiddenInputs()
-    {
-        $html = '<input type="hidden" name="noheader" value="true"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-return-url-' . $this->event->ID() . '"';
-        $html .= ' value="' . EEH_URL::current_url() . $this->template_args['anchor_id'] . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-rows-' . $this->event->ID();
-        $html .= '" value="' . $this->ticket_rows . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-max-atndz-' . $this->event->ID();
-        $html .= '" value="' . $this->template_args['max_atndz'] . '"/>';
-        $html .= '<input type="hidden" name="tkt-slctr-event-id" value="' . $this->event->ID() . '"/>';
-        return $html;
-    }
+	/**
+	 * @var EE_Event
+	 */
+	protected $event;
+
+	/**
+	 * @var EE_Ticket[]
+	 */
+	protected $tickets;
+
+	/**
+	 * @var int
+	 */
+	protected $max_attendees;
+
+	/**
+	 * @var array
+	 */
+	protected $template_args;
+
+	/**
+	 * @var int
+	 */
+	protected $ticket_rows = 0;
+
+
+	/**
+	 * TicketSelectorSimple constructor.
+	 *
+	 * @param EE_Event    $event
+	 * @param EE_Ticket[] $tickets
+	 * @param int          $max_attendees
+	 * @param array        $template_args
+	 */
+	public function __construct(EE_Event $event, array $tickets, $max_attendees, array $template_args)
+	{
+		$this->event = $event;
+		$this->tickets = $tickets;
+		$this->max_attendees = $max_attendees;
+		$this->template_args = $template_args;
+		$this->addTemplateArgs();
+	}
+
+
+	/**
+	 * sets any and all template args that are required for this Ticket Selector
+	 *
+	 * @return void
+	 */
+	abstract protected function addTemplateArgs();
+
+
+	/**
+	 * loadTicketSelectorTemplate
+	 *
+	 * @return string
+	 */
+	protected function loadTicketSelectorTemplate()
+	{
+		try {
+			$this->template_args['hidden_inputs'] = $this->getHiddenInputs();
+			return EEH_Template::locate_template(
+				apply_filters(
+					'FHEE__EE_Ticket_Selector__display_ticket_selector__template_path',
+					$this->template_args['template_path'],
+					$this->event
+				),
+				$this->template_args
+			);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return '';
+	}
+
+
+	/**
+	 * The __toString method allows a class to decide how it will react when it is converted to a string.
+	 *
+	 * @return string
+	 * @link http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.tostring
+	 */
+	public function __toString()
+	{
+		return $this->loadTicketSelectorTemplate();
+	}
+
+
+	/**
+	 * getHiddenInputs
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getHiddenInputs()
+	{
+		$html = '<input type="hidden" name="noheader" value="true"/>';
+		$html .= '<input type="hidden" name="tkt-slctr-return-url-' . $this->event->ID() . '"';
+		$html .= ' value="' . EEH_URL::current_url() . $this->template_args['anchor_id'] . '"/>';
+		$html .= '<input type="hidden" name="tkt-slctr-rows-' . $this->event->ID();
+		$html .= '" value="' . $this->ticket_rows . '"/>';
+		$html .= '<input type="hidden" name="tkt-slctr-max-atndz-' . $this->event->ID();
+		$html .= '" value="' . $this->template_args['max_atndz'] . '"/>';
+		$html .= '<input type="hidden" name="tkt-slctr-event-id" value="' . $this->event->ID() . '"/>';
+		return $html;
+	}
 }

core/services/shortcodes/LegacyShortcodesManager.php

Spacing +15 added lines, -15 removed lines

@@ -84,7 +84,7 @@ 
             'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
             array()
         );
-        if (! empty($shortcodes_to_register)) {
+        if ( ! empty($shortcodes_to_register)) {
             // cycle thru shortcode folders
             foreach ($shortcodes_to_register as $shortcode_path) {
                 // add to list of installed shortcode modules
@@ -128,44 +128,44 @@ 
             // remove last segment
             array_pop($shortcode_path);
             // glue it back together
-            $shortcode_path = implode('/', $shortcode_path) . '/';
+            $shortcode_path = implode('/', $shortcode_path).'/';
         } else {
             // we need to generate the filename based off of the folder name
             // grab and sanitize shortcode directory name
             $shortcode = sanitize_key(basename($shortcode_path));
-            $shortcode_path = rtrim($shortcode_path, '/') . '/';
+            $shortcode_path = rtrim($shortcode_path, '/').'/';
         }
         // create classname from shortcode directory or file name
         $shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
         // add class prefix
-        $shortcode_class = 'EES_' . $shortcode;
+        $shortcode_class = 'EES_'.$shortcode;
         // does the shortcode exist ?
-        if (! is_readable($shortcode_path . '/' . $shortcode_class . $shortcode_ext)) {
+        if ( ! is_readable($shortcode_path.'/'.$shortcode_class.$shortcode_ext)) {
             $msg = sprintf(
                 esc_html__(
                     'The requested %1$s shortcode file could not be found or is not readable due to file permissions. It should be in %2$s',
                     'event_espresso'
                 ),
                 $shortcode_class,
-                $shortcode_path . '/' . $shortcode_class . $shortcode_ext
+                $shortcode_path.'/'.$shortcode_class.$shortcode_ext
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // load the shortcode class file
-        require_once($shortcode_path . $shortcode_class . $shortcode_ext);
+        require_once($shortcode_path.$shortcode_class.$shortcode_ext);
         // verify that class exists
-        if (! class_exists($shortcode_class)) {
+        if ( ! class_exists($shortcode_class)) {
             $msg = sprintf(
                 esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
                 $shortcode_class
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         $shortcode = strtoupper($shortcode);
         // add to array of registered shortcodes
-        $this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
+        $this->registry->shortcodes->{$shortcode} = $shortcode_path.$shortcode_class.$shortcode_ext;
         return true;
     }
 
@@ -181,7 +181,7 @@ 
         // cycle thru shortcode folders
         foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
             // add class prefix
-            $shortcode_class = 'EES_' . $shortcode;
+            $shortcode_class = 'EES_'.$shortcode;
             // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
             // which set hooks ?
             if (is_admin()) {
@@ -197,7 +197,7 @@ 
                 $shortcode_tag = strtoupper($shortcode);
                 // but first check if the shortcode has already
                 // been added before assigning 'fallback_shortcode_processor'
-                if (! shortcode_exists($shortcode_tag)) {
+                if ( ! shortcode_exists($shortcode_tag)) {
                     // NOTE: this shortcode declaration will get overridden if the shortcode
                     // is successfully detected in the post content in initializeShortcode()
                     add_shortcode($shortcode_tag, array($shortcode_class, 'fallback_shortcode_processor'));
@@ -312,7 +312,7 @@ 
             }
         }
         // one last test for an [espresso_*] shortcode
-        if (! $has_shortcode) {
+        if ( ! $has_shortcode) {
             $has_shortcode = strpos($content, '[espresso_') !== false;
         }
         return $has_shortcode;
@@ -418,7 +418,7 @@ 
      */
     public static function addShortcodeClassPrefix($class_name)
     {
-        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
+        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_'.$class_name;
     }
 
 

Indentation +440 added lines, -440 removed lines

@@ -25,444 +25,444 @@
  */
 class LegacyShortcodesManager
 {
-    /**
-     * @type CurrentPage
-     */
-    protected $current_page;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-
-    /**
-     * LegacyShortcodesManager constructor.
-     *
-     * @param EE_Registry $registry
-     * @param CurrentPage $current_page
-     */
-    public function __construct(EE_Registry $registry, CurrentPage $current_page)
-    {
-        $this->registry = $registry;
-        $this->current_page = $current_page;
-    }
-
-
-    /**
-     * @return EE_Registry
-     */
-    public function registry()
-    {
-        return $this->registry;
-    }
-
-
-    /**
-     * registerShortcodes
-     *
-     * @return void
-     */
-    public function registerShortcodes()
-    {
-        $this->registry->shortcodes = $this->getShortcodes();
-    }
-
-
-    /**
-     * getShortcodes
-     *
-     * @return array
-     */
-    public function getShortcodes()
-    {
-        // previously this method would glob the shortcodes directory
-        // then filter that list of shortcodes to register,
-        // but now we are going to just supply an empty array.
-        // this allows any shortcodes that have not yet been converted to the new system
-        // to still get loaded and processed, albeit using the same legacy logic as before
-        $shortcodes_to_register = apply_filters(
-            'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
-            array()
-        );
-        if (! empty($shortcodes_to_register)) {
-            // cycle thru shortcode folders
-            foreach ($shortcodes_to_register as $shortcode_path) {
-                // add to list of installed shortcode modules
-                $this->registerShortcode($shortcode_path);
-            }
-        }
-        // filter list of installed modules
-        return apply_filters(
-            'FHEE__EE_Config___register_shortcodes__installed_shortcodes',
-            ! empty($this->registry->shortcodes)
-                ? $this->registry->shortcodes
-                : array()
-        );
-    }
-
-
-    /**
-     * register_shortcode - makes core aware of this shortcode
-     *
-     * @param    string $shortcode_path - full path up to and including shortcode folder
-     * @return    bool
-     */
-    public function registerShortcode($shortcode_path = null)
-    {
-        do_action('AHEE__EE_Config__register_shortcode__begin', $shortcode_path);
-        $shortcode_ext = '.shortcode.php';
-        // make all separators match
-        $shortcode_path = str_replace(array('\\', '/'), '/', $shortcode_path);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($shortcode_path, $shortcode_ext) !== false) {
-            // grab shortcode file name from directory name and break apart at dots
-            $shortcode_file = explode('.', basename($shortcode_path));
-            // take first segment from file name pieces and remove class prefix if it exists
-            $shortcode = strpos($shortcode_file[0], 'EES_') === 0
-                ? substr($shortcode_file[0], 4)
-                : $shortcode_file[0];
-            // sanitize shortcode directory name
-            $shortcode = sanitize_key($shortcode);
-            // now we need to rebuild the shortcode path
-            $shortcode_path = explode('/', $shortcode_path);
-            // remove last segment
-            array_pop($shortcode_path);
-            // glue it back together
-            $shortcode_path = implode('/', $shortcode_path) . '/';
-        } else {
-            // we need to generate the filename based off of the folder name
-            // grab and sanitize shortcode directory name
-            $shortcode = sanitize_key(basename($shortcode_path));
-            $shortcode_path = rtrim($shortcode_path, '/') . '/';
-        }
-        // create classname from shortcode directory or file name
-        $shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
-        // add class prefix
-        $shortcode_class = 'EES_' . $shortcode;
-        // does the shortcode exist ?
-        if (! is_readable($shortcode_path . '/' . $shortcode_class . $shortcode_ext)) {
-            $msg = sprintf(
-                esc_html__(
-                    'The requested %1$s shortcode file could not be found or is not readable due to file permissions. It should be in %2$s',
-                    'event_espresso'
-                ),
-                $shortcode_class,
-                $shortcode_path . '/' . $shortcode_class . $shortcode_ext
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the shortcode class file
-        require_once($shortcode_path . $shortcode_class . $shortcode_ext);
-        // verify that class exists
-        if (! class_exists($shortcode_class)) {
-            $msg = sprintf(
-                esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
-                $shortcode_class
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $shortcode = strtoupper($shortcode);
-        // add to array of registered shortcodes
-        $this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
-        return true;
-    }
-
-
-    /**
-     *    _initialize_shortcodes
-     *    allow shortcodes to set hooks for the rest of the system
-     *
-     * @return void
-     */
-    public function addShortcodes()
-    {
-        // cycle thru shortcode folders
-        foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
-            // add class prefix
-            $shortcode_class = 'EES_' . $shortcode;
-            // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
-            // which set hooks ?
-            if (is_admin()) {
-                // fire immediately
-                call_user_func(array($shortcode_class, 'set_hooks_admin'));
-            } else {
-                // delay until other systems are online
-                add_action(
-                    'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
-                    array($shortcode_class, 'set_hooks')
-                );
-                // convert classname to UPPERCASE and create WP shortcode.
-                $shortcode_tag = strtoupper($shortcode);
-                // but first check if the shortcode has already
-                // been added before assigning 'fallback_shortcode_processor'
-                if (! shortcode_exists($shortcode_tag)) {
-                    // NOTE: this shortcode declaration will get overridden if the shortcode
-                    // is successfully detected in the post content in initializeShortcode()
-                    add_shortcode($shortcode_tag, array($shortcode_class, 'fallback_shortcode_processor'));
-                }
-            }
-        }
-    }
-
-
-    /**
-     * callback for the WP "get_header" hook point
-     * checks posts for EE shortcodes, and initializes them,
-     * then toggles filter switch that loads core default assets
-     *
-     * @param WP_Query $wp_query
-     * @return void
-     * @throws ReflectionException
-     */
-    public function initializeShortcodes(WP_Query $wp_query)
-    {
-        if (
-            empty($this->registry->shortcodes)
-            || defined('EE_TESTS_DIR')
-            || ! $wp_query->is_main_query()
-            || is_admin()
-        ) {
-            return;
-        }
-        // in case shortcode is loaded unexpectedly and deps haven't been set up correctly
-        EE_Dependency_Map::register_dependencies(
-            'EE_Front_Controller',
-            [
-                'EE_Registry' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\CurrentPage' => EE_Dependency_Map::load_from_cache,
-                'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        global $wp;
-        /** @var EE_Front_controller $Front_Controller */
-        $Front_Controller = LoaderFactory::getLoader()->getShared('EE_Front_Controller');
-        do_action('AHEE__EE_Front_Controller__initialize_shortcodes__begin', $wp, $Front_Controller);
-        $this->current_page->parseQueryVars();
-        // grab post_name from request
-        $current_post = apply_filters(
-            'FHEE__EE_Front_Controller__initialize_shortcodes__current_post_name',
-            $this->current_page->postName()
-        );
-        $show_on_front = get_option('show_on_front');
-        // if it's not set, then check if frontpage is blog
-        if (empty($current_post)) {
-            // yup.. this is the posts page, prepare to load all shortcode modules
-            $current_post = 'posts';
-            // unless..
-            if ($show_on_front === 'page') {
-                // some other page is set as the homepage
-                $page_on_front = get_option('page_on_front');
-                if ($page_on_front) {
-                    // k now we need to find the post_name for this page
-                    global $wpdb;
-                    $page_on_front = $wpdb->get_var(
-                        $wpdb->prepare(
-                            "SELECT post_name from {$wpdb->posts} WHERE post_type='page' AND post_status NOT IN ('auto-draft', 'inherit', 'trash') AND ID=%d",
-                            $page_on_front
-                        )
-                    );
-                    // set the current post slug to what it actually is
-                    $current_post = $page_on_front ?: $current_post;
-                }
-            }
-        }
-        // in case $current_post is hierarchical like: /parent-page/current-page
-        $current_post = basename($current_post);
-        if (
-            // is current page/post the "blog" page ?
-            $current_post === EE_Config::get_page_for_posts()
-            // or are we on a category page?
-            || (
-                is_array(term_exists($current_post, 'category'))
-                || array_key_exists('category_name', $wp->query_vars)
-            )
-        ) {
-            // initialize all legacy shortcodes
-            $load_assets = $this->parseContentForShortcodes('', true);
-        } else {
-            global $post;
-            if ($post instanceof WP_Post) {
-                $post_content = $post->post_content;
-            } else {
-                global $wpdb;
-                $post_content = $wpdb->get_var(
-                    $wpdb->prepare(
-                        "SELECT post_content from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND post_name=%s",
-                        $current_post
-                    )
-                );
-            }
-            $load_assets = $this->parseContentForShortcodes($post_content);
-        }
-        if ($load_assets) {
-            $this->current_page->setEspressoPage(true);
-            add_filter('FHEE_load_css', '__return_true');
-            add_filter('FHEE_load_js', '__return_true');
-        }
-        do_action('AHEE__EE_Front_Controller__initialize_shortcodes__end', $Front_Controller);
-    }
-
-
-    /**
-     * checks supplied content against list of legacy shortcodes,
-     * then initializes any found shortcodes, and returns true.
-     * returns false if no shortcodes found.
-     *
-     * @param string $content
-     * @param bool   $load_all if true, then ALL active legacy shortcodes will be initialized
-     * @return bool
-     * @throws ReflectionException
-     */
-    public function parseContentForShortcodes($content = '', $load_all = false)
-    {
-        $has_shortcode = false;
-        foreach ($this->registry->shortcodes as $shortcode_class => $shortcode) {
-            if ($load_all || has_shortcode($content, $shortcode_class)) {
-                // load up the shortcode
-                $this->initializeShortcode($shortcode_class);
-                $has_shortcode = true;
-            }
-        }
-        // one last test for an [espresso_*] shortcode
-        if (! $has_shortcode) {
-            $has_shortcode = strpos($content, '[espresso_') !== false;
-        }
-        return $has_shortcode;
-    }
-
-
-    /**
-     * given a shortcode name, will instantiate the shortcode and call it's run() method
-     *
-     * @param string $shortcode_class
-     * @param WP     $wp
-     * @throws ReflectionException
-     */
-    public function initializeShortcode($shortcode_class = '', WP $wp = null)
-    {
-        // don't do anything if shortcode is already initialized
-        if (
-            empty($this->registry->shortcodes->{$shortcode_class})
-            || ! is_string($this->registry->shortcodes->{$shortcode_class})
-        ) {
-            return;
-        }
-        // let's pause to reflect on this...
-        $sc_reflector = new ReflectionClass(LegacyShortcodesManager::addShortcodeClassPrefix($shortcode_class));
-        // ensure that class is actually a shortcode
-        if (
-            defined('WP_DEBUG')
-            && WP_DEBUG === true
-            && ! $sc_reflector->isSubclassOf('EES_Shortcode')
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The requested %s shortcode is not of the class "EES_Shortcode". Please check your files.',
-                        'event_espresso'
-                    ),
-                    $shortcode_class
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            add_filter('FHEE_run_EE_the_content', '__return_true');
-            return;
-        }
-        global $wp;
-        // and pass the request object to the run method
-        $this->registry->shortcodes->{$shortcode_class} = $sc_reflector->newInstance();
-        // fire the shortcode class's run method, so that it can activate resources
-        $this->registry->shortcodes->{$shortcode_class}->run($wp);
-    }
-
-
-    /**
-     * get classname, remove EES_prefix, and convert to UPPERCASE
-     *
-     * @param string $class_name
-     * @return string
-     */
-    public static function generateShortcodeTagFromClassName($class_name)
-    {
-        return strtoupper(str_replace('EES_', '', $class_name));
-    }
-
-
-    /**
-     * add EES_prefix and Capitalize words
-     *
-     * @param string $tag
-     * @return string
-     */
-    public static function generateShortcodeClassNameFromTag($tag)
-    {
-        // order of operation runs from inside to out
-        // 5) maybe add prefix
-        return LegacyShortcodesManager::addShortcodeClassPrefix(
-            // 4) find spaces, replace with underscores
-            str_replace(
-                ' ',
-                '_',
-                // 3) capitalize first letter of each word
-                ucwords(
-                    // 2) also change to lowercase so ucwords() will work
-                    strtolower(
-                        // 1) find underscores, replace with spaces so ucwords() will work
-                        str_replace(
-                            '_',
-                            ' ',
-                            $tag
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * maybe add EES_prefix
-     *
-     * @param string $class_name
-     * @return string
-     */
-    public static function addShortcodeClassPrefix($class_name)
-    {
-        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getEspressoShortcodeTags()
-    {
-        static $shortcode_tags = array();
-        if (empty($shortcode_tags)) {
-            $shortcode_tags = array_keys((array) $this->registry->shortcodes);
-        }
-        return $shortcode_tags;
-    }
-
-
-    /**
-     * @param string $content
-     * @return string
-     * @throws ReflectionException
-     */
-    public function doShortcode($content)
-    {
-        foreach ($this->getEspressoShortcodeTags() as $shortcode_tag) {
-            if (strpos($content, $shortcode_tag) !== false) {
-                $shortcode_class = LegacyShortcodesManager::generateShortcodeClassNameFromTag($shortcode_tag);
-                $this->initializeShortcode($shortcode_class);
-            }
-        }
-        return do_shortcode($content);
-    }
+	/**
+	 * @type CurrentPage
+	 */
+	protected $current_page;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+
+	/**
+	 * LegacyShortcodesManager constructor.
+	 *
+	 * @param EE_Registry $registry
+	 * @param CurrentPage $current_page
+	 */
+	public function __construct(EE_Registry $registry, CurrentPage $current_page)
+	{
+		$this->registry = $registry;
+		$this->current_page = $current_page;
+	}
+
+
+	/**
+	 * @return EE_Registry
+	 */
+	public function registry()
+	{
+		return $this->registry;
+	}
+
+
+	/**
+	 * registerShortcodes
+	 *
+	 * @return void
+	 */
+	public function registerShortcodes()
+	{
+		$this->registry->shortcodes = $this->getShortcodes();
+	}
+
+
+	/**
+	 * getShortcodes
+	 *
+	 * @return array
+	 */
+	public function getShortcodes()
+	{
+		// previously this method would glob the shortcodes directory
+		// then filter that list of shortcodes to register,
+		// but now we are going to just supply an empty array.
+		// this allows any shortcodes that have not yet been converted to the new system
+		// to still get loaded and processed, albeit using the same legacy logic as before
+		$shortcodes_to_register = apply_filters(
+			'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
+			array()
+		);
+		if (! empty($shortcodes_to_register)) {
+			// cycle thru shortcode folders
+			foreach ($shortcodes_to_register as $shortcode_path) {
+				// add to list of installed shortcode modules
+				$this->registerShortcode($shortcode_path);
+			}
+		}
+		// filter list of installed modules
+		return apply_filters(
+			'FHEE__EE_Config___register_shortcodes__installed_shortcodes',
+			! empty($this->registry->shortcodes)
+				? $this->registry->shortcodes
+				: array()
+		);
+	}
+
+
+	/**
+	 * register_shortcode - makes core aware of this shortcode
+	 *
+	 * @param    string $shortcode_path - full path up to and including shortcode folder
+	 * @return    bool
+	 */
+	public function registerShortcode($shortcode_path = null)
+	{
+		do_action('AHEE__EE_Config__register_shortcode__begin', $shortcode_path);
+		$shortcode_ext = '.shortcode.php';
+		// make all separators match
+		$shortcode_path = str_replace(array('\\', '/'), '/', $shortcode_path);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($shortcode_path, $shortcode_ext) !== false) {
+			// grab shortcode file name from directory name and break apart at dots
+			$shortcode_file = explode('.', basename($shortcode_path));
+			// take first segment from file name pieces and remove class prefix if it exists
+			$shortcode = strpos($shortcode_file[0], 'EES_') === 0
+				? substr($shortcode_file[0], 4)
+				: $shortcode_file[0];
+			// sanitize shortcode directory name
+			$shortcode = sanitize_key($shortcode);
+			// now we need to rebuild the shortcode path
+			$shortcode_path = explode('/', $shortcode_path);
+			// remove last segment
+			array_pop($shortcode_path);
+			// glue it back together
+			$shortcode_path = implode('/', $shortcode_path) . '/';
+		} else {
+			// we need to generate the filename based off of the folder name
+			// grab and sanitize shortcode directory name
+			$shortcode = sanitize_key(basename($shortcode_path));
+			$shortcode_path = rtrim($shortcode_path, '/') . '/';
+		}
+		// create classname from shortcode directory or file name
+		$shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
+		// add class prefix
+		$shortcode_class = 'EES_' . $shortcode;
+		// does the shortcode exist ?
+		if (! is_readable($shortcode_path . '/' . $shortcode_class . $shortcode_ext)) {
+			$msg = sprintf(
+				esc_html__(
+					'The requested %1$s shortcode file could not be found or is not readable due to file permissions. It should be in %2$s',
+					'event_espresso'
+				),
+				$shortcode_class,
+				$shortcode_path . '/' . $shortcode_class . $shortcode_ext
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the shortcode class file
+		require_once($shortcode_path . $shortcode_class . $shortcode_ext);
+		// verify that class exists
+		if (! class_exists($shortcode_class)) {
+			$msg = sprintf(
+				esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
+				$shortcode_class
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$shortcode = strtoupper($shortcode);
+		// add to array of registered shortcodes
+		$this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
+		return true;
+	}
+
+
+	/**
+	 *    _initialize_shortcodes
+	 *    allow shortcodes to set hooks for the rest of the system
+	 *
+	 * @return void
+	 */
+	public function addShortcodes()
+	{
+		// cycle thru shortcode folders
+		foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
+			// add class prefix
+			$shortcode_class = 'EES_' . $shortcode;
+			// fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
+			// which set hooks ?
+			if (is_admin()) {
+				// fire immediately
+				call_user_func(array($shortcode_class, 'set_hooks_admin'));
+			} else {
+				// delay until other systems are online
+				add_action(
+					'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
+					array($shortcode_class, 'set_hooks')
+				);
+				// convert classname to UPPERCASE and create WP shortcode.
+				$shortcode_tag = strtoupper($shortcode);
+				// but first check if the shortcode has already
+				// been added before assigning 'fallback_shortcode_processor'
+				if (! shortcode_exists($shortcode_tag)) {
+					// NOTE: this shortcode declaration will get overridden if the shortcode
+					// is successfully detected in the post content in initializeShortcode()
+					add_shortcode($shortcode_tag, array($shortcode_class, 'fallback_shortcode_processor'));
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * callback for the WP "get_header" hook point
+	 * checks posts for EE shortcodes, and initializes them,
+	 * then toggles filter switch that loads core default assets
+	 *
+	 * @param WP_Query $wp_query
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	public function initializeShortcodes(WP_Query $wp_query)
+	{
+		if (
+			empty($this->registry->shortcodes)
+			|| defined('EE_TESTS_DIR')
+			|| ! $wp_query->is_main_query()
+			|| is_admin()
+		) {
+			return;
+		}
+		// in case shortcode is loaded unexpectedly and deps haven't been set up correctly
+		EE_Dependency_Map::register_dependencies(
+			'EE_Front_Controller',
+			[
+				'EE_Registry' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\CurrentPage' => EE_Dependency_Map::load_from_cache,
+				'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		global $wp;
+		/** @var EE_Front_controller $Front_Controller */
+		$Front_Controller = LoaderFactory::getLoader()->getShared('EE_Front_Controller');
+		do_action('AHEE__EE_Front_Controller__initialize_shortcodes__begin', $wp, $Front_Controller);
+		$this->current_page->parseQueryVars();
+		// grab post_name from request
+		$current_post = apply_filters(
+			'FHEE__EE_Front_Controller__initialize_shortcodes__current_post_name',
+			$this->current_page->postName()
+		);
+		$show_on_front = get_option('show_on_front');
+		// if it's not set, then check if frontpage is blog
+		if (empty($current_post)) {
+			// yup.. this is the posts page, prepare to load all shortcode modules
+			$current_post = 'posts';
+			// unless..
+			if ($show_on_front === 'page') {
+				// some other page is set as the homepage
+				$page_on_front = get_option('page_on_front');
+				if ($page_on_front) {
+					// k now we need to find the post_name for this page
+					global $wpdb;
+					$page_on_front = $wpdb->get_var(
+						$wpdb->prepare(
+							"SELECT post_name from {$wpdb->posts} WHERE post_type='page' AND post_status NOT IN ('auto-draft', 'inherit', 'trash') AND ID=%d",
+							$page_on_front
+						)
+					);
+					// set the current post slug to what it actually is
+					$current_post = $page_on_front ?: $current_post;
+				}
+			}
+		}
+		// in case $current_post is hierarchical like: /parent-page/current-page
+		$current_post = basename($current_post);
+		if (
+			// is current page/post the "blog" page ?
+			$current_post === EE_Config::get_page_for_posts()
+			// or are we on a category page?
+			|| (
+				is_array(term_exists($current_post, 'category'))
+				|| array_key_exists('category_name', $wp->query_vars)
+			)
+		) {
+			// initialize all legacy shortcodes
+			$load_assets = $this->parseContentForShortcodes('', true);
+		} else {
+			global $post;
+			if ($post instanceof WP_Post) {
+				$post_content = $post->post_content;
+			} else {
+				global $wpdb;
+				$post_content = $wpdb->get_var(
+					$wpdb->prepare(
+						"SELECT post_content from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND post_name=%s",
+						$current_post
+					)
+				);
+			}
+			$load_assets = $this->parseContentForShortcodes($post_content);
+		}
+		if ($load_assets) {
+			$this->current_page->setEspressoPage(true);
+			add_filter('FHEE_load_css', '__return_true');
+			add_filter('FHEE_load_js', '__return_true');
+		}
+		do_action('AHEE__EE_Front_Controller__initialize_shortcodes__end', $Front_Controller);
+	}
+
+
+	/**
+	 * checks supplied content against list of legacy shortcodes,
+	 * then initializes any found shortcodes, and returns true.
+	 * returns false if no shortcodes found.
+	 *
+	 * @param string $content
+	 * @param bool   $load_all if true, then ALL active legacy shortcodes will be initialized
+	 * @return bool
+	 * @throws ReflectionException
+	 */
+	public function parseContentForShortcodes($content = '', $load_all = false)
+	{
+		$has_shortcode = false;
+		foreach ($this->registry->shortcodes as $shortcode_class => $shortcode) {
+			if ($load_all || has_shortcode($content, $shortcode_class)) {
+				// load up the shortcode
+				$this->initializeShortcode($shortcode_class);
+				$has_shortcode = true;
+			}
+		}
+		// one last test for an [espresso_*] shortcode
+		if (! $has_shortcode) {
+			$has_shortcode = strpos($content, '[espresso_') !== false;
+		}
+		return $has_shortcode;
+	}
+
+
+	/**
+	 * given a shortcode name, will instantiate the shortcode and call it's run() method
+	 *
+	 * @param string $shortcode_class
+	 * @param WP     $wp
+	 * @throws ReflectionException
+	 */
+	public function initializeShortcode($shortcode_class = '', WP $wp = null)
+	{
+		// don't do anything if shortcode is already initialized
+		if (
+			empty($this->registry->shortcodes->{$shortcode_class})
+			|| ! is_string($this->registry->shortcodes->{$shortcode_class})
+		) {
+			return;
+		}
+		// let's pause to reflect on this...
+		$sc_reflector = new ReflectionClass(LegacyShortcodesManager::addShortcodeClassPrefix($shortcode_class));
+		// ensure that class is actually a shortcode
+		if (
+			defined('WP_DEBUG')
+			&& WP_DEBUG === true
+			&& ! $sc_reflector->isSubclassOf('EES_Shortcode')
+		) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The requested %s shortcode is not of the class "EES_Shortcode". Please check your files.',
+						'event_espresso'
+					),
+					$shortcode_class
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			add_filter('FHEE_run_EE_the_content', '__return_true');
+			return;
+		}
+		global $wp;
+		// and pass the request object to the run method
+		$this->registry->shortcodes->{$shortcode_class} = $sc_reflector->newInstance();
+		// fire the shortcode class's run method, so that it can activate resources
+		$this->registry->shortcodes->{$shortcode_class}->run($wp);
+	}
+
+
+	/**
+	 * get classname, remove EES_prefix, and convert to UPPERCASE
+	 *
+	 * @param string $class_name
+	 * @return string
+	 */
+	public static function generateShortcodeTagFromClassName($class_name)
+	{
+		return strtoupper(str_replace('EES_', '', $class_name));
+	}
+
+
+	/**
+	 * add EES_prefix and Capitalize words
+	 *
+	 * @param string $tag
+	 * @return string
+	 */
+	public static function generateShortcodeClassNameFromTag($tag)
+	{
+		// order of operation runs from inside to out
+		// 5) maybe add prefix
+		return LegacyShortcodesManager::addShortcodeClassPrefix(
+			// 4) find spaces, replace with underscores
+			str_replace(
+				' ',
+				'_',
+				// 3) capitalize first letter of each word
+				ucwords(
+					// 2) also change to lowercase so ucwords() will work
+					strtolower(
+						// 1) find underscores, replace with spaces so ucwords() will work
+						str_replace(
+							'_',
+							' ',
+							$tag
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * maybe add EES_prefix
+	 *
+	 * @param string $class_name
+	 * @return string
+	 */
+	public static function addShortcodeClassPrefix($class_name)
+	{
+		return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getEspressoShortcodeTags()
+	{
+		static $shortcode_tags = array();
+		if (empty($shortcode_tags)) {
+			$shortcode_tags = array_keys((array) $this->registry->shortcodes);
+		}
+		return $shortcode_tags;
+	}
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 * @throws ReflectionException
+	 */
+	public function doShortcode($content)
+	{
+		foreach ($this->getEspressoShortcodeTags() as $shortcode_tag) {
+			if (strpos($content, $shortcode_tag) !== false) {
+				$shortcode_class = LegacyShortcodesManager::generateShortcodeClassNameFromTag($shortcode_tag);
+				$this->initializeShortcode($shortcode_class);
+			}
+		}
+		return do_shortcode($content);
+	}
 }

modules/ticket_selector/ProcessTicketSelector.php

Spacing +10 added lines, -10 removed lines

@@ -119,7 +119,7 @@ 
     public function cancelTicketSelections()
     {
         // check nonce
-        if (! $this->processTicketSelectorNonce()) {
+        if ( ! $this->processTicketSelectorNonce()) {
             return false;
         }
         $this->session->clear_session(__CLASS__, __FUNCTION__);
@@ -131,7 +131,7 @@ 
             );
         }
         EEH_URL::safeRedirectAndExit(
-            site_url('/' . $this->core_config->event_cpt_slug . '/')
+            site_url('/'.$this->core_config->event_cpt_slug.'/')
         );
         return true;
     }
@@ -212,7 +212,7 @@ 
             EE_Error::add_error($exception->getMessage(), __FILE__, __FUNCTION__, __LINE__);
         }
         // check total tickets ordered vs max number of attendees that can register
-        if (! empty($valid) && $valid['total_tickets'] > $valid['max_atndz']) {
+        if ( ! empty($valid) && $valid['total_tickets'] > $valid['max_atndz']) {
             $this->maxAttendeesViolation($valid);
         } else {
             // all data appears to be valid
@@ -225,7 +225,7 @@ 
         if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
             return false;
         }
-        if (! empty($valid['return_url'])) {
+        if ( ! empty($valid['return_url'])) {
             EEH_URL::safeRedirectAndExit($valid['return_url']);
         }
         // do we have an event id?
@@ -262,7 +262,7 @@ 
             )
         );
         $limit_error_2 = sprintf($max_attendees_string, $valid['max_atndz'], $valid['max_atndz']);
-        EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+        EE_Error::add_error($limit_error_1.'<br/>'.$limit_error_2, __FILE__, __FUNCTION__, __LINE__);
     }
 
 
@@ -278,7 +278,7 @@ 
     {
         $tickets_added = 0;
         $tickets_selected = false;
-        if (! empty($valid['ticket-selections']) && $valid['total_tickets'] > 0) {
+        if ( ! empty($valid['ticket-selections']) && $valid['total_tickets'] > 0) {
             // load cart using factory because we don't want to do so until actually needed
             $this->cart = CartFactory::getCart();
             // if the user is an admin that can edit registrations,
@@ -293,7 +293,7 @@ 
                     // get ticket via the ticket id we put in the form
                     $ticket = $this->ticket_model->get_one_by_ID($ticket_id);
                     if ($ticket instanceof EE_Ticket && ($ticket->is_on_sale() || $current_user_is_admin)) {
-                        $valid_ticket  = true;
+                        $valid_ticket = true;
                         $tickets_added += $this->addTicketToCart($ticket, $qty);
                     }
                     if ($valid_ticket !== true) {
@@ -322,7 +322,7 @@ 
             $this->cart,
             $this
         );
-        if (! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
+        if ( ! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
             // no ticket quantities were selected
             EE_Error::add_error(
                 esc_html__('You need to select a ticket quantity before you can proceed.', 'event_espresso'),
@@ -390,7 +390,7 @@ 
         // exit('KILL REDIRECT BEFORE CART UPDATE'); // <<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
         if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
             // make sure cart is loaded
-            if (! $this->cart instanceof EE_Cart) {
+            if ( ! $this->cart instanceof EE_Cart) {
                 $this->cart = CartFactory::getCart();
             }
             do_action(
@@ -412,7 +412,7 @@ 
                 )
             );
         }
-        if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
+        if ( ! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
             // nothing added to cart
             EE_Error::add_attention(
                 esc_html__('No tickets were added for the event', 'event_espresso'),

Indentation +368 added lines, -368 removed lines

@@ -33,393 +33,393 @@
  */
 class ProcessTicketSelector
 {
-    /**
-     * @var EE_Cart $cart
-     */
-    private $cart;
+	/**
+	 * @var EE_Cart $cart
+	 */
+	private $cart;
 
-    /**
-     * @var EE_Core_Config $core_config
-     */
-    private $core_config;
+	/**
+	 * @var EE_Core_Config $core_config
+	 */
+	private $core_config;
 
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
 
-    /**
-     * @var EE_Session $session
-     */
-    private $session;
+	/**
+	 * @var EE_Session $session
+	 */
+	private $session;
 
-    /**
-     * @var EEM_Ticket $ticket_model
-     */
-    private $ticket_model;
+	/**
+	 * @var EEM_Ticket $ticket_model
+	 */
+	private $ticket_model;
 
-    /**
-     * @var TicketDatetimeAvailabilityTracker $tracker
-     */
-    private $tracker;
+	/**
+	 * @var TicketDatetimeAvailabilityTracker $tracker
+	 */
+	private $tracker;
 
 
-    /**
-     * ProcessTicketSelector constructor.
-     * NOTE: PLZ use the Loader to instantiate this class if need be
-     * so that all dependencies get injected correctly (which will happen automatically)
-     * Null values for parameters are only for backwards compatibility but will be removed later on.
-     *
-     * @param EE_Core_Config                    $core_config
-     * @param RequestInterface                           $request
-     * @param EE_Session                        $session
-     * @param EEM_Ticket                        $ticket_model
-     * @param TicketDatetimeAvailabilityTracker $tracker
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(
-        EE_Core_Config $core_config = null,
-        RequestInterface $request = null,
-        EE_Session $session = null,
-        EEM_Ticket $ticket_model = null,
-        TicketDatetimeAvailabilityTracker $tracker = null
-    ) {
-        $loader = LoaderFactory::getLoader();
-        $this->core_config = $core_config instanceof EE_Core_Config
-            ? $core_config
-            : $loader->getShared('EE_Core_Config');
-        $this->request = $request instanceof RequestInterface
-            ? $request
-            : $loader->getShared('EventEspresso\core\services\request\Request');
-        $this->session = $session instanceof EE_Session
-            ? $session
-            : $loader->getShared('EE_Session');
-        $this->ticket_model = $ticket_model instanceof EEM_Ticket
-            ? $ticket_model
-            : $loader->getShared('EEM_Ticket');
-        $this->tracker = $tracker instanceof TicketDatetimeAvailabilityTracker
-            ? $tracker
-            : $loader->getShared('EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker');
-    }
+	/**
+	 * ProcessTicketSelector constructor.
+	 * NOTE: PLZ use the Loader to instantiate this class if need be
+	 * so that all dependencies get injected correctly (which will happen automatically)
+	 * Null values for parameters are only for backwards compatibility but will be removed later on.
+	 *
+	 * @param EE_Core_Config                    $core_config
+	 * @param RequestInterface                           $request
+	 * @param EE_Session                        $session
+	 * @param EEM_Ticket                        $ticket_model
+	 * @param TicketDatetimeAvailabilityTracker $tracker
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(
+		EE_Core_Config $core_config = null,
+		RequestInterface $request = null,
+		EE_Session $session = null,
+		EEM_Ticket $ticket_model = null,
+		TicketDatetimeAvailabilityTracker $tracker = null
+	) {
+		$loader = LoaderFactory::getLoader();
+		$this->core_config = $core_config instanceof EE_Core_Config
+			? $core_config
+			: $loader->getShared('EE_Core_Config');
+		$this->request = $request instanceof RequestInterface
+			? $request
+			: $loader->getShared('EventEspresso\core\services\request\Request');
+		$this->session = $session instanceof EE_Session
+			? $session
+			: $loader->getShared('EE_Session');
+		$this->ticket_model = $ticket_model instanceof EEM_Ticket
+			? $ticket_model
+			: $loader->getShared('EEM_Ticket');
+		$this->tracker = $tracker instanceof TicketDatetimeAvailabilityTracker
+			? $tracker
+			: $loader->getShared('EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker');
+	}
 
 
-    /**
-     * cancelTicketSelections
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function cancelTicketSelections()
-    {
-        // check nonce
-        if (! $this->processTicketSelectorNonce()) {
-            return false;
-        }
-        $this->session->clear_session(__CLASS__, __FUNCTION__);
-        if ($this->request->requestParamIsSet('event_id')) {
-            EEH_URL::safeRedirectAndExit(
-                EEH_Event_View::event_link_url(
-                    $this->request->getRequestParam('event_id', 0, 'int')
-                )
-            );
-        }
-        EEH_URL::safeRedirectAndExit(
-            site_url('/' . $this->core_config->event_cpt_slug . '/')
-        );
-        return true;
-    }
+	/**
+	 * cancelTicketSelections
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function cancelTicketSelections()
+	{
+		// check nonce
+		if (! $this->processTicketSelectorNonce()) {
+			return false;
+		}
+		$this->session->clear_session(__CLASS__, __FUNCTION__);
+		if ($this->request->requestParamIsSet('event_id')) {
+			EEH_URL::safeRedirectAndExit(
+				EEH_Event_View::event_link_url(
+					$this->request->getRequestParam('event_id', 0, 'int')
+				)
+			);
+		}
+		EEH_URL::safeRedirectAndExit(
+			site_url('/' . $this->core_config->event_cpt_slug . '/')
+		);
+		return true;
+	}
 
 
-    /**
-     * processTicketSelectorNonce
-     *
-     * @return bool
-     */
-    private function processTicketSelectorNonce()
-    {
-        if (
-            ! $this->request->isAdmin()
-            && (
-                ! $this->request->requestParamIsSet('cancel_ticket_selections_nonce')
-                || ! wp_verify_nonce(
-                    $this->request->getRequestParam('cancel_ticket_selections_nonce'),
-                    'cancel_ticket_selections'
-                )
-            )
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * processTicketSelectorNonce
+	 *
+	 * @return bool
+	 */
+	private function processTicketSelectorNonce()
+	{
+		if (
+			! $this->request->isAdmin()
+			&& (
+				! $this->request->requestParamIsSet('cancel_ticket_selections_nonce')
+				|| ! wp_verify_nonce(
+					$this->request->getRequestParam('cancel_ticket_selections_nonce'),
+					'cancel_ticket_selections'
+				)
+			)
+		) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
 
 
-    /**
-     * process_ticket_selections
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function processTicketSelections()
-    {
-        do_action('EED_Ticket_Selector__process_ticket_selections__before');
-        if ($this->request->isBot()) {
-            EEH_URL::safeRedirectAndExit(
-                apply_filters(
-                    'FHEE__EE_Ticket_Selector__process_ticket_selections__bot_redirect_url',
-                    site_url()
-                )
-            );
-        }
-        // we should really only have 1 registration in the works now
-        // (ie, no MER) so unless otherwise requested, clear the session
-        if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
-            $this->session->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // validate/sanitize/filter data
-        $id = null;
-        $valid = [];
-        try {
-            $post_data_validator = new ProcessTicketSelectorPostData($this->request);
-            $id = $post_data_validator->getEventId();
-            $valid               = apply_filters(
-                'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data',
-                $post_data_validator->validatePostData()
-            );
-        } catch (Exception $exception) {
-            EE_Error::add_error($exception->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        // check total tickets ordered vs max number of attendees that can register
-        if (! empty($valid) && $valid['total_tickets'] > $valid['max_atndz']) {
-            $this->maxAttendeesViolation($valid);
-        } else {
-            // all data appears to be valid
-            if ($this->processSuccessfulCart($this->addTicketsToCart($valid))) {
-                return true;
-            }
-        }
-        // die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
-        // at this point, just return if registration is being made from admin
-        if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
-            return false;
-        }
-        if (! empty($valid['return_url'])) {
-            EEH_URL::safeRedirectAndExit($valid['return_url']);
-        }
-        // do we have an event id?
-        if ($id) {
-            EEH_URL::safeRedirectAndExit(get_permalink($id));
-        }
-        echo EE_Error::get_notices(); // already escaped
-        return false;
-    }
+	/**
+	 * process_ticket_selections
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function processTicketSelections()
+	{
+		do_action('EED_Ticket_Selector__process_ticket_selections__before');
+		if ($this->request->isBot()) {
+			EEH_URL::safeRedirectAndExit(
+				apply_filters(
+					'FHEE__EE_Ticket_Selector__process_ticket_selections__bot_redirect_url',
+					site_url()
+				)
+			);
+		}
+		// we should really only have 1 registration in the works now
+		// (ie, no MER) so unless otherwise requested, clear the session
+		if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
+			$this->session->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// validate/sanitize/filter data
+		$id = null;
+		$valid = [];
+		try {
+			$post_data_validator = new ProcessTicketSelectorPostData($this->request);
+			$id = $post_data_validator->getEventId();
+			$valid               = apply_filters(
+				'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data',
+				$post_data_validator->validatePostData()
+			);
+		} catch (Exception $exception) {
+			EE_Error::add_error($exception->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		// check total tickets ordered vs max number of attendees that can register
+		if (! empty($valid) && $valid['total_tickets'] > $valid['max_atndz']) {
+			$this->maxAttendeesViolation($valid);
+		} else {
+			// all data appears to be valid
+			if ($this->processSuccessfulCart($this->addTicketsToCart($valid))) {
+				return true;
+			}
+		}
+		// die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
+		// at this point, just return if registration is being made from admin
+		if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
+			return false;
+		}
+		if (! empty($valid['return_url'])) {
+			EEH_URL::safeRedirectAndExit($valid['return_url']);
+		}
+		// do we have an event id?
+		if ($id) {
+			EEH_URL::safeRedirectAndExit(get_permalink($id));
+		}
+		echo EE_Error::get_notices(); // already escaped
+		return false;
+	}
 
 
-    /**
-     * @param array $valid
-     */
-    private function maxAttendeesViolation(array $valid)
-    {
-        // ordering too many tickets !!!
-        $total_tickets_string = esc_html(
-            _n(
-                'You have attempted to purchase %s ticket.',
-                'You have attempted to purchase %s tickets.',
-                $valid['total_tickets'],
-                'event_espresso'
-            )
-        );
-        $limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']);
-        // dev only message
-        $max_attendees_string = esc_html(
-            _n(
-                'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                $valid['max_atndz'],
-                'event_espresso'
-            )
-        );
-        $limit_error_2 = sprintf($max_attendees_string, $valid['max_atndz'], $valid['max_atndz']);
-        EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
-    }
+	/**
+	 * @param array $valid
+	 */
+	private function maxAttendeesViolation(array $valid)
+	{
+		// ordering too many tickets !!!
+		$total_tickets_string = esc_html(
+			_n(
+				'You have attempted to purchase %s ticket.',
+				'You have attempted to purchase %s tickets.',
+				$valid['total_tickets'],
+				'event_espresso'
+			)
+		);
+		$limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']);
+		// dev only message
+		$max_attendees_string = esc_html(
+			_n(
+				'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				$valid['max_atndz'],
+				'event_espresso'
+			)
+		);
+		$limit_error_2 = sprintf($max_attendees_string, $valid['max_atndz'], $valid['max_atndz']);
+		EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+	}
 
 
-    /**
-     * @param array $valid
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function addTicketsToCart(array $valid)
-    {
-        $tickets_added = 0;
-        $tickets_selected = false;
-        if (! empty($valid['ticket-selections']) && $valid['total_tickets'] > 0) {
-            // load cart using factory because we don't want to do so until actually needed
-            $this->cart = CartFactory::getCart();
-            // if the user is an admin that can edit registrations,
-            // then we'll also allow them to add any tickets, even if they are expired
-            $current_user_is_admin = current_user_can('ee_edit_registrations');
-            // cycle thru the number of data rows sent from the event listing
-            foreach ($valid['ticket-selections'] as $ticket_id => $qty) {
-                if ($qty) {
-                    // YES we have a ticket quantity
-                    $tickets_selected = true;
-                    $valid_ticket     = false;
-                    // get ticket via the ticket id we put in the form
-                    $ticket = $this->ticket_model->get_one_by_ID($ticket_id);
-                    if ($ticket instanceof EE_Ticket && ($ticket->is_on_sale() || $current_user_is_admin)) {
-                        $valid_ticket  = true;
-                        $tickets_added += $this->addTicketToCart($ticket, $qty);
-                    }
-                    if ($valid_ticket !== true) {
-                        // nothing added to cart retrieved
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
-                                    'event_espresso'
-                                ),
-                                '<br/>'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                    if (EE_Error::has_error()) {
-                        break;
-                    }
-                }
-            }
-        }
-        do_action(
-            'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-            $this->cart,
-            $this
-        );
-        if (! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
-            // no ticket quantities were selected
-            EE_Error::add_error(
-                esc_html__('You need to select a ticket quantity before you can proceed.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $tickets_added;
-    }
+	/**
+	 * @param array $valid
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function addTicketsToCart(array $valid)
+	{
+		$tickets_added = 0;
+		$tickets_selected = false;
+		if (! empty($valid['ticket-selections']) && $valid['total_tickets'] > 0) {
+			// load cart using factory because we don't want to do so until actually needed
+			$this->cart = CartFactory::getCart();
+			// if the user is an admin that can edit registrations,
+			// then we'll also allow them to add any tickets, even if they are expired
+			$current_user_is_admin = current_user_can('ee_edit_registrations');
+			// cycle thru the number of data rows sent from the event listing
+			foreach ($valid['ticket-selections'] as $ticket_id => $qty) {
+				if ($qty) {
+					// YES we have a ticket quantity
+					$tickets_selected = true;
+					$valid_ticket     = false;
+					// get ticket via the ticket id we put in the form
+					$ticket = $this->ticket_model->get_one_by_ID($ticket_id);
+					if ($ticket instanceof EE_Ticket && ($ticket->is_on_sale() || $current_user_is_admin)) {
+						$valid_ticket  = true;
+						$tickets_added += $this->addTicketToCart($ticket, $qty);
+					}
+					if ($valid_ticket !== true) {
+						// nothing added to cart retrieved
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
+									'event_espresso'
+								),
+								'<br/>'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+					if (EE_Error::has_error()) {
+						break;
+					}
+				}
+			}
+		}
+		do_action(
+			'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+			$this->cart,
+			$this
+		);
+		if (! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
+			// no ticket quantities were selected
+			EE_Error::add_error(
+				esc_html__('You need to select a ticket quantity before you can proceed.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $tickets_added;
+	}
 
 
-    /**
-     * adds a ticket to the cart
-     *
-     * @param EE_Ticket $ticket
-     * @param int       $qty
-     * @return bool TRUE on success, FALSE on fail
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function addTicketToCart(EE_Ticket $ticket, $qty = 1)
-    {
-        // get the number of spaces left for this datetime ticket
-        $available_spaces = $this->tracker->ticketDatetimeAvailability($ticket);
-        // compare available spaces against the number of tickets being purchased
-        if ($available_spaces >= $qty) {
-            // allow addons to prevent a ticket from being added to cart
-            if (
-                ! apply_filters(
-                    'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
-                    true,
-                    $ticket,
-                    $qty,
-                    $available_spaces
-                )
-            ) {
-                return false;
-            }
-            $qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
-            // add event to cart
-            if ($this->cart->add_ticket_to_cart($ticket, $qty)) {
-                $this->tracker->recalculateTicketDatetimeAvailability($ticket, $qty);
-                return true;
-            }
-            return false;
-        }
-        $this->tracker->processAvailabilityError($ticket, $qty, $this->cart->all_ticket_quantity_count());
-        return false;
-    }
+	/**
+	 * adds a ticket to the cart
+	 *
+	 * @param EE_Ticket $ticket
+	 * @param int       $qty
+	 * @return bool TRUE on success, FALSE on fail
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function addTicketToCart(EE_Ticket $ticket, $qty = 1)
+	{
+		// get the number of spaces left for this datetime ticket
+		$available_spaces = $this->tracker->ticketDatetimeAvailability($ticket);
+		// compare available spaces against the number of tickets being purchased
+		if ($available_spaces >= $qty) {
+			// allow addons to prevent a ticket from being added to cart
+			if (
+				! apply_filters(
+					'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
+					true,
+					$ticket,
+					$qty,
+					$available_spaces
+				)
+			) {
+				return false;
+			}
+			$qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
+			// add event to cart
+			if ($this->cart->add_ticket_to_cart($ticket, $qty)) {
+				$this->tracker->recalculateTicketDatetimeAvailability($ticket, $qty);
+				return true;
+			}
+			return false;
+		}
+		$this->tracker->processAvailabilityError($ticket, $qty, $this->cart->all_ticket_quantity_count());
+		return false;
+	}
 
 
-    /**
-     * @param $tickets_added
-     * @return bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    private function processSuccessfulCart($tickets_added)
-    {
-        // exit('KILL REDIRECT BEFORE CART UPDATE'); // <<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
-        if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
-            // make sure cart is loaded
-            if (! $this->cart instanceof EE_Cart) {
-                $this->cart = CartFactory::getCart();
-            }
-            do_action(
-                'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
-                $this->cart,
-                $this
-            );
-            $this->cart->recalculate_all_cart_totals();
-            $this->cart->save_cart(false);
-            // exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<  OR HERE TO KILL REDIRECT AFTER CART UPDATE
-            // just return TRUE for registrations being made from admin
-            if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
-                return true;
-            }
-            EEH_URL::safeRedirectAndExit(
-                apply_filters(
-                    'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
-                    $this->core_config->reg_page_url()
-                )
-            );
-        }
-        if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
-            // nothing added to cart
-            EE_Error::add_attention(
-                esc_html__('No tickets were added for the event', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return false;
-    }
+	/**
+	 * @param $tickets_added
+	 * @return bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	private function processSuccessfulCart($tickets_added)
+	{
+		// exit('KILL REDIRECT BEFORE CART UPDATE'); // <<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
+		if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
+			// make sure cart is loaded
+			if (! $this->cart instanceof EE_Cart) {
+				$this->cart = CartFactory::getCart();
+			}
+			do_action(
+				'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
+				$this->cart,
+				$this
+			);
+			$this->cart->recalculate_all_cart_totals();
+			$this->cart->save_cart(false);
+			// exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<  OR HERE TO KILL REDIRECT AFTER CART UPDATE
+			// just return TRUE for registrations being made from admin
+			if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
+				return true;
+			}
+			EEH_URL::safeRedirectAndExit(
+				apply_filters(
+					'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
+					$this->core_config->reg_page_url()
+				)
+			);
+		}
+		if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
+			// nothing added to cart
+			EE_Error::add_attention(
+				esc_html__('No tickets were added for the event', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return false;
+	}
 }