eventespresso / event-espresso-core

core/EE_Request_Handler.core.php

Spacing +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
 
     private function getCurrentPage()
     {
-        if (! $this->current_page instanceof CurrentPage) {
+        if ( ! $this->current_page instanceof CurrentPage) {
             $this->current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
         }
         return $this->current_page;

Indentation +269 added lines, -269 removed lines

@@ -16,273 +16,273 @@
  */
 final class EE_Request_Handler implements InterminableInterface
 {
-    /**
-     * @var CurrentPage
-     */
-    private $current_page;
-
-    /**
-     * @var RequestInterface
-     */
-    private $request;
-
-    /**
-     * @var ResponseInterface
-     */
-    private $response;
-
-    /**
-     * whether current request is via AJAX
-     *
-     * @var boolean
-     */
-    public $ajax = false;
-
-    /**
-     * whether current request is via AJAX from the frontend of the site
-     *
-     * @var boolean
-     */
-    public $front_ajax = false;
-
-
-    /**
-     * @param RequestInterface  $request
-     * @param ResponseInterface $response
-     */
-    public function __construct(RequestInterface $request, ResponseInterface $response)
-    {
-        $this->request      = $request;
-        $this->response     = $response;
-        $this->ajax         = $this->request->isAjax();
-        $this->front_ajax   = $this->request->isFrontAjax();
-        do_action('AHEE__EE_Request_Handler__construct__complete');
-    }
-
-
-    /**
-     * @param WP $WP
-     * @return void
-     * @deprecated  4.10.14.p
-     */
-    public function parse_request($WP = null)
-    {
-    }
-
-
-    private function getCurrentPage()
-    {
-        if (! $this->current_page instanceof CurrentPage) {
-            $this->current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
-        }
-        return $this->current_page;
-    }
-
-
-    /**
-     * @param WP $WP
-     * @return void
-     * @deprecated  4.10.14.p
-     */
-    public function set_request_vars($WP = null)
-    {
-        $this->getCurrentPage()->parseQueryVars($WP);
-    }
-
-
-    /**
-     * @param WP $WP
-     * @return int
-     * @deprecated  4.10.14.p
-     */
-    public function get_post_id_from_request($WP = null)
-    {
-        return $this->getCurrentPage()->postId();
-    }
-
-
-    /**
-     * @param WP $WP
-     * @return string
-     * @deprecated  4.10.14.p
-     */
-    public function get_post_name_from_request($WP = null)
-    {
-        return $this->getCurrentPage()->postName();
-    }
-
-
-    /**
-     * @param WP $WP
-     * @return array
-     * @deprecated  4.10.14.p
-     */
-    public function get_post_type_from_request($WP = null)
-    {
-        return $this->getCurrentPage()->postType();
-    }
-
-
-    /**
-     * Just a helper method for getting the url for the displayed page.
-     *
-     * @param WP $WP
-     * @return string
-     * @deprecated  4.10.14.p
-     */
-    public function get_current_page_permalink($WP = null)
-    {
-        return $this->getCurrentPage()->getPermalink($WP);
-    }
-
-
-    /**
-     * @return bool
-     * @deprecated  4.10.14.p
-     */
-    public function test_for_espresso_page()
-    {
-        return $this->getCurrentPage()->isEspressoPage();
-    }
-
-
-    /**
-     * @param $key
-     * @param $value
-     * @return void
-     * @deprecated  4.10.14.p
-     */
-    public function set_notice($key, $value)
-    {
-        $this->response->setNotice($key, $value);
-    }
-
-
-    /**
-     * @param $key
-     * @return mixed
-     * @deprecated  4.10.14.p
-     */
-    public function get_notice($key)
-    {
-        return $this->response->getNotice($key);
-    }
-
-
-    /**
-     * @param $string
-     * @return void
-     * @deprecated  4.10.14.p
-     */
-    public function add_output($string)
-    {
-        $this->response->addOutput($string);
-    }
-
-
-    /**
-     * @return string
-     * @deprecated  4.10.14.p
-     */
-    public function get_output()
-    {
-        return $this->response->getOutput();
-    }
-
-
-    /**
-     * @param $item
-     * @param $key
-     * @deprecated  4.10.14.p
-     */
-    public function sanitize_text_field_for_array_walk(&$item, &$key)
-    {
-        $item = strpos($item, 'email') !== false
-            ? sanitize_email($item)
-            : sanitize_text_field($item);
-    }
-
-
-    /**
-     * @param null|bool $value
-     * @return void
-     * @deprecated  4.10.14.p
-     */
-    public function set_espresso_page($value = null)
-    {
-        $this->getCurrentPage()->setEspressoPage($value);
-    }
-
-
-    /**
-     * @return bool
-     * @deprecated  4.10.14.p
-     */
-    public function is_espresso_page()
-    {
-        return $this->getCurrentPage()->isEspressoPage();
-    }
-
-
-    /**
-     * returns sanitized contents of $_REQUEST
-     *
-     * @return array
-     * @deprecated  4.10.14.p
-     */
-    public function params()
-    {
-        return $this->request->requestParams();
-    }
-
-
-    /**
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return    void
-     * @deprecated  4.10.14.p
-     */
-    public function set($key, $value, $override_ee = false)
-    {
-        $this->request->setRequestParam($key, $value, $override_ee);
-    }
-
-
-    /**
-     * @param      $key
-     * @param null $default
-     * @return    mixed
-     * @deprecated  4.10.14.p
-     */
-    public function get($key, $default = null)
-    {
-        return $this->request->getRequestParam($key, $default);
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param $key
-     * @return    boolean
-     * @deprecated  4.10.14.p
-     */
-    public function is_set($key)
-    {
-        return $this->request->requestParamIsSet($key);
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param $key
-     * @return    void
-     * @deprecated  4.10.14.p
-     */
-    public function un_set($key)
-    {
-        $this->request->unSetRequestParam($key);
-    }
+	/**
+	 * @var CurrentPage
+	 */
+	private $current_page;
+
+	/**
+	 * @var RequestInterface
+	 */
+	private $request;
+
+	/**
+	 * @var ResponseInterface
+	 */
+	private $response;
+
+	/**
+	 * whether current request is via AJAX
+	 *
+	 * @var boolean
+	 */
+	public $ajax = false;
+
+	/**
+	 * whether current request is via AJAX from the frontend of the site
+	 *
+	 * @var boolean
+	 */
+	public $front_ajax = false;
+
+
+	/**
+	 * @param RequestInterface  $request
+	 * @param ResponseInterface $response
+	 */
+	public function __construct(RequestInterface $request, ResponseInterface $response)
+	{
+		$this->request      = $request;
+		$this->response     = $response;
+		$this->ajax         = $this->request->isAjax();
+		$this->front_ajax   = $this->request->isFrontAjax();
+		do_action('AHEE__EE_Request_Handler__construct__complete');
+	}
+
+
+	/**
+	 * @param WP $WP
+	 * @return void
+	 * @deprecated  4.10.14.p
+	 */
+	public function parse_request($WP = null)
+	{
+	}
+
+
+	private function getCurrentPage()
+	{
+		if (! $this->current_page instanceof CurrentPage) {
+			$this->current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
+		}
+		return $this->current_page;
+	}
+
+
+	/**
+	 * @param WP $WP
+	 * @return void
+	 * @deprecated  4.10.14.p
+	 */
+	public function set_request_vars($WP = null)
+	{
+		$this->getCurrentPage()->parseQueryVars($WP);
+	}
+
+
+	/**
+	 * @param WP $WP
+	 * @return int
+	 * @deprecated  4.10.14.p
+	 */
+	public function get_post_id_from_request($WP = null)
+	{
+		return $this->getCurrentPage()->postId();
+	}
+
+
+	/**
+	 * @param WP $WP
+	 * @return string
+	 * @deprecated  4.10.14.p
+	 */
+	public function get_post_name_from_request($WP = null)
+	{
+		return $this->getCurrentPage()->postName();
+	}
+
+
+	/**
+	 * @param WP $WP
+	 * @return array
+	 * @deprecated  4.10.14.p
+	 */
+	public function get_post_type_from_request($WP = null)
+	{
+		return $this->getCurrentPage()->postType();
+	}
+
+
+	/**
+	 * Just a helper method for getting the url for the displayed page.
+	 *
+	 * @param WP $WP
+	 * @return string
+	 * @deprecated  4.10.14.p
+	 */
+	public function get_current_page_permalink($WP = null)
+	{
+		return $this->getCurrentPage()->getPermalink($WP);
+	}
+
+
+	/**
+	 * @return bool
+	 * @deprecated  4.10.14.p
+	 */
+	public function test_for_espresso_page()
+	{
+		return $this->getCurrentPage()->isEspressoPage();
+	}
+
+
+	/**
+	 * @param $key
+	 * @param $value
+	 * @return void
+	 * @deprecated  4.10.14.p
+	 */
+	public function set_notice($key, $value)
+	{
+		$this->response->setNotice($key, $value);
+	}
+
+
+	/**
+	 * @param $key
+	 * @return mixed
+	 * @deprecated  4.10.14.p
+	 */
+	public function get_notice($key)
+	{
+		return $this->response->getNotice($key);
+	}
+
+
+	/**
+	 * @param $string
+	 * @return void
+	 * @deprecated  4.10.14.p
+	 */
+	public function add_output($string)
+	{
+		$this->response->addOutput($string);
+	}
+
+
+	/**
+	 * @return string
+	 * @deprecated  4.10.14.p
+	 */
+	public function get_output()
+	{
+		return $this->response->getOutput();
+	}
+
+
+	/**
+	 * @param $item
+	 * @param $key
+	 * @deprecated  4.10.14.p
+	 */
+	public function sanitize_text_field_for_array_walk(&$item, &$key)
+	{
+		$item = strpos($item, 'email') !== false
+			? sanitize_email($item)
+			: sanitize_text_field($item);
+	}
+
+
+	/**
+	 * @param null|bool $value
+	 * @return void
+	 * @deprecated  4.10.14.p
+	 */
+	public function set_espresso_page($value = null)
+	{
+		$this->getCurrentPage()->setEspressoPage($value);
+	}
+
+
+	/**
+	 * @return bool
+	 * @deprecated  4.10.14.p
+	 */
+	public function is_espresso_page()
+	{
+		return $this->getCurrentPage()->isEspressoPage();
+	}
+
+
+	/**
+	 * returns sanitized contents of $_REQUEST
+	 *
+	 * @return array
+	 * @deprecated  4.10.14.p
+	 */
+	public function params()
+	{
+		return $this->request->requestParams();
+	}
+
+
+	/**
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return    void
+	 * @deprecated  4.10.14.p
+	 */
+	public function set($key, $value, $override_ee = false)
+	{
+		$this->request->setRequestParam($key, $value, $override_ee);
+	}
+
+
+	/**
+	 * @param      $key
+	 * @param null $default
+	 * @return    mixed
+	 * @deprecated  4.10.14.p
+	 */
+	public function get($key, $default = null)
+	{
+		return $this->request->getRequestParam($key, $default);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param $key
+	 * @return    boolean
+	 * @deprecated  4.10.14.p
+	 */
+	public function is_set($key)
+	{
+		return $this->request->requestParamIsSet($key);
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param $key
+	 * @return    void
+	 * @deprecated  4.10.14.p
+	 */
+	public function un_set($key)
+	{
+		$this->request->unSetRequestParam($key);
+	}
 }

payment_methods/Paypal_Express/EEG_Paypal_Express.gateway.php

Spacing +24 added lines, -24 removed lines

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

Indentation +544 added lines, -544 removed lines

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

payment_methods/Paypal_Express/ItemizedOrder.php

Spacing +15 added lines, -15 removed lines

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

Indentation +265 added lines, -265 removed lines

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

payment_methods/Paypal_Express/TokenRequest.php

Indentation +113 added lines, -113 removed lines

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

Spacing +3 added lines, -3 removed lines

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

payment_methods/Paypal_Express/polyfills.php

Indentation +14 added lines, -14 removed lines

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

Spacing +1 added lines, -1 removed lines

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

payment_methods/Paypal_Standard/ItemizedOrder.php

Indentation +251 added lines, -251 removed lines

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

Spacing +25 added lines, -25 removed lines

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

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

Spacing +7 added lines, -7 removed lines

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

Indentation +64 added lines, -64 removed lines

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

modules/ticket_selector/TicketSelector.php

Spacing +7 added lines, -7 removed lines

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

Indentation +107 added lines, -107 removed lines

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

core/services/request/RequestParams.php

Spacing +16 added lines, -16 removed lines

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

Indentation +353 added lines, -353 removed lines

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