eventespresso / event-espresso-core

payment_methods/Paypal_Express/EEG_Paypal_Express.gateway.php

Doc Comments +2 added lines, -2 removed lines

@@ -20,8 +20,8 @@
      * 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
+     * @param integer $start
+     * @param integer $length
      * @return bool|string
      */
     function mb_strcut($string, $start, $length = null)

Spacing +38 added lines, -38 removed lines

@@ -10,7 +10,7 @@ 
  * ----------------------------------------------
  */
 // Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
-if (! function_exists('mb_strcut')) {
+if ( ! function_exists('mb_strcut')) {
     /**
      * 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)
@@ -141,7 +141,7 @@ 
         $notify_url = null,
         $cancel_url = null
     ) {
-        if (! $payment instanceof EEI_Payment) {
+        if ( ! $payment instanceof EEI_Payment) {
             $payment->set_gateway_response(
                 esc_html__(
                     'Error. No associated payment was found.',
@@ -152,7 +152,7 @@ 
             return $payment;
         }
         $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
+        if ( ! $transaction instanceof EEI_Transaction) {
             $payment->set_gateway_response(
                 esc_html__(
                     'Could not process this payment because it has no associated transaction.',
@@ -199,13 +199,13 @@ 
             $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
             $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
             $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
+        } elseif ( ! $this->_request_shipping_addr) {
             // Do not request shipping details on the PP Checkout page.
             $token_request_dtls['NOSHIPPING'] = '1';
             $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
         }
         // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
+        if ( ! empty($this->_image_url)) {
             $token_request_dtls['LOGOIMG'] = $this->_image_url;
         }
         $token_request_dtls = apply_filters(
@@ -230,7 +230,7 @@ 
             );
         } else {
             if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+                $payment->set_gateway_response($response_args['L_ERRORCODE'].'; '.$response_args['L_SHORTMESSAGE']);
             } else {
                 $payment->set_gateway_response(
                     esc_html__(
@@ -261,7 +261,7 @@ 
         if ($payment instanceof EEI_Payment) {
             $this->log(array('Return from Authorization' => $update_info), $payment);
             $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_Transaction) {
+            if ( ! $transaction instanceof EEI_Transaction) {
                 $payment->set_gateway_response(
                     esc_html__(
                         'Could not process this payment because it has no associated transaction.',
@@ -274,7 +274,7 @@ 
             $primary_registrant = $transaction->primary_registration();
             $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 $payment;
             }
@@ -399,7 +399,7 @@ 
         $itemized_list = array();
         $gateway_formatter = $this->_get_gateway_formatter();
         // 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)
+        if ( ! empty($request_response_args)
             && array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args)
             && array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args)
         ) {
@@ -407,7 +407,7 @@ 
                 if (strpos($arg_key, 'PAYMENTREQUEST_') !== false
                     && strpos($arg_key, 'NOTIFYURL') === false
                 ) {
-                    $itemized_list[ $arg_key ] = $arg_val;
+                    $itemized_list[$arg_key] = $arg_val;
                 }
             }
             // If we got only a few Items then something is not right.
@@ -460,25 +460,25 @@ 
                         $line_item_quantity = 1;
                     }
                     // Item Name.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+                    $itemized_list['L_PAYMENTREQUEST_0_NAME'.$item_num] = mb_strcut(
                         $gateway_formatter->formatLineItemName($line_item, $payment),
                         0,
                         127
                     );
                     // Item description.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = mb_strcut(
+                    $itemized_list['L_PAYMENTREQUEST_0_DESC'.$item_num] = mb_strcut(
                         $gateway_formatter->formatLineItemDesc($line_item, $payment),
                         0,
                         127
                     );
                     // Cost of individual item.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency($unit_price);
+                    $itemized_list['L_PAYMENTREQUEST_0_AMT'.$item_num] = $gateway_formatter->formatCurrency($unit_price);
                     // Item Number.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+                    $itemized_list['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
                     // Item quantity.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = $line_item_quantity;
+                    $itemized_list['L_PAYMENTREQUEST_0_QTY'.$item_num] = $line_item_quantity;
                     // Digital item is sold.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+                    $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
                     $itemized_sum += $line_item->total();
                     ++$item_num;
                 }
@@ -496,7 +496,7 @@ 
             // add the difference as an extra line item.
             if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
                 // Item Name.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+                $itemized_list['L_PAYMENTREQUEST_0_NAME'.$item_num] = mb_strcut(
                     esc_html__(
                         'Other (promotion/surcharge/cancellation)',
                         'event_espresso'
@@ -505,17 +505,17 @@ 
                     127
                 );
                 // Item description.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = '';
+                $itemized_list['L_PAYMENTREQUEST_0_DESC'.$item_num] = '';
                 // Cost of individual item.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
+                $itemized_list['L_PAYMENTREQUEST_0_AMT'.$item_num] = $gateway_formatter->formatCurrency(
                     $itemized_sum_diff_from_txn_total
                 );
                 // Item Number.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+                $itemized_list['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
                 // Item quantity.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = 1;
+                $itemized_list['L_PAYMENTREQUEST_0_QTY'.$item_num] = 1;
                 // Digital item is sold.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+                $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
                 $item_num++;
             }
         } else {
@@ -570,7 +570,7 @@ 
             'BUTTONSOURCE' => 'EventEspresso_SP',
         );
         $dtls = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+        $this->_log_clean_request($dtls, $payment, $request_text.' Request');
         // Request Customer Details.
         $request_response = wp_remote_post(
             $this->_base_gateway_url,
@@ -584,7 +584,7 @@ 
             )
         );
         // Log the response.
-        $this->log(array($request_text . ' Response' => $request_response), $payment);
+        $this->log(array($request_text.' Response' => $request_response), $payment);
         return $request_response;
     }
 
@@ -604,7 +604,7 @@ 
         }
         $response_args = array();
         parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
+        if ( ! isset($response_args['ACK'])) {
             return array('status' => false, 'args' => $request_response);
         }
         if ((
@@ -651,18 +651,18 @@ 
     {
         $errors = array();
         $n = 0;
-        while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
-            $l_error_code = isset($data_array[ "L_ERRORCODE{$n}" ])
-                ? $data_array[ "L_ERRORCODE{$n}" ]
+        while (isset($data_array["L_ERRORCODE{$n}"])) {
+            $l_error_code = isset($data_array["L_ERRORCODE{$n}"])
+                ? $data_array["L_ERRORCODE{$n}"]
                 : '';
-            $l_severity_code = isset($data_array[ "L_SEVERITYCODE{$n}" ])
-                ? $data_array[ "L_SEVERITYCODE{$n}" ]
+            $l_severity_code = isset($data_array["L_SEVERITYCODE{$n}"])
+                ? $data_array["L_SEVERITYCODE{$n}"]
                 : '';
-            $l_short_message = isset($data_array[ "L_SHORTMESSAGE{$n}" ])
-                ? $data_array[ "L_SHORTMESSAGE{$n}" ]
+            $l_short_message = isset($data_array["L_SHORTMESSAGE{$n}"])
+                ? $data_array["L_SHORTMESSAGE{$n}"]
                 : '';
-            $l_long_message = isset($data_array[ "L_LONGMESSAGE{$n}" ])
-                ? $data_array[ "L_LONGMESSAGE{$n}" ]
+            $l_long_message = isset($data_array["L_LONGMESSAGE{$n}"])
+                ? $data_array["L_LONGMESSAGE{$n}"]
                 : '';
             if ($n === 0) {
                 $errors = array(
@@ -672,10 +672,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++;
         }

Indentation +666 added lines, -666 removed lines

@@ -11,674 +11,674 @@
  */
 // Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
 if (! function_exists('mb_strcut')) {
-    /**
-     * 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 bool|string
-     */
-    function mb_strcut($string, $start, $length = null)
-    {
-        return mb_substr($string, $start, $length);
-    }
+	/**
+	 * 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 bool|string
+	 */
+	function mb_strcut($string, $start, $length = null)
+	{
+		return mb_substr($string, $start, $length);
+	}
 }
 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 = '';
-
-
-
-    /**
-     * EEG_Paypal_Express constructor.
-     */
-    public function __construct()
-    {
-        $this->_currencies_supported = array(
-            '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();
-    }
-
-
-
-    /**
-     * Sets the gateway URL variable based on whether debug mode is enabled or not.
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        parent::set_settings($settings_array);
-        // Redirect URL.
-        $this->_base_gateway_url = $this->_debug_mode
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
-    }
-
-
-
-    /**
-     * @param EEI_Payment $payment
-     * @param array       $billing_info
-     * @param string      $return_url
-     * @param string      $notify_url
-     * @param string      $cancel_url
-     * @return \EE_Payment|\EEI_Payment
-     * @throws \EE_Error
-     */
-    public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    ) {
-        if (! $payment instanceof EEI_Payment) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Error. No associated payment was found.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_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 $payment;
-        }
-        $gateway_formatter = $this->_get_gateway_formatter();
-        $order_description = mb_strcut($gateway_formatter->formatOrderDescription($payment), 0, 127);
-        $primary_registration = $transaction->primary_registration();
-        $primary_attendee = $primary_registration instanceof EE_Registration
-            ? $primary_registration->attendee()
-            : false;
-        $locale = explode('-', get_bloginfo('language'));
-        // Gather request parameters.
-        $token_request_dtls = array(
-            'METHOD'                         => 'SetExpressCheckout',
-            'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-            'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-            'PAYMENTREQUEST_0_DESC'          => $order_description,
-            '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]
-        );
-        // Show itemized list.
-        $itemized_list = $this->itemize_list($payment, $transaction);
-        $token_request_dtls = array_merge($token_request_dtls, $itemized_list);
-        // Automatically filling out shipping and contact information.
-        if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
-            // If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
-            $token_request_dtls['NOSHIPPING'] = '2';
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
-            $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
-            // Do not request shipping details on the PP Checkout page.
-            $token_request_dtls['NOSHIPPING'] = '1';
-            $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
-        }
-        // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
-            $token_request_dtls['LOGOIMG'] = $this->_image_url;
-        }
-        $token_request_dtls = apply_filters(
-            'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
-            $token_request_dtls,
-            $this
-        );
-        // Request PayPal token.
-        $token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
-        $token_rstatus = $this->_ppExpress_check_response($token_request_response);
-        $response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
-            ? $token_rstatus['args']
-            : array();
-        if ($token_rstatus['status']) {
-            // We got the Token so we may continue with the payment and redirect the client.
-            $payment->set_details($response_args);
-            $gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
-            $payment->set_redirect_url(
-                $gateway_url
-                . '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
-                . $response_args['TOKEN']
-            );
-        } else {
-            if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
-            } else {
-                $payment->set_gateway_response(
-                    esc_html__(
-                        'Error occurred while trying to setup the Express Checkout.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $payment->set_details($response_args);
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     * @param array           $update_info {
-     * @type string           $gateway_txn_id
-     * @type string status an EEMI_Payment status
-     *                                     }
-     * @param EEI_Transaction $transaction
-     * @return EEI_Payment
-     */
-    public function handle_payment_update($update_info, $transaction)
-    {
-        $payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
-        if ($payment instanceof EEI_Payment) {
-            $this->log(array('Return from Authorization' => $update_info), $payment);
-            $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_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 $payment;
-            }
-            $primary_registrant = $transaction->primary_registration();
-            $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 $payment;
-            }
-            $cdetails_request_dtls = array(
-                'METHOD' => 'GetExpressCheckoutDetails',
-                'TOKEN'  => $payment_details['TOKEN'],
-            );
-            // Request Customer Details.
-            $cdetails_request_response = $this->_ppExpress_request(
-                $cdetails_request_dtls,
-                'Customer Details',
-                $payment
-            );
-            $cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
-            $cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
-                ? $cdetails_rstatus['args']
-                : array();
-            if ($cdetails_rstatus['status']) {
-                // We got the PayerID so now we can Complete the transaction.
-                $docheckout_request_dtls = array(
-                    'METHOD'                         => 'DoExpressCheckoutPayment',
-                    'PAYERID'                        => $cdata_response_args['PAYERID'],
-                    'TOKEN'                          => $payment_details['TOKEN'],
-                    'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-                    'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-                    'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-                );
-                 // Include itemized list.
-                $itemized_list = $this->itemize_list(
-                    $payment,
-                    $transaction,
-                    $cdata_response_args
-                );
-                $docheckout_request_dtls = array_merge($docheckout_request_dtls, $itemized_list);
-                // Payment Checkout/Capture.
-                $docheckout_request_response = $this->_ppExpress_request(
-                    $docheckout_request_dtls,
-                    'Do Payment',
-                    $payment
-                );
-                $docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
-                $docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
-                    ? $docheckout_rstatus['args']
-                    : array();
-                if ($docheckout_rstatus['status']) {
-                    // All is well, payment approved.
-                    $primary_registration_code = $primary_registrant instanceof EE_Registration ?
-                        $primary_registrant->reg_code()
-                        : '';
-                    $payment->set_extra_accntng($primary_registration_code);
-                    $payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
-                        ? (float) $docheckout_response_args['PAYMENTINFO_0_AMT']
-                        : 0);
-                    $payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
-                        : null);
-                    $payment->set_details($cdata_response_args);
-                    $payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_ACK']
-                        : '');
-                    $payment->set_status($this->_pay_model->approved_status());
-                } else {
-                    if (isset($docheckout_response_args['L_ERRORCODE'])) {
-                        $payment->set_gateway_response(
-                            $docheckout_response_args['L_ERRORCODE']
-                            . '; '
-                            . $docheckout_response_args['L_SHORTMESSAGE']
-                        );
-                    } else {
-                        $payment->set_gateway_response(
-                            esc_html__(
-                                'Error occurred while trying to Capture the funds.',
-                                'event_espresso'
-                            )
-                        );
-                    }
-                    $payment->set_details($docheckout_response_args);
-                    $payment->set_status($this->_pay_model->declined_status());
-                }
-            } else {
-                if (isset($cdata_response_args['L_ERRORCODE'])) {
-                    $payment->set_gateway_response(
-                        $cdata_response_args['L_ERRORCODE']
-                        . '; '
-                        . $cdata_response_args['L_SHORTMESSAGE']
-                    );
-                } else {
-                    $payment->set_gateway_response(
-                        esc_html__(
-                            'Error occurred while trying to get payment Details from PayPal.',
-                            'event_espresso'
-                        )
-                    );
-                }
-                $payment->set_details($cdata_response_args);
-                $payment->set_status($this->_pay_model->failed_status());
-            }
-        } else {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Error occurred while trying to process the payment.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     *  Make a list of items that are in the giver transaction.
-     *
-     * @param EEI_Payment     $payment
-     * @param EEI_Transaction $transaction
-     * @param array           $request_response_args Data from a previous communication with PP.
-     * @return array
-     */
-    public function itemize_list(EEI_Payment $payment, EEI_Transaction $transaction, $request_response_args = array())
-    {
-        $itemized_list = array();
-        $gateway_formatter = $this->_get_gateway_formatter();
-        // 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
-                ) {
-                    $itemized_list[ $arg_key ] = $arg_val;
-                }
-            }
-            // If we got only a few Items then something is not right.
-            if (count($itemized_list) > 2) {
-                return $itemized_list;
-            } else {
-                if (WP_DEBUG) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                // @codingStandardsIgnoreStart
-                                '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',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            ),
-                            wp_json_encode($itemized_list)
-                        )
-                    );
-                }
-                // Reset the list and log an error, maybe allow to try and generate a new list (below).
-                $itemized_list = array();
-                $this->log(
-                    array(
-                        (string) esc_html__(
-                            'Could not generate a proper item list with:',
-                            'event_espresso'
-                        ) => $request_response_args
-                    ),
-                    $payment
-                );
-            }
-        }
-        // ...otherwise we generate a new list for this transaction.
-        if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
-            $item_num = 0;
-            $itemized_sum = 0;
-            $total_line_items = $transaction->total_line_item();
-            // Go through each item in the list.
-            foreach ($total_line_items->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->total(), '0.00', '==')) {
-                        continue;
-                    }
-                    $unit_price = $line_item->unit_price();
-                    $line_item_quantity = $line_item->quantity();
-                    // This is a discount.
-                    if ($line_item->is_percent()) {
-                        $unit_price = $line_item->total();
-                        $line_item_quantity = 1;
-                    }
-                    // Item Name.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
-                        $gateway_formatter->formatLineItemName($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Item description.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = mb_strcut(
-                        $gateway_formatter->formatLineItemDesc($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Cost of individual item.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency($unit_price);
-                    // Item Number.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
-                    // Item quantity.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = $line_item_quantity;
-                    // Digital item is sold.
-                    $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
-                    $itemized_sum += $line_item->total();
-                    ++$item_num;
-                }
-            }
-            // Item's sales S/H and tax amount.
-            $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
-            $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
-            $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-            $itemized_sum_diff_from_txn_total = round(
-                $transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
-                2
-            );
-            // If we were not able to recognize some item like promotion, surcharge or cancellation,
-            // add the difference as an extra line item.
-            if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
-                // Item Name.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
-                    esc_html__(
-                        'Other (promotion/surcharge/cancellation)',
-                        'event_espresso'
-                    ),
-                    0,
-                    127
-                );
-                // Item description.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = '';
-                // Cost of individual item.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
-                    $itemized_sum_diff_from_txn_total
-                );
-                // Item Number.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
-                // Item quantity.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = 1;
-                // Digital item is sold.
-                $itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
-                $item_num++;
-            }
-        } else {
-            // Just one Item.
-            // Item Name.
-            $itemized_list['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
-                $gateway_formatter->formatPartialPaymentLineItemName($payment),
-                0,
-                127
-            );
-            // Item description.
-            $itemized_list['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
-                $gateway_formatter->formatPartialPaymentLineItemDesc($payment),
-                0,
-                127
-            );
-            // Cost of individual item.
-            $itemized_list['L_PAYMENTREQUEST_0_AMT0'] = $gateway_formatter->formatCurrency($payment->amount());
-            // Item Number.
-            $itemized_list['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
-            // Item quantity.
-            $itemized_list['L_PAYMENTREQUEST_0_QTY0'] = 1;
-            // Digital item is sold.
-            $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
-            // Item's sales S/H and tax amount.
-            $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $gateway_formatter->formatCurrency($payment->amount());
-            $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-        }
-        return $itemized_list;
-    }
-
-
-
-    /**
-     *  Make the Express checkout request.
-     *
-     * @param array       $request_params
-     * @param string      $request_text
-     * @param EEI_Payment $payment
-     * @return mixed
-     */
-    public function _ppExpress_request($request_params, $request_text, $payment)
-    {
-        $request_dtls = array(
-            '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,
-            array(
-                'method'      => 'POST',
-                'timeout'     => 45,
-                'httpversion' => '1.1',
-                'cookies'     => array(),
-                'headers'     => array(),
-                'body'        => http_build_query($dtls, '', '&'),
-            )
-        );
-        // Log the response.
-        $this->log(array($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)
-    {
-        if (is_wp_error($request_response) || empty($request_response['body'])) {
-            // If we got here then there was an error in this request.
-            return array('status' => false, 'args' => $request_response);
-        }
-        $response_args = array();
-        parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
-            return array('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'], array('Success', 'SuccessWithWarning'), true)
-        ) {
-            // Response status OK, return response parameters for further processing.
-            return array('status' => true, 'args' => $response_args);
-        }
-        $errors = $this->_get_errors($response_args);
-        return array('status' => false, 'args' => $errors);
-    }
-
-
-
-    /**
-     *  Log a "Cleared" request.
-     *
-     * @param array       $request
-     * @param EEI_Payment $payment
-     * @param string      $info
-     * @return void
-     */
-    private function _log_clean_request($request, $payment, $info)
-    {
-        $cleaned_request_data = $request;
-        unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
-        $this->log(array($info => $cleaned_request_data), $payment);
-    }
-
-
-
-    /**
-     *  Get error from the response data.
-     *
-     * @param array $data_array
-     * @return array
-     */
-    private function _get_errors($data_array)
-    {
-        $errors = array();
-        $n = 0;
-        while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
-            $l_error_code = isset($data_array[ "L_ERRORCODE{$n}" ])
-                ? $data_array[ "L_ERRORCODE{$n}" ]
-                : '';
-            $l_severity_code = isset($data_array[ "L_SEVERITYCODE{$n}" ])
-                ? $data_array[ "L_SEVERITYCODE{$n}" ]
-                : '';
-            $l_short_message = isset($data_array[ "L_SHORTMESSAGE{$n}" ])
-                ? $data_array[ "L_SHORTMESSAGE{$n}" ]
-                : '';
-            $l_long_message = isset($data_array[ "L_LONGMESSAGE{$n}" ])
-                ? $data_array[ "L_LONGMESSAGE{$n}" ]
-                : '';
-            if ($n === 0) {
-                $errors = array(
-                    '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;
-    }
+	/**
+	 * 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 = '';
+
+
+
+	/**
+	 * EEG_Paypal_Express constructor.
+	 */
+	public function __construct()
+	{
+		$this->_currencies_supported = array(
+			'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();
+	}
+
+
+
+	/**
+	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		parent::set_settings($settings_array);
+		// Redirect URL.
+		$this->_base_gateway_url = $this->_debug_mode
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
+	}
+
+
+
+	/**
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info
+	 * @param string      $return_url
+	 * @param string      $notify_url
+	 * @param string      $cancel_url
+	 * @return \EE_Payment|\EEI_Payment
+	 * @throws \EE_Error
+	 */
+	public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	) {
+		if (! $payment instanceof EEI_Payment) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Error. No associated payment was found.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$transaction = $payment->transaction();
+		if (! $transaction instanceof EEI_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 $payment;
+		}
+		$gateway_formatter = $this->_get_gateway_formatter();
+		$order_description = mb_strcut($gateway_formatter->formatOrderDescription($payment), 0, 127);
+		$primary_registration = $transaction->primary_registration();
+		$primary_attendee = $primary_registration instanceof EE_Registration
+			? $primary_registration->attendee()
+			: false;
+		$locale = explode('-', get_bloginfo('language'));
+		// Gather request parameters.
+		$token_request_dtls = array(
+			'METHOD'                         => 'SetExpressCheckout',
+			'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+			'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+			'PAYMENTREQUEST_0_DESC'          => $order_description,
+			'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]
+		);
+		// Show itemized list.
+		$itemized_list = $this->itemize_list($payment, $transaction);
+		$token_request_dtls = array_merge($token_request_dtls, $itemized_list);
+		// Automatically filling out shipping and contact information.
+		if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
+			// If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
+			$token_request_dtls['NOSHIPPING'] = '2';
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
+			$token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
+		} elseif (! $this->_request_shipping_addr) {
+			// Do not request shipping details on the PP Checkout page.
+			$token_request_dtls['NOSHIPPING'] = '1';
+			$token_request_dtls['REQCONFIRMSHIPPING'] = '0';
+		}
+		// Used a business/personal logo on the PayPal page.
+		if (! empty($this->_image_url)) {
+			$token_request_dtls['LOGOIMG'] = $this->_image_url;
+		}
+		$token_request_dtls = apply_filters(
+			'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
+			$token_request_dtls,
+			$this
+		);
+		// Request PayPal token.
+		$token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
+		$token_rstatus = $this->_ppExpress_check_response($token_request_response);
+		$response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
+			? $token_rstatus['args']
+			: array();
+		if ($token_rstatus['status']) {
+			// We got the Token so we may continue with the payment and redirect the client.
+			$payment->set_details($response_args);
+			$gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
+			$payment->set_redirect_url(
+				$gateway_url
+				. '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
+				. $response_args['TOKEN']
+			);
+		} else {
+			if (isset($response_args['L_ERRORCODE'])) {
+				$payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+			} else {
+				$payment->set_gateway_response(
+					esc_html__(
+						'Error occurred while trying to setup the Express Checkout.',
+						'event_espresso'
+					)
+				);
+			}
+			$payment->set_details($response_args);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 * @param array           $update_info {
+	 * @type string           $gateway_txn_id
+	 * @type string status an EEMI_Payment status
+	 *                                     }
+	 * @param EEI_Transaction $transaction
+	 * @return EEI_Payment
+	 */
+	public function handle_payment_update($update_info, $transaction)
+	{
+		$payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
+		if ($payment instanceof EEI_Payment) {
+			$this->log(array('Return from Authorization' => $update_info), $payment);
+			$transaction = $payment->transaction();
+			if (! $transaction instanceof EEI_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 $payment;
+			}
+			$primary_registrant = $transaction->primary_registration();
+			$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 $payment;
+			}
+			$cdetails_request_dtls = array(
+				'METHOD' => 'GetExpressCheckoutDetails',
+				'TOKEN'  => $payment_details['TOKEN'],
+			);
+			// Request Customer Details.
+			$cdetails_request_response = $this->_ppExpress_request(
+				$cdetails_request_dtls,
+				'Customer Details',
+				$payment
+			);
+			$cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
+			$cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
+				? $cdetails_rstatus['args']
+				: array();
+			if ($cdetails_rstatus['status']) {
+				// We got the PayerID so now we can Complete the transaction.
+				$docheckout_request_dtls = array(
+					'METHOD'                         => 'DoExpressCheckoutPayment',
+					'PAYERID'                        => $cdata_response_args['PAYERID'],
+					'TOKEN'                          => $payment_details['TOKEN'],
+					'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+					'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+					'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+				);
+				 // Include itemized list.
+				$itemized_list = $this->itemize_list(
+					$payment,
+					$transaction,
+					$cdata_response_args
+				);
+				$docheckout_request_dtls = array_merge($docheckout_request_dtls, $itemized_list);
+				// Payment Checkout/Capture.
+				$docheckout_request_response = $this->_ppExpress_request(
+					$docheckout_request_dtls,
+					'Do Payment',
+					$payment
+				);
+				$docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
+				$docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
+					? $docheckout_rstatus['args']
+					: array();
+				if ($docheckout_rstatus['status']) {
+					// All is well, payment approved.
+					$primary_registration_code = $primary_registrant instanceof EE_Registration ?
+						$primary_registrant->reg_code()
+						: '';
+					$payment->set_extra_accntng($primary_registration_code);
+					$payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
+						? (float) $docheckout_response_args['PAYMENTINFO_0_AMT']
+						: 0);
+					$payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
+						? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
+						: null);
+					$payment->set_details($cdata_response_args);
+					$payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
+						? $docheckout_response_args['PAYMENTINFO_0_ACK']
+						: '');
+					$payment->set_status($this->_pay_model->approved_status());
+				} else {
+					if (isset($docheckout_response_args['L_ERRORCODE'])) {
+						$payment->set_gateway_response(
+							$docheckout_response_args['L_ERRORCODE']
+							. '; '
+							. $docheckout_response_args['L_SHORTMESSAGE']
+						);
+					} else {
+						$payment->set_gateway_response(
+							esc_html__(
+								'Error occurred while trying to Capture the funds.',
+								'event_espresso'
+							)
+						);
+					}
+					$payment->set_details($docheckout_response_args);
+					$payment->set_status($this->_pay_model->declined_status());
+				}
+			} else {
+				if (isset($cdata_response_args['L_ERRORCODE'])) {
+					$payment->set_gateway_response(
+						$cdata_response_args['L_ERRORCODE']
+						. '; '
+						. $cdata_response_args['L_SHORTMESSAGE']
+					);
+				} else {
+					$payment->set_gateway_response(
+						esc_html__(
+							'Error occurred while trying to get payment Details from PayPal.',
+							'event_espresso'
+						)
+					);
+				}
+				$payment->set_details($cdata_response_args);
+				$payment->set_status($this->_pay_model->failed_status());
+			}
+		} else {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Error occurred while trying to process the payment.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 *  Make a list of items that are in the giver transaction.
+	 *
+	 * @param EEI_Payment     $payment
+	 * @param EEI_Transaction $transaction
+	 * @param array           $request_response_args Data from a previous communication with PP.
+	 * @return array
+	 */
+	public function itemize_list(EEI_Payment $payment, EEI_Transaction $transaction, $request_response_args = array())
+	{
+		$itemized_list = array();
+		$gateway_formatter = $this->_get_gateway_formatter();
+		// 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
+				) {
+					$itemized_list[ $arg_key ] = $arg_val;
+				}
+			}
+			// If we got only a few Items then something is not right.
+			if (count($itemized_list) > 2) {
+				return $itemized_list;
+			} else {
+				if (WP_DEBUG) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								// @codingStandardsIgnoreStart
+								'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',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							),
+							wp_json_encode($itemized_list)
+						)
+					);
+				}
+				// Reset the list and log an error, maybe allow to try and generate a new list (below).
+				$itemized_list = array();
+				$this->log(
+					array(
+						(string) esc_html__(
+							'Could not generate a proper item list with:',
+							'event_espresso'
+						) => $request_response_args
+					),
+					$payment
+				);
+			}
+		}
+		// ...otherwise we generate a new list for this transaction.
+		if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
+			$item_num = 0;
+			$itemized_sum = 0;
+			$total_line_items = $transaction->total_line_item();
+			// Go through each item in the list.
+			foreach ($total_line_items->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->total(), '0.00', '==')) {
+						continue;
+					}
+					$unit_price = $line_item->unit_price();
+					$line_item_quantity = $line_item->quantity();
+					// This is a discount.
+					if ($line_item->is_percent()) {
+						$unit_price = $line_item->total();
+						$line_item_quantity = 1;
+					}
+					// Item Name.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+						$gateway_formatter->formatLineItemName($line_item, $payment),
+						0,
+						127
+					);
+					// Item description.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = mb_strcut(
+						$gateway_formatter->formatLineItemDesc($line_item, $payment),
+						0,
+						127
+					);
+					// Cost of individual item.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency($unit_price);
+					// Item Number.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+					// Item quantity.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = $line_item_quantity;
+					// Digital item is sold.
+					$itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+					$itemized_sum += $line_item->total();
+					++$item_num;
+				}
+			}
+			// Item's sales S/H and tax amount.
+			$itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
+			$itemized_list['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
+			$itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+			$itemized_sum_diff_from_txn_total = round(
+				$transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
+				2
+			);
+			// If we were not able to recognize some item like promotion, surcharge or cancellation,
+			// add the difference as an extra line item.
+			if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
+				// Item Name.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_NAME' . $item_num ] = mb_strcut(
+					esc_html__(
+						'Other (promotion/surcharge/cancellation)',
+						'event_espresso'
+					),
+					0,
+					127
+				);
+				// Item description.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_DESC' . $item_num ] = '';
+				// Cost of individual item.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_AMT' . $item_num ] = $gateway_formatter->formatCurrency(
+					$itemized_sum_diff_from_txn_total
+				);
+				// Item Number.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_NUMBER' . $item_num ] = $item_num + 1;
+				// Item quantity.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_QTY' . $item_num ] = 1;
+				// Digital item is sold.
+				$itemized_list[ 'L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num ] = 'Physical';
+				$item_num++;
+			}
+		} else {
+			// Just one Item.
+			// Item Name.
+			$itemized_list['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
+				$gateway_formatter->formatPartialPaymentLineItemName($payment),
+				0,
+				127
+			);
+			// Item description.
+			$itemized_list['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
+				$gateway_formatter->formatPartialPaymentLineItemDesc($payment),
+				0,
+				127
+			);
+			// Cost of individual item.
+			$itemized_list['L_PAYMENTREQUEST_0_AMT0'] = $gateway_formatter->formatCurrency($payment->amount());
+			// Item Number.
+			$itemized_list['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
+			// Item quantity.
+			$itemized_list['L_PAYMENTREQUEST_0_QTY0'] = 1;
+			// Digital item is sold.
+			$itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
+			// Item's sales S/H and tax amount.
+			$itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $gateway_formatter->formatCurrency($payment->amount());
+			$itemized_list['PAYMENTREQUEST_0_TAXAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+		}
+		return $itemized_list;
+	}
+
+
+
+	/**
+	 *  Make the Express checkout request.
+	 *
+	 * @param array       $request_params
+	 * @param string      $request_text
+	 * @param EEI_Payment $payment
+	 * @return mixed
+	 */
+	public function _ppExpress_request($request_params, $request_text, $payment)
+	{
+		$request_dtls = array(
+			'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,
+			array(
+				'method'      => 'POST',
+				'timeout'     => 45,
+				'httpversion' => '1.1',
+				'cookies'     => array(),
+				'headers'     => array(),
+				'body'        => http_build_query($dtls, '', '&'),
+			)
+		);
+		// Log the response.
+		$this->log(array($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)
+	{
+		if (is_wp_error($request_response) || empty($request_response['body'])) {
+			// If we got here then there was an error in this request.
+			return array('status' => false, 'args' => $request_response);
+		}
+		$response_args = array();
+		parse_str(urldecode($request_response['body']), $response_args);
+		if (! isset($response_args['ACK'])) {
+			return array('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'], array('Success', 'SuccessWithWarning'), true)
+		) {
+			// Response status OK, return response parameters for further processing.
+			return array('status' => true, 'args' => $response_args);
+		}
+		$errors = $this->_get_errors($response_args);
+		return array('status' => false, 'args' => $errors);
+	}
+
+
+
+	/**
+	 *  Log a "Cleared" request.
+	 *
+	 * @param array       $request
+	 * @param EEI_Payment $payment
+	 * @param string      $info
+	 * @return void
+	 */
+	private function _log_clean_request($request, $payment, $info)
+	{
+		$cleaned_request_data = $request;
+		unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
+		$this->log(array($info => $cleaned_request_data), $payment);
+	}
+
+
+
+	/**
+	 *  Get error from the response data.
+	 *
+	 * @param array $data_array
+	 * @return array
+	 */
+	private function _get_errors($data_array)
+	{
+		$errors = array();
+		$n = 0;
+		while (isset($data_array[ "L_ERRORCODE{$n}" ])) {
+			$l_error_code = isset($data_array[ "L_ERRORCODE{$n}" ])
+				? $data_array[ "L_ERRORCODE{$n}" ]
+				: '';
+			$l_severity_code = isset($data_array[ "L_SEVERITYCODE{$n}" ])
+				? $data_array[ "L_SEVERITYCODE{$n}" ]
+				: '';
+			$l_short_message = isset($data_array[ "L_SHORTMESSAGE{$n}" ])
+				? $data_array[ "L_SHORTMESSAGE{$n}" ]
+				: '';
+			$l_long_message = isset($data_array[ "L_LONGMESSAGE{$n}" ])
+				? $data_array[ "L_LONGMESSAGE{$n}" ]
+				: '';
+			if ($n === 0) {
+				$errors = array(
+					'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;
+	}
 }

core/libraries/form_sections/strategies/display/EE_Button_Display_Strategy.strategy.php

Indentation +28 added lines, -28 removed lines

@@ -12,32 +12,32 @@
 class EE_Button_Display_Strategy extends EE_Display_Strategy_Base
 {
 
-    /**
-     * @return string of html to display the input
-     */
-    public function display()
-    {
-        $default_value = $this->_input->get_default();
-        if ($this->_input->get_normalization_strategy() instanceof EE_Normalization_Strategy_Base) {
-            $default_value = $this->_input->get_normalization_strategy()->unnormalize($default_value);
-        }
-        $html = $this->_opening_tag('button');
-        $html .= $this->_attributes_string(
-            array_merge(
-                $this->_standard_attributes_array(),
-                array(
-                    'value' => $default_value,
-                )
-            )
-        );
-        if ($this->_input instanceof EE_Button_Input) {
-            $button_content = $this->_input->button_content();
-        } else {
-            $button_content = $this->_input->get_default();
-        }
-        $html .= '>';
-        $html .= $button_content;
-        $html .= $this->_closing_tag();
-        return $html;
-    }
+	/**
+	 * @return string of html to display the input
+	 */
+	public function display()
+	{
+		$default_value = $this->_input->get_default();
+		if ($this->_input->get_normalization_strategy() instanceof EE_Normalization_Strategy_Base) {
+			$default_value = $this->_input->get_normalization_strategy()->unnormalize($default_value);
+		}
+		$html = $this->_opening_tag('button');
+		$html .= $this->_attributes_string(
+			array_merge(
+				$this->_standard_attributes_array(),
+				array(
+					'value' => $default_value,
+				)
+			)
+		);
+		if ($this->_input instanceof EE_Button_Input) {
+			$button_content = $this->_input->button_content();
+		} else {
+			$button_content = $this->_input->get_default();
+		}
+		$html .= '>';
+		$html .= $button_content;
+		$html .= $this->_closing_tag();
+		return $html;
+	}
 }

core/domain/DomainFactory.php

Spacing +2 added lines, -2 removed lines

@@ -40,7 +40,7 @@ 
      */
     public static function getShared(FullyQualifiedName $domain_fqcn, array $arguments)
     {
-        if (! isset($arguments[0], $arguments[1])) {
+        if ( ! isset($arguments[0], $arguments[1])) {
             throw new InvalidArgumentException(
                 esc_html__(
                     'You need to pass at least two arguments, representing the addon plugin file and version, in order to generate a Domain class',
@@ -49,7 +49,7 @@ 
             );
         }
         $domain = LoaderFactory::getLoader()->getShared($domain_fqcn, $arguments);
-        if (! $domain instanceof $domain_fqcn && ! $domain instanceof DomainBase) {
+        if ( ! $domain instanceof $domain_fqcn && ! $domain instanceof DomainBase) {
             throw new DomainException(
                 sprintf(
                     esc_html__(

Indentation +55 added lines, -55 removed lines

@@ -28,63 +28,63 @@
 class DomainFactory
 {
 
-    /**
-     * @param FullyQualifiedName $domain_fqcn   [required] Fully Qualified Class Name for the Domain class
-     * @param array $arguments                  [required] array of arguments to be passed to the Domain class
-     *                                          constructor. Must at least include the following two value objects:
-     *                                          array(
-     *                                              EventEspresso\core\domain\values\FilePath $plugin_file
-     *                                              EventEspresso\core\domain\values\Version $version
-     *                                          )
-     * @return mixed
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function getShared(FullyQualifiedName $domain_fqcn, array $arguments)
-    {
-        if (! isset($arguments[0], $arguments[1])) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'You need to pass at least two arguments, representing the addon plugin file and version, in order to generate a Domain class',
-                    'event_espresso'
-                )
-            );
-        }
-        $domain = LoaderFactory::getLoader()->getShared($domain_fqcn, $arguments);
-        if (! $domain instanceof $domain_fqcn && ! $domain instanceof DomainBase) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The requested Domain class "%1$s" could not be loaded.',
-                        'event_espresso'
-                    ),
-                    $domain_fqcn
-                )
-            );
-        }
-        return $domain;
-    }
+	/**
+	 * @param FullyQualifiedName $domain_fqcn   [required] Fully Qualified Class Name for the Domain class
+	 * @param array $arguments                  [required] array of arguments to be passed to the Domain class
+	 *                                          constructor. Must at least include the following two value objects:
+	 *                                          array(
+	 *                                              EventEspresso\core\domain\values\FilePath $plugin_file
+	 *                                              EventEspresso\core\domain\values\Version $version
+	 *                                          )
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getShared(FullyQualifiedName $domain_fqcn, array $arguments)
+	{
+		if (! isset($arguments[0], $arguments[1])) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'You need to pass at least two arguments, representing the addon plugin file and version, in order to generate a Domain class',
+					'event_espresso'
+				)
+			);
+		}
+		$domain = LoaderFactory::getLoader()->getShared($domain_fqcn, $arguments);
+		if (! $domain instanceof $domain_fqcn && ! $domain instanceof DomainBase) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The requested Domain class "%1$s" could not be loaded.',
+						'event_espresso'
+					),
+					$domain_fqcn
+				)
+			);
+		}
+		return $domain;
+	}
 
 
-    /**
-     * @return Domain
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     * @throws InvalidInterfaceException
-     */
-    public static function getEventEspressoCoreDomain()
-    {
-        $domain = new Domain(
-            new FilePath(EVENT_ESPRESSO_MAIN_FILE),
-            Version::fromString(espresso_version())
-        );
-        LoaderFactory::getLoader()->share('EventEspresso\core\domain\Domain', $domain);
-        return $domain;
-    }
+	/**
+	 * @return Domain
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getEventEspressoCoreDomain()
+	{
+		$domain = new Domain(
+			new FilePath(EVENT_ESPRESSO_MAIN_FILE),
+			Version::fromString(espresso_version())
+		);
+		LoaderFactory::getLoader()->share('EventEspresso\core\domain\Domain', $domain);
+		return $domain;
+	}
 }
 
 

core/domain/values/FilePath.php

Indentation +36 added lines, -36 removed lines

@@ -20,42 +20,42 @@
 class FilePath
 {
 
-    /**
-     * @var string file_path
-     */
-    private $file_path;
-
-
-    /**
-     * FilePath constructor.
-     *
-     * @param string $file_path
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     */
-    public function __construct($file_path)
-    {
-        if (! is_string($file_path)) {
-            throw new InvalidDataTypeException(
-                '$file_path',
-                $file_path,
-                'string'
-            );
-        }
-        if (! is_readable($file_path)) {
-            throw new InvalidFilePathException($file_path);
-        }
-        $this->file_path = $file_path;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->file_path;
-    }
+	/**
+	 * @var string file_path
+	 */
+	private $file_path;
+
+
+	/**
+	 * FilePath constructor.
+	 *
+	 * @param string $file_path
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 */
+	public function __construct($file_path)
+	{
+		if (! is_string($file_path)) {
+			throw new InvalidDataTypeException(
+				'$file_path',
+				$file_path,
+				'string'
+			);
+		}
+		if (! is_readable($file_path)) {
+			throw new InvalidFilePathException($file_path);
+		}
+		$this->file_path = $file_path;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->file_path;
+	}
 
 
 }

Spacing +2 added lines, -2 removed lines

@@ -35,14 +35,14 @@
      */
     public function __construct($file_path)
     {
-        if (! is_string($file_path)) {
+        if ( ! is_string($file_path)) {
             throw new InvalidDataTypeException(
                 '$file_path',
                 $file_path,
                 'string'
             );
         }
-        if (! is_readable($file_path)) {
+        if ( ! is_readable($file_path)) {
             throw new InvalidFilePathException($file_path);
         }
         $this->file_path = $file_path;

core/domain/values/FullyQualifiedName.php

Spacing +2 added lines, -2 removed lines

@@ -37,14 +37,14 @@
      */
     public function __construct($fully_qualified_name)
     {
-        if (! is_string($fully_qualified_name)) {
+        if ( ! is_string($fully_qualified_name)) {
             throw new InvalidDataTypeException(
                 '$fully_qualified_name',
                 $fully_qualified_name,
                 'string'
             );
         }
-        if (! class_exists($fully_qualified_name) && ! interface_exists($fully_qualified_name)) {
+        if ( ! class_exists($fully_qualified_name) && ! interface_exists($fully_qualified_name)) {
             if (strpos($fully_qualified_name, 'Interface') !== false) {
                 throw new InvalidInterfaceException($fully_qualified_name);
             }

Indentation +43 added lines, -43 removed lines

@@ -21,54 +21,54 @@
 class FullyQualifiedName
 {
 
-    /**
-     * @var string $fully_qualified_name
-     */
-    private $fully_qualified_name;
+	/**
+	 * @var string $fully_qualified_name
+	 */
+	private $fully_qualified_name;
 
 
-    /**
-     * FullyQualifiedName constructor.
-     *
-     * @param string $fully_qualified_name
-     * @throws InvalidClassException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($fully_qualified_name)
-    {
-        if (! is_string($fully_qualified_name)) {
-            throw new InvalidDataTypeException(
-                '$fully_qualified_name',
-                $fully_qualified_name,
-                'string'
-            );
-        }
-        if (! class_exists($fully_qualified_name) && ! interface_exists($fully_qualified_name)) {
-            if (strpos($fully_qualified_name, 'Interface') !== false) {
-                throw new InvalidInterfaceException($fully_qualified_name);
-            }
-            throw new InvalidClassException($fully_qualified_name);
-        }
-        $this->fully_qualified_name = $fully_qualified_name;
-    }
+	/**
+	 * FullyQualifiedName constructor.
+	 *
+	 * @param string $fully_qualified_name
+	 * @throws InvalidClassException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($fully_qualified_name)
+	{
+		if (! is_string($fully_qualified_name)) {
+			throw new InvalidDataTypeException(
+				'$fully_qualified_name',
+				$fully_qualified_name,
+				'string'
+			);
+		}
+		if (! class_exists($fully_qualified_name) && ! interface_exists($fully_qualified_name)) {
+			if (strpos($fully_qualified_name, 'Interface') !== false) {
+				throw new InvalidInterfaceException($fully_qualified_name);
+			}
+			throw new InvalidClassException($fully_qualified_name);
+		}
+		$this->fully_qualified_name = $fully_qualified_name;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function string()
-    {
-        return $this->fully_qualified_name;
-    }
+	/**
+	 * @return string
+	 */
+	public function string()
+	{
+		return $this->fully_qualified_name;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->fully_qualified_name;
-    }
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->fully_qualified_name;
+	}
 
 }

core/domain/entities/contexts/RequestTypeContext.php

Spacing +1 added lines, -1 removed lines

@@ -91,7 +91,7 @@
     public function __construct($slug, $description)
     {
         parent::__construct($slug, $description);
-        if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
+        if ( ! in_array($this->slug(), $this->validRequestTypes(), true)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(

Indentation +151 added lines, -151 removed lines

@@ -16,155 +16,155 @@
 class RequestTypeContext extends Context
 {
 
-    /**
-     * indicates that the current request involves some form of activation
-     */
-    const ACTIVATION = 'activation-request';
-
-    /**
-     * indicates that the current request is for the admin but is not being made via AJAX
-     */
-    const ADMIN = 'non-ajax-admin-request';
-
-    /**
-     * indicates that the current request is for the admin AND is being made via AJAX
-     */
-    const AJAX_ADMIN = 'admin-ajax-request';
-
-    /**
-     * indicates that the current request is for the frontend AND is being made via AJAX
-     */
-    const AJAX_FRONT = 'frontend-ajax-request';
-
-    /**
-     * indicates that the current request is for the WP Heartbeat
-     */
-    const AJAX_HEARTBEAT = 'admin-ajax-heartbeat';
-
-    /**
-     * indicates that the current request is being made via AJAX, but is NOT for EE
-     */
-    const AJAX_OTHER = 'other-ajax-request';
-
-    /**
-     * indicates that the current request is for the EE REST API
-     */
-    const API = 'rest-api';
-
-    /**
-     * indicates that the current request is from the command line
-     */
-    const CLI = 'command-line';
-
-    /**
-     * indicates that the current request is for a WP_Cron
-     */
-    const CRON = 'wp-cron';
-
-    /**
-     * indicates that the current request is for a feed (ie: RSS)
-     */
-    const FEED = 'feed-request';
-
-    /**
-     * indicates that the current request is for the frontend but is not being made via AJAX
-     */
-    const FRONTEND = 'non-ajax-frontend-request';
-
-    /**
-     * indicates that the current request is for content that is to be displayed within an iframe
-     */
-    const IFRAME = 'iframe-request';
-
-    /**
-     * indicates that the current request is for the WP REST API
-     */
-    const WP_API = 'wp-rest-api';
-
-    /**
-     * indicates that the current request is a loopback sent from WP core to test for errors
-     */
-    const WP_SCRAPE = 'wordpress-scrape';
-
-    /**
-     * @var boolean $is_activation
-     */
-    private $is_activation = false;
-
-    /**
-     * @var array $valid_request_types
-     */
-    private $valid_request_types = array();
-
-
-    /**
-     * RequestTypeContext constructor.
-     *
-     * @param string $slug
-     * @param string $description
-     * @throws InvalidArgumentException
-     */
-    public function __construct($slug, $description)
-    {
-        parent::__construct($slug, $description);
-        if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The RequestTypeContext slug must be one of the following values: %1$s %2$s',
-                        'event_espresso'
-                    ),
-                    var_export($this->validRequestTypes(), true)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function validRequestTypes()
-    {
-        if (empty($this->valid_request_types)) {
-            $this->valid_request_types = apply_filters(
-                'FHEE__EventEspresso_core_domain_entities_contexts_RequestTypeContext__validRequestTypes',
-                array(
-                    RequestTypeContext::ACTIVATION,
-                    RequestTypeContext::ADMIN,
-                    RequestTypeContext::AJAX_ADMIN,
-                    RequestTypeContext::AJAX_FRONT,
-                    RequestTypeContext::AJAX_HEARTBEAT,
-                    RequestTypeContext::AJAX_OTHER,
-                    RequestTypeContext::API,
-                    RequestTypeContext::CLI,
-                    RequestTypeContext::CRON,
-                    RequestTypeContext::FEED,
-                    RequestTypeContext::FRONTEND,
-                    RequestTypeContext::IFRAME,
-                    RequestTypeContext::WP_API,
-                    RequestTypeContext::WP_SCRAPE,
-                )
-            );
-        }
-        return $this->valid_request_types;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->is_activation;
-    }
-
-
-    /**
-     * @param bool $is_activation
-     */
-    public function setIsActivation($is_activation)
-    {
-        $this->is_activation = filter_var($is_activation, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * indicates that the current request involves some form of activation
+	 */
+	const ACTIVATION = 'activation-request';
+
+	/**
+	 * indicates that the current request is for the admin but is not being made via AJAX
+	 */
+	const ADMIN = 'non-ajax-admin-request';
+
+	/**
+	 * indicates that the current request is for the admin AND is being made via AJAX
+	 */
+	const AJAX_ADMIN = 'admin-ajax-request';
+
+	/**
+	 * indicates that the current request is for the frontend AND is being made via AJAX
+	 */
+	const AJAX_FRONT = 'frontend-ajax-request';
+
+	/**
+	 * indicates that the current request is for the WP Heartbeat
+	 */
+	const AJAX_HEARTBEAT = 'admin-ajax-heartbeat';
+
+	/**
+	 * indicates that the current request is being made via AJAX, but is NOT for EE
+	 */
+	const AJAX_OTHER = 'other-ajax-request';
+
+	/**
+	 * indicates that the current request is for the EE REST API
+	 */
+	const API = 'rest-api';
+
+	/**
+	 * indicates that the current request is from the command line
+	 */
+	const CLI = 'command-line';
+
+	/**
+	 * indicates that the current request is for a WP_Cron
+	 */
+	const CRON = 'wp-cron';
+
+	/**
+	 * indicates that the current request is for a feed (ie: RSS)
+	 */
+	const FEED = 'feed-request';
+
+	/**
+	 * indicates that the current request is for the frontend but is not being made via AJAX
+	 */
+	const FRONTEND = 'non-ajax-frontend-request';
+
+	/**
+	 * indicates that the current request is for content that is to be displayed within an iframe
+	 */
+	const IFRAME = 'iframe-request';
+
+	/**
+	 * indicates that the current request is for the WP REST API
+	 */
+	const WP_API = 'wp-rest-api';
+
+	/**
+	 * indicates that the current request is a loopback sent from WP core to test for errors
+	 */
+	const WP_SCRAPE = 'wordpress-scrape';
+
+	/**
+	 * @var boolean $is_activation
+	 */
+	private $is_activation = false;
+
+	/**
+	 * @var array $valid_request_types
+	 */
+	private $valid_request_types = array();
+
+
+	/**
+	 * RequestTypeContext constructor.
+	 *
+	 * @param string $slug
+	 * @param string $description
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($slug, $description)
+	{
+		parent::__construct($slug, $description);
+		if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The RequestTypeContext slug must be one of the following values: %1$s %2$s',
+						'event_espresso'
+					),
+					var_export($this->validRequestTypes(), true)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function validRequestTypes()
+	{
+		if (empty($this->valid_request_types)) {
+			$this->valid_request_types = apply_filters(
+				'FHEE__EventEspresso_core_domain_entities_contexts_RequestTypeContext__validRequestTypes',
+				array(
+					RequestTypeContext::ACTIVATION,
+					RequestTypeContext::ADMIN,
+					RequestTypeContext::AJAX_ADMIN,
+					RequestTypeContext::AJAX_FRONT,
+					RequestTypeContext::AJAX_HEARTBEAT,
+					RequestTypeContext::AJAX_OTHER,
+					RequestTypeContext::API,
+					RequestTypeContext::CLI,
+					RequestTypeContext::CRON,
+					RequestTypeContext::FEED,
+					RequestTypeContext::FRONTEND,
+					RequestTypeContext::IFRAME,
+					RequestTypeContext::WP_API,
+					RequestTypeContext::WP_SCRAPE,
+				)
+			);
+		}
+		return $this->valid_request_types;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->is_activation;
+	}
+
+
+	/**
+	 * @param bool $is_activation
+	 */
+	public function setIsActivation($is_activation)
+	{
+		$this->is_activation = filter_var($is_activation, FILTER_VALIDATE_BOOLEAN);
+	}
 }

core/libraries/messages/validators/EE_Messages_Validator.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -505,7 +505,7 @@
      *
      * @param  string $value            string to evaluate
      * @param  array  $valid_shortcodes array of shortcodes that are acceptable.
-     * @return mixed (bool|string)  return either a list of invalid shortcodes OR false if the shortcodes validate.
+     * @return false|string (bool|string)  return either a list of invalid shortcodes OR false if the shortcodes validate.
      */
     protected function _invalid_shortcodes($value, $valid_shortcodes)
     {

Indentation +622 added lines, -622 removed lines

@@ -18,626 +18,626 @@
 {
 
 
-    /**
-     * These properties just hold the name for the Messenger and Message Type (defined by child classes).
-     * These are used for retrieving objects etc.
-     *
-     * @var string
-     */
-    protected $_m_name;
-    protected $_mt_name;
-
-
-    /**
-     * This will hold any error messages from the validation process.
-     * The _errors property holds an associative array of error messages
-     * listing the field as the key and the message as the value.
-     *
-     * @var array()
-     */
-    private $_errors = array();
-
-
-    /**
-     * holds an array of fields being validated
-     *
-     * @var array
-     */
-    protected $_fields;
-
-
-    /**
-     * this will hold the incoming context
-     *
-     * @var string
-     */
-    protected $_context;
-
-
-    /**
-     * this holds an array of fields and the relevant validation information
-     * that the incoming fields data get validated against.
-     * This gets setup in the _set_props() method.
-     *
-     * @var array
-     */
-    protected $_validators;
-
-
-    /**
-     * holds the messenger object
-     *
-     * @var object
-     */
-    protected $_messenger;
-
-
-    /**
-     * holds the message type object
-     *
-     * @var object
-     */
-    protected $_message_type;
-
-
-    /**
-     * will hold any valid_shortcode modifications made by the _modify_validator() method.
-     *
-     * @var array
-     */
-    protected $_valid_shortcodes_modifier;
-
-
-    /**
-     * There may be times where a message type wants to include a shortcode group but exclude specific
-     * shortcodes.  If that's the case then it can set this property as an array of shortcodes to exclude and
-     * they will not be allowed.
-     * Array should be indexed by field and values are an array of specific shortcodes to exclude.
-     *
-     * @var array
-     */
-    protected $_specific_shortcode_excludes = array();
-
-
-    /**
-     * Runs the validator using the incoming fields array as the fields/values to check.
-     *
-     * @param array $fields The fields sent by the EEM object.
-     * @param       $context
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($fields, $context)
-    {
-        // check that _m_name and _mt_name have been set by child class otherwise we get out.
-        if (empty($this->_m_name) || empty($this->_mt_name)) {
-            throw new EE_Error(
-                esc_html__(
-                    'EE_Messages_Validator child classes MUST set the $_m_name and $_mt_name property.  Check that the child class is doing this',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->_fields  = $fields;
-        $this->_context = $context;
-
-        // load messenger and message_type objects and the related shortcode objects.
-        $this->_load_objects();
-
-
-        // modify any messenger/message_type specific validation instructions.  This is what child classes define.
-        $this->_modify_validator();
-
-
-        // let's set validators property
-        $this->_set_validators();
-    }
-
-
-    /**
-     * Child classes instantiate this and use it to modify the _validator_config array property
-     * for the messenger using messengers set_validate_config() method.
-     * This is so we can specify specific validation instructions for a messenger/message_type combo
-     * that aren't handled by the defaults setup in the messenger.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _modify_validator();
-
-
-    /**
-     * loads all objects used by validator
-     *
-     * @access private
-     * @throws \EE_Error
-     */
-    private function _load_objects()
-    {
-        // load messenger
-        $messenger = ucwords(str_replace('_', ' ', $this->_m_name));
-        $messenger = str_replace(' ', '_', $messenger);
-        $messenger = 'EE_' . $messenger . '_messenger';
-
-        if (! class_exists($messenger)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
-                    $this->_m_name
-                )
-            );
-        }
-
-        $this->_messenger = new $messenger();
-
-        // load message type
-        $message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
-        $message_type = str_replace(' ', '_', $message_type);
-        $message_type = 'EE_' . $message_type . '_message_type';
-
-        if (! class_exists($message_type)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
-                    $this->_mt_name
-                )
-            );
-        }
-
-        $this->_message_type = new $message_type();
-    }
-
-
-    /**
-     * used to set the $_validators property
-     *
-     * @access private
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _set_validators()
-    {
-        // let's get all valid shortcodes from mt and message type
-        // (messenger will have its set in the _validator_config property for the messenger)
-        $mt_codes = $this->_message_type->get_valid_shortcodes();
-
-
-        // get messenger validator_config
-        $msgr_validator = $this->_messenger->get_validator_config();
-
-
-        // we only want the valid shortcodes for the given context!
-        $context  = $this->_context;
-        $mt_codes = $mt_codes[ $context ];
-
-        // in this first loop we're just getting all shortcode group indexes from the msgr_validator
-        // into a single array (so we can get the appropriate shortcode objects for the groups)
-        $shortcode_groups = $mt_codes;
-        $groups_per_field = array();
-
-        foreach ($msgr_validator as $field => $config) {
-            if (empty($config) || ! isset($config['shortcodes'])) {
-                continue;
-            }  //Nothing to see here.
-            $groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
-            $shortcode_groups         = array_merge($config['shortcodes'], $shortcode_groups);
-        }
-
-        $shortcode_groups = array_unique($shortcode_groups);
-
-        // okay now we've got our groups.
-        // Let's get the codes from the objects into an array indexed by group for easy retrieval later.
-        $codes_from_objs = array();
-
-        foreach ($shortcode_groups as $group) {
-            $ref       = ucwords(str_replace('_', ' ', $group));
-            $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
-            if (class_exists($classname)) {
-                $a                       = new ReflectionClass($classname);
-                $obj                     = $a->newInstance();
-                $codes_from_objs[ $group ] = $obj->get_shortcodes();
-            }
-        }
-
-
-        // let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
-        $final_mt_codes = array();
-        foreach ($mt_codes as $group) {
-            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
-        }
-
-        $mt_codes = $final_mt_codes;
-
-
-        // k now in this next loop we're going to loop through $msgr_validator again
-        // and setup the _validators property from the data we've setup so far.
-        foreach ($msgr_validator as $field => $config) {
-            // if required shortcode is not in our list of codes for the given field, then we skip this field.
-            $required = isset($config['required'])
-                ? array_intersect($config['required'], array_keys($mt_codes))
-                : true;
-            if (empty($required)) {
-                continue;
-            }
-
-            // If we have an override then we use it to indicate the codes we want.
-            if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $this->_valid_shortcodes_modifier[ $context ][ $field ],
-                    $codes_from_objs
-                );
-            } //if we have specific shortcodes for a field then we need to use them
-            elseif (isset($groups_per_field[ $field ])) {
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $groups_per_field[ $field ],
-                    $codes_from_objs
-                );
-            } //if empty config then we're assuming we're just going to use the shortcodes from the message type context
-            elseif (empty($config)) {
-                $this->_validators[ $field ]['shortcodes'] = $mt_codes;
-            } //if we have specific shortcodes then we need to use them
-            elseif (isset($config['specific_shortcodes'])) {
-                $this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
-            } //otherwise the shortcodes are what is set by the messenger for that field
-            else {
-                foreach ($config['shortcodes'] as $group) {
-                    $this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
-                        ? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
-                        : $codes_from_objs[ $group ];
-                }
-            }
-
-            // now let's just make sure that any excluded specific shortcodes are removed.
-            $specific_excludes = $this->get_specific_shortcode_excludes();
-            if (isset($specific_excludes[ $field ])) {
-                foreach ($specific_excludes[ $field ] as $sex) {
-                    if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
-                        unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
-                    }
-                }
-            }
-
-            // hey! don't forget to include the type if present!
-            $this->_validators[ $field ]['type'] = isset($config['type']) ? $config['type'] : null;
-        }
-    }
-
-
-    /**
-     * This just returns the validators property that contains information
-     * about the various shortcodes and their availability with each field
-     *
-     * @return array
-     */
-    public function get_validators()
-    {
-        return $this->_validators;
-    }
-
-
-    /**
-     * This simply returns the specific shortcode_excludes property that is set.
-     *
-     * @since 4.5.0
-     * @return array
-     */
-    public function get_specific_shortcode_excludes()
-    {
-        // specific validator filter
-        $shortcode_excludes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
-            $this->_specific_shortcode_excludes,
-            $this->_context
-        );
-        // global filter
-        return apply_filters(
-            'FHEE__EE_Messages_Validator__get_specific_shortcode_excludes',
-            $shortcode_excludes,
-            $this->_context,
-            $this
-        );
-    }
-
-
-    /**
-     * This is the main method that handles validation
-     * What it does is loop through the _fields (the ones that get validated)
-     * and checks them against the shortcodes array for the field and the 'type' indicated by the
-     *
-     * @access public
-     * @return mixed (bool|array)  if errors present we return the array otherwise true
-     */
-    public function validate()
-    {
-        // some defaults
-        $template_fields = $this->_messenger->get_template_fields();
-        // loop through the fields and check!
-        foreach ($this->_fields as $field => $value) {
-            $this->_errors[ $field ] = array();
-            $err_msg               = '';
-            $field_label           = '';
-            // if field is not present in the _validators array then we continue
-            if (! isset($this->_validators[ $field ])) {
-                unset($this->_errors[ $field ]);
-                continue;
-            }
-
-            // get the translated field label!
-            // first check if it's in the main fields list
-            if (isset($template_fields[ $field ])) {
-                if (empty($template_fields[ $field ])) {
-                    $field_label = $field;
-                } //most likely the field is found in the 'extra' array.
-                else {
-                    $field_label = $template_fields[ $field ]['label'];
-                }
-            }
-
-            // if field label is empty OR is equal to the current field
-            // then we need to loop through the 'extra' fields in the template_fields config (if present)
-            if (isset($template_fields['extra']) && (empty($field_label) || $field_label === $field)) {
-                foreach ($template_fields['extra'] as $main_field => $secondary_field) {
-                    foreach ($secondary_field as $name => $values) {
-                        if ($name === $field) {
-                            $field_label = $values['label'];
-                        }
-
-                        // if we've got a 'main' secondary field, let's see if that matches what field we're on
-                        // which means it contains the label for this field.
-                        if ($name === 'main' && $main_field === $field_label) {
-                            $field_label = $values['label'];
-                        }
-                    }
-                }
-            }
-
-            // field is present. Let's validate shortcodes first (but only if shortcodes present).
-            if (isset($this->_validators[ $field ]['shortcodes'])
-                && ! empty($this->_validators[ $field ]['shortcodes'])
-            ) {
-                $invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[ $field ]['shortcodes']);
-                // if true then that means there is a returned error message
-                // that we'll need to add to the _errors array for this field.
-                if ($invalid_shortcodes) {
-                    $v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
-                    $err_msg = sprintf(
-                        esc_html__(
-                            '%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
-                            'event_espresso'
-                        ),
-                        '<strong>' . $field_label . '</strong>',
-                        $invalid_shortcodes,
-                        '<p>',
-                        '</p >'
-                    );
-                    $err_msg .= sprintf(
-                        esc_html__('%2$sValid shortcodes for this field are: %1$s%3$s', 'event_espresso'),
-                        implode(', ', $v_s),
-                        '<strong>',
-                        '</strong>'
-                    );
-                }
-            }
-
-            // if there's a "type" to be validated then let's do that too.
-            if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
-                switch ($this->_validators[ $field ]['type']) {
-                    case 'number':
-                        if (! is_numeric($value)) {
-                            $err_msg .= sprintf(
-                                esc_html__(
-                                    '%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
-                                    'event_espresso'
-                                ),
-                                $field_label,
-                                $value,
-                                '<p>',
-                                '</p >'
-                            );
-                        }
-                        break;
-                    case 'email':
-                        $valid_email = $this->_validate_email($value);
-                        if (! $valid_email) {
-                            $err_msg .= htmlentities(
-                                sprintf(
-                                    esc_html__(
-                                        'The %1$s field has at least one string that is not a valid email address record.  Valid emails are in the format: "Name <email@something.com>" or "email@something.com" and multiple emails can be separated by a comma.',
-                                        'event_espresso'
-                                    ),
-                                    $field_label
-                                )
-                            );
-                        }
-                        break;
-                    default:
-                        break;
-                }
-            }
-
-            // if $err_msg isn't empty let's setup the _errors array for this field.
-            if (! empty($err_msg)) {
-                $this->_errors[ $field ]['msg'] = $err_msg;
-            } else {
-                unset($this->_errors[ $field ]);
-            }
-        }
-
-        // if we have ANY errors, then we want to make sure we return the values
-        // for ALL the fields so the user doesn't have to retype them all.
-        if (! empty($this->_errors)) {
-            foreach ($this->_fields as $field => $value) {
-                $this->_errors[ $field ]['value'] = stripslashes($value);
-            }
-        }
-
-        // return any errors or just TRUE if everything validates
-        return empty($this->_errors) ? true : $this->_errors;
-    }
-
-
-    /**
-     * Reassembles and returns an array of valid shortcodes
-     * given the array of groups and array of shortcodes indexed by group.
-     *
-     * @param  array $groups          array of shortcode groups that we want shortcodes for
-     * @param  array $codes_from_objs All the codes available.
-     * @return array                   an array of actual shortcodes (that will be used for validation).
-     */
-    private function _reassemble_valid_shortcodes_from_group($groups, $codes_from_objs)
-    {
-        $shortcodes = array();
-        foreach ($groups as $group) {
-            $shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
-        }
-        return $shortcodes;
-    }
-
-
-    /**
-     * Validates a string against a list of accepted shortcodes
-     * This function takes in an array of shortcodes
-     * and makes sure that the given string ONLY contains shortcodes in that array.
-     *
-     * @param  string $value            string to evaluate
-     * @param  array  $valid_shortcodes array of shortcodes that are acceptable.
-     * @return mixed (bool|string)  return either a list of invalid shortcodes OR false if the shortcodes validate.
-     */
-    protected function _invalid_shortcodes($value, $valid_shortcodes)
-    {
-        // first we need to go through the string and get the shortcodes in the string
-        preg_match_all('/(\[.+?\])/', $value, $matches);
-        $incoming_shortcodes = (array) $matches[0];
-
-        // get a diff of the shortcodes in the string vs the valid shortcodes
-        $diff = array_diff($incoming_shortcodes, array_keys($valid_shortcodes));
-
-        // we need to account for custom codes so let's loop through the diff and remove any of those type of codes
-        foreach ($diff as $ind => $code) {
-            if (preg_match('/(\[[A-Za-z0-9\_]+_\*)/', $code)) {
-                // strip the shortcode so we just have the BASE string (i.e. [ANSWER_*] )
-                $dynamic_sc = preg_replace('/(_\*+.+)/', '_*]', $code);
-                // does this exist in the $valid_shortcodes?  If so then unset.
-                if (isset($valid_shortcodes[ $dynamic_sc ])) {
-                    unset($diff[ $ind ]);
-                }
-            }
-        }
-
-        if (empty($diff)) {
-            return false;
-        } //there is no diff, we have no invalid shortcodes, so return
-
-        // made it here? then let's assemble the error message
-        $invalid_shortcodes = implode('</strong>,<strong>', $diff);
-        $invalid_shortcodes = '<strong>' . $invalid_shortcodes . '</strong>';
-        return $invalid_shortcodes;
-    }
-
-
-    /**
-     * Validates an incoming string and makes sure we have valid emails in the string.
-     *
-     * @param  string $value incoming value to validate
-     * @return bool        true if the string validates, false if it doesn't
-     */
-    protected function _validate_email($value)
-    {
-        $validate = true;
-        $or_val   = $value;
-
-        // empty strings will validate because this is how a message template
-        // for a particular context can be "turned off" (if there is no email then no message)
-        if (empty($value)) {
-            return $validate;
-        }
-
-        // first determine if there ARE any shortcodes.
-        // If there are shortcodes and then later we find that there were no other valid emails
-        // but the field isn't empty...
-        // that means we've got extra commas that were left after stripping out shortcodes so probably still valid.
-        $has_shortcodes = preg_match('/(\[.+?\])/', $value);
-
-        // first we need to strip out all the shortcodes!
-        $value = preg_replace('/(\[.+?\])/', '', $value);
-
-        // if original value is not empty and new value is, then we've parsed out a shortcode
-        // and we now have an empty string which DOES validate.
-        // We also validate complete empty field for email because
-        // its possible that this message is being "turned off" for a particular context
-
-
-        if (! empty($or_val) && empty($value)) {
-            return $validate;
-        }
-
-        // trim any commas from beginning and end of string ( after whitespace trimmed );
-        $value = trim(trim($value), ',');
-
-
-        // next we need to split up the string if its comma delimited.
-        $emails = explode(',', $value);
-        $empty  = false; // used to indicate that there is an empty comma.
-        // now let's loop through the emails and do our checks
-        foreach ($emails as $email) {
-            if (empty($email)) {
-                $empty = true;
-                continue;
-            }
-
-            // trim whitespace
-            $email = trim($email);
-            // either its of type "bob@whatever.com", or its of type "fname lname <few@few.few>"
-            if (is_email($email)) {
-                continue;
-            }
-            $matches  = array();
-            $validate = preg_match('/(.*)<(.+)>/', $email, $matches) ? true : false;
-            if ($validate && is_email($matches[2])) {
-                continue;
-            }
-            return false;
-        }
-
-        $validate = $empty && ! $has_shortcodes ? false : $validate;
-
-        return $validate;
-    }
-
-
-    /**
-     * Magic getter
-     * Using this to provide back compat with add-ons referencing deprecated properties.
-     *
-     * @param string $property Property being requested
-     * @throws Exception
-     * @return mixed
-     */
-    public function __get($property)
-    {
-        $expected_properties_map = array(
-            /**
-             * @deprecated 4.9.0
-             */
-            '_MSGR'   => '_messenger',
-            /**
-             * @deprecated 4.9.0
-             */
-            '_MSGTYP' => '_message_type',
-        );
-
-        if (isset($expected_properties_map[ $property ])) {
-            return $this->{$expected_properties_map[ $property ]};
-        }
-
-        throw new Exception(
-            sprintf(
-                esc_html__('The property %1$s being requested on %2$s does not exist', 'event_espresso'),
-                $property,
-                get_class($this)
-            )
-        );
-    }
+	/**
+	 * These properties just hold the name for the Messenger and Message Type (defined by child classes).
+	 * These are used for retrieving objects etc.
+	 *
+	 * @var string
+	 */
+	protected $_m_name;
+	protected $_mt_name;
+
+
+	/**
+	 * This will hold any error messages from the validation process.
+	 * The _errors property holds an associative array of error messages
+	 * listing the field as the key and the message as the value.
+	 *
+	 * @var array()
+	 */
+	private $_errors = array();
+
+
+	/**
+	 * holds an array of fields being validated
+	 *
+	 * @var array
+	 */
+	protected $_fields;
+
+
+	/**
+	 * this will hold the incoming context
+	 *
+	 * @var string
+	 */
+	protected $_context;
+
+
+	/**
+	 * this holds an array of fields and the relevant validation information
+	 * that the incoming fields data get validated against.
+	 * This gets setup in the _set_props() method.
+	 *
+	 * @var array
+	 */
+	protected $_validators;
+
+
+	/**
+	 * holds the messenger object
+	 *
+	 * @var object
+	 */
+	protected $_messenger;
+
+
+	/**
+	 * holds the message type object
+	 *
+	 * @var object
+	 */
+	protected $_message_type;
+
+
+	/**
+	 * will hold any valid_shortcode modifications made by the _modify_validator() method.
+	 *
+	 * @var array
+	 */
+	protected $_valid_shortcodes_modifier;
+
+
+	/**
+	 * There may be times where a message type wants to include a shortcode group but exclude specific
+	 * shortcodes.  If that's the case then it can set this property as an array of shortcodes to exclude and
+	 * they will not be allowed.
+	 * Array should be indexed by field and values are an array of specific shortcodes to exclude.
+	 *
+	 * @var array
+	 */
+	protected $_specific_shortcode_excludes = array();
+
+
+	/**
+	 * Runs the validator using the incoming fields array as the fields/values to check.
+	 *
+	 * @param array $fields The fields sent by the EEM object.
+	 * @param       $context
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($fields, $context)
+	{
+		// check that _m_name and _mt_name have been set by child class otherwise we get out.
+		if (empty($this->_m_name) || empty($this->_mt_name)) {
+			throw new EE_Error(
+				esc_html__(
+					'EE_Messages_Validator child classes MUST set the $_m_name and $_mt_name property.  Check that the child class is doing this',
+					'event_espresso'
+				)
+			);
+		}
+		$this->_fields  = $fields;
+		$this->_context = $context;
+
+		// load messenger and message_type objects and the related shortcode objects.
+		$this->_load_objects();
+
+
+		// modify any messenger/message_type specific validation instructions.  This is what child classes define.
+		$this->_modify_validator();
+
+
+		// let's set validators property
+		$this->_set_validators();
+	}
+
+
+	/**
+	 * Child classes instantiate this and use it to modify the _validator_config array property
+	 * for the messenger using messengers set_validate_config() method.
+	 * This is so we can specify specific validation instructions for a messenger/message_type combo
+	 * that aren't handled by the defaults setup in the messenger.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _modify_validator();
+
+
+	/**
+	 * loads all objects used by validator
+	 *
+	 * @access private
+	 * @throws \EE_Error
+	 */
+	private function _load_objects()
+	{
+		// load messenger
+		$messenger = ucwords(str_replace('_', ' ', $this->_m_name));
+		$messenger = str_replace(' ', '_', $messenger);
+		$messenger = 'EE_' . $messenger . '_messenger';
+
+		if (! class_exists($messenger)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
+					$this->_m_name
+				)
+			);
+		}
+
+		$this->_messenger = new $messenger();
+
+		// load message type
+		$message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
+		$message_type = str_replace(' ', '_', $message_type);
+		$message_type = 'EE_' . $message_type . '_message_type';
+
+		if (! class_exists($message_type)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
+					$this->_mt_name
+				)
+			);
+		}
+
+		$this->_message_type = new $message_type();
+	}
+
+
+	/**
+	 * used to set the $_validators property
+	 *
+	 * @access private
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _set_validators()
+	{
+		// let's get all valid shortcodes from mt and message type
+		// (messenger will have its set in the _validator_config property for the messenger)
+		$mt_codes = $this->_message_type->get_valid_shortcodes();
+
+
+		// get messenger validator_config
+		$msgr_validator = $this->_messenger->get_validator_config();
+
+
+		// we only want the valid shortcodes for the given context!
+		$context  = $this->_context;
+		$mt_codes = $mt_codes[ $context ];
+
+		// in this first loop we're just getting all shortcode group indexes from the msgr_validator
+		// into a single array (so we can get the appropriate shortcode objects for the groups)
+		$shortcode_groups = $mt_codes;
+		$groups_per_field = array();
+
+		foreach ($msgr_validator as $field => $config) {
+			if (empty($config) || ! isset($config['shortcodes'])) {
+				continue;
+			}  //Nothing to see here.
+			$groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
+			$shortcode_groups         = array_merge($config['shortcodes'], $shortcode_groups);
+		}
+
+		$shortcode_groups = array_unique($shortcode_groups);
+
+		// okay now we've got our groups.
+		// Let's get the codes from the objects into an array indexed by group for easy retrieval later.
+		$codes_from_objs = array();
+
+		foreach ($shortcode_groups as $group) {
+			$ref       = ucwords(str_replace('_', ' ', $group));
+			$ref       = str_replace(' ', '_', $ref);
+			$classname = 'EE_' . $ref . '_Shortcodes';
+			if (class_exists($classname)) {
+				$a                       = new ReflectionClass($classname);
+				$obj                     = $a->newInstance();
+				$codes_from_objs[ $group ] = $obj->get_shortcodes();
+			}
+		}
+
+
+		// let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
+		$final_mt_codes = array();
+		foreach ($mt_codes as $group) {
+			$final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
+		}
+
+		$mt_codes = $final_mt_codes;
+
+
+		// k now in this next loop we're going to loop through $msgr_validator again
+		// and setup the _validators property from the data we've setup so far.
+		foreach ($msgr_validator as $field => $config) {
+			// if required shortcode is not in our list of codes for the given field, then we skip this field.
+			$required = isset($config['required'])
+				? array_intersect($config['required'], array_keys($mt_codes))
+				: true;
+			if (empty($required)) {
+				continue;
+			}
+
+			// If we have an override then we use it to indicate the codes we want.
+			if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
+				$this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+					$this->_valid_shortcodes_modifier[ $context ][ $field ],
+					$codes_from_objs
+				);
+			} //if we have specific shortcodes for a field then we need to use them
+			elseif (isset($groups_per_field[ $field ])) {
+				$this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+					$groups_per_field[ $field ],
+					$codes_from_objs
+				);
+			} //if empty config then we're assuming we're just going to use the shortcodes from the message type context
+			elseif (empty($config)) {
+				$this->_validators[ $field ]['shortcodes'] = $mt_codes;
+			} //if we have specific shortcodes then we need to use them
+			elseif (isset($config['specific_shortcodes'])) {
+				$this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
+			} //otherwise the shortcodes are what is set by the messenger for that field
+			else {
+				foreach ($config['shortcodes'] as $group) {
+					$this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
+						? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
+						: $codes_from_objs[ $group ];
+				}
+			}
+
+			// now let's just make sure that any excluded specific shortcodes are removed.
+			$specific_excludes = $this->get_specific_shortcode_excludes();
+			if (isset($specific_excludes[ $field ])) {
+				foreach ($specific_excludes[ $field ] as $sex) {
+					if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
+						unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
+					}
+				}
+			}
+
+			// hey! don't forget to include the type if present!
+			$this->_validators[ $field ]['type'] = isset($config['type']) ? $config['type'] : null;
+		}
+	}
+
+
+	/**
+	 * This just returns the validators property that contains information
+	 * about the various shortcodes and their availability with each field
+	 *
+	 * @return array
+	 */
+	public function get_validators()
+	{
+		return $this->_validators;
+	}
+
+
+	/**
+	 * This simply returns the specific shortcode_excludes property that is set.
+	 *
+	 * @since 4.5.0
+	 * @return array
+	 */
+	public function get_specific_shortcode_excludes()
+	{
+		// specific validator filter
+		$shortcode_excludes = apply_filters(
+			'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
+			$this->_specific_shortcode_excludes,
+			$this->_context
+		);
+		// global filter
+		return apply_filters(
+			'FHEE__EE_Messages_Validator__get_specific_shortcode_excludes',
+			$shortcode_excludes,
+			$this->_context,
+			$this
+		);
+	}
+
+
+	/**
+	 * This is the main method that handles validation
+	 * What it does is loop through the _fields (the ones that get validated)
+	 * and checks them against the shortcodes array for the field and the 'type' indicated by the
+	 *
+	 * @access public
+	 * @return mixed (bool|array)  if errors present we return the array otherwise true
+	 */
+	public function validate()
+	{
+		// some defaults
+		$template_fields = $this->_messenger->get_template_fields();
+		// loop through the fields and check!
+		foreach ($this->_fields as $field => $value) {
+			$this->_errors[ $field ] = array();
+			$err_msg               = '';
+			$field_label           = '';
+			// if field is not present in the _validators array then we continue
+			if (! isset($this->_validators[ $field ])) {
+				unset($this->_errors[ $field ]);
+				continue;
+			}
+
+			// get the translated field label!
+			// first check if it's in the main fields list
+			if (isset($template_fields[ $field ])) {
+				if (empty($template_fields[ $field ])) {
+					$field_label = $field;
+				} //most likely the field is found in the 'extra' array.
+				else {
+					$field_label = $template_fields[ $field ]['label'];
+				}
+			}
+
+			// if field label is empty OR is equal to the current field
+			// then we need to loop through the 'extra' fields in the template_fields config (if present)
+			if (isset($template_fields['extra']) && (empty($field_label) || $field_label === $field)) {
+				foreach ($template_fields['extra'] as $main_field => $secondary_field) {
+					foreach ($secondary_field as $name => $values) {
+						if ($name === $field) {
+							$field_label = $values['label'];
+						}
+
+						// if we've got a 'main' secondary field, let's see if that matches what field we're on
+						// which means it contains the label for this field.
+						if ($name === 'main' && $main_field === $field_label) {
+							$field_label = $values['label'];
+						}
+					}
+				}
+			}
+
+			// field is present. Let's validate shortcodes first (but only if shortcodes present).
+			if (isset($this->_validators[ $field ]['shortcodes'])
+				&& ! empty($this->_validators[ $field ]['shortcodes'])
+			) {
+				$invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[ $field ]['shortcodes']);
+				// if true then that means there is a returned error message
+				// that we'll need to add to the _errors array for this field.
+				if ($invalid_shortcodes) {
+					$v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
+					$err_msg = sprintf(
+						esc_html__(
+							'%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
+							'event_espresso'
+						),
+						'<strong>' . $field_label . '</strong>',
+						$invalid_shortcodes,
+						'<p>',
+						'</p >'
+					);
+					$err_msg .= sprintf(
+						esc_html__('%2$sValid shortcodes for this field are: %1$s%3$s', 'event_espresso'),
+						implode(', ', $v_s),
+						'<strong>',
+						'</strong>'
+					);
+				}
+			}
+
+			// if there's a "type" to be validated then let's do that too.
+			if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
+				switch ($this->_validators[ $field ]['type']) {
+					case 'number':
+						if (! is_numeric($value)) {
+							$err_msg .= sprintf(
+								esc_html__(
+									'%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
+									'event_espresso'
+								),
+								$field_label,
+								$value,
+								'<p>',
+								'</p >'
+							);
+						}
+						break;
+					case 'email':
+						$valid_email = $this->_validate_email($value);
+						if (! $valid_email) {
+							$err_msg .= htmlentities(
+								sprintf(
+									esc_html__(
+										'The %1$s field has at least one string that is not a valid email address record.  Valid emails are in the format: "Name <email@something.com>" or "email@something.com" and multiple emails can be separated by a comma.',
+										'event_espresso'
+									),
+									$field_label
+								)
+							);
+						}
+						break;
+					default:
+						break;
+				}
+			}
+
+			// if $err_msg isn't empty let's setup the _errors array for this field.
+			if (! empty($err_msg)) {
+				$this->_errors[ $field ]['msg'] = $err_msg;
+			} else {
+				unset($this->_errors[ $field ]);
+			}
+		}
+
+		// if we have ANY errors, then we want to make sure we return the values
+		// for ALL the fields so the user doesn't have to retype them all.
+		if (! empty($this->_errors)) {
+			foreach ($this->_fields as $field => $value) {
+				$this->_errors[ $field ]['value'] = stripslashes($value);
+			}
+		}
+
+		// return any errors or just TRUE if everything validates
+		return empty($this->_errors) ? true : $this->_errors;
+	}
+
+
+	/**
+	 * Reassembles and returns an array of valid shortcodes
+	 * given the array of groups and array of shortcodes indexed by group.
+	 *
+	 * @param  array $groups          array of shortcode groups that we want shortcodes for
+	 * @param  array $codes_from_objs All the codes available.
+	 * @return array                   an array of actual shortcodes (that will be used for validation).
+	 */
+	private function _reassemble_valid_shortcodes_from_group($groups, $codes_from_objs)
+	{
+		$shortcodes = array();
+		foreach ($groups as $group) {
+			$shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
+		}
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Validates a string against a list of accepted shortcodes
+	 * This function takes in an array of shortcodes
+	 * and makes sure that the given string ONLY contains shortcodes in that array.
+	 *
+	 * @param  string $value            string to evaluate
+	 * @param  array  $valid_shortcodes array of shortcodes that are acceptable.
+	 * @return mixed (bool|string)  return either a list of invalid shortcodes OR false if the shortcodes validate.
+	 */
+	protected function _invalid_shortcodes($value, $valid_shortcodes)
+	{
+		// first we need to go through the string and get the shortcodes in the string
+		preg_match_all('/(\[.+?\])/', $value, $matches);
+		$incoming_shortcodes = (array) $matches[0];
+
+		// get a diff of the shortcodes in the string vs the valid shortcodes
+		$diff = array_diff($incoming_shortcodes, array_keys($valid_shortcodes));
+
+		// we need to account for custom codes so let's loop through the diff and remove any of those type of codes
+		foreach ($diff as $ind => $code) {
+			if (preg_match('/(\[[A-Za-z0-9\_]+_\*)/', $code)) {
+				// strip the shortcode so we just have the BASE string (i.e. [ANSWER_*] )
+				$dynamic_sc = preg_replace('/(_\*+.+)/', '_*]', $code);
+				// does this exist in the $valid_shortcodes?  If so then unset.
+				if (isset($valid_shortcodes[ $dynamic_sc ])) {
+					unset($diff[ $ind ]);
+				}
+			}
+		}
+
+		if (empty($diff)) {
+			return false;
+		} //there is no diff, we have no invalid shortcodes, so return
+
+		// made it here? then let's assemble the error message
+		$invalid_shortcodes = implode('</strong>,<strong>', $diff);
+		$invalid_shortcodes = '<strong>' . $invalid_shortcodes . '</strong>';
+		return $invalid_shortcodes;
+	}
+
+
+	/**
+	 * Validates an incoming string and makes sure we have valid emails in the string.
+	 *
+	 * @param  string $value incoming value to validate
+	 * @return bool        true if the string validates, false if it doesn't
+	 */
+	protected function _validate_email($value)
+	{
+		$validate = true;
+		$or_val   = $value;
+
+		// empty strings will validate because this is how a message template
+		// for a particular context can be "turned off" (if there is no email then no message)
+		if (empty($value)) {
+			return $validate;
+		}
+
+		// first determine if there ARE any shortcodes.
+		// If there are shortcodes and then later we find that there were no other valid emails
+		// but the field isn't empty...
+		// that means we've got extra commas that were left after stripping out shortcodes so probably still valid.
+		$has_shortcodes = preg_match('/(\[.+?\])/', $value);
+
+		// first we need to strip out all the shortcodes!
+		$value = preg_replace('/(\[.+?\])/', '', $value);
+
+		// if original value is not empty and new value is, then we've parsed out a shortcode
+		// and we now have an empty string which DOES validate.
+		// We also validate complete empty field for email because
+		// its possible that this message is being "turned off" for a particular context
+
+
+		if (! empty($or_val) && empty($value)) {
+			return $validate;
+		}
+
+		// trim any commas from beginning and end of string ( after whitespace trimmed );
+		$value = trim(trim($value), ',');
+
+
+		// next we need to split up the string if its comma delimited.
+		$emails = explode(',', $value);
+		$empty  = false; // used to indicate that there is an empty comma.
+		// now let's loop through the emails and do our checks
+		foreach ($emails as $email) {
+			if (empty($email)) {
+				$empty = true;
+				continue;
+			}
+
+			// trim whitespace
+			$email = trim($email);
+			// either its of type "bob@whatever.com", or its of type "fname lname <few@few.few>"
+			if (is_email($email)) {
+				continue;
+			}
+			$matches  = array();
+			$validate = preg_match('/(.*)<(.+)>/', $email, $matches) ? true : false;
+			if ($validate && is_email($matches[2])) {
+				continue;
+			}
+			return false;
+		}
+
+		$validate = $empty && ! $has_shortcodes ? false : $validate;
+
+		return $validate;
+	}
+
+
+	/**
+	 * Magic getter
+	 * Using this to provide back compat with add-ons referencing deprecated properties.
+	 *
+	 * @param string $property Property being requested
+	 * @throws Exception
+	 * @return mixed
+	 */
+	public function __get($property)
+	{
+		$expected_properties_map = array(
+			/**
+			 * @deprecated 4.9.0
+			 */
+			'_MSGR'   => '_messenger',
+			/**
+			 * @deprecated 4.9.0
+			 */
+			'_MSGTYP' => '_message_type',
+		);
+
+		if (isset($expected_properties_map[ $property ])) {
+			return $this->{$expected_properties_map[ $property ]};
+		}
+
+		throw new Exception(
+			sprintf(
+				esc_html__('The property %1$s being requested on %2$s does not exist', 'event_espresso'),
+				$property,
+				get_class($this)
+			)
+		);
+	}
 }

Spacing +54 added lines, -54 removed lines

@@ -158,9 +158,9 @@ 
         // load messenger
         $messenger = ucwords(str_replace('_', ' ', $this->_m_name));
         $messenger = str_replace(' ', '_', $messenger);
-        $messenger = 'EE_' . $messenger . '_messenger';
+        $messenger = 'EE_'.$messenger.'_messenger';
 
-        if (! class_exists($messenger)) {
+        if ( ! class_exists($messenger)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
@@ -174,9 +174,9 @@ 
         // load message type
         $message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
         $message_type = str_replace(' ', '_', $message_type);
-        $message_type = 'EE_' . $message_type . '_message_type';
+        $message_type = 'EE_'.$message_type.'_message_type';
 
-        if (! class_exists($message_type)) {
+        if ( ! class_exists($message_type)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
@@ -209,7 +209,7 @@ 
 
         // we only want the valid shortcodes for the given context!
         $context  = $this->_context;
-        $mt_codes = $mt_codes[ $context ];
+        $mt_codes = $mt_codes[$context];
 
         // in this first loop we're just getting all shortcode group indexes from the msgr_validator
         // into a single array (so we can get the appropriate shortcode objects for the groups)
@@ -220,8 +220,8 @@ 
             if (empty($config) || ! isset($config['shortcodes'])) {
                 continue;
             }  //Nothing to see here.
-            $groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
-            $shortcode_groups         = array_merge($config['shortcodes'], $shortcode_groups);
+            $groups_per_field[$field] = array_intersect($config['shortcodes'], $mt_codes);
+            $shortcode_groups = array_merge($config['shortcodes'], $shortcode_groups);
         }
 
         $shortcode_groups = array_unique($shortcode_groups);
@@ -233,11 +233,11 @@ 
         foreach ($shortcode_groups as $group) {
             $ref       = ucwords(str_replace('_', ' ', $group));
             $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
+            $classname = 'EE_'.$ref.'_Shortcodes';
             if (class_exists($classname)) {
                 $a                       = new ReflectionClass($classname);
                 $obj                     = $a->newInstance();
-                $codes_from_objs[ $group ] = $obj->get_shortcodes();
+                $codes_from_objs[$group] = $obj->get_shortcodes();
             }
         }
 
@@ -245,7 +245,7 @@ 
         // let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
         $final_mt_codes = array();
         foreach ($mt_codes as $group) {
-            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
+            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[$group]);
         }
 
         $mt_codes = $final_mt_codes;
@@ -263,44 +263,44 @@ 
             }
 
             // If we have an override then we use it to indicate the codes we want.
-            if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $this->_valid_shortcodes_modifier[ $context ][ $field ],
+            if (isset($this->_valid_shortcodes_modifier[$context][$field])) {
+                $this->_validators[$field]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+                    $this->_valid_shortcodes_modifier[$context][$field],
                     $codes_from_objs
                 );
             } //if we have specific shortcodes for a field then we need to use them
-            elseif (isset($groups_per_field[ $field ])) {
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $groups_per_field[ $field ],
+            elseif (isset($groups_per_field[$field])) {
+                $this->_validators[$field]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+                    $groups_per_field[$field],
                     $codes_from_objs
                 );
             } //if empty config then we're assuming we're just going to use the shortcodes from the message type context
             elseif (empty($config)) {
-                $this->_validators[ $field ]['shortcodes'] = $mt_codes;
+                $this->_validators[$field]['shortcodes'] = $mt_codes;
             } //if we have specific shortcodes then we need to use them
             elseif (isset($config['specific_shortcodes'])) {
-                $this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
+                $this->_validators[$field]['shortcodes'] = $config['specific_shortcodes'];
             } //otherwise the shortcodes are what is set by the messenger for that field
             else {
                 foreach ($config['shortcodes'] as $group) {
-                    $this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
-                        ? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
-                        : $codes_from_objs[ $group ];
+                    $this->_validators[$field]['shortcodes'] = isset($this->_validators[$field]['shortcodes'])
+                        ? array_merge($this->_validators[$field]['shortcodes'], $codes_from_objs[$group])
+                        : $codes_from_objs[$group];
                 }
             }
 
             // now let's just make sure that any excluded specific shortcodes are removed.
             $specific_excludes = $this->get_specific_shortcode_excludes();
-            if (isset($specific_excludes[ $field ])) {
-                foreach ($specific_excludes[ $field ] as $sex) {
-                    if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
-                        unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
+            if (isset($specific_excludes[$field])) {
+                foreach ($specific_excludes[$field] as $sex) {
+                    if (isset($this->_validators[$field]['shortcodes'][$sex])) {
+                        unset($this->_validators[$field]['shortcodes'][$sex]);
                     }
                 }
             }
 
             // hey! don't forget to include the type if present!
-            $this->_validators[ $field ]['type'] = isset($config['type']) ? $config['type'] : null;
+            $this->_validators[$field]['type'] = isset($config['type']) ? $config['type'] : null;
         }
     }
 
@@ -327,7 +327,7 @@ 
     {
         // specific validator filter
         $shortcode_excludes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
+            'FHEE__'.get_class($this).'__get_specific_shortcode_excludes;',
             $this->_specific_shortcode_excludes,
             $this->_context
         );
@@ -355,23 +355,23 @@ 
         $template_fields = $this->_messenger->get_template_fields();
         // loop through the fields and check!
         foreach ($this->_fields as $field => $value) {
-            $this->_errors[ $field ] = array();
+            $this->_errors[$field] = array();
             $err_msg               = '';
             $field_label           = '';
             // if field is not present in the _validators array then we continue
-            if (! isset($this->_validators[ $field ])) {
-                unset($this->_errors[ $field ]);
+            if ( ! isset($this->_validators[$field])) {
+                unset($this->_errors[$field]);
                 continue;
             }
 
             // get the translated field label!
             // first check if it's in the main fields list
-            if (isset($template_fields[ $field ])) {
-                if (empty($template_fields[ $field ])) {
+            if (isset($template_fields[$field])) {
+                if (empty($template_fields[$field])) {
                     $field_label = $field;
                 } //most likely the field is found in the 'extra' array.
                 else {
-                    $field_label = $template_fields[ $field ]['label'];
+                    $field_label = $template_fields[$field]['label'];
                 }
             }
 
@@ -394,20 +394,20 @@ 
             }
 
             // field is present. Let's validate shortcodes first (but only if shortcodes present).
-            if (isset($this->_validators[ $field ]['shortcodes'])
-                && ! empty($this->_validators[ $field ]['shortcodes'])
+            if (isset($this->_validators[$field]['shortcodes'])
+                && ! empty($this->_validators[$field]['shortcodes'])
             ) {
-                $invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[ $field ]['shortcodes']);
+                $invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[$field]['shortcodes']);
                 // if true then that means there is a returned error message
                 // that we'll need to add to the _errors array for this field.
                 if ($invalid_shortcodes) {
-                    $v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
+                    $v_s     = array_keys($this->_validators[$field]['shortcodes']);
                     $err_msg = sprintf(
                         esc_html__(
                             '%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
                             'event_espresso'
                         ),
-                        '<strong>' . $field_label . '</strong>',
+                        '<strong>'.$field_label.'</strong>',
                         $invalid_shortcodes,
                         '<p>',
                         '</p >'
@@ -422,10 +422,10 @@ 
             }
 
             // if there's a "type" to be validated then let's do that too.
-            if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
-                switch ($this->_validators[ $field ]['type']) {
+            if (isset($this->_validators[$field]['type']) && ! empty($this->_validators[$field]['type'])) {
+                switch ($this->_validators[$field]['type']) {
                     case 'number':
-                        if (! is_numeric($value)) {
+                        if ( ! is_numeric($value)) {
                             $err_msg .= sprintf(
                                 esc_html__(
                                     '%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
@@ -440,7 +440,7 @@ 
                         break;
                     case 'email':
                         $valid_email = $this->_validate_email($value);
-                        if (! $valid_email) {
+                        if ( ! $valid_email) {
                             $err_msg .= htmlentities(
                                 sprintf(
                                     esc_html__(
@@ -458,18 +458,18 @@ 
             }
 
             // if $err_msg isn't empty let's setup the _errors array for this field.
-            if (! empty($err_msg)) {
-                $this->_errors[ $field ]['msg'] = $err_msg;
+            if ( ! empty($err_msg)) {
+                $this->_errors[$field]['msg'] = $err_msg;
             } else {
-                unset($this->_errors[ $field ]);
+                unset($this->_errors[$field]);
             }
         }
 
         // if we have ANY errors, then we want to make sure we return the values
         // for ALL the fields so the user doesn't have to retype them all.
-        if (! empty($this->_errors)) {
+        if ( ! empty($this->_errors)) {
             foreach ($this->_fields as $field => $value) {
-                $this->_errors[ $field ]['value'] = stripslashes($value);
+                $this->_errors[$field]['value'] = stripslashes($value);
             }
         }
 
@@ -490,7 +490,7 @@ 
     {
         $shortcodes = array();
         foreach ($groups as $group) {
-            $shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
+            $shortcodes = array_merge($shortcodes, $codes_from_objs[$group]);
         }
         return $shortcodes;
     }
@@ -520,8 +520,8 @@ 
                 // strip the shortcode so we just have the BASE string (i.e. [ANSWER_*] )
                 $dynamic_sc = preg_replace('/(_\*+.+)/', '_*]', $code);
                 // does this exist in the $valid_shortcodes?  If so then unset.
-                if (isset($valid_shortcodes[ $dynamic_sc ])) {
-                    unset($diff[ $ind ]);
+                if (isset($valid_shortcodes[$dynamic_sc])) {
+                    unset($diff[$ind]);
                 }
             }
         }
@@ -532,7 +532,7 @@ 
 
         // made it here? then let's assemble the error message
         $invalid_shortcodes = implode('</strong>,<strong>', $diff);
-        $invalid_shortcodes = '<strong>' . $invalid_shortcodes . '</strong>';
+        $invalid_shortcodes = '<strong>'.$invalid_shortcodes.'</strong>';
         return $invalid_shortcodes;
     }
 
@@ -569,7 +569,7 @@ 
         // its possible that this message is being "turned off" for a particular context
 
 
-        if (! empty($or_val) && empty($value)) {
+        if ( ! empty($or_val) && empty($value)) {
             return $validate;
         }
 
@@ -628,8 +628,8 @@ 
             '_MSGTYP' => '_message_type',
         );
 
-        if (isset($expected_properties_map[ $property ])) {
-            return $this->{$expected_properties_map[ $property ]};
+        if (isset($expected_properties_map[$property])) {
+            return $this->{$expected_properties_map[$property]};
         }
 
         throw new Exception(

core/db_models/fields/EE_Simple_HTML_Field.php

Indentation +10 added lines, -10 removed lines

@@ -11,14 +11,14 @@
 
 
 
-    /**
-     * removes all tags which a WP Post wouldn't allow in its content normally
-     *
-     * @param string $value
-     * @return string
-     */
-    public function prepare_for_set($value)
-    {
-        return parent::prepare_for_set(wp_kses("$value", EEH_HTML::get_simple_tags()));
-    }
+	/**
+	 * removes all tags which a WP Post wouldn't allow in its content normally
+	 *
+	 * @param string $value
+	 * @return string
+	 */
+	public function prepare_for_set($value)
+	{
+		return parent::prepare_for_set(wp_kses("$value", EEH_HTML::get_simple_tags()));
+	}
 }

core/db_classes/EE_WP_User.class.php

Spacing +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
      */
     public function wp_user_obj()
     {
-        if (! $this->_wp_user_obj) {
+        if ( ! $this->_wp_user_obj) {
             $this->_wp_user_obj = get_user_by('ID', $this->ID());
         }
         return $this->_wp_user_obj;

Indentation +79 added lines, -79 removed lines

@@ -11,91 +11,91 @@
 class EE_WP_User extends EE_Base_Class implements EEI_Admin_Links
 {
 
-    /**
-     * @var WP_User
-     */
-    protected $_wp_user_obj;
+	/**
+	 * @var WP_User
+	 */
+	protected $_wp_user_obj;
 
-    /**
-     * @param array $props_n_values
-     * @return EE_WP_User|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_WP_User|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @return EE_WP_User
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_WP_User
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
 
-    /**
-     * Return a normal WP_User object (caches the object for future calls)
-     *
-     * @return WP_User
-     */
-    public function wp_user_obj()
-    {
-        if (! $this->_wp_user_obj) {
-            $this->_wp_user_obj = get_user_by('ID', $this->ID());
-        }
-        return $this->_wp_user_obj;
-    }
+	/**
+	 * Return a normal WP_User object (caches the object for future calls)
+	 *
+	 * @return WP_User
+	 */
+	public function wp_user_obj()
+	{
+		if (! $this->_wp_user_obj) {
+			$this->_wp_user_obj = get_user_by('ID', $this->ID());
+		}
+		return $this->_wp_user_obj;
+	}
 
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
 
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        return esc_url(
-            add_query_arg(
-                'wp_http_referer',
-                urlencode(
-                    wp_unslash(
-                        $_SERVER['REQUEST_URI']
-                    )
-                ),
-                get_edit_user_link($this->ID())
-            )
-        );
-    }
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		return esc_url(
+			add_query_arg(
+				'wp_http_referer',
+				urlencode(
+					wp_unslash(
+						$_SERVER['REQUEST_URI']
+					)
+				),
+				get_edit_user_link($this->ID())
+			)
+		);
+	}
 
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_edit_link();
-    }
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_edit_link();
+	}
 
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        return admin_url('users.php');
-    }
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		return admin_url('users.php');
+	}
 }