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/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 +64 added lines, -64 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,34 +66,34 @@ 
                             </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 wp_kses(
-                                espressoSubtotalRow($running_total, $display_subtotal),
-                                AllowedTags::getAllowedTags()
-                            );
-                            $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 wp_kses(
+								espressoSubtotalRow($running_total, $display_subtotal),
+								AllowedTags::getAllowedTags()
+							);
+							$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"
@@ -105,20 +105,20 @@ 
                             </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 wp_kses(
-                            espressoSubtotalRow($running_total),
-                            AllowedTags::getAllowedTags()
-                        );
-                        foreach ($ticket->get_ticket_taxes_for_admin() as $tax) { ?>
+						echo wp_kses(
+							espressoSubtotalRow($running_total),
+							AllowedTags::getAllowedTags()
+						);
+						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"
@@ -135,9 +135,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>
@@ -147,24 +147,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 echo 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/request/RequestParams.php

Spacing +16 added lines, -16 removed lines

@@ -17,13 +17,13 @@ 
      * Used for matches() and parameterDrillDown()
      * 'bool' will return true or false if match is found or not
      */
-    const RETURN_BOOL  = 'bool';
+    const RETURN_BOOL = 'bool';
 
     /**
      * Used for matches() and parameterDrillDown()
      * 'key' will return the first key found that matches the supplied pattern
      */
-    const RETURN_KEY   = 'key';
+    const RETURN_KEY = 'key';
 
     /**
      * Used for matches() and parameterDrillDown()
@@ -113,7 +113,7 @@ 
     {
         // don't allow "ee" to be overwritten unless explicitly instructed to do so
         if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
-            $this->request[ $key ] = $value;
+            $this->request[$key] = $value;
         }
     }
 
@@ -237,7 +237,7 @@ 
             preg_quote($pattern, '/')
         );
         foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
+            if (preg_match('/^'.$pattern.'$/is', $key)) {
                 // return value for request param
                 if ($return === self::RETURN_VALUE) {
                     return $request_param;
@@ -299,30 +299,30 @@ 
                 $key      = $real_key ?: $key;
             }
             // check if top level key exists
-            if (isset($request_params[ $key ])) {
+            if (isset($request_params[$key])) {
                 // build a new key to pass along like: 'second[third]'
                 // or just 'second' depending on depth of keys
                 $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
+                if ( ! empty($keys)) {
+                    $key_string .= '['.implode('][', $keys).']';
                 }
                 return $this->parameterDrillDown(
                     $key_string,
                     $default,
                     $callback,
                     $return,
-                    $request_params[ $key ]
+                    $request_params[$key]
                 );
             }
         }
         if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
+            return isset($request_params[$key]);
         }
         if ($callback === 'match') {
             return $this->match($key, $request_params, $default, $return);
         }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
+        return isset($request_params[$key])
+            ? $request_params[$key]
             : $default;
     }
 
@@ -336,12 +336,12 @@ 
     public function unSetRequestParam($key, $unset_from_global_too = false)
     {
         // because unset may not actually remove var
-        $this->get[ $key ]     = null;
-        $this->post[ $key ]    = null;
-        $this->request[ $key ] = null;
-        unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
+        $this->get[$key]     = null;
+        $this->post[$key]    = null;
+        $this->request[$key] = null;
+        unset($this->get[$key], $this->post[$key], $this->request[$key]);
         if ($unset_from_global_too) {
-            unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
+            unset($_GET[$key], $_POST[$key], $_REQUEST[$key]);
         }
     }
 

Indentation +353 added lines, -353 removed lines

@@ -13,357 +13,357 @@
  */
 class RequestParams
 {
-    /**
-     * Used for matches() and parameterDrillDown()
-     * 'bool' will return true or false if match is found or not
-     */
-    const RETURN_BOOL  = 'bool';
-
-    /**
-     * Used for matches() and parameterDrillDown()
-     * 'key' will return the first key found that matches the supplied pattern
-     */
-    const RETURN_KEY   = 'key';
-
-    /**
-     * Used for matches() and parameterDrillDown()
-     * 'value' will return the value for the first request parameter
-     */
-    const RETURN_VALUE = 'value';
-
-    /**
-     * $_GET parameters
-     *
-     * @var array
-     */
-    protected $get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var array
-     */
-    protected $post;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array
-     */
-    protected $request;
-
-    /**
-     * @var RequestSanitizer
-     */
-    protected $sanitizer;
-
-
-    /**
-     * RequestParams constructor.
-     *
-     * @param RequestSanitizer $sanitizer
-     * @param array            $get
-     * @param array            $post
-     */
-    public function __construct(RequestSanitizer $sanitizer, array $get = [], array $post = [])
-    {
-        $this->sanitizer = $sanitizer;
-        $this->get       = $get;
-        $this->post      = $post;
-        $this->request   = array_merge($this->get, $this->post);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->get;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->post;
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @param string     $key
-     * @param mixed|null $value
-     * @param bool       $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
-            $this->request[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * merges the incoming array of parameters into the existing request parameters
-     *
-     * @param array $request_params
-     * @return void
-     * @since   4.10.24.p
-     */
-    public function mergeRequestParams(array $request_params)
-    {
-        $this->request = array_merge($this->request, $request_params);
-    }
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param string     $key
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc.
-     *                              DataType::ARRAY should only be used to indicate an array containing mixed types,
-     *                              ideally another data type should be selected to indicate the contents of the array,
-     *                              and then $is_array should be set to true. ie: an array of integers would be:
-     *                                  $type = DataType::INT
-     *                                  $is_array = true
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
-    {
-        // ensure $is_array is true if the data type is set as such
-        $is_array = $type === DataType::ARRAY ? true : $is_array;
-        $param = $this->sanitizer->clean(
-            $this->parameterDrillDown($key, $default, 'get'),
-            $type,
-            $is_array,
-            $delimiter
-        );
-        // don't convert final return value to something else if an array is expected
-        $type = $is_array ? DataType::ARRAY : $type;
-        return DataType::setDataType($param, $type);
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return (bool) $this->parameterDrillDown($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
-    {
-        $param = $this->sanitizer->clean(
-            $this->parameterDrillDown($pattern, $default, 'match'),
-            $type,
-            $is_array,
-            $delimiter
-        );
-        $type = $is_array ? 'array' : $type;
-        return DataType::setDataType($param, $type);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return bool
-     */
-    public function matches($pattern)
-    {
-        return (bool) $this->parameterDrillDown($pattern, false, 'match', self::RETURN_BOOL);
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
-     *                                      and used to search through the current request's parameter keys
-     * @param array  $request_params        The array of request parameters to search through
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
-     *                                      Default is null
-     * @param string $return                [optional] Controls what kind of value is returned.
-     *                                      Options are the RETURN_* constants:
-     *                                      RETURN_BOOL will return true or false if match is found or not
-     *                                      RETURN_KEY will return the first key found that matches the supplied pattern
-     *                                      RETURN_VALUE will return the value for the first request parameter
-     *                                      whose key matches the supplied pattern
-     *                                      Default is 'value'
-     * @return boolean|string
-     */
-    private function match($pattern, array $request_params, $default = null, $return = self::RETURN_VALUE)
-    {
-        $return = in_array($return, [self::RETURN_BOOL, self::RETURN_KEY, self::RETURN_VALUE], true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            ['\*', '\?'],
-            ['.*', '.'],
-            preg_quote($pattern, '/')
-        );
-        foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
-                // return value for request param
-                if ($return === self::RETURN_VALUE) {
-                    return $request_param;
-                }
-                // or actual key or true just to indicate it was found
-                return $return === self::RETURN_KEY ? $key : true;
-            }
-        }
-        // match not found so return default value or false
-        return $return === self::RETURN_VALUE ? $default : false;
-    }
-
-
-    /**
-     * the supplied key can be a simple string to represent a "top-level" request parameter
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
-     * by using square brackets to surround keys for deeper array elements.
-     * For example :
-     * if the supplied $key was: "first[second][third]"
-     * then this will attempt to drill down into the request parameter array to find a value.
-     * Given the following request parameters:
-     *  array(
-     *      'first' => array(
-     *          'second' => array(
-     *              'third' => 'has a value'
-     *          )
-     *      )
-     *  )
-     * would return true if default parameters were set
-     *
-     * @param string $callback
-     * @param        $key
-     * @param null   $default
-     * @param string $return
-     * @param mixed  $request_params
-     * @return bool|mixed|null
-     */
-    private function parameterDrillDown(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        $return = self::RETURN_VALUE,
-        $request_params = []
-    ) {
-        $callback       = in_array($callback, ['is_set', 'get', 'match'], true)
-            ? $callback
-            : 'is_set';
-        $request_params = ! empty($request_params)
-            ? $request_params
-            : $this->request;
-        // does incoming key represent an array like 'first[second][third]'  ?
-        if (strpos($key, '[') !== false) {
-            // turn it into an actual array
-            $key  = str_replace(']', '', $key);
-            $keys = explode('[', $key);
-            $key  = array_shift($keys);
-            if ($callback === 'match') {
-                $real_key = $this->match($key, $request_params, $default, self::RETURN_KEY);
-                $key      = $real_key ?: $key;
-            }
-            // check if top level key exists
-            if (isset($request_params[ $key ])) {
-                // build a new key to pass along like: 'second[third]'
-                // or just 'second' depending on depth of keys
-                $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
-                }
-                return $this->parameterDrillDown(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $return,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default, $return);
-        }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
-            : $default;
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        // because unset may not actually remove var
-        $this->get[ $key ]     = null;
-        $this->post[ $key ]    = null;
-        $this->request[ $key ] = null;
-        unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
-        }
-    }
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false)
-    {
-        foreach ($keys as $key) {
-            $this->unSetRequestParam($key, $unset_from_global_too);
-        }
-    }
+	/**
+	 * Used for matches() and parameterDrillDown()
+	 * 'bool' will return true or false if match is found or not
+	 */
+	const RETURN_BOOL  = 'bool';
+
+	/**
+	 * Used for matches() and parameterDrillDown()
+	 * 'key' will return the first key found that matches the supplied pattern
+	 */
+	const RETURN_KEY   = 'key';
+
+	/**
+	 * Used for matches() and parameterDrillDown()
+	 * 'value' will return the value for the first request parameter
+	 */
+	const RETURN_VALUE = 'value';
+
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array
+	 */
+	protected $get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var array
+	 */
+	protected $post;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array
+	 */
+	protected $request;
+
+	/**
+	 * @var RequestSanitizer
+	 */
+	protected $sanitizer;
+
+
+	/**
+	 * RequestParams constructor.
+	 *
+	 * @param RequestSanitizer $sanitizer
+	 * @param array            $get
+	 * @param array            $post
+	 */
+	public function __construct(RequestSanitizer $sanitizer, array $get = [], array $post = [])
+	{
+		$this->sanitizer = $sanitizer;
+		$this->get       = $get;
+		$this->post      = $post;
+		$this->request   = array_merge($this->get, $this->post);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->get;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->post;
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @param string     $key
+	 * @param mixed|null $value
+	 * @param bool       $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
+			$this->request[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * merges the incoming array of parameters into the existing request parameters
+	 *
+	 * @param array $request_params
+	 * @return void
+	 * @since   4.10.24.p
+	 */
+	public function mergeRequestParams(array $request_params)
+	{
+		$this->request = array_merge($this->request, $request_params);
+	}
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc.
+	 *                              DataType::ARRAY should only be used to indicate an array containing mixed types,
+	 *                              ideally another data type should be selected to indicate the contents of the array,
+	 *                              and then $is_array should be set to true. ie: an array of integers would be:
+	 *                                  $type = DataType::INT
+	 *                                  $is_array = true
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
+	{
+		// ensure $is_array is true if the data type is set as such
+		$is_array = $type === DataType::ARRAY ? true : $is_array;
+		$param = $this->sanitizer->clean(
+			$this->parameterDrillDown($key, $default, 'get'),
+			$type,
+			$is_array,
+			$delimiter
+		);
+		// don't convert final return value to something else if an array is expected
+		$type = $is_array ? DataType::ARRAY : $type;
+		return DataType::setDataType($param, $type);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return (bool) $this->parameterDrillDown($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
+	{
+		$param = $this->sanitizer->clean(
+			$this->parameterDrillDown($pattern, $default, 'match'),
+			$type,
+			$is_array,
+			$delimiter
+		);
+		$type = $is_array ? 'array' : $type;
+		return DataType::setDataType($param, $type);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return bool
+	 */
+	public function matches($pattern)
+	{
+		return (bool) $this->parameterDrillDown($pattern, false, 'match', self::RETURN_BOOL);
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
+	 *                                      and used to search through the current request's parameter keys
+	 * @param array  $request_params        The array of request parameters to search through
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
+	 *                                      Default is null
+	 * @param string $return                [optional] Controls what kind of value is returned.
+	 *                                      Options are the RETURN_* constants:
+	 *                                      RETURN_BOOL will return true or false if match is found or not
+	 *                                      RETURN_KEY will return the first key found that matches the supplied pattern
+	 *                                      RETURN_VALUE will return the value for the first request parameter
+	 *                                      whose key matches the supplied pattern
+	 *                                      Default is 'value'
+	 * @return boolean|string
+	 */
+	private function match($pattern, array $request_params, $default = null, $return = self::RETURN_VALUE)
+	{
+		$return = in_array($return, [self::RETURN_BOOL, self::RETURN_KEY, self::RETURN_VALUE], true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			['\*', '\?'],
+			['.*', '.'],
+			preg_quote($pattern, '/')
+		);
+		foreach ($request_params as $key => $request_param) {
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
+				// return value for request param
+				if ($return === self::RETURN_VALUE) {
+					return $request_param;
+				}
+				// or actual key or true just to indicate it was found
+				return $return === self::RETURN_KEY ? $key : true;
+			}
+		}
+		// match not found so return default value or false
+		return $return === self::RETURN_VALUE ? $default : false;
+	}
+
+
+	/**
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
+	 * by using square brackets to surround keys for deeper array elements.
+	 * For example :
+	 * if the supplied $key was: "first[second][third]"
+	 * then this will attempt to drill down into the request parameter array to find a value.
+	 * Given the following request parameters:
+	 *  array(
+	 *      'first' => array(
+	 *          'second' => array(
+	 *              'third' => 'has a value'
+	 *          )
+	 *      )
+	 *  )
+	 * would return true if default parameters were set
+	 *
+	 * @param string $callback
+	 * @param        $key
+	 * @param null   $default
+	 * @param string $return
+	 * @param mixed  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function parameterDrillDown(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		$return = self::RETURN_VALUE,
+		$request_params = []
+	) {
+		$callback       = in_array($callback, ['is_set', 'get', 'match'], true)
+			? $callback
+			: 'is_set';
+		$request_params = ! empty($request_params)
+			? $request_params
+			: $this->request;
+		// does incoming key represent an array like 'first[second][third]'  ?
+		if (strpos($key, '[') !== false) {
+			// turn it into an actual array
+			$key  = str_replace(']', '', $key);
+			$keys = explode('[', $key);
+			$key  = array_shift($keys);
+			if ($callback === 'match') {
+				$real_key = $this->match($key, $request_params, $default, self::RETURN_KEY);
+				$key      = $real_key ?: $key;
+			}
+			// check if top level key exists
+			if (isset($request_params[ $key ])) {
+				// build a new key to pass along like: 'second[third]'
+				// or just 'second' depending on depth of keys
+				$key_string = array_shift($keys);
+				if (! empty($keys)) {
+					$key_string .= '[' . implode('][', $keys) . ']';
+				}
+				return $this->parameterDrillDown(
+					$key_string,
+					$default,
+					$callback,
+					$return,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[ $key ]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default, $return);
+		}
+		return isset($request_params[ $key ])
+			? $request_params[ $key ]
+			: $default;
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		// because unset may not actually remove var
+		$this->get[ $key ]     = null;
+		$this->post[ $key ]    = null;
+		$this->request[ $key ] = null;
+		unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
+		}
+	}
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false)
+	{
+		foreach ($keys as $key) {
+			$this->unSetRequestParam($key, $unset_from_global_too);
+		}
+	}
 }

admin_pages/messages/templates/shortcode_selector_skeleton.template.php

Indentation +5 added lines, -5 removed lines

@@ -28,14 +28,14 @@
         </h6>
         <h4>
             <?php
-            printf(
-                esc_html__('"%1$s" field', 'event_espresso'),
-                esc_attr($fieldname)
-            ); ?>
+			printf(
+				esc_html__('"%1$s" field', 'event_espresso'),
+				esc_attr($fieldname)
+			); ?>
         </h4>
         <ul>
         <?php
-        foreach (array_keys($shortcodes) as $shortcode) : ?>
+		foreach (array_keys($shortcodes) as $shortcode) : ?>
             <li>
                 <span class="js-shortcode-selection"
                       data-linked-input-id="<?php echo esc_attr($linked_input_id); ?>"

Spacing +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
  * @type    string $linked_input_id The name of the input that the shortcode gets inserted to.
  */
 
-if (! empty($shortcodes)) : ?>
+if ( ! empty($shortcodes)) : ?>
 <div class="ee-messages-shortcodes-chooser-wrap">
     <button class="button button--secondary button--icon-only ee-messages-shortcodes-chooser js-open-list-trigger"
             aria-label="<?php echo esc_html__('open shortcode selector', 'event_espresso'); ?>"

core/libraries/messages/data_class/EE_Messages_Preview_incoming_data.class.php

Spacing +65 added lines, -65 removed lines

@@ -106,70 +106,70 @@ 
         // we'll actually use the generated line_item identifiers for our loop
         $dtts = $tkts = [];
         foreach ($events as $id => $event) {
-            if (! $event instanceof EE_Event) {
+            if ( ! $event instanceof EE_Event) {
                 continue;
             }
-            $this->_events[ $id ]['ID']       = $id;
-            $this->_events[ $id ]['name']     = $event->get('EVT_name');
+            $this->_events[$id]['ID']       = $id;
+            $this->_events[$id]['name']     = $event->get('EVT_name');
             $datetime                         = $event->get_first_related('Datetime');
             $tickets                          = $datetime instanceof EE_Datetime ? $datetime->get_many_related(
                 'Ticket',
                 ['default_where_conditions' => 'none']
             ) : [];
-            $this->_events[ $id ]['event']    = $event;
-            $this->_events[ $id ]['reg_objs'] = [];
-            $this->_events[ $id ]['tkt_objs'] = $tickets;
-            $this->_events[ $id ]['dtt_objs'] = [];
+            $this->_events[$id]['event']    = $event;
+            $this->_events[$id]['reg_objs'] = [];
+            $this->_events[$id]['tkt_objs'] = $tickets;
+            $this->_events[$id]['dtt_objs'] = [];
 
-            $tkts     = [];
+            $tkts = [];
             foreach ($tickets as $ticket) {
-                if (! $ticket instanceof EE_Ticket) {
+                if ( ! $ticket instanceof EE_Ticket) {
                     continue;
                 }
                 $reldatetime                       = $ticket->datetimes();
-                $tkts[ $ticket->ID() ]             = [];
-                $tkts[ $ticket->ID() ]['ticket']   = $ticket;
-                $tkts[ $ticket->ID() ]['dtt_objs'] = $reldatetime;
-                $tkts[ $ticket->ID() ]['att_objs'] = $attendees;
-                $tkts[ $ticket->ID() ]['count']    = count($attendees);
-                $tkts[ $ticket->ID() ]['EE_Event'] = $event;
+                $tkts[$ticket->ID()]             = [];
+                $tkts[$ticket->ID()]['ticket']   = $ticket;
+                $tkts[$ticket->ID()]['dtt_objs'] = $reldatetime;
+                $tkts[$ticket->ID()]['att_objs'] = $attendees;
+                $tkts[$ticket->ID()]['count']    = count($attendees);
+                $tkts[$ticket->ID()]['EE_Event'] = $event;
                 foreach ($reldatetime as $datetime) {
-                    if ($datetime instanceof EE_Datetime && ! isset($dtts[ $datetime->ID() ])) {
-                        $this->_events[ $id ]['dtt_objs'][ $datetime->ID() ] = $datetime;
-                        $dtts[ $datetime->ID() ]['datetime']                 = $datetime;
-                        $dtts[ $datetime->ID() ]['tkt_objs'][]               = $ticket;
-                        $dtts[ $datetime->ID() ]['evt_objs'][]               = $event;
+                    if ($datetime instanceof EE_Datetime && ! isset($dtts[$datetime->ID()])) {
+                        $this->_events[$id]['dtt_objs'][$datetime->ID()] = $datetime;
+                        $dtts[$datetime->ID()]['datetime']                 = $datetime;
+                        $dtts[$datetime->ID()]['tkt_objs'][]               = $ticket;
+                        $dtts[$datetime->ID()]['evt_objs'][]               = $event;
                     }
                 }
             }
 
-            $this->_events[ $id ]['total_attendees'] = count($attendees);
-            $this->_events[ $id ]['att_objs']        = $attendees;
+            $this->_events[$id]['total_attendees'] = count($attendees);
+            $this->_events[$id]['att_objs']        = $attendees;
 
             // let's also setup the dummy attendees property!
             foreach ($attendees as $att_key => $attendee) {
-                if (! $attendee instanceof EE_Attendee) {
+                if ( ! $attendee instanceof EE_Attendee) {
                     continue;
                 }
-                $this->_attendees[ $att_key ]['line_ref'][] =
-                    $id;  // so later it can be determined what events this attendee registered for!
-                $this->_attendees[ $att_key ]['evt_objs'][] = $event;
-                $this->_attendees[ $att_key ]['att_obj']    = $attendee;
+                $this->_attendees[$att_key]['line_ref'][] =
+                    $id; // so later it can be determined what events this attendee registered for!
+                $this->_attendees[$att_key]['evt_objs'][] = $event;
+                $this->_attendees[$att_key]['att_obj']    = $attendee;
                 // $this->_attendees[$att_key]['registration_id'] = 0;
-                $this->_attendees[ $att_key ]['attendee_email'] = $attendee->email();
-                $this->_attendees[ $att_key ]['tkt_objs']       = $tickets;
+                $this->_attendees[$att_key]['attendee_email'] = $attendee->email();
+                $this->_attendees[$att_key]['tkt_objs']       = $tickets;
                 if ($att_key == 999999991) {
-                    $this->_attendees[ $att_key ]['ans_objs'][999]  = $answers_n_questions['answers'][999];
-                    $this->_attendees[ $att_key ]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
-                    $this->_attendees[ $att_key ]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
+                    $this->_attendees[$att_key]['ans_objs'][999]  = $answers_n_questions['answers'][999];
+                    $this->_attendees[$att_key]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
+                    $this->_attendees[$att_key]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
                 } elseif ($att_key == 999999992) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
-                    $this->_attendees[ $att_key ]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
-                    $this->_attendees[ $att_key ]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
+                    $this->_attendees[$att_key]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
+                    $this->_attendees[$att_key]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
+                    $this->_attendees[$att_key]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
                 } elseif ($att_key == 999999993) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
-                    $this->_attendees[ $att_key ]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
-                    $this->_attendees[ $att_key ]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
+                    $this->_attendees[$att_key]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
+                    $this->_attendees[$att_key]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
+                    $this->_attendees[$att_key]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
                 }
             }
         }
@@ -270,7 +270,7 @@ 
             /** @var $email string */
             /** @var $phone string */
             /** @var $attid string */
-            $attendees[ $attid ] = EE_Attendee::new_instance(
+            $attendees[$attid] = EE_Attendee::new_instance(
                 [
                     'ATT_fname'    => $fname,
                     'ATT_lname'    => $lname,
@@ -377,7 +377,7 @@ 
         // first the questions
         foreach ($quests_array as $qst) {
             $qstobj                    = array_combine($qst_columns, $qst);
-            $qsts[ $qstobj['QST_ID'] ] = EE_Question::new_instance($qstobj);
+            $qsts[$qstobj['QST_ID']] = EE_Question::new_instance($qstobj);
         }
 
         // now the answers (and we'll setup our arrays)
@@ -385,8 +385,8 @@ 
         foreach ($ans_array as $ans) {
             $ansobj                               = array_combine($ans_columns, $ans);
             $ansobj                               = EE_Answer::new_instance($ansobj);
-            $q_n_as['answers'][ $ansobj->ID() ]   = $ansobj;
-            $q_n_as['questions'][ $ansobj->ID() ] = $qsts[ $ansobj->get('QST_ID') ];
+            $q_n_as['answers'][$ansobj->ID()]   = $ansobj;
+            $q_n_as['questions'][$ansobj->ID()] = $qsts[$ansobj->get('QST_ID')];
         }
 
         return $q_n_as;
@@ -471,11 +471,11 @@ 
             $regtxn = $this->txn->ID();
             $regcnt = 1;
             foreach ($attendee['line_ref'] as $evtid) {
-                foreach ($this->_events[ $evtid ]['tkt_objs'] as $ticket) {
-                    if (! $ticket instanceof EE_Ticket) {
+                foreach ($this->_events[$evtid]['tkt_objs'] as $ticket) {
+                    if ( ! $ticket instanceof EE_Ticket) {
                         continue;
                     }
-                    $reg_array                                            = [
+                    $reg_array = [
                         'EVT_ID'           => $evtid,
                         'ATT_ID'           => $regatt,
                         'TXN_ID'           => $regtxn,
@@ -484,18 +484,18 @@ 
                         'REG_date'         => time(),
                         'REG_final_price'  => $ticket->get('TKT_price'),
                         'REG_session'      => 'dummy_session_id',
-                        'REG_code'         => $regid . '-dummy-generated-code',
-                        'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
+                        'REG_code'         => $regid.'-dummy-generated-code',
+                        'REG_url_link'     => $regcnt.'-daafpapasdlfakasdfpqasdfasdf',
                         'REG_count'        => $regcnt,
-                        'REG_group_size'   => $this->_events[ $evtid ]['total_attendees'],
+                        'REG_group_size'   => $this->_events[$evtid]['total_attendees'],
                         'REG_att_is_going' => true,
                         'REG_ID'           => $regid,
                     ];
                     $REG_OBJ                                              = EE_Registration::new_instance($reg_array);
-                    $this->_attendees[ $key ]['reg_objs'][ $regid ]       = $REG_OBJ;
-                    $this->_events[ $evtid ]['reg_objs'][]                = $REG_OBJ;
+                    $this->_attendees[$key]['reg_objs'][$regid]       = $REG_OBJ;
+                    $this->_events[$evtid]['reg_objs'][]                = $REG_OBJ;
                     $this->reg_objs[]                                     = $REG_OBJ;
-                    $this->tickets[ $ticket->ID() ]['reg_objs'][ $regid ] = $REG_OBJ;
+                    $this->tickets[$ticket->ID()]['reg_objs'][$regid] = $REG_OBJ;
 
                     $regcnt++;
                     $regid++;
@@ -541,19 +541,19 @@ 
         $event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
         $line_items       = [];
         foreach ($event_line_items as $line_item) {
-            if (! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
+            if ( ! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
                 continue;
             }
             $ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
             foreach ($ticket_line_items as $ticket_line_item) {
-                if (! $ticket_line_item instanceof EE_Line_Item) {
+                if ( ! $ticket_line_item instanceof EE_Line_Item) {
                     continue;
                 }
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['line_item']      = $ticket_line_item;
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['sub_line_items'] = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['children']              = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['EE_Ticket']             =
-                    $this->tickets[ $ticket_line_item->OBJ_ID() ]['ticket'];
+                $this->tickets[$ticket_line_item->OBJ_ID()]['line_item']      = $ticket_line_item;
+                $this->tickets[$ticket_line_item->OBJ_ID()]['sub_line_items'] = $ticket_line_item->children();
+                $line_items[$ticket_line_item->ID()]['children']              = $ticket_line_item->children();
+                $line_items[$ticket_line_item->ID()]['EE_Ticket']             =
+                    $this->tickets[$ticket_line_item->OBJ_ID()]['ticket'];
             }
         }
 
@@ -568,15 +568,15 @@ 
 
         // add additional details for each registration
         foreach ($this->reg_objs as $reg) {
-            if (! $reg instanceof EE_Registration) {
+            if ( ! $reg instanceof EE_Registration) {
                 continue;
             }
-            $this->_registrations[ $reg->ID() ]['tkt_obj']  = $this->tickets[ $reg->get('TKT_ID') ]['ticket'];
-            $this->_registrations[ $reg->ID() ]['evt_obj']  = $this->_events[ $reg->get('EVT_ID') ]['event'];
-            $this->_registrations[ $reg->ID() ]['reg_obj']  = $reg;
-            $this->_registrations[ $reg->ID() ]['ans_objs'] = $this->_attendees[ $reg->get('ATT_ID') ]['ans_objs'];
-            $this->_registrations[ $reg->ID() ]['att_obj']  = $this->_attendees[ $reg->get('ATT_ID') ]['att_obj'];
-            $this->_registrations[ $reg->ID() ]['dtt_objs'] = $this->tickets[ $reg->get('TKT_ID') ]['dtt_objs'];
+            $this->_registrations[$reg->ID()]['tkt_obj']  = $this->tickets[$reg->get('TKT_ID')]['ticket'];
+            $this->_registrations[$reg->ID()]['evt_obj']  = $this->_events[$reg->get('EVT_ID')]['event'];
+            $this->_registrations[$reg->ID()]['reg_obj']  = $reg;
+            $this->_registrations[$reg->ID()]['ans_objs'] = $this->_attendees[$reg->get('ATT_ID')]['ans_objs'];
+            $this->_registrations[$reg->ID()]['att_obj']  = $this->_attendees[$reg->get('ATT_ID')]['att_obj'];
+            $this->_registrations[$reg->ID()]['dtt_objs'] = $this->tickets[$reg->get('TKT_ID')]['dtt_objs'];
         }
 
 

Indentation +599 added lines, -599 removed lines

@@ -21,603 +21,603 @@
  */
 class EE_Messages_Preview_incoming_data extends EE_Messages_incoming_data
 {
-    // some specific properties we need for this class
-    private $_events        = [];
-
-    private $_attendees     = [];
-
-    private $_registrations = [];
-
-
-    /**
-     * For the constructor of this special preview class.  We're either looking for an event id or empty data.  If we
-     * have an event id (or ids) then we'll use that as the source for the "dummy" data.  If the data is empty then
-     * we'll get the first three published events from the users database and use that as a source.
-     *
-     * @param array $data
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($data = [])
-    {
-        $this->_data = isset($data['event_ids']) ? $data['event_ids'] : [];
-        $this->_setup_attendees_events();
-        parent::__construct($data);
-    }
-
-
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param array $data The incoming data to be prepped.
-     *
-     * @return array   The prepped data for db
-     */
-    public static function convert_data_for_persistent_storage($data)
-    {
-        return $data;
-    }
-
-
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param array $data
-     *
-     * @return array
-     */
-    public static function convert_data_from_persistent_storage($data)
-    {
-        return $data;
-    }
-
-
-    /**
-     * This will just setup the _events property in the expected format.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _setup_attendees_events()
-    {
-
-        // setup some attendee objects
-        $attendees = $this->_get_some_attendees();
-
-        // if empty $data we'll do a query to get some events from the server.
-        // otherwise we'll retrieve the event data for the given ids.
-        $events = $this->_get_some_events($this->_data);
-
-        $answers_n_questions = $this->_get_some_q_and_as();
-
-        if (count($events) < 1) {
-            throw new EE_Error(
-                esc_html__(
-                    'We can\'t generate a preview for you because there are no active events in your database',
-                    'event_espresso'
-                )
-            );
-        }
-
-
-        // now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
-        // we'll actually use the generated line_item identifiers for our loop
-        $dtts = $tkts = [];
-        foreach ($events as $id => $event) {
-            if (! $event instanceof EE_Event) {
-                continue;
-            }
-            $this->_events[ $id ]['ID']       = $id;
-            $this->_events[ $id ]['name']     = $event->get('EVT_name');
-            $datetime                         = $event->get_first_related('Datetime');
-            $tickets                          = $datetime instanceof EE_Datetime ? $datetime->get_many_related(
-                'Ticket',
-                ['default_where_conditions' => 'none']
-            ) : [];
-            $this->_events[ $id ]['event']    = $event;
-            $this->_events[ $id ]['reg_objs'] = [];
-            $this->_events[ $id ]['tkt_objs'] = $tickets;
-            $this->_events[ $id ]['dtt_objs'] = [];
-
-            $tkts     = [];
-            foreach ($tickets as $ticket) {
-                if (! $ticket instanceof EE_Ticket) {
-                    continue;
-                }
-                $reldatetime                       = $ticket->datetimes();
-                $tkts[ $ticket->ID() ]             = [];
-                $tkts[ $ticket->ID() ]['ticket']   = $ticket;
-                $tkts[ $ticket->ID() ]['dtt_objs'] = $reldatetime;
-                $tkts[ $ticket->ID() ]['att_objs'] = $attendees;
-                $tkts[ $ticket->ID() ]['count']    = count($attendees);
-                $tkts[ $ticket->ID() ]['EE_Event'] = $event;
-                foreach ($reldatetime as $datetime) {
-                    if ($datetime instanceof EE_Datetime && ! isset($dtts[ $datetime->ID() ])) {
-                        $this->_events[ $id ]['dtt_objs'][ $datetime->ID() ] = $datetime;
-                        $dtts[ $datetime->ID() ]['datetime']                 = $datetime;
-                        $dtts[ $datetime->ID() ]['tkt_objs'][]               = $ticket;
-                        $dtts[ $datetime->ID() ]['evt_objs'][]               = $event;
-                    }
-                }
-            }
-
-            $this->_events[ $id ]['total_attendees'] = count($attendees);
-            $this->_events[ $id ]['att_objs']        = $attendees;
-
-            // let's also setup the dummy attendees property!
-            foreach ($attendees as $att_key => $attendee) {
-                if (! $attendee instanceof EE_Attendee) {
-                    continue;
-                }
-                $this->_attendees[ $att_key ]['line_ref'][] =
-                    $id;  // so later it can be determined what events this attendee registered for!
-                $this->_attendees[ $att_key ]['evt_objs'][] = $event;
-                $this->_attendees[ $att_key ]['att_obj']    = $attendee;
-                // $this->_attendees[$att_key]['registration_id'] = 0;
-                $this->_attendees[ $att_key ]['attendee_email'] = $attendee->email();
-                $this->_attendees[ $att_key ]['tkt_objs']       = $tickets;
-                if ($att_key == 999999991) {
-                    $this->_attendees[ $att_key ]['ans_objs'][999]  = $answers_n_questions['answers'][999];
-                    $this->_attendees[ $att_key ]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
-                    $this->_attendees[ $att_key ]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
-                } elseif ($att_key == 999999992) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
-                    $this->_attendees[ $att_key ]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
-                    $this->_attendees[ $att_key ]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
-                } elseif ($att_key == 999999993) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
-                    $this->_attendees[ $att_key ]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
-                    $this->_attendees[ $att_key ]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
-                }
-            }
-        }
-
-        $this->tickets            = $tkts;
-        $this->datetimes          = $dtts;
-        $this->answers            = $answers_n_questions['answers'];
-        $this->questions          = $answers_n_questions['questions'];
-        $this->total_ticket_count = count($tkts) * count($this->_attendees);
-    }
-
-
-    /**
-     * This just returns an array of dummy attendee objects that we'll use to attach to events for our preview data
-     *
-     * @access private
-     * @return array an array of attendee objects
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    private function _get_some_attendees()
-    {
-        // let's just setup a dummy array of various attendee details
-        $dummy_attendees = [
-            0 => [
-                'Luke',
-                'Skywalker',
-                'farfaraway@galaxy.sp',
-                '804 Bantha Dr.',
-                'Complex 8',
-                'Mos Eisley',
-                32,
-                'US',
-                'f0r3e',
-                '222-333-4763',
-                false,
-                '999999991',
-            ],
-            1 => [
-                'Princess',
-                'Leia',
-                'buns@fcn.al',
-                '1456 Valley Way Boulevard',
-                'Suite 9',
-                'Alderaan',
-                15,
-                'US',
-                'c1h2c',
-                '78-123-111-1111',
-                false,
-                '999999992',
-            ],
-            2 => [
-                'Yoda',
-                'I Am',
-                'arrivenot@emailbad.fr',
-                '4th Tree',
-                '5th Knot',
-                'Marsh',
-                22,
-                'US',
-                'l18n',
-                '999-999-9999',
-                false,
-                '999999993',
-            ],
-        ];
-
-        // let's generate the attendee objects
-        $attendees = [];
-        $var_array = [
-            'fname',
-            'lname',
-            'email',
-            'address',
-            'address2',
-            'city',
-            'staid',
-            'cntry',
-            'zip',
-            'phone',
-            'deleted',
-            'attid',
-        ];
-
-        // EE_Registry::instance()->load_class( 'Attendee', array(), FALSE, false, TRUE );
-        foreach ($dummy_attendees as $dummy) {
-            $att = array_combine($var_array, $dummy);
-            extract($att);
-            /** @var $fname string */
-            /** @var $lname string */
-            /** @var $address string */
-            /** @var $address2 string */
-            /** @var $city string */
-            /** @var $staid string */
-            /** @var $cntry string */
-            /** @var $zip string */
-            /** @var $email string */
-            /** @var $phone string */
-            /** @var $attid string */
-            $attendees[ $attid ] = EE_Attendee::new_instance(
-                [
-                    'ATT_fname'    => $fname,
-                    'ATT_lname'    => $lname,
-                    'ATT_address'  => $address,
-                    'ATT_address2' => $address2,
-                    'ATT_city'     => $city,
-                    'STA_ID'       => $staid,
-                    'CNT_ISO'      => $cntry,
-                    'ATT_zip'      => $zip,
-                    'ATT_email'    => $email,
-                    'ATT_phone'    => $phone,
-                    'ATT_ID'       => $attid,
-                ]
-            );
-        }
-
-        return $attendees;
-    }
-
-
-    /**
-     * Return an array of dummy question objects indexed by answer id and dummy answer objects indexed by answer id.
-     * This will be used in our dummy data setup
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_some_q_and_as()
-    {
-        $quests_array = [
-            0 => [
-                555,
-                esc_html__('What is your favorite planet?', 'event_espresso'),
-                0,
-            ],
-            1 => [
-                556,
-                esc_html__('What is your favorite food?', 'event_espresso'),
-                0,
-            ],
-            2 => [
-                557,
-                esc_html__('How many lightyears have you travelled', 'event_espresso'),
-                0,
-            ],
-        ];
-
-        $ans_array = [
-            0 => [
-                999,
-                555,
-                'Tattoine',
-            ],
-            1 => [
-                1000,
-                555,
-                'Alderaan',
-            ],
-            2 => [
-                1001,
-                555,
-                'Dantooine',
-            ],
-            3 => [
-                1002,
-                556,
-                'Fish Fingers',
-            ],
-            4 => [
-                1003,
-                556,
-                'Sushi',
-            ],
-            5 => [
-                1004,
-                556,
-                'Water',
-            ],
-            6 => [
-                1005,
-                557,
-                'A lot',
-            ],
-            7 => [
-                1006,
-                557,
-                "That's none of your business.",
-            ],
-            8 => [
-                1007,
-                557,
-                "People less travel me then.",
-            ],
-        ];
-
-        $qst_columns = ['QST_ID', 'QST_display_text', 'QST_system'];
-        $ans_columns = ['ANS_ID', 'QST_ID', 'ANS_value'];
-
-        // EE_Registry::instance()->load_class( 'Question', array(), FALSE, TRUE, TRUE );
-        // EE_Registry::instance()->load_class( 'Answer', array(), FALSE, TRUE, TRUE );
-
-        $qsts = [];
-        // first the questions
-        foreach ($quests_array as $qst) {
-            $qstobj                    = array_combine($qst_columns, $qst);
-            $qsts[ $qstobj['QST_ID'] ] = EE_Question::new_instance($qstobj);
-        }
-
-        // now the answers (and we'll setup our arrays)
-        $q_n_as = [];
-        foreach ($ans_array as $ans) {
-            $ansobj                               = array_combine($ans_columns, $ans);
-            $ansobj                               = EE_Answer::new_instance($ansobj);
-            $q_n_as['answers'][ $ansobj->ID() ]   = $ansobj;
-            $q_n_as['questions'][ $ansobj->ID() ] = $qsts[ $ansobj->get('QST_ID') ];
-        }
-
-        return $q_n_as;
-    }
-
-
-    /**
-     * Return an array of event objects from the database
-     *
-     * If event ids are not included then we'll just retrieve the first published event from the database.
-     *
-     * @param array $event_ids if set, this will be an array of event ids to obtain events for.
-     *
-     * @return array    An array of event objects from the db.
-     * @throws EE_Error
-     */
-    private function _get_some_events(array $event_ids = [])
-    {
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        // if we have an evt_id then we want to make sure we use that for the preview
-        // (because a specific event template is being viewed);
-        $event_ids = $request->getRequestParam('evt_id', $event_ids, 'int', true);
-        // clear out any invalid IDs, like 0
-        $event_ids = array_filter($event_ids);
-        $limit     = ! empty($event_ids)
-            ? null
-            : apply_filters('FHEE__EE_Messages_Preview_incoming_data___get_some_events__limit', '0,1');
-
-        $where = ! empty($event_ids)
-            ? [
-                'EVT_ID'                 => ['IN', $event_ids],
-                'Datetime.Ticket.TKT_ID' => ['>', 1],
-            ]
-            : ['Datetime.Ticket.TKT_ID' => ['>', 1]];
-
-        return EEM_Event::instance()->get_all([$where, 'limit' => $limit]);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _setup_data()
-    {
-        // need to figure out the running total for test purposes so... we're going to create a temp cart and add the tickets to it!
-        if (EE_Registry::instance()->SSN instanceof EE_Session) {
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-            $session = EE_Registry::instance()->SSN;
-        } else {
-            $session = EE_Registry::instance()->load_core('Session');
-        }
-        $cart = EE_Cart::instance(null, $session);
-
-        // add tickets to cart
-        foreach ($this->tickets as $ticket) {
-            $cart->add_ticket_to_cart($ticket['ticket']);
-        }
-
-        // setup txn property
-        $this->txn = EE_Transaction::new_instance(
-            [
-                'TXN_timestamp'    => time(), // unix timestamp
-                'TXN_total'        => 0, // txn_total
-                'TXN_paid'         => 0, // txn_paid
-                'STS_ID'           => EEM_Transaction::incomplete_status_code, // sts_id
-                'TXN_session_data' => null, // dump of txn session object (we're just going to leave blank here)
-                'TXN_hash_salt'    => null, // hash salt blank as well
-                'TXN_ID'           => 999999,
-            ]
-        );
-
-
-        // setup reg_objects
-        // note we're setting up a reg object for each attendee in each event but ALSO adding to the reg_object array.
-        $this->reg_objs = [];
-        $regid          = 9999990;
-        foreach ($this->_attendees as $key => $attendee) {
-            // note we need to setup reg_objects for each event this attendee belongs to
-            $regatt = $attendee['att_obj'] instanceof EE_Attendee ? $attendee['att_obj']->ID() : null;
-            $regtxn = $this->txn->ID();
-            $regcnt = 1;
-            foreach ($attendee['line_ref'] as $evtid) {
-                foreach ($this->_events[ $evtid ]['tkt_objs'] as $ticket) {
-                    if (! $ticket instanceof EE_Ticket) {
-                        continue;
-                    }
-                    $reg_array                                            = [
-                        'EVT_ID'           => $evtid,
-                        'ATT_ID'           => $regatt,
-                        'TXN_ID'           => $regtxn,
-                        'TKT_ID'           => $ticket->ID(),
-                        'STS_ID'           => RegStatus::PENDING_PAYMENT,
-                        'REG_date'         => time(),
-                        'REG_final_price'  => $ticket->get('TKT_price'),
-                        'REG_session'      => 'dummy_session_id',
-                        'REG_code'         => $regid . '-dummy-generated-code',
-                        'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
-                        'REG_count'        => $regcnt,
-                        'REG_group_size'   => $this->_events[ $evtid ]['total_attendees'],
-                        'REG_att_is_going' => true,
-                        'REG_ID'           => $regid,
-                    ];
-                    $REG_OBJ                                              = EE_Registration::new_instance($reg_array);
-                    $this->_attendees[ $key ]['reg_objs'][ $regid ]       = $REG_OBJ;
-                    $this->_events[ $evtid ]['reg_objs'][]                = $REG_OBJ;
-                    $this->reg_objs[]                                     = $REG_OBJ;
-                    $this->tickets[ $ticket->ID() ]['reg_objs'][ $regid ] = $REG_OBJ;
-
-                    $regcnt++;
-                    $regid++;
-                }
-            }
-        }
-
-
-        // setup line items!
-        $line_item_total = EEH_Line_Item::create_total_line_item($this->txn);
-
-        // add tickets
-        foreach ($this->tickets as $item) {
-            $qty    = $item['count'];
-            $ticket = $item['ticket'];
-            EEH_Line_Item::add_ticket_purchase($line_item_total, $ticket, $qty);
-        }
-
-        $shipping_line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_name'       => esc_html__(
-                    'Shipping Surcharge',
-                    'event_espresso'
-                ),
-                'LIN_desc'       => esc_html__(
-                    'Sent via Millenium Falcon',
-                    'event_espresso'
-                ),
-                'LIN_unit_price' => 20,
-                'LIN_quantity'   => 1,
-                'LIN_is_taxable' => true,
-                'LIN_total'      => 20,
-                'LIN_type'       => EEM_Line_Item::type_line_item,
-            ]
-        );
-        EEH_Line_Item::add_item($line_item_total, $shipping_line_item);
-        $this->additional_line_items = [$shipping_line_item];
-
-        // now let's add taxes
-        EEH_Line_Item::apply_taxes($line_item_total);
-
-        // now we should be able to get the items we need from this object
-        $event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
-        $line_items       = [];
-        foreach ($event_line_items as $line_item) {
-            if (! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
-                continue;
-            }
-            $ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
-            foreach ($ticket_line_items as $ticket_line_item) {
-                if (! $ticket_line_item instanceof EE_Line_Item) {
-                    continue;
-                }
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['line_item']      = $ticket_line_item;
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['sub_line_items'] = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['children']              = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['EE_Ticket']             =
-                    $this->tickets[ $ticket_line_item->OBJ_ID() ]['ticket'];
-            }
-        }
-
-        $this->line_items_with_children = $line_items;
-        $this->tax_line_items           = $line_item_total->tax_descendants();
-
-        // add proper total to transaction object.
-        $grand_total                 = $line_item_total->recalculate_total_including_taxes();
-        $this->grand_total_line_item = $line_item_total;
-        $this->txn->set_total($grand_total);
-
-
-        // add additional details for each registration
-        foreach ($this->reg_objs as $reg) {
-            if (! $reg instanceof EE_Registration) {
-                continue;
-            }
-            $this->_registrations[ $reg->ID() ]['tkt_obj']  = $this->tickets[ $reg->get('TKT_ID') ]['ticket'];
-            $this->_registrations[ $reg->ID() ]['evt_obj']  = $this->_events[ $reg->get('EVT_ID') ]['event'];
-            $this->_registrations[ $reg->ID() ]['reg_obj']  = $reg;
-            $this->_registrations[ $reg->ID() ]['ans_objs'] = $this->_attendees[ $reg->get('ATT_ID') ]['ans_objs'];
-            $this->_registrations[ $reg->ID() ]['att_obj']  = $this->_attendees[ $reg->get('ATT_ID') ]['att_obj'];
-            $this->_registrations[ $reg->ID() ]['dtt_objs'] = $this->tickets[ $reg->get('TKT_ID') ]['dtt_objs'];
-        }
-
-
-        // events and attendees
-        $this->events        = $this->_events;
-        $this->attendees     = $this->_attendees;
-        $this->registrations = $this->_registrations;
-
-        $attendees_to_shift = $this->_attendees;
-
-        // setup primary attendee property
-        $this->primary_attendee_data = [
-            'fname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->fname()
-                : '',
-
-            'lname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->lname()
-                : '',
-
-            'email' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->email()
-                : '',
-
-            'att_obj' => $this->_attendees[999999991]['att_obj'],
-
-            'reg_obj' => array_shift($attendees_to_shift[999999991]['reg_objs']),
-        ];
-
-        // reg_info property
-        // note this isn't referenced by any shortcode parsers so we'll ignore for now.
-        $this->reg_info = [];
-
-        // let's set a reg_obj for messengers expecting one.
-        $this->reg_obj = array_shift($this->_attendees[999999991]['reg_objs']);
-
-        // the below are just dummy items.
-        $this->user_id     = 1;
-        $this->ip_address  = '192.0.2.1';
-        $this->user_agent  = '';
-        $this->init_access = time();
-        $this->last_access = time();
-    }
+	// some specific properties we need for this class
+	private $_events        = [];
+
+	private $_attendees     = [];
+
+	private $_registrations = [];
+
+
+	/**
+	 * For the constructor of this special preview class.  We're either looking for an event id or empty data.  If we
+	 * have an event id (or ids) then we'll use that as the source for the "dummy" data.  If the data is empty then
+	 * we'll get the first three published events from the users database and use that as a source.
+	 *
+	 * @param array $data
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($data = [])
+	{
+		$this->_data = isset($data['event_ids']) ? $data['event_ids'] : [];
+		$this->_setup_attendees_events();
+		parent::__construct($data);
+	}
+
+
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param array $data The incoming data to be prepped.
+	 *
+	 * @return array   The prepped data for db
+	 */
+	public static function convert_data_for_persistent_storage($data)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param array $data
+	 *
+	 * @return array
+	 */
+	public static function convert_data_from_persistent_storage($data)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * This will just setup the _events property in the expected format.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _setup_attendees_events()
+	{
+
+		// setup some attendee objects
+		$attendees = $this->_get_some_attendees();
+
+		// if empty $data we'll do a query to get some events from the server.
+		// otherwise we'll retrieve the event data for the given ids.
+		$events = $this->_get_some_events($this->_data);
+
+		$answers_n_questions = $this->_get_some_q_and_as();
+
+		if (count($events) < 1) {
+			throw new EE_Error(
+				esc_html__(
+					'We can\'t generate a preview for you because there are no active events in your database',
+					'event_espresso'
+				)
+			);
+		}
+
+
+		// now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
+		// we'll actually use the generated line_item identifiers for our loop
+		$dtts = $tkts = [];
+		foreach ($events as $id => $event) {
+			if (! $event instanceof EE_Event) {
+				continue;
+			}
+			$this->_events[ $id ]['ID']       = $id;
+			$this->_events[ $id ]['name']     = $event->get('EVT_name');
+			$datetime                         = $event->get_first_related('Datetime');
+			$tickets                          = $datetime instanceof EE_Datetime ? $datetime->get_many_related(
+				'Ticket',
+				['default_where_conditions' => 'none']
+			) : [];
+			$this->_events[ $id ]['event']    = $event;
+			$this->_events[ $id ]['reg_objs'] = [];
+			$this->_events[ $id ]['tkt_objs'] = $tickets;
+			$this->_events[ $id ]['dtt_objs'] = [];
+
+			$tkts     = [];
+			foreach ($tickets as $ticket) {
+				if (! $ticket instanceof EE_Ticket) {
+					continue;
+				}
+				$reldatetime                       = $ticket->datetimes();
+				$tkts[ $ticket->ID() ]             = [];
+				$tkts[ $ticket->ID() ]['ticket']   = $ticket;
+				$tkts[ $ticket->ID() ]['dtt_objs'] = $reldatetime;
+				$tkts[ $ticket->ID() ]['att_objs'] = $attendees;
+				$tkts[ $ticket->ID() ]['count']    = count($attendees);
+				$tkts[ $ticket->ID() ]['EE_Event'] = $event;
+				foreach ($reldatetime as $datetime) {
+					if ($datetime instanceof EE_Datetime && ! isset($dtts[ $datetime->ID() ])) {
+						$this->_events[ $id ]['dtt_objs'][ $datetime->ID() ] = $datetime;
+						$dtts[ $datetime->ID() ]['datetime']                 = $datetime;
+						$dtts[ $datetime->ID() ]['tkt_objs'][]               = $ticket;
+						$dtts[ $datetime->ID() ]['evt_objs'][]               = $event;
+					}
+				}
+			}
+
+			$this->_events[ $id ]['total_attendees'] = count($attendees);
+			$this->_events[ $id ]['att_objs']        = $attendees;
+
+			// let's also setup the dummy attendees property!
+			foreach ($attendees as $att_key => $attendee) {
+				if (! $attendee instanceof EE_Attendee) {
+					continue;
+				}
+				$this->_attendees[ $att_key ]['line_ref'][] =
+					$id;  // so later it can be determined what events this attendee registered for!
+				$this->_attendees[ $att_key ]['evt_objs'][] = $event;
+				$this->_attendees[ $att_key ]['att_obj']    = $attendee;
+				// $this->_attendees[$att_key]['registration_id'] = 0;
+				$this->_attendees[ $att_key ]['attendee_email'] = $attendee->email();
+				$this->_attendees[ $att_key ]['tkt_objs']       = $tickets;
+				if ($att_key == 999999991) {
+					$this->_attendees[ $att_key ]['ans_objs'][999]  = $answers_n_questions['answers'][999];
+					$this->_attendees[ $att_key ]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
+					$this->_attendees[ $att_key ]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
+				} elseif ($att_key == 999999992) {
+					$this->_attendees[ $att_key ]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
+					$this->_attendees[ $att_key ]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
+					$this->_attendees[ $att_key ]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
+				} elseif ($att_key == 999999993) {
+					$this->_attendees[ $att_key ]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
+					$this->_attendees[ $att_key ]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
+					$this->_attendees[ $att_key ]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
+				}
+			}
+		}
+
+		$this->tickets            = $tkts;
+		$this->datetimes          = $dtts;
+		$this->answers            = $answers_n_questions['answers'];
+		$this->questions          = $answers_n_questions['questions'];
+		$this->total_ticket_count = count($tkts) * count($this->_attendees);
+	}
+
+
+	/**
+	 * This just returns an array of dummy attendee objects that we'll use to attach to events for our preview data
+	 *
+	 * @access private
+	 * @return array an array of attendee objects
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	private function _get_some_attendees()
+	{
+		// let's just setup a dummy array of various attendee details
+		$dummy_attendees = [
+			0 => [
+				'Luke',
+				'Skywalker',
+				'farfaraway@galaxy.sp',
+				'804 Bantha Dr.',
+				'Complex 8',
+				'Mos Eisley',
+				32,
+				'US',
+				'f0r3e',
+				'222-333-4763',
+				false,
+				'999999991',
+			],
+			1 => [
+				'Princess',
+				'Leia',
+				'buns@fcn.al',
+				'1456 Valley Way Boulevard',
+				'Suite 9',
+				'Alderaan',
+				15,
+				'US',
+				'c1h2c',
+				'78-123-111-1111',
+				false,
+				'999999992',
+			],
+			2 => [
+				'Yoda',
+				'I Am',
+				'arrivenot@emailbad.fr',
+				'4th Tree',
+				'5th Knot',
+				'Marsh',
+				22,
+				'US',
+				'l18n',
+				'999-999-9999',
+				false,
+				'999999993',
+			],
+		];
+
+		// let's generate the attendee objects
+		$attendees = [];
+		$var_array = [
+			'fname',
+			'lname',
+			'email',
+			'address',
+			'address2',
+			'city',
+			'staid',
+			'cntry',
+			'zip',
+			'phone',
+			'deleted',
+			'attid',
+		];
+
+		// EE_Registry::instance()->load_class( 'Attendee', array(), FALSE, false, TRUE );
+		foreach ($dummy_attendees as $dummy) {
+			$att = array_combine($var_array, $dummy);
+			extract($att);
+			/** @var $fname string */
+			/** @var $lname string */
+			/** @var $address string */
+			/** @var $address2 string */
+			/** @var $city string */
+			/** @var $staid string */
+			/** @var $cntry string */
+			/** @var $zip string */
+			/** @var $email string */
+			/** @var $phone string */
+			/** @var $attid string */
+			$attendees[ $attid ] = EE_Attendee::new_instance(
+				[
+					'ATT_fname'    => $fname,
+					'ATT_lname'    => $lname,
+					'ATT_address'  => $address,
+					'ATT_address2' => $address2,
+					'ATT_city'     => $city,
+					'STA_ID'       => $staid,
+					'CNT_ISO'      => $cntry,
+					'ATT_zip'      => $zip,
+					'ATT_email'    => $email,
+					'ATT_phone'    => $phone,
+					'ATT_ID'       => $attid,
+				]
+			);
+		}
+
+		return $attendees;
+	}
+
+
+	/**
+	 * Return an array of dummy question objects indexed by answer id and dummy answer objects indexed by answer id.
+	 * This will be used in our dummy data setup
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_some_q_and_as()
+	{
+		$quests_array = [
+			0 => [
+				555,
+				esc_html__('What is your favorite planet?', 'event_espresso'),
+				0,
+			],
+			1 => [
+				556,
+				esc_html__('What is your favorite food?', 'event_espresso'),
+				0,
+			],
+			2 => [
+				557,
+				esc_html__('How many lightyears have you travelled', 'event_espresso'),
+				0,
+			],
+		];
+
+		$ans_array = [
+			0 => [
+				999,
+				555,
+				'Tattoine',
+			],
+			1 => [
+				1000,
+				555,
+				'Alderaan',
+			],
+			2 => [
+				1001,
+				555,
+				'Dantooine',
+			],
+			3 => [
+				1002,
+				556,
+				'Fish Fingers',
+			],
+			4 => [
+				1003,
+				556,
+				'Sushi',
+			],
+			5 => [
+				1004,
+				556,
+				'Water',
+			],
+			6 => [
+				1005,
+				557,
+				'A lot',
+			],
+			7 => [
+				1006,
+				557,
+				"That's none of your business.",
+			],
+			8 => [
+				1007,
+				557,
+				"People less travel me then.",
+			],
+		];
+
+		$qst_columns = ['QST_ID', 'QST_display_text', 'QST_system'];
+		$ans_columns = ['ANS_ID', 'QST_ID', 'ANS_value'];
+
+		// EE_Registry::instance()->load_class( 'Question', array(), FALSE, TRUE, TRUE );
+		// EE_Registry::instance()->load_class( 'Answer', array(), FALSE, TRUE, TRUE );
+
+		$qsts = [];
+		// first the questions
+		foreach ($quests_array as $qst) {
+			$qstobj                    = array_combine($qst_columns, $qst);
+			$qsts[ $qstobj['QST_ID'] ] = EE_Question::new_instance($qstobj);
+		}
+
+		// now the answers (and we'll setup our arrays)
+		$q_n_as = [];
+		foreach ($ans_array as $ans) {
+			$ansobj                               = array_combine($ans_columns, $ans);
+			$ansobj                               = EE_Answer::new_instance($ansobj);
+			$q_n_as['answers'][ $ansobj->ID() ]   = $ansobj;
+			$q_n_as['questions'][ $ansobj->ID() ] = $qsts[ $ansobj->get('QST_ID') ];
+		}
+
+		return $q_n_as;
+	}
+
+
+	/**
+	 * Return an array of event objects from the database
+	 *
+	 * If event ids are not included then we'll just retrieve the first published event from the database.
+	 *
+	 * @param array $event_ids if set, this will be an array of event ids to obtain events for.
+	 *
+	 * @return array    An array of event objects from the db.
+	 * @throws EE_Error
+	 */
+	private function _get_some_events(array $event_ids = [])
+	{
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		// if we have an evt_id then we want to make sure we use that for the preview
+		// (because a specific event template is being viewed);
+		$event_ids = $request->getRequestParam('evt_id', $event_ids, 'int', true);
+		// clear out any invalid IDs, like 0
+		$event_ids = array_filter($event_ids);
+		$limit     = ! empty($event_ids)
+			? null
+			: apply_filters('FHEE__EE_Messages_Preview_incoming_data___get_some_events__limit', '0,1');
+
+		$where = ! empty($event_ids)
+			? [
+				'EVT_ID'                 => ['IN', $event_ids],
+				'Datetime.Ticket.TKT_ID' => ['>', 1],
+			]
+			: ['Datetime.Ticket.TKT_ID' => ['>', 1]];
+
+		return EEM_Event::instance()->get_all([$where, 'limit' => $limit]);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _setup_data()
+	{
+		// need to figure out the running total for test purposes so... we're going to create a temp cart and add the tickets to it!
+		if (EE_Registry::instance()->SSN instanceof EE_Session) {
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+			$session = EE_Registry::instance()->SSN;
+		} else {
+			$session = EE_Registry::instance()->load_core('Session');
+		}
+		$cart = EE_Cart::instance(null, $session);
+
+		// add tickets to cart
+		foreach ($this->tickets as $ticket) {
+			$cart->add_ticket_to_cart($ticket['ticket']);
+		}
+
+		// setup txn property
+		$this->txn = EE_Transaction::new_instance(
+			[
+				'TXN_timestamp'    => time(), // unix timestamp
+				'TXN_total'        => 0, // txn_total
+				'TXN_paid'         => 0, // txn_paid
+				'STS_ID'           => EEM_Transaction::incomplete_status_code, // sts_id
+				'TXN_session_data' => null, // dump of txn session object (we're just going to leave blank here)
+				'TXN_hash_salt'    => null, // hash salt blank as well
+				'TXN_ID'           => 999999,
+			]
+		);
+
+
+		// setup reg_objects
+		// note we're setting up a reg object for each attendee in each event but ALSO adding to the reg_object array.
+		$this->reg_objs = [];
+		$regid          = 9999990;
+		foreach ($this->_attendees as $key => $attendee) {
+			// note we need to setup reg_objects for each event this attendee belongs to
+			$regatt = $attendee['att_obj'] instanceof EE_Attendee ? $attendee['att_obj']->ID() : null;
+			$regtxn = $this->txn->ID();
+			$regcnt = 1;
+			foreach ($attendee['line_ref'] as $evtid) {
+				foreach ($this->_events[ $evtid ]['tkt_objs'] as $ticket) {
+					if (! $ticket instanceof EE_Ticket) {
+						continue;
+					}
+					$reg_array                                            = [
+						'EVT_ID'           => $evtid,
+						'ATT_ID'           => $regatt,
+						'TXN_ID'           => $regtxn,
+						'TKT_ID'           => $ticket->ID(),
+						'STS_ID'           => RegStatus::PENDING_PAYMENT,
+						'REG_date'         => time(),
+						'REG_final_price'  => $ticket->get('TKT_price'),
+						'REG_session'      => 'dummy_session_id',
+						'REG_code'         => $regid . '-dummy-generated-code',
+						'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
+						'REG_count'        => $regcnt,
+						'REG_group_size'   => $this->_events[ $evtid ]['total_attendees'],
+						'REG_att_is_going' => true,
+						'REG_ID'           => $regid,
+					];
+					$REG_OBJ                                              = EE_Registration::new_instance($reg_array);
+					$this->_attendees[ $key ]['reg_objs'][ $regid ]       = $REG_OBJ;
+					$this->_events[ $evtid ]['reg_objs'][]                = $REG_OBJ;
+					$this->reg_objs[]                                     = $REG_OBJ;
+					$this->tickets[ $ticket->ID() ]['reg_objs'][ $regid ] = $REG_OBJ;
+
+					$regcnt++;
+					$regid++;
+				}
+			}
+		}
+
+
+		// setup line items!
+		$line_item_total = EEH_Line_Item::create_total_line_item($this->txn);
+
+		// add tickets
+		foreach ($this->tickets as $item) {
+			$qty    = $item['count'];
+			$ticket = $item['ticket'];
+			EEH_Line_Item::add_ticket_purchase($line_item_total, $ticket, $qty);
+		}
+
+		$shipping_line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_name'       => esc_html__(
+					'Shipping Surcharge',
+					'event_espresso'
+				),
+				'LIN_desc'       => esc_html__(
+					'Sent via Millenium Falcon',
+					'event_espresso'
+				),
+				'LIN_unit_price' => 20,
+				'LIN_quantity'   => 1,
+				'LIN_is_taxable' => true,
+				'LIN_total'      => 20,
+				'LIN_type'       => EEM_Line_Item::type_line_item,
+			]
+		);
+		EEH_Line_Item::add_item($line_item_total, $shipping_line_item);
+		$this->additional_line_items = [$shipping_line_item];
+
+		// now let's add taxes
+		EEH_Line_Item::apply_taxes($line_item_total);
+
+		// now we should be able to get the items we need from this object
+		$event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
+		$line_items       = [];
+		foreach ($event_line_items as $line_item) {
+			if (! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
+				continue;
+			}
+			$ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
+			foreach ($ticket_line_items as $ticket_line_item) {
+				if (! $ticket_line_item instanceof EE_Line_Item) {
+					continue;
+				}
+				$this->tickets[ $ticket_line_item->OBJ_ID() ]['line_item']      = $ticket_line_item;
+				$this->tickets[ $ticket_line_item->OBJ_ID() ]['sub_line_items'] = $ticket_line_item->children();
+				$line_items[ $ticket_line_item->ID() ]['children']              = $ticket_line_item->children();
+				$line_items[ $ticket_line_item->ID() ]['EE_Ticket']             =
+					$this->tickets[ $ticket_line_item->OBJ_ID() ]['ticket'];
+			}
+		}
+
+		$this->line_items_with_children = $line_items;
+		$this->tax_line_items           = $line_item_total->tax_descendants();
+
+		// add proper total to transaction object.
+		$grand_total                 = $line_item_total->recalculate_total_including_taxes();
+		$this->grand_total_line_item = $line_item_total;
+		$this->txn->set_total($grand_total);
+
+
+		// add additional details for each registration
+		foreach ($this->reg_objs as $reg) {
+			if (! $reg instanceof EE_Registration) {
+				continue;
+			}
+			$this->_registrations[ $reg->ID() ]['tkt_obj']  = $this->tickets[ $reg->get('TKT_ID') ]['ticket'];
+			$this->_registrations[ $reg->ID() ]['evt_obj']  = $this->_events[ $reg->get('EVT_ID') ]['event'];
+			$this->_registrations[ $reg->ID() ]['reg_obj']  = $reg;
+			$this->_registrations[ $reg->ID() ]['ans_objs'] = $this->_attendees[ $reg->get('ATT_ID') ]['ans_objs'];
+			$this->_registrations[ $reg->ID() ]['att_obj']  = $this->_attendees[ $reg->get('ATT_ID') ]['att_obj'];
+			$this->_registrations[ $reg->ID() ]['dtt_objs'] = $this->tickets[ $reg->get('TKT_ID') ]['dtt_objs'];
+		}
+
+
+		// events and attendees
+		$this->events        = $this->_events;
+		$this->attendees     = $this->_attendees;
+		$this->registrations = $this->_registrations;
+
+		$attendees_to_shift = $this->_attendees;
+
+		// setup primary attendee property
+		$this->primary_attendee_data = [
+			'fname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->fname()
+				: '',
+
+			'lname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->lname()
+				: '',
+
+			'email' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->email()
+				: '',
+
+			'att_obj' => $this->_attendees[999999991]['att_obj'],
+
+			'reg_obj' => array_shift($attendees_to_shift[999999991]['reg_objs']),
+		];
+
+		// reg_info property
+		// note this isn't referenced by any shortcode parsers so we'll ignore for now.
+		$this->reg_info = [];
+
+		// let's set a reg_obj for messengers expecting one.
+		$this->reg_obj = array_shift($this->_attendees[999999991]['reg_objs']);
+
+		// the below are just dummy items.
+		$this->user_id     = 1;
+		$this->ip_address  = '192.0.2.1';
+		$this->user_agent  = '';
+		$this->init_access = time();
+		$this->last_access = time();
+	}
 }