eventespresso / event-espresso-core

espresso.php

Indentation +107 added lines, -107 removed lines

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

PaymentMethods/PayPalCommerce/api/orders/CreateOrder.php

Indentation +457 added lines, -457 removed lines

@@ -36,461 +36,461 @@
  */
 class CreateOrder extends OrdersApi
 {
-    /**
-     * Line items total.
-     *
-     * @var float
-     */
-    protected float $items_total = 0.0;
-
-    /**
-     * Promotions total.
-     *
-     * @var float
-     */
-    protected float $promos_total = 0.0;
-
-    /**
-     * Tax total.
-     *
-     * @var float
-     */
-    protected float $tax_total = 0.0;
-
-    /**
-     * Currency.
-     *
-     * @var string
-     */
-    protected string $currency_code;
-
-    /**
-     * Billing info.
-     *
-     * @var array
-     */
-    protected array $billing_info;
-
-    /**
-     * Transaction this order is for.
-     *
-     * @var EE_Transaction
-     */
-    protected EE_Transaction     $transaction;
-
-    private FeatureFlags         $feature;
-
-    private GatewayDataFormatter $gateway_data_formatter;
-
-    private EE_Payment           $payment;
-
-
-    /**
-     * CreateOrder constructor.
-     *
-     * @param PayPalApi      $api
-     * @param EE_Transaction $transaction
-     * @param array          $billing_info
-     * @param FeatureFlags   $feature
-     */
-    public function __construct(
-        PayPalApi            $api,
-        EE_Transaction       $transaction,
-        array                $billing_info,
-        FeatureFlags         $feature,
-        GatewayDataFormatter $gateway_data_formatter
-    ) {
-        parent::__construct($api);
-        $this->transaction   = $transaction;
-        $this->feature       = $feature;
-        $this->currency_code = CurrencyManager::currencyCode();
-        $this->sanitizeRequestParameters($billing_info);
-        $this->gateway_data_formatter = $gateway_data_formatter;
-        $this->setPaymentPlaceholder();
-    }
-
-
-    /**
-     * Sanitize the array of billing form data.
-     *
-     * @param array $billing_info
-     * @return void
-     */
-    public function sanitizeRequestParameters(array $billing_info): void
-    {
-        $sanitizer = new RequestSanitizer(new Basic());
-        foreach ($billing_info as $item => $value) {
-            $this->billing_info[ $item ] = $sanitizer->clean($value);
-        }
-    }
-
-
-    /**
-     * Create PayPal Order.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create(): array
-    {
-        $order_parameters = $this->getParameters();
-        // Create Order request.
-        $create_response = $this->api->sendRequest($order_parameters, $this->request_url);
-        // Check for MISMATCH errors.
-        if ($this->isMismatchError($create_response)) {
-            // Mismatch, fix items.
-            $order_parameters['purchase_units'][0]['items'] = $this->getSimplifiedItems();
-            // Add simplified breakdown.
-            $order_parameters['purchase_units'][0]['amount']['breakdown'] = $this->getSimplifiedAmountBreakdown();
-            // Retry Order request.
-            $create_response = $this->api->sendRequest($order_parameters, $this->request_url);
-        }
-        return $this->validateOrder($create_response, $order_parameters);
-    }
-
-
-    /**
-     * Form order parameters.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    protected function getParameters(): array
-    {
-        $registrant  = $this->transaction->primary_registration();
-        $attendee    = $registrant->attendee();
-        $description = $this->gateway_data_formatter->formatOrderDescription($this->payment);
-        $parameters  = [
-            'intent'         => 'CAPTURE',
-            'purchase_units' => [
-                [
-                    'custom_id'   => $this->transaction->ID(),
-                    'description' => substr(wp_strip_all_tags($description), 0, 125),
-                    'items'       => $this->getLineItems(),
-                    'amount'      => [
-                        'value'         => (string) CurrencyManager::normalizeValue($this->transaction->remaining()),
-                        'currency_code' => $this->currency_code,
-                        'breakdown'     => $this->getBreakdown(),
-                    ],
-                ],
-            ],
-            'payment_source' => [
-                'paypal' => [
-                    'experience_context' => [
-                        'user_action' => 'PAY_NOW',
-                    ],
-                    'email_address'      => $attendee->email(),
-                    'name'               => [
-                        'given_name' => $attendee->fname(),
-                        'surname'    => $attendee->lname(),
-                    ],
-                ],
-            ],
-        ];
-        $CNT_ISO     = $attendee->country_ID();
-
-        // No country ID set, maybe just state?
-        if (empty($CNT_ISO)) {
-            $state_obj = $attendee->state_obj();
-            if ($state_obj instanceof EE_State) {
-                $CNT_ISO = $state_obj->country_iso();
-            }
-        }
-
-        if (strlen($CNT_ISO > 2)) {
-            // uh-oh... did someone save the country name for the ISO?
-            $country = EEM_Country::instance()->getCountryByName(ucwords(strtolower($CNT_ISO)));
-            if ($country instanceof EE_Country) {
-                $CNT_ISO = $country->ISO();
-            }
-        }
-
-        // If we have and address on the attendee, send it to PayPal.
-        if ($CNT_ISO && strlen($CNT_ISO == 2)) {
-            $parameters['payment_source']['paypal']['address'] = [
-                'address_line_1' => $attendee->address(),
-                'address_line_2' => $attendee->address2(),
-                'admin_area_2'   => $attendee->city(),
-                'admin_area_1'   => $attendee->state_abbrev(),
-                'postal_code'    => $attendee->zip(),
-                'country_code'   => $attendee->country_ID(),
-            ];
-        }
-
-        // Do we have the permissions for the fees ?
-        $scopes = PayPalExtraMetaManager::getPmOption(
-            $this->transaction->payment_method(),
-            Domain::META_KEY_AUTHORIZED_SCOPES
-        );
-        if (
-            (
-                (defined('EE_PPC_USE_PAYMENT_FEES') && EE_PPC_USE_PAYMENT_FEES)
-                || (! defined('EE_PPC_USE_PAYMENT_FEES')
-                    && $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
-                )
-            )
-            && ! empty($scopes)
-            && in_array('partnerfee', $scopes)
-        ) {
-            /** @var PartnerPaymentFees $payment_fees */
-            $payment_fees = LoaderFactory::getShared(PartnerPaymentFees::class);
-            $parameters['purchase_units'][0]['payment_instruction'] = [
-                'platform_fees' => [
-                    [
-                        'amount' => [
-                            'value'         => (string) $payment_fees->getPartnerFee($this->transaction),
-                            'currency_code' => $this->currency_code,
-                        ],
-                    ],
-                ],
-            ];
-        }
-        return $parameters;
-    }
-
-
-    /**
-     * Itemize the payment. List all the line items, discounts and taxes.
-     *
-     * @return array
-     * @throws EE_Error|ReflectionException
-     */
-    protected function getLineItems(): array
-    {
-        // Order line items.
-        $line_items       = [];
-        $event_line_items = $this->transaction->items_purchased();
-        // List actual line items.
-        foreach ($event_line_items as $line_item) {
-            if (
-                $line_item instanceof EE_Line_Item
-                && $line_item->OBJ_type() !== 'Promotion'
-                && $line_item->quantity() > 0
-            ) {
-                $item_money    = CurrencyManager::normalizeValue($line_item->unit_price());
-                $line_items [] = [
-                    'name'        => substr(
-                        wp_strip_all_tags(
-                            $this->gateway_data_formatter->formatLineItemName($line_item, $this->payment)
-                        ),
-                        0,
-                        125
-                    ),
-                    'quantity'    => $line_item->quantity(),
-                    'description' => substr(
-                        wp_strip_all_tags(
-                            $this->gateway_data_formatter->formatLineItemDesc($line_item, $this->payment)
-                        ),
-                        0,
-                        125
-                    ),
-                    'unit_amount' => [
-                        'currency_code' => $this->currency_code,
-                        'value'         => (string) $item_money,
-                    ],
-                    'category'    => 'DIGITAL_GOODS',
-                ];
-                // Line item total.
-                $this->items_total += $line_item->pretaxTotal();
-            } elseif ($line_item->OBJ_type() === 'Promotion' && $line_item->quantity() > 0) {
-                // Promotions total.
-                $this->promos_total += $line_item->total();
-            }
-        }
-        // Make sure we have an absolute number with only two decimal laces.
-        $this->items_total  = CurrencyManager::normalizeValue($this->items_total);
-        $this->promos_total = CurrencyManager::normalizeValue($this->promos_total);
-        // If this is a partial payment, apply the paid amount as a promo.
-        if ($this->transaction->paid() > 0) {
-            $this->promos_total += CurrencyManager::normalizeValue($this->transaction->paid());
-        }
-        $this->countTaxTotal();
-        return $line_items;
-    }
-
-
-    /**
-     * Count the tax total.
-     *
-     * @return void
-     * @throws EE_Error|ReflectionException
-     */
-    protected function countTaxTotal(): void
-    {
-        // List taxes.
-        $this->tax_total = 0.0;
-        $tax_items       = $this->transaction->tax_items();
-        foreach ($tax_items as $tax_item) {
-            $this->tax_total += $tax_item->total();
-        }
-        $this->tax_total = CurrencyManager::normalizeValue($this->tax_total);
-    }
-
-
-    /**
-     * Itemize the payment the breakdown list.
-     *
-     * @return array
-     */
-    protected function getBreakdown(): array
-    {
-        $breakdown['item_total'] = [
-            'currency_code' => $this->currency_code,
-            'value'         => (string) $this->items_total,
-        ];
-        $breakdown['tax_total']  = [
-            'currency_code' => $this->currency_code,
-            'value'         => (string) $this->tax_total,
-        ];
-        $breakdown['discount']   = [
-            'currency_code' => $this->currency_code,
-            'value'         => (string) abs($this->promos_total),
-        ];
-        return $breakdown;
-    }
-
-
-    /**
-     * Makes sure that we have received an Order back from the API call.
-     *
-     * @param $response
-     * @param $parameters
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function validateOrder($response, $parameters): array
-    {
-        PayPalLogger::errorLog(
-            esc_html__('Validating Order Create:', 'event_espresso'),
-            [$this->request_url, $response],
-            $this->transaction->payment_method(),
-            false,
-            $this->transaction
-        );
-        if (! empty($response['error'])) {
-            return $response;
-        }
-        if (! isset($response['id'])) {
-            $message = esc_html__('Unexpected response. Unable to find the order.', 'event_espresso');
-            try {
-                PayPalLogger::errorLog(
-                    $message,
-                    [$this->request_url, $parameters, $response],
-                    $this->transaction->payment_method()
-                );
-            } catch (EE_Error|ReflectionException $e) {
-                error_log("PayPalLogger Error: $message: " . json_encode($response));
-            }
-            return [
-                'error'    => $response['error'] ?? 'missing_order',
-                'message'  => $response['message'] ?? $message,
-                'response' => $response,
-            ];
-        }
-        return $response;
-    }
-
-
-    /**
-     * Check if PayPals response contains 'MISMATCH' errors.
-     *
-     * @return bool
-     */
-    public function isMismatchError($response): bool
-    {
-        if (! isset($response['details']) || ! is_array($response['details'])) {
-            return false;
-        }
-
-        foreach ($response['details'] as $detail) {
-            if (! empty($detail['issue'])) {
-                if (
-                    strtoupper($detail['issue']) === 'ITEM_TOTAL_MISMATCH'
-                    || strtoupper($detail['issue']) === 'AMOUNT_MISMATCH'
-                ) {
-                    PayPalLogger::errorLog(
-                        esc_html__('Mistmatch Error:', 'event_espresso'),
-                        [$this->request_url, $response],
-                        $this->transaction->payment_method(),
-                        false,
-                        $this->transaction
-                    );
-                    return true;
-                }
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Itemize the simplified payment breakdown list.
-     *
-     * @return array
-     */
-    protected function getSimplifiedAmountBreakdown(): array
-    {
-        $tax_total               = $this->transaction->tax_total();
-        $breakdown['item_total'] = [
-            'currency_code' => $this->currency_code,
-            'value'         => (string) CurrencyManager::normalizeValue($this->transaction->remaining() - $tax_total),
-        ];
-        if ($tax_total > 0) {
-            $breakdown['tax_total'] = [
-                'currency_code' => $this->currency_code,
-                'value'         => (string) CurrencyManager::normalizeValue($tax_total),
-            ];
-        }
-        return $breakdown;
-    }
-
-
-    /**
-     * Generate single line item for full order.
-     *
-     * @return array
-     */
-    protected function getSimplifiedItems(): array
-    {
-        // Simplified single line item.
-        $line_items           = [];
-        $primary_registrant   = $this->transaction->primary_registration();
-        $event_obj            = $primary_registrant->event_obj();
-        $name_and_description = $this->gateway_data_formatter->formatOrderDescription($this->payment);
-
-        $line_items[] = [
-            'name'        => substr(wp_strip_all_tags($name_and_description), 0, 125),
-            'quantity'    => 1,
-            'description' => substr(wp_strip_all_tags($name_and_description), 0, 2047),
-            'unit_amount' => [
-                'currency_code' => $this->currency_code,
-                'value'         => (string) CurrencyManager::normalizeValue(
-                    $this->transaction->remaining() - $this->transaction->tax_total()
-                ),
-            ],
-            'category'    => 'DIGITAL_GOODS',
-        ];
-        return $line_items;
-    }
-
-
-    /**
-     * Generates an EE_Payment object but doesn't save it.
-     */
-    private function setPaymentPlaceholder(): void
-    {
-        $this->payment = EE_Payment::new_instance(
-            [
-                'STS_ID'        => EEM_Payment::status_id_pending,
-                'TXN_ID'        => $this->transaction->ID(),
-                'PMD_ID'        => $this->transaction->payment_method_ID(),
-                'PAY_amount'    => 0.00,
-                'PAY_timestamp' => time(),
-            ]
-        );
-    }
+	/**
+	 * Line items total.
+	 *
+	 * @var float
+	 */
+	protected float $items_total = 0.0;
+
+	/**
+	 * Promotions total.
+	 *
+	 * @var float
+	 */
+	protected float $promos_total = 0.0;
+
+	/**
+	 * Tax total.
+	 *
+	 * @var float
+	 */
+	protected float $tax_total = 0.0;
+
+	/**
+	 * Currency.
+	 *
+	 * @var string
+	 */
+	protected string $currency_code;
+
+	/**
+	 * Billing info.
+	 *
+	 * @var array
+	 */
+	protected array $billing_info;
+
+	/**
+	 * Transaction this order is for.
+	 *
+	 * @var EE_Transaction
+	 */
+	protected EE_Transaction     $transaction;
+
+	private FeatureFlags         $feature;
+
+	private GatewayDataFormatter $gateway_data_formatter;
+
+	private EE_Payment           $payment;
+
+
+	/**
+	 * CreateOrder constructor.
+	 *
+	 * @param PayPalApi      $api
+	 * @param EE_Transaction $transaction
+	 * @param array          $billing_info
+	 * @param FeatureFlags   $feature
+	 */
+	public function __construct(
+		PayPalApi            $api,
+		EE_Transaction       $transaction,
+		array                $billing_info,
+		FeatureFlags         $feature,
+		GatewayDataFormatter $gateway_data_formatter
+	) {
+		parent::__construct($api);
+		$this->transaction   = $transaction;
+		$this->feature       = $feature;
+		$this->currency_code = CurrencyManager::currencyCode();
+		$this->sanitizeRequestParameters($billing_info);
+		$this->gateway_data_formatter = $gateway_data_formatter;
+		$this->setPaymentPlaceholder();
+	}
+
+
+	/**
+	 * Sanitize the array of billing form data.
+	 *
+	 * @param array $billing_info
+	 * @return void
+	 */
+	public function sanitizeRequestParameters(array $billing_info): void
+	{
+		$sanitizer = new RequestSanitizer(new Basic());
+		foreach ($billing_info as $item => $value) {
+			$this->billing_info[ $item ] = $sanitizer->clean($value);
+		}
+	}
+
+
+	/**
+	 * Create PayPal Order.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create(): array
+	{
+		$order_parameters = $this->getParameters();
+		// Create Order request.
+		$create_response = $this->api->sendRequest($order_parameters, $this->request_url);
+		// Check for MISMATCH errors.
+		if ($this->isMismatchError($create_response)) {
+			// Mismatch, fix items.
+			$order_parameters['purchase_units'][0]['items'] = $this->getSimplifiedItems();
+			// Add simplified breakdown.
+			$order_parameters['purchase_units'][0]['amount']['breakdown'] = $this->getSimplifiedAmountBreakdown();
+			// Retry Order request.
+			$create_response = $this->api->sendRequest($order_parameters, $this->request_url);
+		}
+		return $this->validateOrder($create_response, $order_parameters);
+	}
+
+
+	/**
+	 * Form order parameters.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	protected function getParameters(): array
+	{
+		$registrant  = $this->transaction->primary_registration();
+		$attendee    = $registrant->attendee();
+		$description = $this->gateway_data_formatter->formatOrderDescription($this->payment);
+		$parameters  = [
+			'intent'         => 'CAPTURE',
+			'purchase_units' => [
+				[
+					'custom_id'   => $this->transaction->ID(),
+					'description' => substr(wp_strip_all_tags($description), 0, 125),
+					'items'       => $this->getLineItems(),
+					'amount'      => [
+						'value'         => (string) CurrencyManager::normalizeValue($this->transaction->remaining()),
+						'currency_code' => $this->currency_code,
+						'breakdown'     => $this->getBreakdown(),
+					],
+				],
+			],
+			'payment_source' => [
+				'paypal' => [
+					'experience_context' => [
+						'user_action' => 'PAY_NOW',
+					],
+					'email_address'      => $attendee->email(),
+					'name'               => [
+						'given_name' => $attendee->fname(),
+						'surname'    => $attendee->lname(),
+					],
+				],
+			],
+		];
+		$CNT_ISO     = $attendee->country_ID();
+
+		// No country ID set, maybe just state?
+		if (empty($CNT_ISO)) {
+			$state_obj = $attendee->state_obj();
+			if ($state_obj instanceof EE_State) {
+				$CNT_ISO = $state_obj->country_iso();
+			}
+		}
+
+		if (strlen($CNT_ISO > 2)) {
+			// uh-oh... did someone save the country name for the ISO?
+			$country = EEM_Country::instance()->getCountryByName(ucwords(strtolower($CNT_ISO)));
+			if ($country instanceof EE_Country) {
+				$CNT_ISO = $country->ISO();
+			}
+		}
+
+		// If we have and address on the attendee, send it to PayPal.
+		if ($CNT_ISO && strlen($CNT_ISO == 2)) {
+			$parameters['payment_source']['paypal']['address'] = [
+				'address_line_1' => $attendee->address(),
+				'address_line_2' => $attendee->address2(),
+				'admin_area_2'   => $attendee->city(),
+				'admin_area_1'   => $attendee->state_abbrev(),
+				'postal_code'    => $attendee->zip(),
+				'country_code'   => $attendee->country_ID(),
+			];
+		}
+
+		// Do we have the permissions for the fees ?
+		$scopes = PayPalExtraMetaManager::getPmOption(
+			$this->transaction->payment_method(),
+			Domain::META_KEY_AUTHORIZED_SCOPES
+		);
+		if (
+			(
+				(defined('EE_PPC_USE_PAYMENT_FEES') && EE_PPC_USE_PAYMENT_FEES)
+				|| (! defined('EE_PPC_USE_PAYMENT_FEES')
+					&& $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
+				)
+			)
+			&& ! empty($scopes)
+			&& in_array('partnerfee', $scopes)
+		) {
+			/** @var PartnerPaymentFees $payment_fees */
+			$payment_fees = LoaderFactory::getShared(PartnerPaymentFees::class);
+			$parameters['purchase_units'][0]['payment_instruction'] = [
+				'platform_fees' => [
+					[
+						'amount' => [
+							'value'         => (string) $payment_fees->getPartnerFee($this->transaction),
+							'currency_code' => $this->currency_code,
+						],
+					],
+				],
+			];
+		}
+		return $parameters;
+	}
+
+
+	/**
+	 * Itemize the payment. List all the line items, discounts and taxes.
+	 *
+	 * @return array
+	 * @throws EE_Error|ReflectionException
+	 */
+	protected function getLineItems(): array
+	{
+		// Order line items.
+		$line_items       = [];
+		$event_line_items = $this->transaction->items_purchased();
+		// List actual line items.
+		foreach ($event_line_items as $line_item) {
+			if (
+				$line_item instanceof EE_Line_Item
+				&& $line_item->OBJ_type() !== 'Promotion'
+				&& $line_item->quantity() > 0
+			) {
+				$item_money    = CurrencyManager::normalizeValue($line_item->unit_price());
+				$line_items [] = [
+					'name'        => substr(
+						wp_strip_all_tags(
+							$this->gateway_data_formatter->formatLineItemName($line_item, $this->payment)
+						),
+						0,
+						125
+					),
+					'quantity'    => $line_item->quantity(),
+					'description' => substr(
+						wp_strip_all_tags(
+							$this->gateway_data_formatter->formatLineItemDesc($line_item, $this->payment)
+						),
+						0,
+						125
+					),
+					'unit_amount' => [
+						'currency_code' => $this->currency_code,
+						'value'         => (string) $item_money,
+					],
+					'category'    => 'DIGITAL_GOODS',
+				];
+				// Line item total.
+				$this->items_total += $line_item->pretaxTotal();
+			} elseif ($line_item->OBJ_type() === 'Promotion' && $line_item->quantity() > 0) {
+				// Promotions total.
+				$this->promos_total += $line_item->total();
+			}
+		}
+		// Make sure we have an absolute number with only two decimal laces.
+		$this->items_total  = CurrencyManager::normalizeValue($this->items_total);
+		$this->promos_total = CurrencyManager::normalizeValue($this->promos_total);
+		// If this is a partial payment, apply the paid amount as a promo.
+		if ($this->transaction->paid() > 0) {
+			$this->promos_total += CurrencyManager::normalizeValue($this->transaction->paid());
+		}
+		$this->countTaxTotal();
+		return $line_items;
+	}
+
+
+	/**
+	 * Count the tax total.
+	 *
+	 * @return void
+	 * @throws EE_Error|ReflectionException
+	 */
+	protected function countTaxTotal(): void
+	{
+		// List taxes.
+		$this->tax_total = 0.0;
+		$tax_items       = $this->transaction->tax_items();
+		foreach ($tax_items as $tax_item) {
+			$this->tax_total += $tax_item->total();
+		}
+		$this->tax_total = CurrencyManager::normalizeValue($this->tax_total);
+	}
+
+
+	/**
+	 * Itemize the payment the breakdown list.
+	 *
+	 * @return array
+	 */
+	protected function getBreakdown(): array
+	{
+		$breakdown['item_total'] = [
+			'currency_code' => $this->currency_code,
+			'value'         => (string) $this->items_total,
+		];
+		$breakdown['tax_total']  = [
+			'currency_code' => $this->currency_code,
+			'value'         => (string) $this->tax_total,
+		];
+		$breakdown['discount']   = [
+			'currency_code' => $this->currency_code,
+			'value'         => (string) abs($this->promos_total),
+		];
+		return $breakdown;
+	}
+
+
+	/**
+	 * Makes sure that we have received an Order back from the API call.
+	 *
+	 * @param $response
+	 * @param $parameters
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function validateOrder($response, $parameters): array
+	{
+		PayPalLogger::errorLog(
+			esc_html__('Validating Order Create:', 'event_espresso'),
+			[$this->request_url, $response],
+			$this->transaction->payment_method(),
+			false,
+			$this->transaction
+		);
+		if (! empty($response['error'])) {
+			return $response;
+		}
+		if (! isset($response['id'])) {
+			$message = esc_html__('Unexpected response. Unable to find the order.', 'event_espresso');
+			try {
+				PayPalLogger::errorLog(
+					$message,
+					[$this->request_url, $parameters, $response],
+					$this->transaction->payment_method()
+				);
+			} catch (EE_Error|ReflectionException $e) {
+				error_log("PayPalLogger Error: $message: " . json_encode($response));
+			}
+			return [
+				'error'    => $response['error'] ?? 'missing_order',
+				'message'  => $response['message'] ?? $message,
+				'response' => $response,
+			];
+		}
+		return $response;
+	}
+
+
+	/**
+	 * Check if PayPals response contains 'MISMATCH' errors.
+	 *
+	 * @return bool
+	 */
+	public function isMismatchError($response): bool
+	{
+		if (! isset($response['details']) || ! is_array($response['details'])) {
+			return false;
+		}
+
+		foreach ($response['details'] as $detail) {
+			if (! empty($detail['issue'])) {
+				if (
+					strtoupper($detail['issue']) === 'ITEM_TOTAL_MISMATCH'
+					|| strtoupper($detail['issue']) === 'AMOUNT_MISMATCH'
+				) {
+					PayPalLogger::errorLog(
+						esc_html__('Mistmatch Error:', 'event_espresso'),
+						[$this->request_url, $response],
+						$this->transaction->payment_method(),
+						false,
+						$this->transaction
+					);
+					return true;
+				}
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Itemize the simplified payment breakdown list.
+	 *
+	 * @return array
+	 */
+	protected function getSimplifiedAmountBreakdown(): array
+	{
+		$tax_total               = $this->transaction->tax_total();
+		$breakdown['item_total'] = [
+			'currency_code' => $this->currency_code,
+			'value'         => (string) CurrencyManager::normalizeValue($this->transaction->remaining() - $tax_total),
+		];
+		if ($tax_total > 0) {
+			$breakdown['tax_total'] = [
+				'currency_code' => $this->currency_code,
+				'value'         => (string) CurrencyManager::normalizeValue($tax_total),
+			];
+		}
+		return $breakdown;
+	}
+
+
+	/**
+	 * Generate single line item for full order.
+	 *
+	 * @return array
+	 */
+	protected function getSimplifiedItems(): array
+	{
+		// Simplified single line item.
+		$line_items           = [];
+		$primary_registrant   = $this->transaction->primary_registration();
+		$event_obj            = $primary_registrant->event_obj();
+		$name_and_description = $this->gateway_data_formatter->formatOrderDescription($this->payment);
+
+		$line_items[] = [
+			'name'        => substr(wp_strip_all_tags($name_and_description), 0, 125),
+			'quantity'    => 1,
+			'description' => substr(wp_strip_all_tags($name_and_description), 0, 2047),
+			'unit_amount' => [
+				'currency_code' => $this->currency_code,
+				'value'         => (string) CurrencyManager::normalizeValue(
+					$this->transaction->remaining() - $this->transaction->tax_total()
+				),
+			],
+			'category'    => 'DIGITAL_GOODS',
+		];
+		return $line_items;
+	}
+
+
+	/**
+	 * Generates an EE_Payment object but doesn't save it.
+	 */
+	private function setPaymentPlaceholder(): void
+	{
+		$this->payment = EE_Payment::new_instance(
+			[
+				'STS_ID'        => EEM_Payment::status_id_pending,
+				'TXN_ID'        => $this->transaction->ID(),
+				'PMD_ID'        => $this->transaction->payment_method_ID(),
+				'PAY_amount'    => 0.00,
+				'PAY_timestamp' => time(),
+			]
+		);
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -120,7 +120,7 @@ 
     {
         $sanitizer = new RequestSanitizer(new Basic());
         foreach ($billing_info as $item => $value) {
-            $this->billing_info[ $item ] = $sanitizer->clean($value);
+            $this->billing_info[$item] = $sanitizer->clean($value);
         }
     }
 
@@ -190,7 +190,7 @@ 
                 ],
             ],
         ];
-        $CNT_ISO     = $attendee->country_ID();
+        $CNT_ISO = $attendee->country_ID();
 
         // No country ID set, maybe just state?
         if (empty($CNT_ISO)) {
@@ -228,7 +228,7 @@ 
         if (
             (
                 (defined('EE_PPC_USE_PAYMENT_FEES') && EE_PPC_USE_PAYMENT_FEES)
-                || (! defined('EE_PPC_USE_PAYMENT_FEES')
+                || ( ! defined('EE_PPC_USE_PAYMENT_FEES')
                     && $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
                 )
             )
@@ -341,11 +341,11 @@ 
             'currency_code' => $this->currency_code,
             'value'         => (string) $this->items_total,
         ];
-        $breakdown['tax_total']  = [
+        $breakdown['tax_total'] = [
             'currency_code' => $this->currency_code,
             'value'         => (string) $this->tax_total,
         ];
-        $breakdown['discount']   = [
+        $breakdown['discount'] = [
             'currency_code' => $this->currency_code,
             'value'         => (string) abs($this->promos_total),
         ];
@@ -371,10 +371,10 @@ 
             false,
             $this->transaction
         );
-        if (! empty($response['error'])) {
+        if ( ! empty($response['error'])) {
             return $response;
         }
-        if (! isset($response['id'])) {
+        if ( ! isset($response['id'])) {
             $message = esc_html__('Unexpected response. Unable to find the order.', 'event_espresso');
             try {
                 PayPalLogger::errorLog(
@@ -382,8 +382,8 @@ 
                     [$this->request_url, $parameters, $response],
                     $this->transaction->payment_method()
                 );
-            } catch (EE_Error|ReflectionException $e) {
-                error_log("PayPalLogger Error: $message: " . json_encode($response));
+            } catch (EE_Error | ReflectionException $e) {
+                error_log("PayPalLogger Error: $message: ".json_encode($response));
             }
             return [
                 'error'    => $response['error'] ?? 'missing_order',
@@ -402,12 +402,12 @@ 
      */
     public function isMismatchError($response): bool
     {
-        if (! isset($response['details']) || ! is_array($response['details'])) {
+        if ( ! isset($response['details']) || ! is_array($response['details'])) {
             return false;
         }
 
         foreach ($response['details'] as $detail) {
-            if (! empty($detail['issue'])) {
+            if ( ! empty($detail['issue'])) {
                 if (
                     strtoupper($detail['issue']) === 'ITEM_TOTAL_MISMATCH'
                     || strtoupper($detail['issue']) === 'AMOUNT_MISMATCH'

PaymentMethods/PayPalCommerce/domain/Domain.php

Indentation +193 added lines, -193 removed lines

@@ -17,197 +17,197 @@
  */
 class Domain
 {
-    /**
-     * Name of the extra meta key that stores this PM options as one meta.
-     */
-    public const META_KEY_PAYPAL_DATA = 'paypal_data';
-    /**
-     * Name of the extra meta key that stores this PM options as one meta.
-     */
-    public const META_KEY_PAYPAL_DATA_SANDBOX = 'paypal_data_sandbox';
-
-    /**
-     * Name of the extra meta that stores whether the credentials were for the sandbox or live mode.
-     */
-    public const META_KEY_SANDBOX_MODE = 'sandbox_mode';
-
-    /**
-     * Name of the extra meta that stores the Access Token that is used to auth in API requests to PayPal.
-     */
-    public const META_KEY_ACCESS_TOKEN = 'access_token';
-
-    /**
-     * Name of the extra meta that stores the last request tracking ID.
-     */
-    public const META_KEY_TRACKING_ID = 'tracking_id';
-
-    /**
-     * Name of the extra meta that stores the Event Espresso PayPal Account's merchant id.
-     */
-    public const META_KEY_APP_ID = 'app_id';
-
-    /**
-     * Name of the extra meta that holds the seller client ID.
-     */
-    public const META_KEY_CLIENT_ID = 'client_id';
-
-    /**
-     * Name of the extra meta that holds the seller secret.
-     */
-    public const META_KEY_CLIENT_SECRET = 'client_secret';
-
-    /**
-     * Name of the extra meta that stores the expiration date of the Access Token.
-     */
-    public const META_KEY_TOKEN_EXPIRES_IN = 'expires_in';
-
-    /**
-     * Name of the extra meta that holds the partner client ID.
-     */
-    public const META_KEY_PARTNER_CLIENT_ID = 'partner_client_id';
-
-    /**
-     * Name of the extra meta that holds the partner merchant ID.
-     */
-    public const META_KEY_PARTNER_MERCHANT_ID = 'partner_merchant_id';
-
-    /**
-     * Name of the extra meta that holds the seller merchant ID.
-     */
-    public const META_KEY_SELLER_MERCHANT_ID = 'merchantIdInPayPal';
-
-    /**
-     * Name of the extra meta that holds the BN / request tracking code.
-     */
-    public const META_KEY_BN_CODE = 'bn_code';
-
-    /**
-     * Name of the extra meta that stores the merchant authorized scopes for our app to work within.
-     */
-    public const META_KEY_AUTHORIZED_SCOPES = 'authorized_scopes';
-
-    /**
-     * Name of the extra meta that stores the PP checkout type selected by merchant after onboarding.
-     */
-    public const META_KEY_CHECKOUT_TYPE = 'checkout_type';
-
-    /**
-     * Name of the extra meta that stores the allowed PP checkout type selected by merchant while onboarding.
-     */
-    public const META_KEY_ALLOWED_CHECKOUT_TYPE = 'allowed_checkout_type';
-
-    /**
-     * Name of the extra meta that stores the selected PP function options.
-     */
-    public const META_KEY_FUNDING_OPTIONS = 'funding_options';
-
-    /**
-     * Name of the PayPal API parameter that holds the auth code.
-     */
-    public const API_KEY_AUTH_CODE = 'authCode';
-
-    /**
-     * Name of the PayPal API parameter that holds the client token.
-     */
-    public const API_KEY_CLIENT_TOKEN = 'client_token';
-
-     /**
-     * Name of the extra meta that holds the seller payer ID.
-     */
-    public const META_KEY_PAYER_ID = 'payer_id';
-
-    /**
-     * Name of the PayPal API parameter that holds the client token expiration time.
-     */
-    public const API_KEY_EXPIRES_IN = 'expires_in';
-
-    /**
-     * Name of the PayPal API parameter that holds the list of oAuth integrations related to the merchant.
-     */
-    public const API_PARAM_OAUTH_INTEGRATIONS = 'oauth_integrations';
-
-    /**
-     * Name of the PayPal API parameter that holds the list of third party permissions that were granted.
-     */
-    public const API_PARAM_PERMISSIONS_GRANTED = 'oauth_third_party';
-
-    /**
-     * Name of the PayPal API parameter that holds the bool of if the primary email was confirmed.
-     */
-    public const API_PARAM_PRIM_EMAIL_CONFIRMED = 'primary_email_confirmed';
-
-    /**
-     * Name of the PayPal API parameter that holds the bool of if email was confirmed.
-     */
-    public const API_PARAM_EMAIL_CONFIRMED = 'isEmailConfirmed';
-
-    /**
-     * Name of the PayPal API parameter that holds the partner ID.
-     */
-    public const API_PARAM_PARTNER_ID = 'merchantId';
-
-    /**
-     * Name of the PayPal API parameter that holds the merchant ID in the Track seller onboarding status request.
-     */
-    public const API_PARAM_TRACK_MERCHANT_ID = 'merchant_id';
-
-    /**
-     * Name of the PayPal API parameter that holds the payments_receivable status.
-     */
-    public const API_PARAM_PAYMENTS_RECEIVABLE = 'payments_receivable';
-
-    /**
-     * Name of the nonce used in the capture order request.
-     */
-    public const CAPTURE_ORDER_NONCE_NAME = 'eea_pp_commerce_capture_order_payment';
-
-    /**
-     * Name of the nonce used in the onboarding process.
-     */
-    public const NONCE_NAME_ONBOARDING_RETURN = 'eea_pp_commerce_onboarding_return';
-
-    /**
-     * Holds this payment method slug.
-     */
-    public const PM_SLUG = 'paypalcheckout';
-
-    /**
-     * Holds an array of funding options.
-     */
-    public const FUNDING_OPTIONS = [
-        'venmo',
-        'paylater',
-        'bancontact',
-        'blik',
-        'eps',
-        'giropay',
-        'ideal',
-        'mercadopago',
-        'mybank',
-        'p24',
-        'sepa',
-        'sofort',
-    ];
-
-    /**
-     * Holds an array of default/enabled funding options.
-     */
-    public const DEFAULT_FUNDING_OPTIONS = [
-        'venmo',
-        'paylater',
-    ];
-
-
-    /**
-     * Returns the base PayPal API URL.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getPayPalApiUrl(EE_Payment_Method $payment_method): string
-    {
-        return $payment_method->debug_mode() ? 'https://api-m.sandbox.paypal.com' : 'https://api-m.paypal.com';
-    }
+	/**
+	 * Name of the extra meta key that stores this PM options as one meta.
+	 */
+	public const META_KEY_PAYPAL_DATA = 'paypal_data';
+	/**
+	 * Name of the extra meta key that stores this PM options as one meta.
+	 */
+	public const META_KEY_PAYPAL_DATA_SANDBOX = 'paypal_data_sandbox';
+
+	/**
+	 * Name of the extra meta that stores whether the credentials were for the sandbox or live mode.
+	 */
+	public const META_KEY_SANDBOX_MODE = 'sandbox_mode';
+
+	/**
+	 * Name of the extra meta that stores the Access Token that is used to auth in API requests to PayPal.
+	 */
+	public const META_KEY_ACCESS_TOKEN = 'access_token';
+
+	/**
+	 * Name of the extra meta that stores the last request tracking ID.
+	 */
+	public const META_KEY_TRACKING_ID = 'tracking_id';
+
+	/**
+	 * Name of the extra meta that stores the Event Espresso PayPal Account's merchant id.
+	 */
+	public const META_KEY_APP_ID = 'app_id';
+
+	/**
+	 * Name of the extra meta that holds the seller client ID.
+	 */
+	public const META_KEY_CLIENT_ID = 'client_id';
+
+	/**
+	 * Name of the extra meta that holds the seller secret.
+	 */
+	public const META_KEY_CLIENT_SECRET = 'client_secret';
+
+	/**
+	 * Name of the extra meta that stores the expiration date of the Access Token.
+	 */
+	public const META_KEY_TOKEN_EXPIRES_IN = 'expires_in';
+
+	/**
+	 * Name of the extra meta that holds the partner client ID.
+	 */
+	public const META_KEY_PARTNER_CLIENT_ID = 'partner_client_id';
+
+	/**
+	 * Name of the extra meta that holds the partner merchant ID.
+	 */
+	public const META_KEY_PARTNER_MERCHANT_ID = 'partner_merchant_id';
+
+	/**
+	 * Name of the extra meta that holds the seller merchant ID.
+	 */
+	public const META_KEY_SELLER_MERCHANT_ID = 'merchantIdInPayPal';
+
+	/**
+	 * Name of the extra meta that holds the BN / request tracking code.
+	 */
+	public const META_KEY_BN_CODE = 'bn_code';
+
+	/**
+	 * Name of the extra meta that stores the merchant authorized scopes for our app to work within.
+	 */
+	public const META_KEY_AUTHORIZED_SCOPES = 'authorized_scopes';
+
+	/**
+	 * Name of the extra meta that stores the PP checkout type selected by merchant after onboarding.
+	 */
+	public const META_KEY_CHECKOUT_TYPE = 'checkout_type';
+
+	/**
+	 * Name of the extra meta that stores the allowed PP checkout type selected by merchant while onboarding.
+	 */
+	public const META_KEY_ALLOWED_CHECKOUT_TYPE = 'allowed_checkout_type';
+
+	/**
+	 * Name of the extra meta that stores the selected PP function options.
+	 */
+	public const META_KEY_FUNDING_OPTIONS = 'funding_options';
+
+	/**
+	 * Name of the PayPal API parameter that holds the auth code.
+	 */
+	public const API_KEY_AUTH_CODE = 'authCode';
+
+	/**
+	 * Name of the PayPal API parameter that holds the client token.
+	 */
+	public const API_KEY_CLIENT_TOKEN = 'client_token';
+
+	 /**
+	  * Name of the extra meta that holds the seller payer ID.
+	  */
+	public const META_KEY_PAYER_ID = 'payer_id';
+
+	/**
+	 * Name of the PayPal API parameter that holds the client token expiration time.
+	 */
+	public const API_KEY_EXPIRES_IN = 'expires_in';
+
+	/**
+	 * Name of the PayPal API parameter that holds the list of oAuth integrations related to the merchant.
+	 */
+	public const API_PARAM_OAUTH_INTEGRATIONS = 'oauth_integrations';
+
+	/**
+	 * Name of the PayPal API parameter that holds the list of third party permissions that were granted.
+	 */
+	public const API_PARAM_PERMISSIONS_GRANTED = 'oauth_third_party';
+
+	/**
+	 * Name of the PayPal API parameter that holds the bool of if the primary email was confirmed.
+	 */
+	public const API_PARAM_PRIM_EMAIL_CONFIRMED = 'primary_email_confirmed';
+
+	/**
+	 * Name of the PayPal API parameter that holds the bool of if email was confirmed.
+	 */
+	public const API_PARAM_EMAIL_CONFIRMED = 'isEmailConfirmed';
+
+	/**
+	 * Name of the PayPal API parameter that holds the partner ID.
+	 */
+	public const API_PARAM_PARTNER_ID = 'merchantId';
+
+	/**
+	 * Name of the PayPal API parameter that holds the merchant ID in the Track seller onboarding status request.
+	 */
+	public const API_PARAM_TRACK_MERCHANT_ID = 'merchant_id';
+
+	/**
+	 * Name of the PayPal API parameter that holds the payments_receivable status.
+	 */
+	public const API_PARAM_PAYMENTS_RECEIVABLE = 'payments_receivable';
+
+	/**
+	 * Name of the nonce used in the capture order request.
+	 */
+	public const CAPTURE_ORDER_NONCE_NAME = 'eea_pp_commerce_capture_order_payment';
+
+	/**
+	 * Name of the nonce used in the onboarding process.
+	 */
+	public const NONCE_NAME_ONBOARDING_RETURN = 'eea_pp_commerce_onboarding_return';
+
+	/**
+	 * Holds this payment method slug.
+	 */
+	public const PM_SLUG = 'paypalcheckout';
+
+	/**
+	 * Holds an array of funding options.
+	 */
+	public const FUNDING_OPTIONS = [
+		'venmo',
+		'paylater',
+		'bancontact',
+		'blik',
+		'eps',
+		'giropay',
+		'ideal',
+		'mercadopago',
+		'mybank',
+		'p24',
+		'sepa',
+		'sofort',
+	];
+
+	/**
+	 * Holds an array of default/enabled funding options.
+	 */
+	public const DEFAULT_FUNDING_OPTIONS = [
+		'venmo',
+		'paylater',
+	];
+
+
+	/**
+	 * Returns the base PayPal API URL.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getPayPalApiUrl(EE_Payment_Method $payment_method): string
+	{
+		return $payment_method->debug_mode() ? 'https://api-m.sandbox.paypal.com' : 'https://api-m.paypal.com';
+	}
 }

PaymentMethods/PayPalCommerce/PayPalCheckout/forms/SettingsForm.php

Indentation +208 added lines, -208 removed lines

@@ -25,212 +25,212 @@
  */
 class SettingsForm extends EE_Payment_Method_Form
 {
-    /**
-     *  Payment method.
-     *
-     * @var EE_PMT_Base|null
-     */
-    protected $payment_method = null;
-
-    /**
-     *  Payment method instance.
-     *
-     * @var EE_PMT_Base|null
-     */
-    protected $pm_instance = null;
-
-
-    /**
-     * Class constructor.
-     *
-     * @param EE_PMT_PayPalCheckout $payment_method
-     * @param EE_Payment_Method     $pm_instance
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(EE_PMT_PayPalCheckout $payment_method, EE_Payment_Method $pm_instance)
-    {
-        $form_parameters      = [];
-        $this->payment_method = $payment_method;
-        $this->pm_instance    = $pm_instance;
-        // Allow Advanced Card Checkout if PPCP checkout type was possible and selected when onboarding.
-        $allowed_type = PayPalExtraMetaManager::getPmOption($pm_instance, Domain::META_KEY_ALLOWED_CHECKOUT_TYPE);
-        $is_onboard   = EED_PayPalOnboard::isOnboard($pm_instance);
-        if ($is_onboard) {
-            if ($allowed_type === 'ppcp' || $allowed_type === 'all') {
-                $form_parameters = $this->addCheckoutTypeSelect($form_parameters);
-            }
-            // If the checkout type is currently set to ACDC only, don't add funding options
-            if ($pm_instance->get_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, true) !== 'ppcp') {
-                $form_parameters = $this->addFundingOptions($form_parameters);
-            }
-        }
-        // Build the PM form.
-        parent::__construct($form_parameters);
-        // Add a form for PayPal Onboard.
-        $this->addOnboardingForm($payment_method, $pm_instance);
-        // Add the clear data button.
-        $this->clearMetadataButton($pm_instance);
-        // Disable inputs if needed.
-        $this->toggleSubsections($pm_instance);
-    }
-
-
-    /**
-     * Adds an onboarding form as a subsection.
-     *
-     * @param EE_PMT_PayPalCheckout $payment_method
-     * @param EE_Payment_Method     $pm_instance
-     * @return void
-     */
-    public function addOnboardingForm(EE_PMT_PayPalCheckout $payment_method, EE_Payment_Method $pm_instance): void
-    {
-        // Add the connect button before the app id field.
-        try {
-            $this->add_subsections(
-                [
-                    'paypal_onboard' => new OnboardingForm($payment_method, $pm_instance),
-                ],
-                'PMD_debug_mode',
-                false
-            );
-        } catch (EE_Error $e) {
-            // Simply don't add the form.
-        }
-    }
-
-
-    /**
-     * Add a checkout type select.
-     *
-     * @param array $form_parameters
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function addCheckoutTypeSelect(array $form_parameters): array
-    {
-        $pm_slug = $this->pm_instance->slug();
-        // Section to be displayed if onboard.
-        $form_parameters['extra_meta_inputs'][ Domain::META_KEY_CHECKOUT_TYPE ] = new EE_Select_Input(
-            [
-                'express_checkout' => esc_html__('Express Checkout', 'event_espresso'),
-                'ppcp'             => esc_html__('Advanced Credit and Debit Card payments', 'event_espresso'),
-                'all'              => esc_html__('Both, ACDC and Express Checkout', 'event_espresso'),
-            ],
-            [
-                'html_name'  => "eep_checkout_type_option_$pm_slug",
-                'html_id'    => "eep_checkout_type_option_$pm_slug",
-                'html_class' => "eep-checkout-type-option-$pm_slug",
-                'required'   => true,
-                'default'    => PayPalExtraMetaManager::getPmOption(
-                    $this->pm_instance,
-                    Domain::META_KEY_ALLOWED_CHECKOUT_TYPE
-                ),
-            ]
-        );
-        return $form_parameters;
-    }
-
-
-    /**
-     * Add a checkout type select.
-     *
-     * @param array $form_parameters
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function addFundingOptions(array $form_parameters): array
-    {
-        $pm_slug = $this->pm_instance->slug();
-        // Section to be displayed if onboard.
-        $form_parameters['extra_meta_inputs'][ Domain::META_KEY_FUNDING_OPTIONS ] = new EE_Checkbox_Multi_Input(
-            [
-                'venmo'       => esc_html__('Venmo', 'event_espresso'),
-                'paylater'    => esc_html__('PayLater', 'event_espresso'),
-                'bancontact'  => esc_html__('Bancontact', 'event_espresso'),
-                'blik'        => esc_html__('BLIK', 'event_espresso'),
-                'eps'         => esc_html__('EPS', 'event_espresso'),
-                'giropay'     => esc_html__('giropay', 'event_espresso'),
-                'ideal'       => esc_html__('iDEAL', 'event_espresso'),
-                'mercadopago' => esc_html__('Mercado Pago', 'event_espresso'),
-                'mybank'      => esc_html__('MyBank', 'event_espresso'),
-                'p24'         => esc_html__('Przelewy24', 'event_espresso'),
-                'sepa'        => esc_html__('SEPA-Lastschrift', 'event_espresso'),
-                'sofort'      => esc_html__('Sofort', 'event_espresso'),
-            ],
-            [
-                'html_name'       => "eep_checkout_funding_options_$pm_slug",
-                'html_id'         => "eep_checkout_funding_options_$pm_slug",
-                'html_class'      => "eep-checkout-funding-options-$pm_slug",
-                'html_label_text' => esc_html__('Enable PayPal funding options:', 'event_espresso'),
-                'default'         => ['venmo', 'paylater'],
-            ]
-        );
-        return $form_parameters;
-    }
-
-
-    /**
-     * Adds a button for clearing the PM metadata.
-     *
-     * @param EE_Payment_Method $pm_instance
-     * @return void
-     */
-    public function clearMetadataButton(EE_Payment_Method $pm_instance): void
-    {
-        try {
-            $is_onboard = EED_PayPalOnboard::isOnboard($pm_instance);
-            if ($is_onboard) {
-                return;
-            }
-            $button_text = sprintf(
-                esc_html__('Clear %1$s metadata', 'event_espresso'),
-                $pm_instance->admin_name()
-            );
-            $this->add_subsections(
-                [
-                    'clear_pm_metadata' => new EE_Form_Section_HTML(
-                        EEH_HTML::tr(
-                            EEH_HTML::th(esc_html__('Clear PM metadata ?', 'event_espresso')) .
-                            EEH_HTML::td(
-                                EEH_HTML::link(
-                                    '',
-                                    $button_text,
-                                    $button_text,
-                                    'eea_clear_metadata_' . $pm_instance->slug(),
-                                    'espresso-button button button--secondary'
-                                )
-                            )
-                        )
-                    ),
-                ],
-                'PMD_order',
-                false
-            );
-        } catch (EE_Error $e) {
-            // Don't add the button if there's some error.
-        }
-    }
-
-
-    /**
-     * Toggles subsections depending on the OAuth status etc.
-     *
-     * @param EE_Payment_Method $pm_instance
-     * @return void
-     * @throws EE_Error
-     */
-    private function toggleSubsections(EE_Payment_Method $pm_instance): void
-    {
-        $onboard = EED_PayPalOnboard::isOnboard($pm_instance);
-        // Don't allow changing the debug mode setting while connected.
-        if ($onboard) {
-            $debug_mode_input = $this->get_input('PMD_debug_mode', false);
-            if (method_exists($debug_mode_input, 'isDisabled')) {
-                $debug_mode_input->disable();
-            }
-        }
-    }
+	/**
+	 *  Payment method.
+	 *
+	 * @var EE_PMT_Base|null
+	 */
+	protected $payment_method = null;
+
+	/**
+	 *  Payment method instance.
+	 *
+	 * @var EE_PMT_Base|null
+	 */
+	protected $pm_instance = null;
+
+
+	/**
+	 * Class constructor.
+	 *
+	 * @param EE_PMT_PayPalCheckout $payment_method
+	 * @param EE_Payment_Method     $pm_instance
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(EE_PMT_PayPalCheckout $payment_method, EE_Payment_Method $pm_instance)
+	{
+		$form_parameters      = [];
+		$this->payment_method = $payment_method;
+		$this->pm_instance    = $pm_instance;
+		// Allow Advanced Card Checkout if PPCP checkout type was possible and selected when onboarding.
+		$allowed_type = PayPalExtraMetaManager::getPmOption($pm_instance, Domain::META_KEY_ALLOWED_CHECKOUT_TYPE);
+		$is_onboard   = EED_PayPalOnboard::isOnboard($pm_instance);
+		if ($is_onboard) {
+			if ($allowed_type === 'ppcp' || $allowed_type === 'all') {
+				$form_parameters = $this->addCheckoutTypeSelect($form_parameters);
+			}
+			// If the checkout type is currently set to ACDC only, don't add funding options
+			if ($pm_instance->get_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, true) !== 'ppcp') {
+				$form_parameters = $this->addFundingOptions($form_parameters);
+			}
+		}
+		// Build the PM form.
+		parent::__construct($form_parameters);
+		// Add a form for PayPal Onboard.
+		$this->addOnboardingForm($payment_method, $pm_instance);
+		// Add the clear data button.
+		$this->clearMetadataButton($pm_instance);
+		// Disable inputs if needed.
+		$this->toggleSubsections($pm_instance);
+	}
+
+
+	/**
+	 * Adds an onboarding form as a subsection.
+	 *
+	 * @param EE_PMT_PayPalCheckout $payment_method
+	 * @param EE_Payment_Method     $pm_instance
+	 * @return void
+	 */
+	public function addOnboardingForm(EE_PMT_PayPalCheckout $payment_method, EE_Payment_Method $pm_instance): void
+	{
+		// Add the connect button before the app id field.
+		try {
+			$this->add_subsections(
+				[
+					'paypal_onboard' => new OnboardingForm($payment_method, $pm_instance),
+				],
+				'PMD_debug_mode',
+				false
+			);
+		} catch (EE_Error $e) {
+			// Simply don't add the form.
+		}
+	}
+
+
+	/**
+	 * Add a checkout type select.
+	 *
+	 * @param array $form_parameters
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function addCheckoutTypeSelect(array $form_parameters): array
+	{
+		$pm_slug = $this->pm_instance->slug();
+		// Section to be displayed if onboard.
+		$form_parameters['extra_meta_inputs'][ Domain::META_KEY_CHECKOUT_TYPE ] = new EE_Select_Input(
+			[
+				'express_checkout' => esc_html__('Express Checkout', 'event_espresso'),
+				'ppcp'             => esc_html__('Advanced Credit and Debit Card payments', 'event_espresso'),
+				'all'              => esc_html__('Both, ACDC and Express Checkout', 'event_espresso'),
+			],
+			[
+				'html_name'  => "eep_checkout_type_option_$pm_slug",
+				'html_id'    => "eep_checkout_type_option_$pm_slug",
+				'html_class' => "eep-checkout-type-option-$pm_slug",
+				'required'   => true,
+				'default'    => PayPalExtraMetaManager::getPmOption(
+					$this->pm_instance,
+					Domain::META_KEY_ALLOWED_CHECKOUT_TYPE
+				),
+			]
+		);
+		return $form_parameters;
+	}
+
+
+	/**
+	 * Add a checkout type select.
+	 *
+	 * @param array $form_parameters
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function addFundingOptions(array $form_parameters): array
+	{
+		$pm_slug = $this->pm_instance->slug();
+		// Section to be displayed if onboard.
+		$form_parameters['extra_meta_inputs'][ Domain::META_KEY_FUNDING_OPTIONS ] = new EE_Checkbox_Multi_Input(
+			[
+				'venmo'       => esc_html__('Venmo', 'event_espresso'),
+				'paylater'    => esc_html__('PayLater', 'event_espresso'),
+				'bancontact'  => esc_html__('Bancontact', 'event_espresso'),
+				'blik'        => esc_html__('BLIK', 'event_espresso'),
+				'eps'         => esc_html__('EPS', 'event_espresso'),
+				'giropay'     => esc_html__('giropay', 'event_espresso'),
+				'ideal'       => esc_html__('iDEAL', 'event_espresso'),
+				'mercadopago' => esc_html__('Mercado Pago', 'event_espresso'),
+				'mybank'      => esc_html__('MyBank', 'event_espresso'),
+				'p24'         => esc_html__('Przelewy24', 'event_espresso'),
+				'sepa'        => esc_html__('SEPA-Lastschrift', 'event_espresso'),
+				'sofort'      => esc_html__('Sofort', 'event_espresso'),
+			],
+			[
+				'html_name'       => "eep_checkout_funding_options_$pm_slug",
+				'html_id'         => "eep_checkout_funding_options_$pm_slug",
+				'html_class'      => "eep-checkout-funding-options-$pm_slug",
+				'html_label_text' => esc_html__('Enable PayPal funding options:', 'event_espresso'),
+				'default'         => ['venmo', 'paylater'],
+			]
+		);
+		return $form_parameters;
+	}
+
+
+	/**
+	 * Adds a button for clearing the PM metadata.
+	 *
+	 * @param EE_Payment_Method $pm_instance
+	 * @return void
+	 */
+	public function clearMetadataButton(EE_Payment_Method $pm_instance): void
+	{
+		try {
+			$is_onboard = EED_PayPalOnboard::isOnboard($pm_instance);
+			if ($is_onboard) {
+				return;
+			}
+			$button_text = sprintf(
+				esc_html__('Clear %1$s metadata', 'event_espresso'),
+				$pm_instance->admin_name()
+			);
+			$this->add_subsections(
+				[
+					'clear_pm_metadata' => new EE_Form_Section_HTML(
+						EEH_HTML::tr(
+							EEH_HTML::th(esc_html__('Clear PM metadata ?', 'event_espresso')) .
+							EEH_HTML::td(
+								EEH_HTML::link(
+									'',
+									$button_text,
+									$button_text,
+									'eea_clear_metadata_' . $pm_instance->slug(),
+									'espresso-button button button--secondary'
+								)
+							)
+						)
+					),
+				],
+				'PMD_order',
+				false
+			);
+		} catch (EE_Error $e) {
+			// Don't add the button if there's some error.
+		}
+	}
+
+
+	/**
+	 * Toggles subsections depending on the OAuth status etc.
+	 *
+	 * @param EE_Payment_Method $pm_instance
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function toggleSubsections(EE_Payment_Method $pm_instance): void
+	{
+		$onboard = EED_PayPalOnboard::isOnboard($pm_instance);
+		// Don't allow changing the debug mode setting while connected.
+		if ($onboard) {
+			$debug_mode_input = $this->get_input('PMD_debug_mode', false);
+			if (method_exists($debug_mode_input, 'isDisabled')) {
+				$debug_mode_input->disable();
+			}
+		}
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -112,7 +112,7 @@ 
     {
         $pm_slug = $this->pm_instance->slug();
         // Section to be displayed if onboard.
-        $form_parameters['extra_meta_inputs'][ Domain::META_KEY_CHECKOUT_TYPE ] = new EE_Select_Input(
+        $form_parameters['extra_meta_inputs'][Domain::META_KEY_CHECKOUT_TYPE] = new EE_Select_Input(
             [
                 'express_checkout' => esc_html__('Express Checkout', 'event_espresso'),
                 'ppcp'             => esc_html__('Advanced Credit and Debit Card payments', 'event_espresso'),
@@ -145,7 +145,7 @@ 
     {
         $pm_slug = $this->pm_instance->slug();
         // Section to be displayed if onboard.
-        $form_parameters['extra_meta_inputs'][ Domain::META_KEY_FUNDING_OPTIONS ] = new EE_Checkbox_Multi_Input(
+        $form_parameters['extra_meta_inputs'][Domain::META_KEY_FUNDING_OPTIONS] = new EE_Checkbox_Multi_Input(
             [
                 'venmo'       => esc_html__('Venmo', 'event_espresso'),
                 'paylater'    => esc_html__('PayLater', 'event_espresso'),
@@ -193,13 +193,13 @@ 
                 [
                     'clear_pm_metadata' => new EE_Form_Section_HTML(
                         EEH_HTML::tr(
-                            EEH_HTML::th(esc_html__('Clear PM metadata ?', 'event_espresso')) .
+                            EEH_HTML::th(esc_html__('Clear PM metadata ?', 'event_espresso')).
                             EEH_HTML::td(
                                 EEH_HTML::link(
                                     '',
                                     $button_text,
                                     $button_text,
-                                    'eea_clear_metadata_' . $pm_instance->slug(),
+                                    'eea_clear_metadata_'.$pm_instance->slug(),
                                     'espresso-button button button--secondary'
                                 )
                             )

PaymentMethods/PayPalCommerce/PayPalCheckout/forms/BillingForm.php

Indentation +539 added lines, -539 removed lines

@@ -37,570 +37,570 @@
  */
 class BillingForm extends EE_Billing_Attendee_Info_Form
 {
-    protected EE_Payment_Method $paypal_pmt;
+	protected EE_Payment_Method $paypal_pmt;
 
-    protected ?EE_Transaction   $transaction = null;
+	protected ?EE_Transaction   $transaction = null;
 
-    protected string            $checkout_type;
+	protected string            $checkout_type;
 
-    /**
-     * Filepath to template files
-     *
-     * @var string $template_path
-     */
-    protected string $template_path;
+	/**
+	 * Filepath to template files
+	 *
+	 * @var string $template_path
+	 */
+	protected string $template_path;
 
 
-    /**
-     * Class constructor.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @param array             $options
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(EE_Payment_Method $payment_method, array $options)
-    {
-        $this->paypal_pmt = $payment_method;
-        // Can't be too careful.
-        $this->transaction   = $options['transaction'] ?? null;
-        $this->template_path = $options['template_path'] ?? '';
-        $this->checkout_type = $payment_method->get_extra_meta(
-            Domain::META_KEY_CHECKOUT_TYPE,
-            true,
-            'express_checkout'
-        );
-        $pm_slug             = $payment_method->slug();
-        $parameters          = array_replace_recursive(
-            $options,
-            [
-                'name'        => 'PayPalCommerceBillingForm',
-                'html_id'     => 'pp-' . $pm_slug . '-billing-form',
-                'html_class'  => 'pp_commerce_billing_form',
-                'subsections' => [
-                    'eea_paypal_commerce_token' => new EE_Hidden_Input(
-                        [
-                            'html_id'   => 'eea-paypal-commerce-token',
-                            'html_name' => 'EEA_paymentToken',
-                            'default'   => '',
-                        ]
-                    ),
-                    'pp_order_nonce'            => new EE_Hidden_Input(
-                        [
-                            'html_id'   => 'eea-' . $pm_slug . '-order-nonce',
-                            'html_name' => 'pp_order_nonce',
-                            'default'   => '',
-                        ]
-                    ),
-                    'pp_order_id'               => new EE_Hidden_Input(
-                        [
-                            'html_id'   => 'eea-' . $pm_slug . '-order-id',
-                            'html_name' => 'pp_order_id',
-                            'default'   => '',
-                        ]
-                    ),
-                    'pp_order_status'           => new EE_Hidden_Input(
-                        [
-                            'html_id'   => 'eea-' . $pm_slug . '-order-status',
-                            'html_name' => 'pp_order_status',
-                            'default'   => '',
-                        ]
-                    ),
-                ],
-            ]
-        );
-        // Add data tags to the PP script.
-        add_filter('script_loader_tag', [$this, 'addDataTagsToScript'], 10, 2);
-        parent::__construct($payment_method, $parameters);
-        // Add and exclude other sections.
-        $this->addPaymentSections();
-        // Additional actions and/or filters.
-        $this->loadActionsAndFilters();
-    }
+	/**
+	 * Class constructor.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @param array             $options
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(EE_Payment_Method $payment_method, array $options)
+	{
+		$this->paypal_pmt = $payment_method;
+		// Can't be too careful.
+		$this->transaction   = $options['transaction'] ?? null;
+		$this->template_path = $options['template_path'] ?? '';
+		$this->checkout_type = $payment_method->get_extra_meta(
+			Domain::META_KEY_CHECKOUT_TYPE,
+			true,
+			'express_checkout'
+		);
+		$pm_slug             = $payment_method->slug();
+		$parameters          = array_replace_recursive(
+			$options,
+			[
+				'name'        => 'PayPalCommerceBillingForm',
+				'html_id'     => 'pp-' . $pm_slug . '-billing-form',
+				'html_class'  => 'pp_commerce_billing_form',
+				'subsections' => [
+					'eea_paypal_commerce_token' => new EE_Hidden_Input(
+						[
+							'html_id'   => 'eea-paypal-commerce-token',
+							'html_name' => 'EEA_paymentToken',
+							'default'   => '',
+						]
+					),
+					'pp_order_nonce'            => new EE_Hidden_Input(
+						[
+							'html_id'   => 'eea-' . $pm_slug . '-order-nonce',
+							'html_name' => 'pp_order_nonce',
+							'default'   => '',
+						]
+					),
+					'pp_order_id'               => new EE_Hidden_Input(
+						[
+							'html_id'   => 'eea-' . $pm_slug . '-order-id',
+							'html_name' => 'pp_order_id',
+							'default'   => '',
+						]
+					),
+					'pp_order_status'           => new EE_Hidden_Input(
+						[
+							'html_id'   => 'eea-' . $pm_slug . '-order-status',
+							'html_name' => 'pp_order_status',
+							'default'   => '',
+						]
+					),
+				],
+			]
+		);
+		// Add data tags to the PP script.
+		add_filter('script_loader_tag', [$this, 'addDataTagsToScript'], 10, 2);
+		parent::__construct($payment_method, $parameters);
+		// Add and exclude other sections.
+		$this->addPaymentSections();
+		// Additional actions and/or filters.
+		$this->loadActionsAndFilters();
+	}
 
 
-    /**
-     * Add PayPal payment sections.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function addPaymentSections(): void
-    {
-        // Exclude the default billing form fields.
-        $this->exclude(
-            [
-                'first_name',
-                'last_name',
-                'email',
-            ]
-        );
-        // Add PayPal Hosted Fields.
-        if (! empty($this->checkout_type) && $this->checkout_type !== 'express_checkout') {
-            $this->addAdvancedCardFields();
-        }
-        // Add payment types separator, if both are enabled.
-        if ($this->checkout_type === 'all') {
-            $this->addTypesSeparator();
-        }
-        // Add PayPal Buttons section.
-        if ($this->checkout_type !== 'ppcp') {
-            $this->add_subsections(
-                [
-                    'paypal_commerce_pm_form' => $this->addPayPalCheckout(),
-                ]
-            );
-        }
-        // Exclude the rest billing form fields if the payment type is express checkout.
-        if ($this->checkout_type === 'express_checkout') {
-            $this->exclude(
-                [
-                    'address',
-                    'address2',
-                    'state',
-                    'phone',
-                    'city',
-                    'country',
-                    'zip',
-                ]
-            );
-            // Remove the Info subsection.
-            add_filter('FHEE__EE_Form_Section_Proper___construct__options_array', [$this, 'excludeInfoSubsection']);
-        }
-        $this->add_subsections(
-            [
-                'debug_content' => $this->addDebugContent($this->paypal_pmt),
-            ]
-        );
-    }
+	/**
+	 * Add PayPal payment sections.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function addPaymentSections(): void
+	{
+		// Exclude the default billing form fields.
+		$this->exclude(
+			[
+				'first_name',
+				'last_name',
+				'email',
+			]
+		);
+		// Add PayPal Hosted Fields.
+		if (! empty($this->checkout_type) && $this->checkout_type !== 'express_checkout') {
+			$this->addAdvancedCardFields();
+		}
+		// Add payment types separator, if both are enabled.
+		if ($this->checkout_type === 'all') {
+			$this->addTypesSeparator();
+		}
+		// Add PayPal Buttons section.
+		if ($this->checkout_type !== 'ppcp') {
+			$this->add_subsections(
+				[
+					'paypal_commerce_pm_form' => $this->addPayPalCheckout(),
+				]
+			);
+		}
+		// Exclude the rest billing form fields if the payment type is express checkout.
+		if ($this->checkout_type === 'express_checkout') {
+			$this->exclude(
+				[
+					'address',
+					'address2',
+					'state',
+					'phone',
+					'city',
+					'country',
+					'zip',
+				]
+			);
+			// Remove the Info subsection.
+			add_filter('FHEE__EE_Form_Section_Proper___construct__options_array', [$this, 'excludeInfoSubsection']);
+		}
+		$this->add_subsections(
+			[
+				'debug_content' => $this->addDebugContent($this->paypal_pmt),
+			]
+		);
+	}
 
 
-    /**
-     * Additional actions and/or filters.
-     *
-     * @return void
-     */
-    public function loadActionsAndFilters(): void
-    {
-        add_filter(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-            [__CLASS__, 'excludeBillingFormFields'],
-            10,
-            2
-        );
-    }
+	/**
+	 * Additional actions and/or filters.
+	 *
+	 * @return void
+	 */
+	public function loadActionsAndFilters(): void
+	{
+		add_filter(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+			[__CLASS__, 'excludeBillingFormFields'],
+			10,
+			2
+		);
+	}
 
 
-    /**
-     * Filter out billing form fields if pay button was used.
-     *
-     * @param EE_Billing_Info_Form $billing_form
-     * @param EE_Payment_Method    $payment_method
-     * @return EE_Billing_Info_Form
-     */
-    public static function excludeBillingFormFields(
-        EE_Billing_Info_Form $billing_form,
-        EE_Payment_Method    $payment_method
-    ): EE_Billing_Info_Form {
-        $request        = LoaderFactory::getShared(Request::class);
-        $request_params = $request->requestParams();
-        // Only the PPC billing form.
-        if (! $billing_form instanceof BillingForm) {
-            return $billing_form;
-        }
-        // Make sure the billing form subsections have correct names.
-        $inputs = $billing_form->inputs_in_subsections();
-        if (
-            ! empty($request_params['process_form_submission'])
-            && $request_params['process_form_submission'] === '1'
-            && ! empty($request_params['eep_ppc_skip_form_validation'])
-        ) {
-            // Hide card info fields.
-            $billing_form->exclude(
-                [
-                    'pp_name_on_card',
-                    'address',
-                    'address2',
-                    'state',
-                    'phone',
-                    'city',
-                    'country',
-                    'zip',
-                ]
-            );
-        }
-        return $billing_form;
-    }
+	/**
+	 * Filter out billing form fields if pay button was used.
+	 *
+	 * @param EE_Billing_Info_Form $billing_form
+	 * @param EE_Payment_Method    $payment_method
+	 * @return EE_Billing_Info_Form
+	 */
+	public static function excludeBillingFormFields(
+		EE_Billing_Info_Form $billing_form,
+		EE_Payment_Method    $payment_method
+	): EE_Billing_Info_Form {
+		$request        = LoaderFactory::getShared(Request::class);
+		$request_params = $request->requestParams();
+		// Only the PPC billing form.
+		if (! $billing_form instanceof BillingForm) {
+			return $billing_form;
+		}
+		// Make sure the billing form subsections have correct names.
+		$inputs = $billing_form->inputs_in_subsections();
+		if (
+			! empty($request_params['process_form_submission'])
+			&& $request_params['process_form_submission'] === '1'
+			&& ! empty($request_params['eep_ppc_skip_form_validation'])
+		) {
+			// Hide card info fields.
+			$billing_form->exclude(
+				[
+					'pp_name_on_card',
+					'address',
+					'address2',
+					'state',
+					'phone',
+					'city',
+					'country',
+					'zip',
+				]
+			);
+		}
+		return $billing_form;
+	}
 
 
-    /**
-     * Add advanced card & debit card fields.
-     *
-     * @return void
-     * @throws EE_Error|ReflectionException
-     */
-    public function addAdvancedCardFields(): void
-    {
-        $pm_slug = $this->paypal_pmt->slug();
-        $this->add_subsections(
-            [
-                'pp_card_number'     => new EE_Form_Section_HTML(
-                    EEH_HTML::label(
-                        esc_html__('Card Number', 'event_espresso'),
-                        "$pm_slug-card-number-lbl",
-                        "$pm_slug-card-fields",
-                        "",
-                        'for="' . $pm_slug . '-card-number"'
-                    ) .
-                    EEH_HTML::p(
-                        "",
-                        "$pm_slug-card-number",
-                        "card_field $pm_slug-card-fields"
-                    )
-                ),
-                'pp_expiration_date' => new EE_Form_Section_HTML(
-                    EEH_HTML::label(
-                        esc_html__('Expiration Date', 'event_espresso'),
-                        "$pm_slug-expiration-date-lbl",
-                        "$pm_slug-card-fields",
-                        "",
-                        'for="' . $pm_slug . '-expiration-date"'
-                    ) .
-                    EEH_HTML::p(
-                        "",
-                        "$pm_slug-expiration-date",
-                        "card_field $pm_slug-card-fields"
-                    )
-                ),
-                'pp_card_cvv'        => new EE_Form_Section_HTML(
-                    EEH_HTML::label(
-                        esc_html__('CVV', 'event_espresso'),
-                        "$pm_slug-cvv-lbl",
-                        "$pm_slug-card-fields",
-                        "",
-                        'for="' . $pm_slug . '-cvv"'
-                    ) .
-                    EEH_HTML::p(
-                        "",
-                        "$pm_slug-cvv",
-                        "card_field $pm_slug-card-fields"
-                    )
-                ),
-                'pp_name_on_card'    => new EE_Text_Input(
-                    [
-                        'html_label_text' => esc_html__('Name On Card', 'event_espresso'),
-                        'html_id'         => $pm_slug . '-card-holder-name',
-                        'html_name'       => 'card-holder-name',
-                        'html_class'      => '',
-                        'required'        => true,
-                    ]
-                ),
-            ]
-        );
-        // Add the submit button at the end.
-        $this->add_subsections(
-            [
-                'pp_cc_submit' => new EE_Submit_Input(
-                    [
-                        'html_label_text' => esc_html__('Submit', 'event_espresso'),
-                        'html_id'         => $pm_slug,
-                        'html_class'      => 'eep-ppc-btn',
-                    ]
-                ),
-            ],
-            'phone',
-            false
-        );
-    }
+	/**
+	 * Add advanced card & debit card fields.
+	 *
+	 * @return void
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function addAdvancedCardFields(): void
+	{
+		$pm_slug = $this->paypal_pmt->slug();
+		$this->add_subsections(
+			[
+				'pp_card_number'     => new EE_Form_Section_HTML(
+					EEH_HTML::label(
+						esc_html__('Card Number', 'event_espresso'),
+						"$pm_slug-card-number-lbl",
+						"$pm_slug-card-fields",
+						"",
+						'for="' . $pm_slug . '-card-number"'
+					) .
+					EEH_HTML::p(
+						"",
+						"$pm_slug-card-number",
+						"card_field $pm_slug-card-fields"
+					)
+				),
+				'pp_expiration_date' => new EE_Form_Section_HTML(
+					EEH_HTML::label(
+						esc_html__('Expiration Date', 'event_espresso'),
+						"$pm_slug-expiration-date-lbl",
+						"$pm_slug-card-fields",
+						"",
+						'for="' . $pm_slug . '-expiration-date"'
+					) .
+					EEH_HTML::p(
+						"",
+						"$pm_slug-expiration-date",
+						"card_field $pm_slug-card-fields"
+					)
+				),
+				'pp_card_cvv'        => new EE_Form_Section_HTML(
+					EEH_HTML::label(
+						esc_html__('CVV', 'event_espresso'),
+						"$pm_slug-cvv-lbl",
+						"$pm_slug-card-fields",
+						"",
+						'for="' . $pm_slug . '-cvv"'
+					) .
+					EEH_HTML::p(
+						"",
+						"$pm_slug-cvv",
+						"card_field $pm_slug-card-fields"
+					)
+				),
+				'pp_name_on_card'    => new EE_Text_Input(
+					[
+						'html_label_text' => esc_html__('Name On Card', 'event_espresso'),
+						'html_id'         => $pm_slug . '-card-holder-name',
+						'html_name'       => 'card-holder-name',
+						'html_class'      => '',
+						'required'        => true,
+					]
+				),
+			]
+		);
+		// Add the submit button at the end.
+		$this->add_subsections(
+			[
+				'pp_cc_submit' => new EE_Submit_Input(
+					[
+						'html_label_text' => esc_html__('Submit', 'event_espresso'),
+						'html_id'         => $pm_slug,
+						'html_class'      => 'eep-ppc-btn',
+					]
+				),
+			],
+			'phone',
+			false
+		);
+	}
 
 
-    /**
-     * Add advanced card & debit card fields.
-     *
-     * @return void
-     * @throws EE_Error|ReflectionException
-     */
-    public function addTypesSeparator(): void
-    {
-        $this->add_subsections(
-            [
-                'pp_payment_types_separator' => new EE_Form_Section_HTML(
-                    EEH_HTML::div(
-                        EEH_HTML::div(
-                            ' ',
-                            'eep-' . $this->paypal_pmt->slug() . '-payments-separator',
-                            'eep-ppc-separator-line eep-left-floating'
-                        ) .
-                        EEH_HTML::div(
-                            esc_html__(' or ', 'event_espresso'),
-                            'eep-' . $this->paypal_pmt->slug() . '-separator-text',
-                            'eep-ppc-separator-text1 eep-mid-floating'
-                        ) . EEH_HTML::div(
-                            ' ',
-                            'eep-' . $this->paypal_pmt->slug() . '-payments-separator',
-                            'eep-ppc-separator-line eep-right-floating'
-                        ),
-                        'eep-ppc-separator-holder',
-                        'eep-ppc-separator-holder'
-                    )
-                ),
-            ]
-        );
-    }
+	/**
+	 * Add advanced card & debit card fields.
+	 *
+	 * @return void
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function addTypesSeparator(): void
+	{
+		$this->add_subsections(
+			[
+				'pp_payment_types_separator' => new EE_Form_Section_HTML(
+					EEH_HTML::div(
+						EEH_HTML::div(
+							' ',
+							'eep-' . $this->paypal_pmt->slug() . '-payments-separator',
+							'eep-ppc-separator-line eep-left-floating'
+						) .
+						EEH_HTML::div(
+							esc_html__(' or ', 'event_espresso'),
+							'eep-' . $this->paypal_pmt->slug() . '-separator-text',
+							'eep-ppc-separator-text1 eep-mid-floating'
+						) . EEH_HTML::div(
+							' ',
+							'eep-' . $this->paypal_pmt->slug() . '-payments-separator',
+							'eep-ppc-separator-line eep-right-floating'
+						),
+						'eep-ppc-separator-holder',
+						'eep-ppc-separator-holder'
+					)
+				),
+			]
+		);
+	}
 
 
-    /**
-     * Exclude the info subsection from the PPC checkout form.
-     *
-     * @param array $options_array
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function excludeInfoSubsection(array $options_array): array
-    {
-        if (
-            ! empty($options_array['html_id'])
-            && $options_array['html_id'] === 'spco-payment-method-info-' . $this->paypal_pmt->slug()
-        ) {
-            if (! empty($options_array['subsections']) && isset($options_array['subsections']['info'])) {
-                unset($options_array['subsections']['info']);
-            }
-        }
-        return $options_array;
-    }
+	/**
+	 * Exclude the info subsection from the PPC checkout form.
+	 *
+	 * @param array $options_array
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function excludeInfoSubsection(array $options_array): array
+	{
+		if (
+			! empty($options_array['html_id'])
+			&& $options_array['html_id'] === 'spco-payment-method-info-' . $this->paypal_pmt->slug()
+		) {
+			if (! empty($options_array['subsections']) && isset($options_array['subsections']['info'])) {
+				unset($options_array['subsections']['info']);
+			}
+		}
+		return $options_array;
+	}
 
 
-    /**
-     * Possibly adds debug content to PayPal commerce billing form.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return EE_Form_Section_Base
-     * @throws EE_Error|ReflectionException
-     */
-    public function addDebugContent(EE_Payment_Method $paypal_pm): EE_Form_Section_Base
-    {
-        if ($paypal_pm->debug_mode()) {
-            return new EE_Form_Section_Proper(
-                [
-                    'layout_strategy' => new EE_Template_Layout(
-                        [
-                            'layout_template_file' => $this->template_path . 'debugInfo.template.php',
-                            'template_args'        => [],
-                        ]
-                    ),
-                ]
-            );
-        }
-        return new EE_Form_Section_HTML();
-    }
+	/**
+	 * Possibly adds debug content to PayPal commerce billing form.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function addDebugContent(EE_Payment_Method $paypal_pm): EE_Form_Section_Base
+	{
+		if ($paypal_pm->debug_mode()) {
+			return new EE_Form_Section_Proper(
+				[
+					'layout_strategy' => new EE_Template_Layout(
+						[
+							'layout_template_file' => $this->template_path . 'debugInfo.template.php',
+							'template_args'        => [],
+						]
+					),
+				]
+			);
+		}
+		return new EE_Form_Section_HTML();
+	}
 
 
-    /**
-     * Add PayPal checkout buttons.
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function addPayPalCheckout(): EE_Form_Section_Proper
-    {
-        $template_args['pm_slug'] = $this->paypal_pmt->slug();
-        return new EE_Form_Section_Proper(
-            [
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file' => $this->template_path . 'paymentButtons.template.php',
-                        'template_args'        => $template_args,
-                    ]
-                ),
-            ]
-        );
-    }
+	/**
+	 * Add PayPal checkout buttons.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function addPayPalCheckout(): EE_Form_Section_Proper
+	{
+		$template_args['pm_slug'] = $this->paypal_pmt->slug();
+		return new EE_Form_Section_Proper(
+			[
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file' => $this->template_path . 'paymentButtons.template.php',
+						'template_args'        => $template_args,
+					]
+				),
+			]
+		);
+	}
 
 
-    /**
-     * Load scripts and localize data needed for this form.
-     *
-     * @param $tag
-     * @param $handle
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function addDataTagsToScript($tag, $handle): string
-    {
-        if ($handle === 'eea_paypal_commerce_js_lib') {
-            $bn_code  = PayPalExtraMetaManager::getPmOption($this->_pm_instance, Domain::META_KEY_BN_CODE);
-            $response = EED_PayPalCommerce::requestClientToken($this->paypal_pmt);
-            if (empty($response['client_token'])) {
-                return $tag;
-            }
-            $client_token = $response['client_token'];
-            $attributes   = " data-partner-attribution-id=\"$bn_code\" data-client-token=\"$client_token\"";
-            $tag          = str_replace('></script>', $attributes . '></script>', $tag);
-        }
-        return $tag;
-    }
+	/**
+	 * Load scripts and localize data needed for this form.
+	 *
+	 * @param $tag
+	 * @param $handle
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function addDataTagsToScript($tag, $handle): string
+	{
+		if ($handle === 'eea_paypal_commerce_js_lib') {
+			$bn_code  = PayPalExtraMetaManager::getPmOption($this->_pm_instance, Domain::META_KEY_BN_CODE);
+			$response = EED_PayPalCommerce::requestClientToken($this->paypal_pmt);
+			if (empty($response['client_token'])) {
+				return $tag;
+			}
+			$client_token = $response['client_token'];
+			$attributes   = " data-partner-attribution-id=\"$bn_code\" data-client-token=\"$client_token\"";
+			$tag          = str_replace('></script>', $attributes . '></script>', $tag);
+		}
+		return $tag;
+	}
 
 
-    /**
-     * Load scripts and localize data needed for this form.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function enqueue_js(): void
-    {
-        // Setup default values
-        $client_id_key   = Domain::META_KEY_CLIENT_ID;
-        $merchant_id     = false;
-        // Override the above if third party integration
-        if (EED_PayPalCommerce::isThirdParty($this->_pm_instance)) {
-            $client_id_key = Domain::META_KEY_PARTNER_CLIENT_ID;
-            $merchant_id   = PayPalExtraMetaManager::getPmOption(
-                $this->_pm_instance,
-                Domain::META_KEY_SELLER_MERCHANT_ID
-            );
-        }
-        // Setup query args
-        $url_params = [
-            'client-id'   => PayPalExtraMetaManager::getPmOption($this->_pm_instance, $client_id_key),
-            'currency'    => CurrencyManager::currencyCode(),
-            'components'  => implode(',', ['buttons', 'hosted-fields']),
-            'intent'      => 'capture',
-            'merchant-id' => $merchant_id,
-        ];
-        // Which funding methods are active?
-        $enabled_funding = $this->_pm_instance->get_extra_meta(
-            Domain::META_KEY_FUNDING_OPTIONS,
-            true,
-            Domain::DEFAULT_FUNDING_OPTIONS
-        );
-        // Any funding method not enabled should be disabled.
-        $disabled_funding = array_diff(Domain::FUNDING_OPTIONS, $enabled_funding);
-        // Any funding options enabled?
-        if (count($enabled_funding) > 0) {
-            $url_params['enable-funding'] = implode(',', $enabled_funding);
-        }
-        // Any funding options disabled?
-        if (count($disabled_funding) > 0) {
-            $url_params['disable-funding'] = implode(',', $disabled_funding);
-        }
-        // Enqueue the PayPal JS
-        wp_enqueue_script(
-            'eea_paypal_commerce_js_lib',
-            add_query_arg($url_params, 'https://www.paypal.com/sdk/js'),
-            [],
-            null
-        );
-        wp_enqueue_script(
-            'eea_paypal_commerce_js',
-            EEP_PAYPAL_COMMERCE_URL . 'assets/js/paypal-commerce-payments.js',
-            ['eea_paypal_commerce_js_lib'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        // Styles.
-        wp_enqueue_style(
-            'eea_paypal_checkout_form_styles',
-            EEP_PAYPAL_COMMERCE_URL . 'assets' . DS . 'css' . DS . 'eea-paypal-checkout.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        // Localize the script with our transaction data.
-        $parameters = $this->localizeParameters();
-        wp_localize_script('eea_paypal_commerce_js', 'eeaPPCommerceParameters', $parameters);
-        parent::enqueue_js();
-    }
+	/**
+	 * Load scripts and localize data needed for this form.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function enqueue_js(): void
+	{
+		// Setup default values
+		$client_id_key   = Domain::META_KEY_CLIENT_ID;
+		$merchant_id     = false;
+		// Override the above if third party integration
+		if (EED_PayPalCommerce::isThirdParty($this->_pm_instance)) {
+			$client_id_key = Domain::META_KEY_PARTNER_CLIENT_ID;
+			$merchant_id   = PayPalExtraMetaManager::getPmOption(
+				$this->_pm_instance,
+				Domain::META_KEY_SELLER_MERCHANT_ID
+			);
+		}
+		// Setup query args
+		$url_params = [
+			'client-id'   => PayPalExtraMetaManager::getPmOption($this->_pm_instance, $client_id_key),
+			'currency'    => CurrencyManager::currencyCode(),
+			'components'  => implode(',', ['buttons', 'hosted-fields']),
+			'intent'      => 'capture',
+			'merchant-id' => $merchant_id,
+		];
+		// Which funding methods are active?
+		$enabled_funding = $this->_pm_instance->get_extra_meta(
+			Domain::META_KEY_FUNDING_OPTIONS,
+			true,
+			Domain::DEFAULT_FUNDING_OPTIONS
+		);
+		// Any funding method not enabled should be disabled.
+		$disabled_funding = array_diff(Domain::FUNDING_OPTIONS, $enabled_funding);
+		// Any funding options enabled?
+		if (count($enabled_funding) > 0) {
+			$url_params['enable-funding'] = implode(',', $enabled_funding);
+		}
+		// Any funding options disabled?
+		if (count($disabled_funding) > 0) {
+			$url_params['disable-funding'] = implode(',', $disabled_funding);
+		}
+		// Enqueue the PayPal JS
+		wp_enqueue_script(
+			'eea_paypal_commerce_js_lib',
+			add_query_arg($url_params, 'https://www.paypal.com/sdk/js'),
+			[],
+			null
+		);
+		wp_enqueue_script(
+			'eea_paypal_commerce_js',
+			EEP_PAYPAL_COMMERCE_URL . 'assets/js/paypal-commerce-payments.js',
+			['eea_paypal_commerce_js_lib'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		// Styles.
+		wp_enqueue_style(
+			'eea_paypal_checkout_form_styles',
+			EEP_PAYPAL_COMMERCE_URL . 'assets' . DS . 'css' . DS . 'eea-paypal-checkout.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		// Localize the script with our transaction data.
+		$parameters = $this->localizeParameters();
+		wp_localize_script('eea_paypal_commerce_js', 'eeaPPCommerceParameters', $parameters);
+		parent::enqueue_js();
+	}
 
 
-    /**
-     * Form and return PayPal commerce parameters for script localization.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function localizeParameters(): array
-    {
-        // Also tell the script about each instance of this PM.
-        $pm_versions            = [];
-        $active_payment_methods = EEM_Payment_Method::instance()->get_all_active(
-            EEM_Payment_Method::scope_cart,
-            [['PMD_slug' => ['LIKE', '%paypalcheckout%']]]
-        );
-        foreach ($active_payment_methods as $payment_method) {
-            $pm_versions[ $payment_method->slug() ] = [
-                'pm_slug' => $payment_method->slug(),
-            ];
-        }
-        // Convert money for a display format.
-        $decimal_places = CurrencyManager::getDecimalPlaces();
-        $org_country    = isset(EE_Registry::instance()->CFG->organization)
-                          && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
-            : 'US';
-        $transaction_id = $this->transaction instanceof EE_Transaction ? $this->transaction->ID() : 0;
-        $currency_code  = CurrencyManager::currencyCode();
-        return [
-            'pm_versions'            => $pm_versions,
-            'payment_currency'       => $currency_code,
-            'checkout_type'          => $this->checkout_type,
-            'currency_sign'          => EE_Registry::instance()->CFG->currency->sign,
-            'pp_order_nonce'         => wp_create_nonce(Domain::CAPTURE_ORDER_NONCE_NAME),
-            // The transaction ID is only used for logging errors.
-            'txn_id'                 => $transaction_id,
-            'org_country'            => $org_country,
-            'decimal_places'         => $decimal_places,
-            'site_name'              => get_bloginfo('name'),
-            'active_states'          => EED_PayPalCommerce::getActiveStates(),
-            'no_spco_error'          => esc_html__(
-                'It appears the SDK script was not loaded properly! Please refresh the page and try again or contact support.',
-                'event_espresso'
-            ),
-            'no_pm_error'            => esc_html__(
-                'It appears that PayPal Commerce checkout JavaScript was not loaded properly! Please refresh the page and try again or contact support. PayPal Commerce payments can\'t be processed.',
-                'event_espresso'
-            ),
-            'browser_not_supported'  => esc_html__(
-                'It appears that this browser is not supported by PayPal scripts. We apologize, but PayPal payments won\'t work in this browser version.',
-                'event_espresso'
-            ),
-            'get_token_error'        => esc_html__(
-                'There was an error while trying to get the payment token. Please refresh the page and try again or contact support.',
-                'event_espresso'
-            ),
-            'form_validation_notice' => esc_html__('Billing form information not valid.', 'event_espresso'),
-            'no_verification_token'  => esc_html__('Missing the Verification token.', 'event_espresso'),
-            'error_response'         => esc_html__('Error response received', 'event_espresso'),
-            'payment_error'          => esc_html__(
-                'There was an error with this payment. See the logs for details.',
-                'event_espresso'
-            ),
-            'no_order_id'            => esc_html__('No Order ID found.', 'event_espresso'),
-            'general_pp_error'       => esc_html__('PayPal form threw an error.', 'event_espresso'),
-            'hf_render_error'        => esc_html__('Hosted fields could not be rendered!', 'event_espresso'),
-            'pm_capture_error'       => esc_html__('Payment could not be captured!', 'event_espresso'),
-            'contact_support_msg'    => sprintf(
-                /* translators: %1$s: organization email, %2$s: the transaction ID */
-                esc_html__(
-                    'Please contact support (%1$s) for more details on this transaction #%2$s.',
-                    'event_espresso'
-                ),
-                EE_Registry::instance()->CFG->organization->get_pretty('email'),
-                $transaction_id
-            ),
-            'not_acdc_eligible'      => esc_html__(
-                'This merchant is not eligible for Advanced Card Fields checkout type.',
-                'event_espresso'
-            ),
-            'processor_response'     => esc_html__('Processor response: ', 'event_espresso'),
-        ];
-    }
+	/**
+	 * Form and return PayPal commerce parameters for script localization.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function localizeParameters(): array
+	{
+		// Also tell the script about each instance of this PM.
+		$pm_versions            = [];
+		$active_payment_methods = EEM_Payment_Method::instance()->get_all_active(
+			EEM_Payment_Method::scope_cart,
+			[['PMD_slug' => ['LIKE', '%paypalcheckout%']]]
+		);
+		foreach ($active_payment_methods as $payment_method) {
+			$pm_versions[ $payment_method->slug() ] = [
+				'pm_slug' => $payment_method->slug(),
+			];
+		}
+		// Convert money for a display format.
+		$decimal_places = CurrencyManager::getDecimalPlaces();
+		$org_country    = isset(EE_Registry::instance()->CFG->organization)
+						  && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
+			: 'US';
+		$transaction_id = $this->transaction instanceof EE_Transaction ? $this->transaction->ID() : 0;
+		$currency_code  = CurrencyManager::currencyCode();
+		return [
+			'pm_versions'            => $pm_versions,
+			'payment_currency'       => $currency_code,
+			'checkout_type'          => $this->checkout_type,
+			'currency_sign'          => EE_Registry::instance()->CFG->currency->sign,
+			'pp_order_nonce'         => wp_create_nonce(Domain::CAPTURE_ORDER_NONCE_NAME),
+			// The transaction ID is only used for logging errors.
+			'txn_id'                 => $transaction_id,
+			'org_country'            => $org_country,
+			'decimal_places'         => $decimal_places,
+			'site_name'              => get_bloginfo('name'),
+			'active_states'          => EED_PayPalCommerce::getActiveStates(),
+			'no_spco_error'          => esc_html__(
+				'It appears the SDK script was not loaded properly! Please refresh the page and try again or contact support.',
+				'event_espresso'
+			),
+			'no_pm_error'            => esc_html__(
+				'It appears that PayPal Commerce checkout JavaScript was not loaded properly! Please refresh the page and try again or contact support. PayPal Commerce payments can\'t be processed.',
+				'event_espresso'
+			),
+			'browser_not_supported'  => esc_html__(
+				'It appears that this browser is not supported by PayPal scripts. We apologize, but PayPal payments won\'t work in this browser version.',
+				'event_espresso'
+			),
+			'get_token_error'        => esc_html__(
+				'There was an error while trying to get the payment token. Please refresh the page and try again or contact support.',
+				'event_espresso'
+			),
+			'form_validation_notice' => esc_html__('Billing form information not valid.', 'event_espresso'),
+			'no_verification_token'  => esc_html__('Missing the Verification token.', 'event_espresso'),
+			'error_response'         => esc_html__('Error response received', 'event_espresso'),
+			'payment_error'          => esc_html__(
+				'There was an error with this payment. See the logs for details.',
+				'event_espresso'
+			),
+			'no_order_id'            => esc_html__('No Order ID found.', 'event_espresso'),
+			'general_pp_error'       => esc_html__('PayPal form threw an error.', 'event_espresso'),
+			'hf_render_error'        => esc_html__('Hosted fields could not be rendered!', 'event_espresso'),
+			'pm_capture_error'       => esc_html__('Payment could not be captured!', 'event_espresso'),
+			'contact_support_msg'    => sprintf(
+				/* translators: %1$s: organization email, %2$s: the transaction ID */
+				esc_html__(
+					'Please contact support (%1$s) for more details on this transaction #%2$s.',
+					'event_espresso'
+				),
+				EE_Registry::instance()->CFG->organization->get_pretty('email'),
+				$transaction_id
+			),
+			'not_acdc_eligible'      => esc_html__(
+				'This merchant is not eligible for Advanced Card Fields checkout type.',
+				'event_espresso'
+			),
+			'processor_response'     => esc_html__('Processor response: ', 'event_espresso'),
+		];
+	}
 }

Spacing +26 added lines, -26 removed lines

@@ -75,7 +75,7 @@ 
             $options,
             [
                 'name'        => 'PayPalCommerceBillingForm',
-                'html_id'     => 'pp-' . $pm_slug . '-billing-form',
+                'html_id'     => 'pp-'.$pm_slug.'-billing-form',
                 'html_class'  => 'pp_commerce_billing_form',
                 'subsections' => [
                     'eea_paypal_commerce_token' => new EE_Hidden_Input(
@@ -87,21 +87,21 @@ 
                     ),
                     'pp_order_nonce'            => new EE_Hidden_Input(
                         [
-                            'html_id'   => 'eea-' . $pm_slug . '-order-nonce',
+                            'html_id'   => 'eea-'.$pm_slug.'-order-nonce',
                             'html_name' => 'pp_order_nonce',
                             'default'   => '',
                         ]
                     ),
                     'pp_order_id'               => new EE_Hidden_Input(
                         [
-                            'html_id'   => 'eea-' . $pm_slug . '-order-id',
+                            'html_id'   => 'eea-'.$pm_slug.'-order-id',
                             'html_name' => 'pp_order_id',
                             'default'   => '',
                         ]
                     ),
                     'pp_order_status'           => new EE_Hidden_Input(
                         [
-                            'html_id'   => 'eea-' . $pm_slug . '-order-status',
+                            'html_id'   => 'eea-'.$pm_slug.'-order-status',
                             'html_name' => 'pp_order_status',
                             'default'   => '',
                         ]
@@ -137,7 +137,7 @@ 
             ]
         );
         // Add PayPal Hosted Fields.
-        if (! empty($this->checkout_type) && $this->checkout_type !== 'express_checkout') {
+        if ( ! empty($this->checkout_type) && $this->checkout_type !== 'express_checkout') {
             $this->addAdvancedCardFields();
         }
         // Add payment types separator, if both are enabled.
@@ -206,7 +206,7 @@ 
         $request        = LoaderFactory::getShared(Request::class);
         $request_params = $request->requestParams();
         // Only the PPC billing form.
-        if (! $billing_form instanceof BillingForm) {
+        if ( ! $billing_form instanceof BillingForm) {
             return $billing_form;
         }
         // Make sure the billing form subsections have correct names.
@@ -251,8 +251,8 @@ 
                         "$pm_slug-card-number-lbl",
                         "$pm_slug-card-fields",
                         "",
-                        'for="' . $pm_slug . '-card-number"'
-                    ) .
+                        'for="'.$pm_slug.'-card-number"'
+                    ).
                     EEH_HTML::p(
                         "",
                         "$pm_slug-card-number",
@@ -265,8 +265,8 @@ 
                         "$pm_slug-expiration-date-lbl",
                         "$pm_slug-card-fields",
                         "",
-                        'for="' . $pm_slug . '-expiration-date"'
-                    ) .
+                        'for="'.$pm_slug.'-expiration-date"'
+                    ).
                     EEH_HTML::p(
                         "",
                         "$pm_slug-expiration-date",
@@ -279,8 +279,8 @@ 
                         "$pm_slug-cvv-lbl",
                         "$pm_slug-card-fields",
                         "",
-                        'for="' . $pm_slug . '-cvv"'
-                    ) .
+                        'for="'.$pm_slug.'-cvv"'
+                    ).
                     EEH_HTML::p(
                         "",
                         "$pm_slug-cvv",
@@ -290,7 +290,7 @@ 
                 'pp_name_on_card'    => new EE_Text_Input(
                     [
                         'html_label_text' => esc_html__('Name On Card', 'event_espresso'),
-                        'html_id'         => $pm_slug . '-card-holder-name',
+                        'html_id'         => $pm_slug.'-card-holder-name',
                         'html_name'       => 'card-holder-name',
                         'html_class'      => '',
                         'required'        => true,
@@ -329,16 +329,16 @@ 
                     EEH_HTML::div(
                         EEH_HTML::div(
                             ' ',
-                            'eep-' . $this->paypal_pmt->slug() . '-payments-separator',
+                            'eep-'.$this->paypal_pmt->slug().'-payments-separator',
                             'eep-ppc-separator-line eep-left-floating'
-                        ) .
+                        ).
                         EEH_HTML::div(
                             esc_html__(' or ', 'event_espresso'),
-                            'eep-' . $this->paypal_pmt->slug() . '-separator-text',
+                            'eep-'.$this->paypal_pmt->slug().'-separator-text',
                             'eep-ppc-separator-text1 eep-mid-floating'
-                        ) . EEH_HTML::div(
+                        ).EEH_HTML::div(
                             ' ',
-                            'eep-' . $this->paypal_pmt->slug() . '-payments-separator',
+                            'eep-'.$this->paypal_pmt->slug().'-payments-separator',
                             'eep-ppc-separator-line eep-right-floating'
                         ),
                         'eep-ppc-separator-holder',
@@ -362,9 +362,9 @@ 
     {
         if (
             ! empty($options_array['html_id'])
-            && $options_array['html_id'] === 'spco-payment-method-info-' . $this->paypal_pmt->slug()
+            && $options_array['html_id'] === 'spco-payment-method-info-'.$this->paypal_pmt->slug()
         ) {
-            if (! empty($options_array['subsections']) && isset($options_array['subsections']['info'])) {
+            if ( ! empty($options_array['subsections']) && isset($options_array['subsections']['info'])) {
                 unset($options_array['subsections']['info']);
             }
         }
@@ -386,7 +386,7 @@ 
                 [
                     'layout_strategy' => new EE_Template_Layout(
                         [
-                            'layout_template_file' => $this->template_path . 'debugInfo.template.php',
+                            'layout_template_file' => $this->template_path.'debugInfo.template.php',
                             'template_args'        => [],
                         ]
                     ),
@@ -412,7 +412,7 @@ 
             [
                 'layout_strategy' => new EE_Template_Layout(
                     [
-                        'layout_template_file' => $this->template_path . 'paymentButtons.template.php',
+                        'layout_template_file' => $this->template_path.'paymentButtons.template.php',
                         'template_args'        => $template_args,
                     ]
                 ),
@@ -440,7 +440,7 @@ 
             }
             $client_token = $response['client_token'];
             $attributes   = " data-partner-attribution-id=\"$bn_code\" data-client-token=\"$client_token\"";
-            $tag          = str_replace('></script>', $attributes . '></script>', $tag);
+            $tag          = str_replace('></script>', $attributes.'></script>', $tag);
         }
         return $tag;
     }
@@ -500,7 +500,7 @@ 
         );
         wp_enqueue_script(
             'eea_paypal_commerce_js',
-            EEP_PAYPAL_COMMERCE_URL . 'assets/js/paypal-commerce-payments.js',
+            EEP_PAYPAL_COMMERCE_URL.'assets/js/paypal-commerce-payments.js',
             ['eea_paypal_commerce_js_lib'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -508,7 +508,7 @@ 
         // Styles.
         wp_enqueue_style(
             'eea_paypal_checkout_form_styles',
-            EEP_PAYPAL_COMMERCE_URL . 'assets' . DS . 'css' . DS . 'eea-paypal-checkout.css',
+            EEP_PAYPAL_COMMERCE_URL.'assets'.DS.'css'.DS.'eea-paypal-checkout.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -536,7 +536,7 @@ 
             [['PMD_slug' => ['LIKE', '%paypalcheckout%']]]
         );
         foreach ($active_payment_methods as $payment_method) {
-            $pm_versions[ $payment_method->slug() ] = [
+            $pm_versions[$payment_method->slug()] = [
                 'pm_slug' => $payment_method->slug(),
             ];
         }

admin_pages/messages/help_tabs/messages_settings.help_tab.php

Indentation +9 added lines, -9 removed lines

@@ -3,23 +3,23 @@
 </p>
 <p>
     <?php esc_html_e(
-        'On its first activation, Event Espresso will automatically setup the core messenger (email) and message types (registration and payment).',
-        'event_espresso'
-    ); ?>
+		'On its first activation, Event Espresso will automatically setup the core messenger (email) and message types (registration and payment).',
+		'event_espresso'
+	); ?>
 </p>
 <p>
     <strong><?php esc_html_e('Recommendations', 'event_espresso'); ?></strong>
     <br />
     <?php esc_html_e(
-        'To learn more about the options on this page, take a look at the different tabs that appear on the left side of the page.',
-        'event_espresso'
-    ); ?>
+		'To learn more about the options on this page, take a look at the different tabs that appear on the left side of the page.',
+		'event_espresso'
+	); ?>
 </p>
 <p>
     <strong><?php esc_html_e('Screen Options', 'event_espresso'); ?></strong>
     <br />
     <?php esc_html_e(
-        'You can customize the information that is shown on this page by toggling the Screen Options tab. Then you can add or remove checkmarks to hide or show certain content.',
-        'event_espresso'
-    ); ?>
+		'You can customize the information that is shown on this page by toggling the Screen Options tab. Then you can add or remove checkmarks to hide or show certain content.',
+		'event_espresso'
+	); ?>
 </p>

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_org_options.dmsstage.php

Indentation +306 added lines, -306 removed lines

@@ -89,323 +89,323 @@
  */
 class EE_DMS_4_1_0_org_options extends EE_Data_Migration_Script_Stage
 {
-    public function __construct()
-    {
-        $this->_pretty_name                        = esc_html__("Organization Options/Config", "event_espresso");
-        $this->_org_options_we_know_how_to_migrate = apply_filters(
-            'FHEE__EE_DMS_4_1_0_org_options__org_options_we_know_how_to_migrate',
-            $this->_org_options_we_know_how_to_migrate
-        );
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		$this->_pretty_name                        = esc_html__("Organization Options/Config", "event_espresso");
+		$this->_org_options_we_know_how_to_migrate = apply_filters(
+			'FHEE__EE_DMS_4_1_0_org_options__org_options_we_know_how_to_migrate',
+			$this->_org_options_we_know_how_to_migrate
+		);
+		parent::__construct();
+	}
 
 
-    public function _migration_step($num_items_to_migrate = 50)
-    {
-        $items_actually_migrated = 0;
-        $old_org_options         = get_option('events_organization_settings');
-        foreach ($this->_org_options_we_know_how_to_migrate as $option_name) {
-            // only bother migrating if there's a setting to migrate. Otherwise we'll just use the default
-            if (isset($old_org_options[ $option_name ])) {
-                $this->_handle_org_option($option_name, $old_org_options[ $option_name ]);
-            }
-            if ($option_name == 'surcharge') {
-                $this->_insert_new_global_surcharge_price($old_org_options);
-            }
-            $items_actually_migrated++;
-        }
+	public function _migration_step($num_items_to_migrate = 50)
+	{
+		$items_actually_migrated = 0;
+		$old_org_options         = get_option('events_organization_settings');
+		foreach ($this->_org_options_we_know_how_to_migrate as $option_name) {
+			// only bother migrating if there's a setting to migrate. Otherwise we'll just use the default
+			if (isset($old_org_options[ $option_name ])) {
+				$this->_handle_org_option($option_name, $old_org_options[ $option_name ]);
+			}
+			if ($option_name == 'surcharge') {
+				$this->_insert_new_global_surcharge_price($old_org_options);
+			}
+			$items_actually_migrated++;
+		}
 
-        $success = EE_Config::instance()->update_espresso_config();
-        if (! $success) {
-            $this->add_error(
-                sprintf(
-                    esc_html__('Could not save EE Config during org options stage. Reason: %s', 'event_espresso'),
-                    EE_Error::get_notices(false)
-                )
-            );
-            EE_Error::overwrite_errors();
-        }
-        EE_Network_Config::instance()->update_config(false, false);
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            // we may have added new pages and this might be necessary
-            flush_rewrite_rules();
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
+		$success = EE_Config::instance()->update_espresso_config();
+		if (! $success) {
+			$this->add_error(
+				sprintf(
+					esc_html__('Could not save EE Config during org options stage. Reason: %s', 'event_espresso'),
+					EE_Error::get_notices(false)
+				)
+			);
+			EE_Error::overwrite_errors();
+		}
+		EE_Network_Config::instance()->update_config(false, false);
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			// we may have added new pages and this might be necessary
+			flush_rewrite_rules();
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
 
 
-    public function _count_records_to_migrate(): int
-    {
-        return (int) count($this->_org_options_we_know_how_to_migrate);
-    }
+	public function _count_records_to_migrate(): int
+	{
+		return (int) count($this->_org_options_we_know_how_to_migrate);
+	}
 
 
-    private function _handle_org_option($option_name, $value)
-    {
-        $c  = EE_Config::instance();
-        $cn = EE_Network_Config::instance();
-        switch ($option_name) {
-            case 'organization':
-                $c->organization->name = $value;
-                break;
-            case 'organization_street1':
-                $c->organization->address_1 = $value;
-                break;
-            case 'organization_street2':
-                $c->organization->address_2 = $value;
-                break;
-            case 'organization_city':
-                $c->organization->city = $value;
-                break;
-            case 'organization_state':
-                try {
-                    $state                   = $this->get_migration_script()->get_or_create_state($value);
-                    $state_id                = $state['STA_ID'];
-                    $c->organization->STA_ID = $state_id;
-                } catch (EE_Error $e) {
-                }
-                break;
-            case 'organization_zip':
-                $c->organization->zip = $value;
-                break;
-            case 'contact_email':
-                $c->organization->email = $value;
-                break;
-            case 'default_payment_status':
-                $c->registration->default_STS_ID =
-                    $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID($value);
-                break;
-            case 'organization_country':
-                $iso                      = $this->get_migration_script()->get_iso_from_3_1_country_id($value);
-                $c->organization->CNT_ISO = $iso;
-                $country_row              = $this->get_migration_script()->get_or_create_country($iso);
-                if (! $country_row) {
-                    $this->add_error(
-                        sprintf(
-                            esc_html__(
-                                "Could not set country's currency config because no country exists for ISO %s",
-                                "event_espresso"
-                            ),
-                            $iso
-                        )
-                    );
-                }
-                // can't use EE_Currency_Config's handy constructor because the models are off-limits right now (and it uses them)
-                $c->currency->code    = $country_row['CNT_cur_code'];             // currency code: USD, CAD, EUR
-                $c->currency->name    = $country_row['CNT_cur_single'];           // Dollar
-                $c->currency->plural  = $country_row['CNT_cur_plural'];           // Dollars
-                $c->currency->sign    = $country_row['CNT_cur_sign'];             // currency sign: $
-                $c->currency->sign_b4 = filter_var(
-                    $country_row['CNT_cur_sign_b4'],
-                    FILTER_VALIDATE_BOOLEAN
-                );                                                                // currency sign before or after: $TRUE  or  FALSE$
-                $c->currency->dec_plc = (int) $country_row['CNT_cur_dec_plc'];    // decimal places: 2 = 0.00  3 = 0.000
-                $c->currency->dec_mrk =
-                    $country_row['CNT_cur_dec_mrk'];                              // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-                $c->currency->thsnds  = $country_row['CNT_cur_thsnds'];
-                break;  // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
-            //  $c->currency = new EE_Currency_Config($c->organization->CNT_ISO);break;
-            //  case 'currency_symbol': ignore the currency symbol. we'll just go by their country.
-            //  $c->currency->sign = $value;break;
-            case 'show_pending_payment_options':
-                $c->registration->show_pending_payment_options = ($value == 'Y');
-                break;
-            // case 'display_address_in_regform':
-            //     $c->template_settings->display_address_in_regform = ($value == 'Y');
-            //     break;
-            case 'default_logo_url':
-                $c->organization->logo_url = $value;
-                break;
-            case 'event_page_id':
-                // also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS
-                // to ESPRESSO_THANK_YOU
-                $reg_page_post               = get_post(absint($value));
-                $reg_page_post->post_content = str_replace(
-                    "[ESPRESSO_EVENTS]",
-                    "[ESPRESSO_CHECKOUT]",
-                    $reg_page_post->post_content
-                );
-                wp_update_post($reg_page_post);
-                $c->core->reg_page_id = $value;
-                break;
-            case 'return_url':
-                // also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS
-                // to ESPRESSO_THANK_YOU
-                $thank_you_page_post               = get_post(absint($value));
-                $thank_you_page_post->post_content = str_replace(
-                    "[ESPRESSO_PAYMENTS]",
-                    "[ESPRESSO_THANK_YOU]",
-                    $thank_you_page_post->post_content
-                );
-                wp_update_post($thank_you_page_post);
-                $c->core->thank_you_page_id = absint($value);
-                break;
-            case 'cancel_return':
-                $c->core->cancel_page_id = absint($value);
+	private function _handle_org_option($option_name, $value)
+	{
+		$c  = EE_Config::instance();
+		$cn = EE_Network_Config::instance();
+		switch ($option_name) {
+			case 'organization':
+				$c->organization->name = $value;
+				break;
+			case 'organization_street1':
+				$c->organization->address_1 = $value;
+				break;
+			case 'organization_street2':
+				$c->organization->address_2 = $value;
+				break;
+			case 'organization_city':
+				$c->organization->city = $value;
+				break;
+			case 'organization_state':
+				try {
+					$state                   = $this->get_migration_script()->get_or_create_state($value);
+					$state_id                = $state['STA_ID'];
+					$c->organization->STA_ID = $state_id;
+				} catch (EE_Error $e) {
+				}
+				break;
+			case 'organization_zip':
+				$c->organization->zip = $value;
+				break;
+			case 'contact_email':
+				$c->organization->email = $value;
+				break;
+			case 'default_payment_status':
+				$c->registration->default_STS_ID =
+					$this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID($value);
+				break;
+			case 'organization_country':
+				$iso                      = $this->get_migration_script()->get_iso_from_3_1_country_id($value);
+				$c->organization->CNT_ISO = $iso;
+				$country_row              = $this->get_migration_script()->get_or_create_country($iso);
+				if (! $country_row) {
+					$this->add_error(
+						sprintf(
+							esc_html__(
+								"Could not set country's currency config because no country exists for ISO %s",
+								"event_espresso"
+							),
+							$iso
+						)
+					);
+				}
+				// can't use EE_Currency_Config's handy constructor because the models are off-limits right now (and it uses them)
+				$c->currency->code    = $country_row['CNT_cur_code'];             // currency code: USD, CAD, EUR
+				$c->currency->name    = $country_row['CNT_cur_single'];           // Dollar
+				$c->currency->plural  = $country_row['CNT_cur_plural'];           // Dollars
+				$c->currency->sign    = $country_row['CNT_cur_sign'];             // currency sign: $
+				$c->currency->sign_b4 = filter_var(
+					$country_row['CNT_cur_sign_b4'],
+					FILTER_VALIDATE_BOOLEAN
+				);                                                                // currency sign before or after: $TRUE  or  FALSE$
+				$c->currency->dec_plc = (int) $country_row['CNT_cur_dec_plc'];    // decimal places: 2 = 0.00  3 = 0.000
+				$c->currency->dec_mrk =
+					$country_row['CNT_cur_dec_mrk'];                              // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+				$c->currency->thsnds  = $country_row['CNT_cur_thsnds'];
+				break;  // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+			//  $c->currency = new EE_Currency_Config($c->organization->CNT_ISO);break;
+			//  case 'currency_symbol': ignore the currency symbol. we'll just go by their country.
+			//  $c->currency->sign = $value;break;
+			case 'show_pending_payment_options':
+				$c->registration->show_pending_payment_options = ($value == 'Y');
+				break;
+			// case 'display_address_in_regform':
+			//     $c->template_settings->display_address_in_regform = ($value == 'Y');
+			//     break;
+			case 'default_logo_url':
+				$c->organization->logo_url = $value;
+				break;
+			case 'event_page_id':
+				// also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS
+				// to ESPRESSO_THANK_YOU
+				$reg_page_post               = get_post(absint($value));
+				$reg_page_post->post_content = str_replace(
+					"[ESPRESSO_EVENTS]",
+					"[ESPRESSO_CHECKOUT]",
+					$reg_page_post->post_content
+				);
+				wp_update_post($reg_page_post);
+				$c->core->reg_page_id = $value;
+				break;
+			case 'return_url':
+				// also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS
+				// to ESPRESSO_THANK_YOU
+				$thank_you_page_post               = get_post(absint($value));
+				$thank_you_page_post->post_content = str_replace(
+					"[ESPRESSO_PAYMENTS]",
+					"[ESPRESSO_THANK_YOU]",
+					$thank_you_page_post->post_content
+				);
+				wp_update_post($thank_you_page_post);
+				$c->core->thank_you_page_id = absint($value);
+				break;
+			case 'cancel_return':
+				$c->core->cancel_page_id = absint($value);
 
-                break;
-            case 'notify_url':
-                $c->core->txn_page_id = absint($value);
-                break;
-            case 'use_captcha':
-                $c->registration->use_captcha = ($value == 'Y');
-                break;
-            case 'recaptcha_publickey':
-                $c->registration->recaptcha_publickey = $value;
-                break;
-            case 'recaptcha_privatekey':
-                $c->registration->recaptcha_privatekey = $value;
-                break;
-            case 'recaptcha_theme':
-                $c->registration->recaptcha_theme = $value;
-                break;
-            case 'recaptcha_width':
-                $c->registration->recaptcha_width = $value;
-                break;
-            case 'recaptcha_language':
-                $c->registration->recaptcha_language = $value;
-                break;
-            case 'espresso_dashboard_widget':
-                $c->admin->use_dashboard_widget = ($value == 'Y');
-                break;
-            case 'use_personnel_manager':
-                $c->admin->use_personnel_manager = ($value == 'Y');
-                break;
-            case 'use_event_timezones':
-                $c->admin->use_event_timezones = ($value == 'Y');
-                break;
-            case 'affiliate_id':
-                $c->admin->affiliate_id = $value;
-                break;
-            case 'site_license_key':
-                $cn->core->site_license_key = $value;
-                break;
-            default:
-                do_action('AHEE__EE_DMS_4_1_0__handle_org_option', $option_name, $value);
-        }
-    }
+				break;
+			case 'notify_url':
+				$c->core->txn_page_id = absint($value);
+				break;
+			case 'use_captcha':
+				$c->registration->use_captcha = ($value == 'Y');
+				break;
+			case 'recaptcha_publickey':
+				$c->registration->recaptcha_publickey = $value;
+				break;
+			case 'recaptcha_privatekey':
+				$c->registration->recaptcha_privatekey = $value;
+				break;
+			case 'recaptcha_theme':
+				$c->registration->recaptcha_theme = $value;
+				break;
+			case 'recaptcha_width':
+				$c->registration->recaptcha_width = $value;
+				break;
+			case 'recaptcha_language':
+				$c->registration->recaptcha_language = $value;
+				break;
+			case 'espresso_dashboard_widget':
+				$c->admin->use_dashboard_widget = ($value == 'Y');
+				break;
+			case 'use_personnel_manager':
+				$c->admin->use_personnel_manager = ($value == 'Y');
+				break;
+			case 'use_event_timezones':
+				$c->admin->use_event_timezones = ($value == 'Y');
+				break;
+			case 'affiliate_id':
+				$c->admin->affiliate_id = $value;
+				break;
+			case 'site_license_key':
+				$cn->core->site_license_key = $value;
+				break;
+			default:
+				do_action('AHEE__EE_DMS_4_1_0__handle_org_option', $option_name, $value);
+		}
+	}
 
 
-    /**
-     * Creates a 4.1 member price discount
-     *
-     * @param array $org_options
-     * @return void
-     * @global wpdb $wpdb
-     */
-    private function _insert_new_global_surcharge_price(array $org_options): void
-    {
-        $amount = (float) $org_options['surcharge'];
-        // dont create a price if the surcharge is 0
-        if ($amount <= .01) {
-            return;
-        }
-        if ($org_options['surcharge_type'] == 'flat_rate') {
-            $price_type = EE_DMS_4_1_0_prices::price_type_flat_surcharge;
-        } else {
-            $price_type = EE_DMS_4_1_0_prices::price_type_percent_surcharge;
-        }
-        global $wpdb;
-        $cols_n_values = [
-            'PRT_ID'         => $price_type,
-            'PRC_amount'     => $amount,
-            'PRC_name'       => $org_options['surcharge_text'],
-            'PRC_is_default' => true,
-            'PRC_overrides'  => false,
-            'PRC_order'      => 100,
-            'PRC_deleted'    => false,
-            'PRC_parent'     => null,
+	/**
+	 * Creates a 4.1 member price discount
+	 *
+	 * @param array $org_options
+	 * @return void
+	 * @global wpdb $wpdb
+	 */
+	private function _insert_new_global_surcharge_price(array $org_options): void
+	{
+		$amount = (float) $org_options['surcharge'];
+		// dont create a price if the surcharge is 0
+		if ($amount <= .01) {
+			return;
+		}
+		if ($org_options['surcharge_type'] == 'flat_rate') {
+			$price_type = EE_DMS_4_1_0_prices::price_type_flat_surcharge;
+		} else {
+			$price_type = EE_DMS_4_1_0_prices::price_type_percent_surcharge;
+		}
+		global $wpdb;
+		$cols_n_values = [
+			'PRT_ID'         => $price_type,
+			'PRC_amount'     => $amount,
+			'PRC_name'       => $org_options['surcharge_text'],
+			'PRC_is_default' => true,
+			'PRC_overrides'  => false,
+			'PRC_order'      => 100,
+			'PRC_deleted'    => false,
+			'PRC_parent'     => null,
 
-        ];
-        $data_types    = [
-            '%d',// PRT_ID
-            '%f',// PRT_amount
-            '%s',// PRC_name
-            '%d',// PRC_is_default
-            '%d',// PRC_overrides
-            '%d',// PRC_order
-            '%d',// PRC_deleted
-            '%d',// PRC_parent
-        ];
-        $price_table   = $wpdb->prefix . "esp_price";
-        $success       = $wpdb->insert($price_table, $cols_n_values, $data_types);
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    'org_options',
-                    [
-                        'surcharge'      => $org_options['surcharge'],
-                        'surcharge_type' => $org_options['surcharge_type'],
-                        'surcharge_text' => $org_options['surcharge_text'],
-                    ],
-                    $price_table,
-                    $cols_n_values,
-                    $data_types
-                )
-            );
-        }
-    }
+		];
+		$data_types    = [
+			'%d',// PRT_ID
+			'%f',// PRT_amount
+			'%s',// PRC_name
+			'%d',// PRC_is_default
+			'%d',// PRC_overrides
+			'%d',// PRC_order
+			'%d',// PRC_deleted
+			'%d',// PRC_parent
+		];
+		$price_table   = $wpdb->prefix . "esp_price";
+		$success       = $wpdb->insert($price_table, $cols_n_values, $data_types);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					'org_options',
+					[
+						'surcharge'      => $org_options['surcharge'],
+						'surcharge_type' => $org_options['surcharge_type'],
+						'surcharge_text' => $org_options['surcharge_text'],
+					],
+					$price_table,
+					$cols_n_values,
+					$data_types
+				)
+			);
+		}
+	}
 
 
-    protected $_org_options_we_know_how_to_migrate = [
-        'organization',
-        'organization_street1',
-        'organization_street2',
-        'organization_city',
-        'organization_state',
-        'organization_zip',
-        'contact_email',
-        'default_mail',
-        'payment_subject',
-        'payment_message',
-        'message',
-        'default_payment_status',
-        'surcharge',                                // used during price migration
-        'country_id',                               // used during price migration
-        'organization_country',
-        //'currency_symbol',
-        'expire_on_registration_end',
-        'email_before_payment',
-        'email_fancy_headers',
-        //'enable_default_style',                   // unused
-        'event_ssl_active',
-        'selected_style',
-        'show_pending_payment_options',
-        'show_reg_footer',
-        'skip_confirmation_page',
-        'allow_mer_discounts',                      // no equiv
-        'allow_mer_vouchers',                       // no equiv
-        'display_short_description_in_event_list',
-        //'display_description_on_multi_reg_page',  // unused
-        'display_address_in_event_list',
-        //'display_address_in_regform',             // unused
-        //'use_custom_post_types',                    // no equiv
-        'display_ical_download',
-        'display_featured_image',
-        'themeroller',
-        'default_logo_url',
-        'event_page_id',
-        'return_url',
-        'cancel_return',
-        'notify_url',
-        'events_in_dasboard',
-        'events_in_dashboard',
-        'use_captcha',
-        'recaptcha_publickey',
-        'recaptcha_privatekey',
-        'recaptcha_theme',
-        'recaptcha_width',
-        'recaptcha_language',
-        'espresso_dashboard_widget',
-        'time_reg_limit',
-        //'use_attendee_pre_approval',              // removed in 4.1- instead this is factored into the default reg status
-        'use_personnel_manager',                    // no equiv
-        'use_event_timezones',
-        //'full_logging',                           // unused
-        'surcharge_type',                           // used during price migration
-        'surcharge_text',                           // used during price migration
-        'affiliate_id',
-        'site_license_key',
-    ];
+	protected $_org_options_we_know_how_to_migrate = [
+		'organization',
+		'organization_street1',
+		'organization_street2',
+		'organization_city',
+		'organization_state',
+		'organization_zip',
+		'contact_email',
+		'default_mail',
+		'payment_subject',
+		'payment_message',
+		'message',
+		'default_payment_status',
+		'surcharge',                                // used during price migration
+		'country_id',                               // used during price migration
+		'organization_country',
+		//'currency_symbol',
+		'expire_on_registration_end',
+		'email_before_payment',
+		'email_fancy_headers',
+		//'enable_default_style',                   // unused
+		'event_ssl_active',
+		'selected_style',
+		'show_pending_payment_options',
+		'show_reg_footer',
+		'skip_confirmation_page',
+		'allow_mer_discounts',                      // no equiv
+		'allow_mer_vouchers',                       // no equiv
+		'display_short_description_in_event_list',
+		//'display_description_on_multi_reg_page',  // unused
+		'display_address_in_event_list',
+		//'display_address_in_regform',             // unused
+		//'use_custom_post_types',                    // no equiv
+		'display_ical_download',
+		'display_featured_image',
+		'themeroller',
+		'default_logo_url',
+		'event_page_id',
+		'return_url',
+		'cancel_return',
+		'notify_url',
+		'events_in_dasboard',
+		'events_in_dashboard',
+		'use_captcha',
+		'recaptcha_publickey',
+		'recaptcha_privatekey',
+		'recaptcha_theme',
+		'recaptcha_width',
+		'recaptcha_language',
+		'espresso_dashboard_widget',
+		'time_reg_limit',
+		//'use_attendee_pre_approval',              // removed in 4.1- instead this is factored into the default reg status
+		'use_personnel_manager',                    // no equiv
+		'use_event_timezones',
+		//'full_logging',                           // unused
+		'surcharge_type',                           // used during price migration
+		'surcharge_text',                           // used during price migration
+		'affiliate_id',
+		'site_license_key',
+	];
 }

core/EE_Front_Controller.core.php

Indentation +516 added lines, -516 removed lines

@@ -20,520 +20,520 @@
  */
 final class EE_Front_Controller
 {
-    /**
-     * @var string
-     */
-    private $_template_path;
-
-    /**
-     * @var string
-     */
-    private $_template;
-
-    /**
-     * @type EE_Registry
-     */
-    protected $Registry;
-
-    /**
-     * @type EE_Request_Handler
-     */
-    protected $Request_Handler;
-
-    /**
-     * @type EE_Module_Request_Router
-     */
-    protected $Module_Request_Router;
-
-    /**
-     * @type CurrentPage
-     */
-    protected $current_page;
-
-
-    /**
-     *    class constructor
-     *    should fire after shortcode, module, addon, or other plugin's default priority init phases have run
-     *
-     * @access    public
-     * @param EE_Registry              $Registry
-     * @param CurrentPage              $EspressoPage
-     * @param EE_Module_Request_Router $Module_Request_Router
-     */
-    public function __construct(
-        EE_Registry $Registry,
-        CurrentPage $EspressoPage,
-        EE_Module_Request_Router $Module_Request_Router
-    ) {
-        $this->Registry              = $Registry;
-        $this->current_page          = $EspressoPage;
-        $this->Module_Request_Router = $Module_Request_Router;
-        // load other resources and begin to actually run shortcodes and modules
-        // analyse the incoming WP request
-        add_action('parse_request', [$this, 'get_request'], 1);
-        // process request with module factory
-        add_action('pre_get_posts', [$this, 'pre_get_posts']);
-        // before headers sent
-        add_action('wp', [$this, 'wp'], 5);
-        // primarily used to process any content shortcodes
-        add_action('template_redirect', [$this, 'templateRedirect'], 999);
-        // header
-        add_action('wp_head', [$this, 'header_meta_tag'], 5);
-        add_action('wp_print_scripts', [$this, 'wp_print_scripts']);
-        add_filter('template_include', [$this, 'template_include'], 1);
-        // display errors
-        add_action('loop_start', [$this, 'display_errors'], 2);
-        // the content
-        // add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 );
-        // exclude our private cpt comments
-        add_filter('comments_clauses', [$this, 'filter_wp_comments']);
-        // make sure any ajax requests will respect the url schema
-        // when requests are made against admin-ajax.php (http:// or https://)
-        add_filter('admin_url', [$this, 'maybe_force_admin_ajax_ssl'], 200);
-        // action hook EE
-        do_action('AHEE__EE_Front_Controller__construct__done', $this);
-    }
-
-
-    /**
-     * @return EE_Request_Handler
-     * @deprecated 4.10.14.p
-     */
-    public function Request_Handler()
-    {
-        if (! $this->Request_Handler instanceof EE_Request_Handler) {
-            $this->Request_Handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
-        }
-        return $this->Request_Handler;
-    }
-
-
-    /**
-     * @return EE_Module_Request_Router
-     */
-    public function Module_Request_Router()
-    {
-        return $this->Module_Request_Router;
-    }
-
-
-    /**
-     * @return LegacyShortcodesManager
-     * @deprecated 4.10.14.p
-     */
-    public function getLegacyShortcodesManager()
-    {
-        return EE_Config::getLegacyShortcodesManager();
-    }
-
-
-
-
-
-    /***********************************************        INIT ACTION HOOK         ***********************************************/
-    /**
-     * filter_wp_comments
-     * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment
-     * widgets/queries done on frontend
-     *
-     * @param array $clauses array of comment clauses setup by WP_Comment_Query
-     * @return array array of comment clauses with modifications.
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function filter_wp_comments($clauses)
-    {
-        global $wpdb;
-        if (strpos($clauses['join'], $wpdb->posts) !== false) {
-            /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-            $custom_post_types = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-            );
-            $cpts              = $custom_post_types->getPrivateCustomPostTypes();
-            foreach ($cpts as $cpt => $details) {
-                $clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt);
-            }
-        }
-        return $clauses;
-    }
-
-
-    /**
-     * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend
-     *
-     * @param string $url incoming url
-     * @return string         final assembled url
-     */
-    public function maybe_force_admin_ajax_ssl($url)
-    {
-        if (is_ssl() && preg_match('/admin-ajax.php/', $url)) {
-            $url = str_replace('http://', 'https://', $url);
-        }
-        return $url;
-    }
-
-
-
-
-
-
-    /***********************************************        WP_LOADED ACTION HOOK         ***********************************************/
-
-
-    /**
-     *    wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their
-     *    default priority init phases have run
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-
-
-
-    /***********************************************        PARSE_REQUEST HOOK         ***********************************************/
-    /**
-     *    _get_request
-     *
-     * @access public
-     * @param WP $WP
-     * @return void
-     */
-    public function get_request(WP $WP)
-    {
-        static $done = false;
-        if ($done) {
-            return;
-        }
-        $done = true;
-        do_action('AHEE__EE_Front_Controller__get_request__start');
-        $this->current_page->parseQueryVars($WP);
-        do_action('AHEE__EE_Front_Controller__get_request__complete');
-    }
-
-
-    /**
-     *    pre_get_posts - basically a module factory for instantiating modules and selecting the final view template
-     *
-     * @access    public
-     * @param WP_Query $WP_Query
-     * @return    void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function pre_get_posts($WP_Query)
-    {
-        // only load Module_Request_Router if this is the main query
-        if (
-            $this->Module_Request_Router instanceof EE_Module_Request_Router
-            && $WP_Query->is_main_query()
-        ) {
-            // cycle thru module routes
-            while ($route = $this->Module_Request_Router->get_route($WP_Query)) {
-                // determine module and method for route
-                $module = $this->Module_Request_Router->resolve_route($route[0], $route[1]);
-                if ($module instanceof EED_Module) {
-                    // get registered view for route
-                    $this->_template_path = $this->Module_Request_Router->get_view($route);
-                    // grab module name
-                    $module_name = $module->module_name();
-                    // map the module to the module objects
-                    $this->Registry->modules->{$module_name} = $module;
-                }
-            }
-        }
-    }
-
-
-
-
-
-    /***********************************************        WP HOOK         ***********************************************/
-
-
-    /**
-     *    wp - basically last chance to do stuff before headers sent
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp()
-    {
-        AriaLiveAnnouncer::setHooks();
-    }
-
-
-
-    /***********************     GET_HEADER && WP_HEAD HOOK     ***********************/
-
-
-    /**
-     * callback for the "template_redirect" hook point
-     * checks sidebars for EE widgets
-     * loads resources and assets accordingly
-     *
-     * @return void
-     */
-    public function templateRedirect()
-    {
-        global $wp_query;
-        if (empty($wp_query->posts)) {
-            return;
-        }
-        // if we already know this is an espresso page, then load assets
-        $load_assets = $this->current_page->isEspressoPage();
-        // if we are already loading assets then just move along, otherwise check for widgets
-        $load_assets = $load_assets || $this->espresso_widgets_in_active_sidebars();
-        if ($load_assets) {
-            add_action('wp_enqueue_scripts', [$this, 'enqueueStyle']);
-            add_action('wp_enqueue_scripts', [$this, 'enqueueScripts']);
-        }
-
-        if (is_singular(EspressoPostType::EVENTS)) {
-            new FilterNextPreviousEventPostQuery();
-        }
-    }
-
-
-    /**
-     * builds list of active widgets then scans active sidebars looking for them
-     * returns true is an EE widget is found in an active sidebar
-     * Please Note: this does NOT mean that the sidebar or widget
-     * is actually in use in a given template, as that is unfortunately not known
-     * until a sidebar and it's widgets are actually loaded
-     *
-     * @return boolean
-     */
-    private function espresso_widgets_in_active_sidebars()
-    {
-        $espresso_widgets = [];
-        foreach ($this->Registry->widgets as $widget_class => $widget) {
-            $id_base = EspressoWidget::getIdBase($widget_class);
-            if (is_active_widget(false, false, $id_base)) {
-                $espresso_widgets[] = $id_base;
-            }
-        }
-        $all_sidebar_widgets = wp_get_sidebars_widgets();
-        foreach ($all_sidebar_widgets as $sidebar_widgets) {
-            if (is_array($sidebar_widgets) && ! empty($sidebar_widgets)) {
-                foreach ($sidebar_widgets as $sidebar_widget) {
-                    foreach ($espresso_widgets as $espresso_widget) {
-                        if (strpos($sidebar_widget, $espresso_widget) !== false) {
-                            return true;
-                        }
-                    }
-                }
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    header_meta_tag
-     *
-     * @access    public
-     * @return    void
-     */
-    public function header_meta_tag()
-    {
-        print(
-        apply_filters(
-            'FHEE__EE_Front_Controller__header_meta_tag',
-            '<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n"
-        )
-        );
-
-        // let's exclude all event type taxonomy term archive pages from search engine indexing
-        // @see https://events.codebasehq.com/projects/event-espresso/tickets/10249
-        // also exclude all critical pages from indexing
-        if (
-            (
-                is_tax('espresso_event_type')
-                && get_option('blog_public') !== '0'
-            )
-            || is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array())
-        ) {
-            print(
-            apply_filters(
-                'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
-                '<meta name="robots" content="noindex,follow" />' . "\n"
-            )
-            );
-        }
-    }
-
-
-    /**
-     * wp_print_scripts
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function wp_print_scripts()
-    {
-        global $post;
-        if (
-            isset($post->EE_Event)
-            && $post->EE_Event instanceof EE_Event
-            && get_post_type() === EspressoPostType::EVENTS
-            && is_singular()
-        ) {
-            EEH_Schema::add_json_linked_data_for_event($post->EE_Event);
-        }
-    }
-
-
-    public function enqueueStyle()
-    {
-        wp_enqueue_style('espresso_default');
-        wp_enqueue_style('espresso_custom_css');
-    }
-
-
-    /***********************************************        WP_FOOTER         ***********************************************/
-
-
-    public function enqueueScripts()
-    {
-        wp_enqueue_script('espresso_core');
-    }
-
-
-    /**
-     * @param WP_Query $query
-     * @return void
-     * @throws DomainException
-     */
-    public function display_errors(WP_Query $query)
-    {
-        if (! $query->is_main_query()) {
-            return;
-        }
-        static $shown_already = false;
-        do_action('AHEE__EE_Front_Controller__display_errors__begin');
-        if (
-            ! $shown_already
-            && apply_filters('FHEE__EE_Front_Controller__display_errors', true)
-            && is_main_query()
-            && ! is_feed()
-            && in_the_loop()
-            && $this->current_page->isEspressoPage()
-        ) {
-            $shown_already = true;
-            if (did_action('wp_head')) {
-                echo wp_kses($this->printNotices(), AllowedTags::getAllowedTags());
-            } else {
-                // block enabled themes run their query loop before headers are sent
-                // so we need to add our notices onto the beginning of the content
-                add_filter('the_content', [$this, 'prependNotices'], 1);
-            }
-        }
-        do_action('AHEE__EE_Front_Controller__display_errors__end');
-    }
-
-
-    /**
-     * @param string $the_content
-     * @return string
-     * @since 4.10.30.p
-     */
-    public function prependNotices($the_content)
-    {
-        $notices = $this->printNotices();
-        return $notices ? $notices . $the_content : $the_content;
-    }
-
-
-    /**
-     * @return false|string
-     * @since 4.10.30.p
-     */
-    public function printNotices()
-    {
-        ob_start();
-        echo wp_kses(EE_Error::get_notices(), AllowedTags::getWithFormTags());
-        EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
-        return ob_get_clean();
-    }
-
-
-
-    /***********************************************        UTILITIES         ***********************************************/
-
-
-    /**
-     * @param bool|string $template_include_path
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function template_include($template_include_path = '')
-    {
-        if ($this->current_page->isEspressoPage()) {
-            // despite all helpers having autoloaders set, we need to manually load the template loader
-            // because there are some side effects in that class for triggering template tag functions
-            $this->Registry->load_helper('EEH_Template');
-            $this->_template_path = ! empty($this->_template_path)
-                ? basename($this->_template_path)
-                : basename((string) $template_include_path);
-            $template_path        = EEH_Template::locate_template($this->_template_path, [], false);
-            $this->_template_path = ! empty($template_path) ? $template_path : $template_include_path;
-            $this->_template      = basename($this->_template_path);
-            return $this->_template_path;
-        }
-        return $template_include_path;
-    }
-
-
-    /**
-     * @param bool $with_path
-     * @return    string
-     */
-    public function get_selected_template($with_path = false)
-    {
-        return $with_path ? $this->_template_path : $this->_template;
-    }
-
-    /**
-     * @param string $shortcode_class
-     * @param WP     $wp
-     * @throws ReflectionException
-     * @deprecated 4.9.26
-     */
-    public function initialize_shortcode($shortcode_class = '', WP $wp = null)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Usage is deprecated. Please use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::initializeShortcode() instead.',
-                'event_espresso'
-            ),
-            '4.9.26'
-        );
-        $this->getLegacyShortcodesManager()->initializeShortcode($shortcode_class, $wp);
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 4.9.57.p
-     */
-    public function loadPersistentAdminNoticeManager()
-    {
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 4.9.64.p
-     */
-    public function employ_CPT_Strategy()
-    {
-    }
+	/**
+	 * @var string
+	 */
+	private $_template_path;
+
+	/**
+	 * @var string
+	 */
+	private $_template;
+
+	/**
+	 * @type EE_Registry
+	 */
+	protected $Registry;
+
+	/**
+	 * @type EE_Request_Handler
+	 */
+	protected $Request_Handler;
+
+	/**
+	 * @type EE_Module_Request_Router
+	 */
+	protected $Module_Request_Router;
+
+	/**
+	 * @type CurrentPage
+	 */
+	protected $current_page;
+
+
+	/**
+	 *    class constructor
+	 *    should fire after shortcode, module, addon, or other plugin's default priority init phases have run
+	 *
+	 * @access    public
+	 * @param EE_Registry              $Registry
+	 * @param CurrentPage              $EspressoPage
+	 * @param EE_Module_Request_Router $Module_Request_Router
+	 */
+	public function __construct(
+		EE_Registry $Registry,
+		CurrentPage $EspressoPage,
+		EE_Module_Request_Router $Module_Request_Router
+	) {
+		$this->Registry              = $Registry;
+		$this->current_page          = $EspressoPage;
+		$this->Module_Request_Router = $Module_Request_Router;
+		// load other resources and begin to actually run shortcodes and modules
+		// analyse the incoming WP request
+		add_action('parse_request', [$this, 'get_request'], 1);
+		// process request with module factory
+		add_action('pre_get_posts', [$this, 'pre_get_posts']);
+		// before headers sent
+		add_action('wp', [$this, 'wp'], 5);
+		// primarily used to process any content shortcodes
+		add_action('template_redirect', [$this, 'templateRedirect'], 999);
+		// header
+		add_action('wp_head', [$this, 'header_meta_tag'], 5);
+		add_action('wp_print_scripts', [$this, 'wp_print_scripts']);
+		add_filter('template_include', [$this, 'template_include'], 1);
+		// display errors
+		add_action('loop_start', [$this, 'display_errors'], 2);
+		// the content
+		// add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 );
+		// exclude our private cpt comments
+		add_filter('comments_clauses', [$this, 'filter_wp_comments']);
+		// make sure any ajax requests will respect the url schema
+		// when requests are made against admin-ajax.php (http:// or https://)
+		add_filter('admin_url', [$this, 'maybe_force_admin_ajax_ssl'], 200);
+		// action hook EE
+		do_action('AHEE__EE_Front_Controller__construct__done', $this);
+	}
+
+
+	/**
+	 * @return EE_Request_Handler
+	 * @deprecated 4.10.14.p
+	 */
+	public function Request_Handler()
+	{
+		if (! $this->Request_Handler instanceof EE_Request_Handler) {
+			$this->Request_Handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
+		}
+		return $this->Request_Handler;
+	}
+
+
+	/**
+	 * @return EE_Module_Request_Router
+	 */
+	public function Module_Request_Router()
+	{
+		return $this->Module_Request_Router;
+	}
+
+
+	/**
+	 * @return LegacyShortcodesManager
+	 * @deprecated 4.10.14.p
+	 */
+	public function getLegacyShortcodesManager()
+	{
+		return EE_Config::getLegacyShortcodesManager();
+	}
+
+
+
+
+
+	/***********************************************        INIT ACTION HOOK         ***********************************************/
+	/**
+	 * filter_wp_comments
+	 * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment
+	 * widgets/queries done on frontend
+	 *
+	 * @param array $clauses array of comment clauses setup by WP_Comment_Query
+	 * @return array array of comment clauses with modifications.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function filter_wp_comments($clauses)
+	{
+		global $wpdb;
+		if (strpos($clauses['join'], $wpdb->posts) !== false) {
+			/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+			$custom_post_types = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+			);
+			$cpts              = $custom_post_types->getPrivateCustomPostTypes();
+			foreach ($cpts as $cpt => $details) {
+				$clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt);
+			}
+		}
+		return $clauses;
+	}
+
+
+	/**
+	 * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend
+	 *
+	 * @param string $url incoming url
+	 * @return string         final assembled url
+	 */
+	public function maybe_force_admin_ajax_ssl($url)
+	{
+		if (is_ssl() && preg_match('/admin-ajax.php/', $url)) {
+			$url = str_replace('http://', 'https://', $url);
+		}
+		return $url;
+	}
+
+
+
+
+
+
+	/***********************************************        WP_LOADED ACTION HOOK         ***********************************************/
+
+
+	/**
+	 *    wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their
+	 *    default priority init phases have run
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+
+
+
+	/***********************************************        PARSE_REQUEST HOOK         ***********************************************/
+	/**
+	 *    _get_request
+	 *
+	 * @access public
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function get_request(WP $WP)
+	{
+		static $done = false;
+		if ($done) {
+			return;
+		}
+		$done = true;
+		do_action('AHEE__EE_Front_Controller__get_request__start');
+		$this->current_page->parseQueryVars($WP);
+		do_action('AHEE__EE_Front_Controller__get_request__complete');
+	}
+
+
+	/**
+	 *    pre_get_posts - basically a module factory for instantiating modules and selecting the final view template
+	 *
+	 * @access    public
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function pre_get_posts($WP_Query)
+	{
+		// only load Module_Request_Router if this is the main query
+		if (
+			$this->Module_Request_Router instanceof EE_Module_Request_Router
+			&& $WP_Query->is_main_query()
+		) {
+			// cycle thru module routes
+			while ($route = $this->Module_Request_Router->get_route($WP_Query)) {
+				// determine module and method for route
+				$module = $this->Module_Request_Router->resolve_route($route[0], $route[1]);
+				if ($module instanceof EED_Module) {
+					// get registered view for route
+					$this->_template_path = $this->Module_Request_Router->get_view($route);
+					// grab module name
+					$module_name = $module->module_name();
+					// map the module to the module objects
+					$this->Registry->modules->{$module_name} = $module;
+				}
+			}
+		}
+	}
+
+
+
+
+
+	/***********************************************        WP HOOK         ***********************************************/
+
+
+	/**
+	 *    wp - basically last chance to do stuff before headers sent
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp()
+	{
+		AriaLiveAnnouncer::setHooks();
+	}
+
+
+
+	/***********************     GET_HEADER && WP_HEAD HOOK     ***********************/
+
+
+	/**
+	 * callback for the "template_redirect" hook point
+	 * checks sidebars for EE widgets
+	 * loads resources and assets accordingly
+	 *
+	 * @return void
+	 */
+	public function templateRedirect()
+	{
+		global $wp_query;
+		if (empty($wp_query->posts)) {
+			return;
+		}
+		// if we already know this is an espresso page, then load assets
+		$load_assets = $this->current_page->isEspressoPage();
+		// if we are already loading assets then just move along, otherwise check for widgets
+		$load_assets = $load_assets || $this->espresso_widgets_in_active_sidebars();
+		if ($load_assets) {
+			add_action('wp_enqueue_scripts', [$this, 'enqueueStyle']);
+			add_action('wp_enqueue_scripts', [$this, 'enqueueScripts']);
+		}
+
+		if (is_singular(EspressoPostType::EVENTS)) {
+			new FilterNextPreviousEventPostQuery();
+		}
+	}
+
+
+	/**
+	 * builds list of active widgets then scans active sidebars looking for them
+	 * returns true is an EE widget is found in an active sidebar
+	 * Please Note: this does NOT mean that the sidebar or widget
+	 * is actually in use in a given template, as that is unfortunately not known
+	 * until a sidebar and it's widgets are actually loaded
+	 *
+	 * @return boolean
+	 */
+	private function espresso_widgets_in_active_sidebars()
+	{
+		$espresso_widgets = [];
+		foreach ($this->Registry->widgets as $widget_class => $widget) {
+			$id_base = EspressoWidget::getIdBase($widget_class);
+			if (is_active_widget(false, false, $id_base)) {
+				$espresso_widgets[] = $id_base;
+			}
+		}
+		$all_sidebar_widgets = wp_get_sidebars_widgets();
+		foreach ($all_sidebar_widgets as $sidebar_widgets) {
+			if (is_array($sidebar_widgets) && ! empty($sidebar_widgets)) {
+				foreach ($sidebar_widgets as $sidebar_widget) {
+					foreach ($espresso_widgets as $espresso_widget) {
+						if (strpos($sidebar_widget, $espresso_widget) !== false) {
+							return true;
+						}
+					}
+				}
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    header_meta_tag
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function header_meta_tag()
+	{
+		print(
+		apply_filters(
+			'FHEE__EE_Front_Controller__header_meta_tag',
+			'<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n"
+		)
+		);
+
+		// let's exclude all event type taxonomy term archive pages from search engine indexing
+		// @see https://events.codebasehq.com/projects/event-espresso/tickets/10249
+		// also exclude all critical pages from indexing
+		if (
+			(
+				is_tax('espresso_event_type')
+				&& get_option('blog_public') !== '0'
+			)
+			|| is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array())
+		) {
+			print(
+			apply_filters(
+				'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
+				'<meta name="robots" content="noindex,follow" />' . "\n"
+			)
+			);
+		}
+	}
+
+
+	/**
+	 * wp_print_scripts
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function wp_print_scripts()
+	{
+		global $post;
+		if (
+			isset($post->EE_Event)
+			&& $post->EE_Event instanceof EE_Event
+			&& get_post_type() === EspressoPostType::EVENTS
+			&& is_singular()
+		) {
+			EEH_Schema::add_json_linked_data_for_event($post->EE_Event);
+		}
+	}
+
+
+	public function enqueueStyle()
+	{
+		wp_enqueue_style('espresso_default');
+		wp_enqueue_style('espresso_custom_css');
+	}
+
+
+	/***********************************************        WP_FOOTER         ***********************************************/
+
+
+	public function enqueueScripts()
+	{
+		wp_enqueue_script('espresso_core');
+	}
+
+
+	/**
+	 * @param WP_Query $query
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function display_errors(WP_Query $query)
+	{
+		if (! $query->is_main_query()) {
+			return;
+		}
+		static $shown_already = false;
+		do_action('AHEE__EE_Front_Controller__display_errors__begin');
+		if (
+			! $shown_already
+			&& apply_filters('FHEE__EE_Front_Controller__display_errors', true)
+			&& is_main_query()
+			&& ! is_feed()
+			&& in_the_loop()
+			&& $this->current_page->isEspressoPage()
+		) {
+			$shown_already = true;
+			if (did_action('wp_head')) {
+				echo wp_kses($this->printNotices(), AllowedTags::getAllowedTags());
+			} else {
+				// block enabled themes run their query loop before headers are sent
+				// so we need to add our notices onto the beginning of the content
+				add_filter('the_content', [$this, 'prependNotices'], 1);
+			}
+		}
+		do_action('AHEE__EE_Front_Controller__display_errors__end');
+	}
+
+
+	/**
+	 * @param string $the_content
+	 * @return string
+	 * @since 4.10.30.p
+	 */
+	public function prependNotices($the_content)
+	{
+		$notices = $this->printNotices();
+		return $notices ? $notices . $the_content : $the_content;
+	}
+
+
+	/**
+	 * @return false|string
+	 * @since 4.10.30.p
+	 */
+	public function printNotices()
+	{
+		ob_start();
+		echo wp_kses(EE_Error::get_notices(), AllowedTags::getWithFormTags());
+		EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
+		return ob_get_clean();
+	}
+
+
+
+	/***********************************************        UTILITIES         ***********************************************/
+
+
+	/**
+	 * @param bool|string $template_include_path
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function template_include($template_include_path = '')
+	{
+		if ($this->current_page->isEspressoPage()) {
+			// despite all helpers having autoloaders set, we need to manually load the template loader
+			// because there are some side effects in that class for triggering template tag functions
+			$this->Registry->load_helper('EEH_Template');
+			$this->_template_path = ! empty($this->_template_path)
+				? basename($this->_template_path)
+				: basename((string) $template_include_path);
+			$template_path        = EEH_Template::locate_template($this->_template_path, [], false);
+			$this->_template_path = ! empty($template_path) ? $template_path : $template_include_path;
+			$this->_template      = basename($this->_template_path);
+			return $this->_template_path;
+		}
+		return $template_include_path;
+	}
+
+
+	/**
+	 * @param bool $with_path
+	 * @return    string
+	 */
+	public function get_selected_template($with_path = false)
+	{
+		return $with_path ? $this->_template_path : $this->_template;
+	}
+
+	/**
+	 * @param string $shortcode_class
+	 * @param WP     $wp
+	 * @throws ReflectionException
+	 * @deprecated 4.9.26
+	 */
+	public function initialize_shortcode($shortcode_class = '', WP $wp = null)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Usage is deprecated. Please use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::initializeShortcode() instead.',
+				'event_espresso'
+			),
+			'4.9.26'
+		);
+		$this->getLegacyShortcodesManager()->initializeShortcode($shortcode_class, $wp);
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 4.9.57.p
+	 */
+	public function loadPersistentAdminNoticeManager()
+	{
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 4.9.64.p
+	 */
+	public function employ_CPT_Strategy()
+	{
+	}
 }

core/libraries/shortcodes/EE_Venue_Shortcodes.lib.php

Indentation +299 added lines, -299 removed lines

@@ -15,303 +15,303 @@
  */
 class EE_Venue_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * Will hold the EE_Event if available
-     *
-     * @var EE_Event
-     */
-    protected $_event;
-
-    /**
-     * Will hold the EE_Venue if available
-     *
-     * @var EE_Venue
-     */
-    protected $_venue;
-
-
-    /**
-     * Initialize properties
-     */
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Venue Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to venue related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[VENUE_TITLE]'             => esc_html__('The title for the event venue', 'event_espresso'),
-            '[VENUE_DESCRIPTION]'       => esc_html__('The description for the event venue', 'event_espresso'),
-            '[VENUE_URL]'               => esc_html__('A url to a webpage for the venue', 'event_espresso'),
-            '[VENUE_DETAILS_URL]'       => sprintf(
-                esc_html__(
-                    'This shortcode outputs the url or website address to the venue details page on this website. This differs from %s which outputs what is entered in the "url" field in the venue details page.',
-                    'event_espresso'
-                ),
-                '[VENUE_URL]'
-            ),
-            '[VENUE_IMAGE]'             => esc_html__('An image representing the event venue', 'event_espresso'),
-            '[VENUE_PHONE]'             => esc_html__('The phone number for the venue', 'event_espresso'),
-            '[VENUE_ADDRESS]'           => esc_html__('The address for the venue', 'event_espresso'),
-            '[VENUE_ADDRESS2]'          => esc_html__('Address 2 for the venue', 'event_espresso'),
-            '[VENUE_CITY]'              => esc_html__('The city the venue is in', 'event_espresso'),
-            '[VENUE_STATE]'             => esc_html__('The state the venue is located in', 'event_espresso'),
-            '[VENUE_COUNTRY]'           => esc_html__('The country the venue is located in', 'event_espresso'),
-            '[VENUE_FORMATTED_ADDRESS]' => esc_html__(
-                'This just outputs the venue address in a semantic address format.',
-                'event_espresso'
-            ),
-            '[VENUE_ZIP]'               => esc_html__('The zip code for the venue address', 'event_espresso'),
-            '[VENUE_META_*]'            => esc_html__(
-                'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the venue then it will be output in place of this shortcode.',
-                'event_espresso'
-            ),
-            '[GOOGLE_MAP_URL]'          => esc_html__(
-                'URL for the google map associated with the venue.',
-                'event_espresso'
-            ),
-            '[GOOGLE_MAP_LINK]'         => esc_html__('Link to a google map for the venue', 'event_espresso'),
-            '[GOOGLE_MAP_IMAGE]'        => esc_html__('Google map for venue wrapped in image tags', 'event_espresso'),
-        );
-    }
-
-
-    /**
-     * Parse incoming shortcode
-     *
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    protected function _parser($shortcode)
-    {
-        $this->_venue = $this->_get_venue();
-        // If there is no venue object by now then get out.
-        if (! $this->_venue instanceof EE_Venue) {
-            return '';
-        }
-
-        switch ($shortcode) {
-            case '[VENUE_TITLE]':
-                return $this->_venue('title');
-
-            case '[VENUE_DESCRIPTION]':
-                return $this->_venue('description');
-
-            case '[VENUE_URL]':
-                return $this->_venue('url');
-
-            case '[VENUE_IMAGE]':
-                return $this->_venue('image');
-
-            case '[VENUE_PHONE]':
-                return $this->_venue('phone');
-
-            case '[VENUE_ADDRESS]':
-                return $this->_venue('address');
-
-            case '[VENUE_ADDRESS2]':
-                return $this->_venue('address2');
-
-            case '[VENUE_CITY]':
-                return $this->_venue('city');
-
-            case '[VENUE_COUNTRY]':
-                return $this->_venue('country');
-
-            case '[VENUE_STATE]':
-                return $this->_venue('state');
-
-            case '[VENUE_ZIP]':
-                return $this->_venue('zip');
-
-            case '[VENUE_FORMATTED_ADDRESS]':
-                return $this->_venue('formatted_address');
-
-            case '[GOOGLE_MAP_URL]':
-                return $this->_venue('gmap_url');
-
-            case '[GOOGLE_MAP_LINK]':
-                return $this->_venue('gmap_link');
-
-            case '[GOOGLE_MAP_IMAGE]':
-                return $this->_venue('gmap_link_img');
-
-            case '[VENUE_DETAILS_URL]':
-                return $this->_venue('permalink');
-        }
-
-        if (strpos($shortcode, '[VENUE_META_*') !== false) {
-            $shortcode = str_replace('[VENUE_META_*', '', $shortcode);
-            $shortcode = trim(str_replace(']', '', $shortcode));
-
-            // pull the meta value from the venue post
-            $venue_meta = $this->_venue->get_post_meta($shortcode, true);
-
-            return ! empty($venue_meta) ? $venue_meta : '';
-        }
-    }
-
-    /**
-     * This retrieves the EE_Venue from the available data object.
-     *
-     * @return EE_Venue|null
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    private function _get_venue()
-    {
-        // if we have datetime, use the venue assigned to it.
-        if( $this->_data instanceof EE_Datetime ) {
-            return $this->_data->venue();
-        }
-
-        // if we don't have a datetime, we need the EE_Event object to get the venue.
-        $this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
-
-        // if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the
-        // reg_obj instead.
-        if (! $this->_event instanceof EE_Event) {
-            $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-            $aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
-
-            $this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
-                ? $aee->reg_obj->event()
-                : null;
-
-            // if still empty do we have a ticket data item?
-            $this->_event = ! $this->_event instanceof EE_Event
-                            && $this->_data instanceof EE_Ticket
-                            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->tickets[ $this->_data->ID() ]['EE_Event']
-                : $this->_event;
-
-            // if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee
-            // and use that.
-            $this->_event = ! $this->_event instanceof EE_Event && $aee instanceof EE_Messages_Addressee
-                ? reset($aee->events)
-                : $this->_event;
-        }
-
-        // If we have an event object use it to pull the venue.
-        if ($this->_event instanceof EE_Event) {
-            return $this->_event->get_first_related('Venue');
-        }
-
-        return null;
-    }
-
-    /**
-     * This retrieves the specified venue information
-     *
-     * @param string $field What Venue field to retrieve
-     * @return string What was retrieved!
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    private function _venue($field)
-    {
-
-        if (! $this->_venue instanceof EE_Venue) {
-            return '';
-        } //no venue so get out.
-
-        switch ($field) {
-            case 'title':
-                return $this->_venue->get('VNU_name');
-                break;
-
-            case 'description':
-                return $this->_venue->get('VNU_desc');
-                break;
-
-            case 'url':
-                $url = $this->_venue->get('VNU_url');
-                return empty($url) ? $this->_venue->get_permalink() : $url;
-                break;
-
-            case 'permalink':
-                return $this->_venue->get_permalink();
-                break;
-
-            case 'image':
-                return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
-                       . '" alt="' . sprintf(
-                           esc_attr__('%s Feature Image', 'event_espresso'),
-                           $this->_venue->get('VNU_name')
-                       ) . '" />';
-                break;
-
-            case 'phone':
-                return $this->_venue->get('VNU_phone');
-                break;
-
-            case 'address':
-                return $this->_venue->get('VNU_address');
-                break;
-
-            case 'address2':
-                return $this->_venue->get('VNU_address2');
-                break;
-
-            case 'city':
-                return $this->_venue->get('VNU_city');
-                break;
-
-            case 'state':
-                $state = $this->_venue->state_obj();
-                return is_object($state) ? $state->get('STA_name') : '';
-                break;
-
-            case 'country':
-                $country = $this->_venue->country_obj();
-                return is_object($country) ? $country->get('CNT_name') : '';
-                break;
-
-            case 'zip':
-                return $this->_venue->get('VNU_zip');
-                break;
-
-            case 'formatted_address':
-                return EEH_Address::format($this->_venue);
-                break;
-
-            case 'gmap_link':
-            case 'gmap_url':
-            case 'gmap_link_img':
-                $atts = $this->get_map_attributes($this->_venue, $field);
-                return EEH_Maps::google_map_link($atts);
-                break;
-        }
-        return '';
-    }
-
-
-    /**
-     * Generates the attributes for retrieving a google_map artifact.
-     *
-     * @param EE_Venue $venue
-     * @param string   $field
-     * @return array
-     * @throws EE_Error
-     */
-    protected function get_map_attributes(EE_Venue $venue, $field = 'gmap_link')
-    {
-        $state = $venue->state_obj();
-        $country = $venue->country_obj();
-        $atts = array(
-            'id'      => $venue->ID(),
-            'address' => $venue->get('VNU_address'),
-            'city'    => $venue->get('VNU_city'),
-            'state'   => is_object($state) ? $state->get('STA_name') : '',
-            'zip'     => $venue->get('VNU_zip'),
-            'country' => is_object($country) ? $country->get('CNT_name') : '',
-            'type'    => $field === 'gmap_link' ? 'url' : 'map',
-            'map_w'   => 200,
-            'map_h'   => 200,
-        );
-        if ($field === 'gmap_url') {
-            $atts['type'] = 'url_only';
-        }
-        return $atts;
-    }
+	/**
+	 * Will hold the EE_Event if available
+	 *
+	 * @var EE_Event
+	 */
+	protected $_event;
+
+	/**
+	 * Will hold the EE_Venue if available
+	 *
+	 * @var EE_Venue
+	 */
+	protected $_venue;
+
+
+	/**
+	 * Initialize properties
+	 */
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Venue Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to venue related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[VENUE_TITLE]'             => esc_html__('The title for the event venue', 'event_espresso'),
+			'[VENUE_DESCRIPTION]'       => esc_html__('The description for the event venue', 'event_espresso'),
+			'[VENUE_URL]'               => esc_html__('A url to a webpage for the venue', 'event_espresso'),
+			'[VENUE_DETAILS_URL]'       => sprintf(
+				esc_html__(
+					'This shortcode outputs the url or website address to the venue details page on this website. This differs from %s which outputs what is entered in the "url" field in the venue details page.',
+					'event_espresso'
+				),
+				'[VENUE_URL]'
+			),
+			'[VENUE_IMAGE]'             => esc_html__('An image representing the event venue', 'event_espresso'),
+			'[VENUE_PHONE]'             => esc_html__('The phone number for the venue', 'event_espresso'),
+			'[VENUE_ADDRESS]'           => esc_html__('The address for the venue', 'event_espresso'),
+			'[VENUE_ADDRESS2]'          => esc_html__('Address 2 for the venue', 'event_espresso'),
+			'[VENUE_CITY]'              => esc_html__('The city the venue is in', 'event_espresso'),
+			'[VENUE_STATE]'             => esc_html__('The state the venue is located in', 'event_espresso'),
+			'[VENUE_COUNTRY]'           => esc_html__('The country the venue is located in', 'event_espresso'),
+			'[VENUE_FORMATTED_ADDRESS]' => esc_html__(
+				'This just outputs the venue address in a semantic address format.',
+				'event_espresso'
+			),
+			'[VENUE_ZIP]'               => esc_html__('The zip code for the venue address', 'event_espresso'),
+			'[VENUE_META_*]'            => esc_html__(
+				'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the venue then it will be output in place of this shortcode.',
+				'event_espresso'
+			),
+			'[GOOGLE_MAP_URL]'          => esc_html__(
+				'URL for the google map associated with the venue.',
+				'event_espresso'
+			),
+			'[GOOGLE_MAP_LINK]'         => esc_html__('Link to a google map for the venue', 'event_espresso'),
+			'[GOOGLE_MAP_IMAGE]'        => esc_html__('Google map for venue wrapped in image tags', 'event_espresso'),
+		);
+	}
+
+
+	/**
+	 * Parse incoming shortcode
+	 *
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	protected function _parser($shortcode)
+	{
+		$this->_venue = $this->_get_venue();
+		// If there is no venue object by now then get out.
+		if (! $this->_venue instanceof EE_Venue) {
+			return '';
+		}
+
+		switch ($shortcode) {
+			case '[VENUE_TITLE]':
+				return $this->_venue('title');
+
+			case '[VENUE_DESCRIPTION]':
+				return $this->_venue('description');
+
+			case '[VENUE_URL]':
+				return $this->_venue('url');
+
+			case '[VENUE_IMAGE]':
+				return $this->_venue('image');
+
+			case '[VENUE_PHONE]':
+				return $this->_venue('phone');
+
+			case '[VENUE_ADDRESS]':
+				return $this->_venue('address');
+
+			case '[VENUE_ADDRESS2]':
+				return $this->_venue('address2');
+
+			case '[VENUE_CITY]':
+				return $this->_venue('city');
+
+			case '[VENUE_COUNTRY]':
+				return $this->_venue('country');
+
+			case '[VENUE_STATE]':
+				return $this->_venue('state');
+
+			case '[VENUE_ZIP]':
+				return $this->_venue('zip');
+
+			case '[VENUE_FORMATTED_ADDRESS]':
+				return $this->_venue('formatted_address');
+
+			case '[GOOGLE_MAP_URL]':
+				return $this->_venue('gmap_url');
+
+			case '[GOOGLE_MAP_LINK]':
+				return $this->_venue('gmap_link');
+
+			case '[GOOGLE_MAP_IMAGE]':
+				return $this->_venue('gmap_link_img');
+
+			case '[VENUE_DETAILS_URL]':
+				return $this->_venue('permalink');
+		}
+
+		if (strpos($shortcode, '[VENUE_META_*') !== false) {
+			$shortcode = str_replace('[VENUE_META_*', '', $shortcode);
+			$shortcode = trim(str_replace(']', '', $shortcode));
+
+			// pull the meta value from the venue post
+			$venue_meta = $this->_venue->get_post_meta($shortcode, true);
+
+			return ! empty($venue_meta) ? $venue_meta : '';
+		}
+	}
+
+	/**
+	 * This retrieves the EE_Venue from the available data object.
+	 *
+	 * @return EE_Venue|null
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	private function _get_venue()
+	{
+		// if we have datetime, use the venue assigned to it.
+		if( $this->_data instanceof EE_Datetime ) {
+			return $this->_data->venue();
+		}
+
+		// if we don't have a datetime, we need the EE_Event object to get the venue.
+		$this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
+
+		// if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the
+		// reg_obj instead.
+		if (! $this->_event instanceof EE_Event) {
+			$aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+			$aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
+
+			$this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
+				? $aee->reg_obj->event()
+				: null;
+
+			// if still empty do we have a ticket data item?
+			$this->_event = ! $this->_event instanceof EE_Event
+							&& $this->_data instanceof EE_Ticket
+							&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']->tickets[ $this->_data->ID() ]['EE_Event']
+				: $this->_event;
+
+			// if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee
+			// and use that.
+			$this->_event = ! $this->_event instanceof EE_Event && $aee instanceof EE_Messages_Addressee
+				? reset($aee->events)
+				: $this->_event;
+		}
+
+		// If we have an event object use it to pull the venue.
+		if ($this->_event instanceof EE_Event) {
+			return $this->_event->get_first_related('Venue');
+		}
+
+		return null;
+	}
+
+	/**
+	 * This retrieves the specified venue information
+	 *
+	 * @param string $field What Venue field to retrieve
+	 * @return string What was retrieved!
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	private function _venue($field)
+	{
+
+		if (! $this->_venue instanceof EE_Venue) {
+			return '';
+		} //no venue so get out.
+
+		switch ($field) {
+			case 'title':
+				return $this->_venue->get('VNU_name');
+				break;
+
+			case 'description':
+				return $this->_venue->get('VNU_desc');
+				break;
+
+			case 'url':
+				$url = $this->_venue->get('VNU_url');
+				return empty($url) ? $this->_venue->get_permalink() : $url;
+				break;
+
+			case 'permalink':
+				return $this->_venue->get_permalink();
+				break;
+
+			case 'image':
+				return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
+					   . '" alt="' . sprintf(
+						   esc_attr__('%s Feature Image', 'event_espresso'),
+						   $this->_venue->get('VNU_name')
+					   ) . '" />';
+				break;
+
+			case 'phone':
+				return $this->_venue->get('VNU_phone');
+				break;
+
+			case 'address':
+				return $this->_venue->get('VNU_address');
+				break;
+
+			case 'address2':
+				return $this->_venue->get('VNU_address2');
+				break;
+
+			case 'city':
+				return $this->_venue->get('VNU_city');
+				break;
+
+			case 'state':
+				$state = $this->_venue->state_obj();
+				return is_object($state) ? $state->get('STA_name') : '';
+				break;
+
+			case 'country':
+				$country = $this->_venue->country_obj();
+				return is_object($country) ? $country->get('CNT_name') : '';
+				break;
+
+			case 'zip':
+				return $this->_venue->get('VNU_zip');
+				break;
+
+			case 'formatted_address':
+				return EEH_Address::format($this->_venue);
+				break;
+
+			case 'gmap_link':
+			case 'gmap_url':
+			case 'gmap_link_img':
+				$atts = $this->get_map_attributes($this->_venue, $field);
+				return EEH_Maps::google_map_link($atts);
+				break;
+		}
+		return '';
+	}
+
+
+	/**
+	 * Generates the attributes for retrieving a google_map artifact.
+	 *
+	 * @param EE_Venue $venue
+	 * @param string   $field
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function get_map_attributes(EE_Venue $venue, $field = 'gmap_link')
+	{
+		$state = $venue->state_obj();
+		$country = $venue->country_obj();
+		$atts = array(
+			'id'      => $venue->ID(),
+			'address' => $venue->get('VNU_address'),
+			'city'    => $venue->get('VNU_city'),
+			'state'   => is_object($state) ? $state->get('STA_name') : '',
+			'zip'     => $venue->get('VNU_zip'),
+			'country' => is_object($country) ? $country->get('CNT_name') : '',
+			'type'    => $field === 'gmap_link' ? 'url' : 'map',
+			'map_w'   => 200,
+			'map_h'   => 200,
+		);
+		if ($field === 'gmap_url') {
+			$atts['type'] = 'url_only';
+		}
+		return $atts;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -86,7 +86,7 @@ 
     {
         $this->_venue = $this->_get_venue();
         // If there is no venue object by now then get out.
-        if (! $this->_venue instanceof EE_Venue) {
+        if ( ! $this->_venue instanceof EE_Venue) {
             return '';
         }
 
@@ -161,7 +161,7 @@ 
     private function _get_venue()
     {
         // if we have datetime, use the venue assigned to it.
-        if( $this->_data instanceof EE_Datetime ) {
+        if ($this->_data instanceof EE_Datetime) {
             return $this->_data->venue();
         }
 
@@ -170,7 +170,7 @@ 
 
         // if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the
         // reg_obj instead.
-        if (! $this->_event instanceof EE_Event) {
+        if ( ! $this->_event instanceof EE_Event) {
             $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
             $aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
 
@@ -182,7 +182,7 @@ 
             $this->_event = ! $this->_event instanceof EE_Event
                             && $this->_data instanceof EE_Ticket
                             && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->tickets[ $this->_data->ID() ]['EE_Event']
+                ? $this->_extra_data['data']->tickets[$this->_data->ID()]['EE_Event']
                 : $this->_event;
 
             // if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee
@@ -211,7 +211,7 @@ 
     private function _venue($field)
     {
 
-        if (! $this->_venue instanceof EE_Venue) {
+        if ( ! $this->_venue instanceof EE_Venue) {
             return '';
         } //no venue so get out.
 
@@ -234,11 +234,11 @@ 
                 break;
 
             case 'image':
-                return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
-                       . '" alt="' . sprintf(
+                return '<img src="'.$this->_venue->feature_image_url(array(200, 200,))
+                       . '" alt="'.sprintf(
                            esc_attr__('%s Feature Image', 'event_espresso'),
                            $this->_venue->get('VNU_name')
-                       ) . '" />';
+                       ).'" />';
                 break;
 
             case 'phone':