eventespresso / event-espresso-core

caffeinated/payment_methods/Paypal_Pro/EEG_Paypal_Pro.gateway.php

Doc Comments +1 added lines, -1 removed lines

@@ -450,7 +450,7 @@
 
 
     /**
-     * @param $Request
+     * @param string $Request
      * @return mixed
      */
     private function _CURLRequest($Request)

Spacing +29 added lines, -29 removed lines

@@ -77,13 +77,13 @@ 
     public function do_direct_payment($payment, $billing_info = null)
     {
         $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
+        if ( ! $transaction instanceof EEI_Transaction) {
             throw new EE_Error(
                 esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso')
             );
         }
         $primary_registrant = $transaction->primary_registration();
-        if (! $primary_registrant instanceof EEI_Registration) {
+        if ( ! $primary_registrant instanceof EEI_Registration) {
             throw new EE_Error(
                 esc_html__(
                     'No primary registration on transaction while paying with PayPal Pro.',
@@ -92,7 +92,7 @@ 
             );
         }
         $attendee = $primary_registrant->attendee();
-        if (! $attendee instanceof EEI_Attendee) {
+        if ( ! $attendee instanceof EEI_Attendee) {
             throw new EE_Error(
                 esc_html__(
                     'No attendee on primary registration while paying with PayPal Pro.',
@@ -189,7 +189,7 @@ 
             // Required.  Credit card number.  No spaces or punctuation.
             'acct'           => $billing_info['credit_card'],
             // Required.  Credit card expiration date.  Format is MMYYYY
-            'expdate'        => $billing_info['exp_month'] . $billing_info['exp_year'],
+            'expdate'        => $billing_info['exp_month'].$billing_info['exp_year'],
             // Requirements determined by your PayPal account settings.  Security digits for credit card.
             'cvv2'           => $billing_info['cvv'],
         );
@@ -241,7 +241,7 @@ 
         $ShippingAddress = array(
             'shiptoname'     => substr($use_registration_address_info
                 ? $attendee->full_name()
-                : $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32),
+                : $billing_info['first_name'].' '.$billing_info['last_name'], 0, 32),
             'shiptostreet'   => substr($use_registration_address_info
                 ? $attendee->address()
                 : $billing_info['address'], 0, 100),
@@ -270,7 +270,7 @@ 
             'currencycode' => $payment->currency_code(),
             // Required if you include itemized cart details. (L_AMTn, etc.)
             // Subtotal of items not including S&H, or tax.
-            'itemamt'      => $gateway_formatter->formatCurrency($item_amount),//
+            'itemamt'      => $gateway_formatter->formatCurrency($item_amount), //
             // Total shipping costs for the order.  If you specify shippingamt, you must also specify itemamt.
             'shippingamt'  => '',
             // Total handling costs for the order.  If you specify handlingamt, you must also specify itemamt.
@@ -283,10 +283,10 @@ 
             // Free-form field for your own use.  256 char max.
             'custom'       => $primary_registrant ? $primary_registrant->ID() : '',
             // Your own invoice or tracking number
-            'invnum'       => wp_generate_password(12, false),// $transaction->ID(),
+            'invnum'       => wp_generate_password(12, false), // $transaction->ID(),
             // URL for receiving Instant Payment Notifications.  This overrides what your profile is set to use.
             'notifyurl'    => '',
-            'buttonsource' => 'EventEspresso_SP',// EE will blow up if you change this
+            'buttonsource' => 'EventEspresso_SP', // EE will blow up if you change this
         );
         // Wrap all data arrays into a single, "master" array which will be passed into the class function.
         $PayPalRequestData = array(
@@ -396,52 +396,52 @@ 
         // DP Fields
         $DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array();
         foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) {
-            $DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal);
+            $DPFieldsNVP .= '&'.strtoupper($DPFieldsVar).'='.urlencode($DPFieldsVal);
         }
         // CC Details Fields
         $CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array();
         foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) {
-            $CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal);
+            $CCDetailsNVP .= '&'.strtoupper($CCDetailsVar).'='.urlencode($CCDetailsVal);
         }
         // PayerInfo Type Fields
         $PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array();
         foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) {
-            $PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal);
+            $PayerInfoNVP .= '&'.strtoupper($PayerInfoVar).'='.urlencode($PayerInfoVal);
         }
         // Payer Name Fields
         $PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array();
         foreach ($PayerName as $PayerNameVar => $PayerNameVal) {
-            $PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal);
+            $PayerNameNVP .= '&'.strtoupper($PayerNameVar).'='.urlencode($PayerNameVal);
         }
         // Address Fields (Billing)
         $BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array();
         foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) {
-            $BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal);
+            $BillingAddressNVP .= '&'.strtoupper($BillingAddressVar).'='.urlencode($BillingAddressVal);
         }
         // Payment Details Type Fields
         $PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array();
         foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) {
-            $PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal);
+            $PaymentDetailsNVP .= '&'.strtoupper($PaymentDetailsVar).'='.urlencode($PaymentDetailsVal);
         }
         // Payment Details Item Type Fields
         $OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array();
         $n = 0;
         foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) {
-            $CurrentItem = $OrderItems[ $OrderItemsVar ];
+            $CurrentItem = $OrderItems[$OrderItemsVar];
             foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) {
-                $OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal);
+                $OrderItemsNVP .= '&'.strtoupper($CurrentItemVar).$n.'='.urlencode($CurrentItemVal);
             }
             $n++;
         }
         // Ship To Address Fields
         $ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array();
         foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) {
-            $ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal);
+            $ShippingAddressNVP .= '&'.strtoupper($ShippingAddressVar).'='.urlencode($ShippingAddressVal);
         }
         // 3D Secure Fields
         $Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array();
         foreach ($Secure3D as $Secure3DVar => $Secure3DVal) {
-            $Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal);
+            $Secure3DNVP .= '&'.strtoupper($Secure3DVar).'='.urlencode($Secure3DVal);
         }
         // Now that we have each chunk we need to go ahead and append them all together for our entire NVP string
         $NVPRequest = 'USER='
@@ -512,7 +512,7 @@ 
             $valuepos = strpos($NVPString, '&') ? strpos($NVPString, '&') : strlen($NVPString);
             $valval = substr($NVPString, $keypos + 1, $valuepos - $keypos - 1);
             // decoding the response
-            $proArray[ $keyval ] = urldecode($valval);
+            $proArray[$keyval] = urldecode($valval);
             $NVPString = substr($NVPString, $valuepos + 1, strlen($NVPString));
         }
         return $proArray;
@@ -545,16 +545,16 @@ 
     {
         $Errors = array();
         $n = 0;
-        while (isset($DataArray[ 'L_ERRORCODE' . $n . '' ])) {
-            $LErrorCode = isset($DataArray[ 'L_ERRORCODE' . $n . '' ]) ? $DataArray[ 'L_ERRORCODE' . $n . '' ] : '';
-            $LShortMessage = isset($DataArray[ 'L_SHORTMESSAGE' . $n . '' ])
-                ? $DataArray[ 'L_SHORTMESSAGE' . $n . '' ]
+        while (isset($DataArray['L_ERRORCODE'.$n.''])) {
+            $LErrorCode = isset($DataArray['L_ERRORCODE'.$n.'']) ? $DataArray['L_ERRORCODE'.$n.''] : '';
+            $LShortMessage = isset($DataArray['L_SHORTMESSAGE'.$n.''])
+                ? $DataArray['L_SHORTMESSAGE'.$n.'']
                 : '';
-            $LLongMessage = isset($DataArray[ 'L_LONGMESSAGE' . $n . '' ])
-                ? $DataArray[ 'L_LONGMESSAGE' . $n . '' ]
+            $LLongMessage = isset($DataArray['L_LONGMESSAGE'.$n.''])
+                ? $DataArray['L_LONGMESSAGE'.$n.'']
                 : '';
-            $LSeverityCode = isset($DataArray[ 'L_SEVERITYCODE' . $n . '' ])
-                ? $DataArray[ 'L_SEVERITYCODE' . $n . '' ]
+            $LSeverityCode = isset($DataArray['L_SEVERITYCODE'.$n.''])
+                ? $DataArray['L_SEVERITYCODE'.$n.'']
                 : '';
             $CurrentItem = array(
                 'L_ERRORCODE'    => $LErrorCode,
@@ -581,7 +581,7 @@ 
     {
         $error = '';
         foreach ($Errors as $ErrorVar => $ErrorVal) {
-            $CurrentError = $Errors[ $ErrorVar ];
+            $CurrentError = $Errors[$ErrorVar];
             foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) {
                 $CurrentVarName = '';
                 if ($CurrentErrorVar == 'L_ERRORCODE') {
@@ -593,7 +593,7 @@ 
                 } elseif ($CurrentErrorVar == 'L_SEVERITYCODE') {
                     $CurrentVarName = 'Severity Code';
                 }
-                $error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal;
+                $error .= '<br />'.$CurrentVarName.': '.$CurrentErrorVal;
             }
         }
         return $error;

Indentation +602 added lines, -602 removed lines

@@ -11,606 +11,606 @@
 class EEG_Paypal_Pro extends EE_Onsite_Gateway
 {
 
-    /**
-     * @var $_paypal_api_username string
-     */
-    protected $_api_username = null;
-
-    /**
-     * @var $_api_password string
-     */
-    protected $_api_password = null;
-
-    /**
-     * @var $_api_signature string
-     */
-    protected $_api_signature = null;
-
-    /**
-     * @var $_credit_card_types array with the keys for credit card types accepted on this account
-     */
-    protected $_credit_card_types    = null;
-
-    protected $_currencies_supported = array(
-        'USD',
-        'GBP',
-        'CAD',
-        'AUD',
-        'BRL',
-        'CHF',
-        'CZK',
-        'DKK',
-        'EUR',
-        'HKD',
-        'HUF',
-        'ILS',
-        'JPY',
-        'MXN',
-        'MYR',
-        'NOK',
-        'NZD',
-        'PHP',
-        'PLN',
-        'SEK',
-        'SGD',
-        'THB',
-        'TRY',
-        'TWD',
-        'RUB',
-        'INR',
-    );
-
-
-
-    /**
-     * @param EEI_Payment $payment
-     * @param array       $billing_info {
-     * @type string $credit_card
-     * @type string $credit_card_type
-     * @type string $exp_month always 2 characters
-     * @type string $exp_year always 4 characters
-     * @type string $cvv
-     * }
-     * @see      parent::do_direct_payment for more info
-     * @return EE_Payment|EEI_Payment
-     * @throws EE_Error
-     */
-    public function do_direct_payment($payment, $billing_info = null)
-    {
-        $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
-            throw new EE_Error(
-                esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso')
-            );
-        }
-        $primary_registrant = $transaction->primary_registration();
-        if (! $primary_registrant instanceof EEI_Registration) {
-            throw new EE_Error(
-                esc_html__(
-                    'No primary registration on transaction while paying with PayPal Pro.',
-                    'event_espresso'
-                )
-            );
-        }
-        $attendee = $primary_registrant->attendee();
-        if (! $attendee instanceof EEI_Attendee) {
-            throw new EE_Error(
-                esc_html__(
-                    'No attendee on primary registration while paying with PayPal Pro.',
-                    'event_espresso'
-                )
-            );
-        }
-        $gateway_formatter = $this->_get_gateway_formatter();
-        $order_description = substr($gateway_formatter->formatOrderDescription($payment), 0, 127);
-        // charge for the full amount. Show itemized list
-        if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
-            $item_num = 1;
-            $total_line_item = $transaction->total_line_item();
-            $order_items = array();
-            foreach ($total_line_item->get_items() as $line_item) {
-                // ignore line items with a quantity of 0
-                if ($line_item->quantity() == 0) {
-                    continue;
-                }
-                // For percent items, whose unit_price is 0, use the total instead.
-                if ($line_item->is_percent()) {
-                    $unit_price = $line_item->total();
-                    $line_item_quantity = 1;
-                } else {
-                    $unit_price = $line_item->unit_price();
-                    $line_item_quantity = $line_item->quantity();
-                }
-                $item = array(
-                    // Item Name.  127 char max.
-                    'l_name'                 => substr(
-                        $gateway_formatter->formatLineItemName($line_item, $payment),
-                        0,
-                        127
-                    ),
-                    // Item description.  127 char max.
-                    'l_desc'                 => substr(
-                        $gateway_formatter->formatLineItemDesc($line_item, $payment),
-                        0,
-                        127
-                    ),
-                    // Cost of individual item.
-                    'l_amt'                  => $unit_price,
-                    // Item Number.  127 char max.
-                    'l_number'               => $item_num++,
-                    // Item quantity.  Must be any positive integer.
-                    'l_qty'                  => $line_item_quantity,
-                    // Item's sales tax amount.
-                    'l_taxamt'               => '',
-                    // eBay auction number of item.
-                    'l_ebayitemnumber'       => '',
-                    // eBay transaction ID of purchased item.
-                    'l_ebayitemauctiontxnid' => '',
-                    // eBay order ID for the item.
-                    'l_ebayitemorderid'      => '',
-                );
-                // add to array of all items
-                array_push($order_items, $item);
-            }
-            $item_amount = $total_line_item->get_items_total();
-            $tax_amount = $total_line_item->get_total_tax();
-        } else {
-            $order_items = array();
-            $item_amount = $payment->amount();
-            $tax_amount = 0;
-            array_push($order_items, array(
-                // Item Name.  127 char max.
-                'l_name'   => substr(
-                    $gateway_formatter->formatPartialPaymentLineItemName($payment),
-                    0,
-                    127
-                ),
-                // Item description.  127 char max.
-                'l_desc'   => substr(
-                    $gateway_formatter->formatPartialPaymentLineItemDesc($payment),
-                    0,
-                    127
-                ),
-                // Cost of individual item.
-                'l_amt'    => $payment->amount(),
-                // Item Number.  127 char max.
-                'l_number' => 1,
-                // Item quantity.  Must be any positive integer.
-                'l_qty'    => 1,
-            ));
-        }
-        // Populate data arrays with order data.
-        $DPFields = array(
-            // How you want to obtain payment ?
-            // Authorization indicates the payment is a basic auth subject to settlement with Auth & Capture.
-            // Sale indicates that this is a final sale for which you are requesting payment.  Default is Sale.
-            'paymentaction'    => 'Sale',
-            // Required.  IP address of the payer's browser.
-            'ipaddress'        => $_SERVER['REMOTE_ADDR'],
-            // Flag to determine whether you want the results returned by FMF.  1 or 0.  Default is 0.
-            'returnfmfdetails' => '1',
-        );
-        $CCDetails = array(
-            // Required. Type of credit card.  Visa, MasterCard, Discover, Amex, Maestro, Solo.
-            // If Maestro or Solo, the currency code must be GBP.
-            //  In addition, either start date or issue number must be specified.
-            'creditcardtype' => $billing_info['credit_card_type'],
-            // Required.  Credit card number.  No spaces or punctuation.
-            'acct'           => $billing_info['credit_card'],
-            // Required.  Credit card expiration date.  Format is MMYYYY
-            'expdate'        => $billing_info['exp_month'] . $billing_info['exp_year'],
-            // Requirements determined by your PayPal account settings.  Security digits for credit card.
-            'cvv2'           => $billing_info['cvv'],
-        );
-        $PayerInfo = array(
-            // Email address of payer.
-            'email'       => $billing_info['email'],
-            // Unique PayPal customer ID for payer.
-            'payerid'     => '',
-            // Status of payer.  Values are verified or unverified
-            'payerstatus' => '',
-            // Payer's business name.
-            'business'    => '',
-        );
-        $PayerName = array(
-            // Payer's salutation.  20 char max.
-            'salutation' => '',
-            // Payer's first name.  25 char max.
-            'firstname'  => substr($billing_info['first_name'], 0, 25),
-            // Payer's middle name.  25 char max.
-            'middlename' => '',
-            // Payer's last name.  25 char max.
-            'lastname'   => substr($billing_info['last_name'], 0, 25),
-            // Payer's suffix.  12 char max.
-            'suffix'     => '',
-        );
-        $BillingAddress = array(
-            // Required.  First street address.
-            'street'      => $billing_info['address'],
-            // Second street address.
-            'street2'     => $billing_info['address2'],
-            // Required.  Name of City.
-            'city'        => $billing_info['city'],
-            // Required. Name of State or Province.
-            'state'       => substr($billing_info['state'], 0, 40),
-            // Required.  Country code.
-            'countrycode' => $billing_info['country'],
-            // Required.  Postal code of payer.
-            'zip'         => $billing_info['zip'],
-        );
-        // check if the registration info contains the needed fields for paypal pro
-        // (see https://developer.paypal.com/docs/classic/api/merchant/DoDirectPayment_API_Operation_NVP/)
-        if ($attendee->address() && $attendee->city() && $attendee->country_ID()) {
-            $use_registration_address_info = true;
-        } else {
-            $use_registration_address_info = false;
-        }
-        // so if the attendee has enough data to fill out PayPal Pro's shipping info, use it.
-        // If not, use the billing info again
-        $ShippingAddress = array(
-            'shiptoname'     => substr($use_registration_address_info
-                ? $attendee->full_name()
-                : $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32),
-            'shiptostreet'   => substr($use_registration_address_info
-                ? $attendee->address()
-                : $billing_info['address'], 0, 100),
-            'shiptostreet2'  => substr($use_registration_address_info
-                ? $attendee->address2() : $billing_info['address2'], 0, 100),
-            'shiptocity'     => substr($use_registration_address_info
-                ? $attendee->city()
-                : $billing_info['city'], 0, 40),
-            'state'          => substr($use_registration_address_info
-                ? $attendee->state_name()
-                : $billing_info['state'], 0, 40),
-            'shiptocountry'  => $use_registration_address_info
-                ? $attendee->country_ID()
-                : $billing_info['country'],
-            'shiptozip'      => substr($use_registration_address_info
-                ? $attendee->zip()
-                : $billing_info['zip'], 0, 20),
-            'shiptophonenum' => substr($use_registration_address_info
-                ? $attendee->phone()
-                : $billing_info['phone'], 0, 20),
-        );
-        $PaymentDetails = array(
-            // Required.  Total amount of order, including shipping, handling, and tax.
-            'amt'          => $gateway_formatter->formatCurrency($payment->amount()),
-            // Required.  Three-letter currency code.  Default is USD.
-            'currencycode' => $payment->currency_code(),
-            // Required if you include itemized cart details. (L_AMTn, etc.)
-            // Subtotal of items not including S&H, or tax.
-            'itemamt'      => $gateway_formatter->formatCurrency($item_amount),//
-            // Total shipping costs for the order.  If you specify shippingamt, you must also specify itemamt.
-            'shippingamt'  => '',
-            // Total handling costs for the order.  If you specify handlingamt, you must also specify itemamt.
-            'handlingamt'  => '',
-            // Required if you specify itemized cart tax details.
-            // Sum of tax for all items on the order.  Total sales tax.
-            'taxamt'       => $gateway_formatter->formatCurrency($tax_amount),
-            // Description of the order the customer is purchasing.  127 char max.
-            'desc'         => $order_description,
-            // Free-form field for your own use.  256 char max.
-            'custom'       => $primary_registrant ? $primary_registrant->ID() : '',
-            // Your own invoice or tracking number
-            'invnum'       => wp_generate_password(12, false),// $transaction->ID(),
-            // URL for receiving Instant Payment Notifications.  This overrides what your profile is set to use.
-            'notifyurl'    => '',
-            'buttonsource' => 'EventEspresso_SP',// EE will blow up if you change this
-        );
-        // Wrap all data arrays into a single, "master" array which will be passed into the class function.
-        $PayPalRequestData = array(
-            'DPFields'        => $DPFields,
-            'CCDetails'       => $CCDetails,
-            'PayerInfo'       => $PayerInfo,
-            'PayerName'       => $PayerName,
-            'BillingAddress'  => $BillingAddress,
-            'ShippingAddress' => $ShippingAddress,
-            'PaymentDetails'  => $PaymentDetails,
-            'OrderItems'      => $order_items,
-        );
-        $this->_log_clean_request($PayPalRequestData, $payment);
-        try {
-            $PayPalResult = $this->prep_and_curl_request($PayPalRequestData);
-            // remove PCI-sensitive data so it doesn't get stored
-            $PayPalResult = $this->_log_clean_response($PayPalResult, $payment);
-            if (isset($PayPalResult['L_ERRORCODE0']) && $PayPalResult['L_ERRORCODE0'] === '10002') {
-                $message = esc_html__('PayPal did not accept your API username, password, or signature. Please double-check these credentials and if debug mode is on.', 'event_espresso');
-            } elseif (isset($PayPalResult['L_LONGMESSAGE0'])) {
-                $message = $PayPalResult['L_LONGMESSAGE0'];
-            } else {
-                $message = $PayPalResult['ACK'];
-            }
-            if (empty($PayPalResult['RAWRESPONSE'])) {
-                $payment->set_status($this->_pay_model->failed_status());
-                $payment->set_gateway_response(__('No response received from Paypal Pro', 'event_espresso'));
-                $payment->set_details($PayPalResult);
-            } else {
-                if ($this->_APICallSuccessful($PayPalResult)) {
-                    $payment->set_status($this->_pay_model->approved_status());
-                } else {
-                    $payment->set_status($this->_pay_model->declined_status());
-                }
-                // make sure we interpret the AMT as a float, not an international string
-                // (where periods are thousand separators)
-                $payment->set_amount(isset($PayPalResult['AMT']) ? floatval($PayPalResult['AMT']) : 0);
-                $payment->set_gateway_response($message);
-                $payment->set_txn_id_chq_nmbr(isset($PayPalResult['TRANSACTIONID'])
-                    ? $PayPalResult['TRANSACTIONID']
-                    : null);
-                $primary_registration_code = $primary_registrant instanceof EE_Registration
-                    ? $primary_registrant->reg_code()
-                    : '';
-                $payment->set_extra_accntng($primary_registration_code);
-                $payment->set_details($PayPalResult);
-            }
-        } catch (Exception $e) {
-            $payment->set_status($this->_pay_model->failed_status());
-            $payment->set_gateway_response($e->getMessage());
-        }
-        // $payment->set_status( $this->_pay_model->declined_status() );
-        // $payment->set_gateway_response( '' );
-        return $payment;
-    }
-
-
-
-    /**
-     * CLeans out sensitive CC data and then logs it, and returns the cleaned request
-     *
-     * @param array       $request
-     * @param EEI_Payment $payment
-     * @return void
-     */
-    private function _log_clean_request($request, $payment)
-    {
-        $cleaned_request_data = $request;
-        unset($cleaned_request_data['CCDetails']['acct']);
-        unset($cleaned_request_data['CCDetails']['cvv2']);
-        unset($cleaned_request_data['CCDetails']['expdate']);
-        $this->log(array('Paypal Request' => $cleaned_request_data), $payment);
-    }
-
-
-
-    /**
-     * Cleans the response, logs it, and returns it
-     *
-     * @param array       $response
-     * @param EEI_Payment $payment
-     * @return array cleaned
-     */
-    private function _log_clean_response($response, $payment)
-    {
-        unset($response['REQUESTDATA']['CREDITCARDTYPE']);
-        unset($response['REQUESTDATA']['ACCT']);
-        unset($response['REQUESTDATA']['EXPDATE']);
-        unset($response['REQUESTDATA']['CVV2']);
-        unset($response['RAWREQUEST']);
-        $this->log(array('Paypal Response' => $response), $payment);
-        return $response;
-    }
-
-
-
-    /**
-     * @param $DataArray
-     * @return array
-     */
-    private function prep_and_curl_request($DataArray)
-    {
-        // Create empty holders for each portion of the NVP string
-        $DPFieldsNVP = '&METHOD=DoDirectPayment&BUTTONSOURCE=AngellEYE_PHP_Class_DDP';
-        $CCDetailsNVP = '';
-        $PayerInfoNVP = '';
-        $PayerNameNVP = '';
-        $BillingAddressNVP = '';
-        $ShippingAddressNVP = '';
-        $PaymentDetailsNVP = '';
-        $OrderItemsNVP = '';
-        $Secure3DNVP = '';
-        // DP Fields
-        $DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array();
-        foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) {
-            $DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal);
-        }
-        // CC Details Fields
-        $CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array();
-        foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) {
-            $CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal);
-        }
-        // PayerInfo Type Fields
-        $PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array();
-        foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) {
-            $PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal);
-        }
-        // Payer Name Fields
-        $PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array();
-        foreach ($PayerName as $PayerNameVar => $PayerNameVal) {
-            $PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal);
-        }
-        // Address Fields (Billing)
-        $BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array();
-        foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) {
-            $BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal);
-        }
-        // Payment Details Type Fields
-        $PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array();
-        foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) {
-            $PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal);
-        }
-        // Payment Details Item Type Fields
-        $OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array();
-        $n = 0;
-        foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) {
-            $CurrentItem = $OrderItems[ $OrderItemsVar ];
-            foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) {
-                $OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal);
-            }
-            $n++;
-        }
-        // Ship To Address Fields
-        $ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array();
-        foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) {
-            $ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal);
-        }
-        // 3D Secure Fields
-        $Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array();
-        foreach ($Secure3D as $Secure3DVar => $Secure3DVal) {
-            $Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal);
-        }
-        // Now that we have each chunk we need to go ahead and append them all together for our entire NVP string
-        $NVPRequest = 'USER='
-                      . $this->_api_username
-                      . '&PWD='
-                      . $this->_api_password
-                      . '&VERSION=64.0'
-                      . '&SIGNATURE='
-                      . $this->_api_signature
-                      . $DPFieldsNVP
-                      . $CCDetailsNVP
-                      . $PayerInfoNVP
-                      . $PayerNameNVP
-                      . $BillingAddressNVP
-                      . $PaymentDetailsNVP
-                      . $OrderItemsNVP
-                      . $ShippingAddressNVP
-                      . $Secure3DNVP;
-        $NVPResponse = $this->_CURLRequest($NVPRequest);
-        $NVPRequestArray = $this->_NVPToArray($NVPRequest);
-        $NVPResponseArray = $this->_NVPToArray($NVPResponse);
-        $Errors = $this->_GetErrors($NVPResponseArray);
-        $NVPResponseArray['ERRORS'] = $Errors;
-        $NVPResponseArray['REQUESTDATA'] = $NVPRequestArray;
-        $NVPResponseArray['RAWREQUEST'] = $NVPRequest;
-        $NVPResponseArray['RAWRESPONSE'] = $NVPResponse;
-        return $NVPResponseArray;
-    }
-
-
-
-    /**
-     * @param $Request
-     * @return mixed
-     */
-    private function _CURLRequest($Request)
-    {
-        $EndPointURL = $this->_debug_mode ? 'https://api-3t.sandbox.paypal.com/nvp' : 'https://api-3t.paypal.com/nvp';
-        $curl = curl_init();
-        curl_setopt($curl, CURLOPT_VERBOSE, apply_filters('FHEE__EEG_Paypal_Pro__CurlRequest__CURLOPT_VERBOSE', true));
-        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
-        curl_setopt($curl, CURLOPT_TIMEOUT, 60);
-        curl_setopt($curl, CURLOPT_URL, $EndPointURL);
-        curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
-        curl_setopt($curl, CURLOPT_POSTFIELDS, $Request);
-        curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
-        // execute the curl POST
-        $Response = curl_exec($curl);
-        curl_close($curl);
-        return $Response;
-    }
-
-
-
-    /**
-     * @param $NVPString
-     * @return array
-     */
-    private function _NVPToArray($NVPString)
-    {
-        // prepare responses into array
-        $proArray = array();
-        while (strlen($NVPString)) {
-            // name
-            $keypos = strpos($NVPString, '=');
-            $keyval = substr($NVPString, 0, $keypos);
-            // value
-            $valuepos = strpos($NVPString, '&') ? strpos($NVPString, '&') : strlen($NVPString);
-            $valval = substr($NVPString, $keypos + 1, $valuepos - $keypos - 1);
-            // decoding the response
-            $proArray[ $keyval ] = urldecode($valval);
-            $NVPString = substr($NVPString, $valuepos + 1, strlen($NVPString));
-        }
-        return $proArray;
-    }
-
-
-
-    /**
-     * @param array $PayPalResult
-     * @return bool
-     */
-    private function _APICallSuccessful($PayPalResult)
-    {
-        $approved = false;
-        // check main response message from PayPal
-        if (isset($PayPalResult['ACK']) && ! empty($PayPalResult['ACK'])) {
-            $ack = strtoupper($PayPalResult['ACK']);
-            $approved = ($ack == 'SUCCESS' || $ack == 'SUCCESSWITHWARNING' || $ack == 'PARTIALSUCCESS') ? true : false;
-        }
-        return $approved;
-    }
-
-
-
-    /**
-     * @param $DataArray
-     * @return array
-     */
-    private function _GetErrors($DataArray)
-    {
-        $Errors = array();
-        $n = 0;
-        while (isset($DataArray[ 'L_ERRORCODE' . $n . '' ])) {
-            $LErrorCode = isset($DataArray[ 'L_ERRORCODE' . $n . '' ]) ? $DataArray[ 'L_ERRORCODE' . $n . '' ] : '';
-            $LShortMessage = isset($DataArray[ 'L_SHORTMESSAGE' . $n . '' ])
-                ? $DataArray[ 'L_SHORTMESSAGE' . $n . '' ]
-                : '';
-            $LLongMessage = isset($DataArray[ 'L_LONGMESSAGE' . $n . '' ])
-                ? $DataArray[ 'L_LONGMESSAGE' . $n . '' ]
-                : '';
-            $LSeverityCode = isset($DataArray[ 'L_SEVERITYCODE' . $n . '' ])
-                ? $DataArray[ 'L_SEVERITYCODE' . $n . '' ]
-                : '';
-            $CurrentItem = array(
-                'L_ERRORCODE'    => $LErrorCode,
-                'L_SHORTMESSAGE' => $LShortMessage,
-                'L_LONGMESSAGE'  => $LLongMessage,
-                'L_SEVERITYCODE' => $LSeverityCode,
-            );
-            array_push($Errors, $CurrentItem);
-            $n++;
-        }
-        return $Errors;
-    }
-
-
-
-    /**
-     *        nothing to see here...  move along....
-     *
-     * @access protected
-     * @param $Errors
-     * @return string
-     */
-    private function _DisplayErrors($Errors)
-    {
-        $error = '';
-        foreach ($Errors as $ErrorVar => $ErrorVal) {
-            $CurrentError = $Errors[ $ErrorVar ];
-            foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) {
-                $CurrentVarName = '';
-                if ($CurrentErrorVar == 'L_ERRORCODE') {
-                    $CurrentVarName = 'Error Code';
-                } elseif ($CurrentErrorVar == 'L_SHORTMESSAGE') {
-                    $CurrentVarName = 'Short Message';
-                } elseif ($CurrentErrorVar == 'L_LONGMESSAGE') {
-                    $CurrentVarName = 'Long Message';
-                } elseif ($CurrentErrorVar == 'L_SEVERITYCODE') {
-                    $CurrentVarName = 'Severity Code';
-                }
-                $error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal;
-            }
-        }
-        return $error;
-    }
+	/**
+	 * @var $_paypal_api_username string
+	 */
+	protected $_api_username = null;
+
+	/**
+	 * @var $_api_password string
+	 */
+	protected $_api_password = null;
+
+	/**
+	 * @var $_api_signature string
+	 */
+	protected $_api_signature = null;
+
+	/**
+	 * @var $_credit_card_types array with the keys for credit card types accepted on this account
+	 */
+	protected $_credit_card_types    = null;
+
+	protected $_currencies_supported = array(
+		'USD',
+		'GBP',
+		'CAD',
+		'AUD',
+		'BRL',
+		'CHF',
+		'CZK',
+		'DKK',
+		'EUR',
+		'HKD',
+		'HUF',
+		'ILS',
+		'JPY',
+		'MXN',
+		'MYR',
+		'NOK',
+		'NZD',
+		'PHP',
+		'PLN',
+		'SEK',
+		'SGD',
+		'THB',
+		'TRY',
+		'TWD',
+		'RUB',
+		'INR',
+	);
+
+
+
+	/**
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info {
+	 * @type string $credit_card
+	 * @type string $credit_card_type
+	 * @type string $exp_month always 2 characters
+	 * @type string $exp_year always 4 characters
+	 * @type string $cvv
+	 * }
+	 * @see      parent::do_direct_payment for more info
+	 * @return EE_Payment|EEI_Payment
+	 * @throws EE_Error
+	 */
+	public function do_direct_payment($payment, $billing_info = null)
+	{
+		$transaction = $payment->transaction();
+		if (! $transaction instanceof EEI_Transaction) {
+			throw new EE_Error(
+				esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso')
+			);
+		}
+		$primary_registrant = $transaction->primary_registration();
+		if (! $primary_registrant instanceof EEI_Registration) {
+			throw new EE_Error(
+				esc_html__(
+					'No primary registration on transaction while paying with PayPal Pro.',
+					'event_espresso'
+				)
+			);
+		}
+		$attendee = $primary_registrant->attendee();
+		if (! $attendee instanceof EEI_Attendee) {
+			throw new EE_Error(
+				esc_html__(
+					'No attendee on primary registration while paying with PayPal Pro.',
+					'event_espresso'
+				)
+			);
+		}
+		$gateway_formatter = $this->_get_gateway_formatter();
+		$order_description = substr($gateway_formatter->formatOrderDescription($payment), 0, 127);
+		// charge for the full amount. Show itemized list
+		if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
+			$item_num = 1;
+			$total_line_item = $transaction->total_line_item();
+			$order_items = array();
+			foreach ($total_line_item->get_items() as $line_item) {
+				// ignore line items with a quantity of 0
+				if ($line_item->quantity() == 0) {
+					continue;
+				}
+				// For percent items, whose unit_price is 0, use the total instead.
+				if ($line_item->is_percent()) {
+					$unit_price = $line_item->total();
+					$line_item_quantity = 1;
+				} else {
+					$unit_price = $line_item->unit_price();
+					$line_item_quantity = $line_item->quantity();
+				}
+				$item = array(
+					// Item Name.  127 char max.
+					'l_name'                 => substr(
+						$gateway_formatter->formatLineItemName($line_item, $payment),
+						0,
+						127
+					),
+					// Item description.  127 char max.
+					'l_desc'                 => substr(
+						$gateway_formatter->formatLineItemDesc($line_item, $payment),
+						0,
+						127
+					),
+					// Cost of individual item.
+					'l_amt'                  => $unit_price,
+					// Item Number.  127 char max.
+					'l_number'               => $item_num++,
+					// Item quantity.  Must be any positive integer.
+					'l_qty'                  => $line_item_quantity,
+					// Item's sales tax amount.
+					'l_taxamt'               => '',
+					// eBay auction number of item.
+					'l_ebayitemnumber'       => '',
+					// eBay transaction ID of purchased item.
+					'l_ebayitemauctiontxnid' => '',
+					// eBay order ID for the item.
+					'l_ebayitemorderid'      => '',
+				);
+				// add to array of all items
+				array_push($order_items, $item);
+			}
+			$item_amount = $total_line_item->get_items_total();
+			$tax_amount = $total_line_item->get_total_tax();
+		} else {
+			$order_items = array();
+			$item_amount = $payment->amount();
+			$tax_amount = 0;
+			array_push($order_items, array(
+				// Item Name.  127 char max.
+				'l_name'   => substr(
+					$gateway_formatter->formatPartialPaymentLineItemName($payment),
+					0,
+					127
+				),
+				// Item description.  127 char max.
+				'l_desc'   => substr(
+					$gateway_formatter->formatPartialPaymentLineItemDesc($payment),
+					0,
+					127
+				),
+				// Cost of individual item.
+				'l_amt'    => $payment->amount(),
+				// Item Number.  127 char max.
+				'l_number' => 1,
+				// Item quantity.  Must be any positive integer.
+				'l_qty'    => 1,
+			));
+		}
+		// Populate data arrays with order data.
+		$DPFields = array(
+			// How you want to obtain payment ?
+			// Authorization indicates the payment is a basic auth subject to settlement with Auth & Capture.
+			// Sale indicates that this is a final sale for which you are requesting payment.  Default is Sale.
+			'paymentaction'    => 'Sale',
+			// Required.  IP address of the payer's browser.
+			'ipaddress'        => $_SERVER['REMOTE_ADDR'],
+			// Flag to determine whether you want the results returned by FMF.  1 or 0.  Default is 0.
+			'returnfmfdetails' => '1',
+		);
+		$CCDetails = array(
+			// Required. Type of credit card.  Visa, MasterCard, Discover, Amex, Maestro, Solo.
+			// If Maestro or Solo, the currency code must be GBP.
+			//  In addition, either start date or issue number must be specified.
+			'creditcardtype' => $billing_info['credit_card_type'],
+			// Required.  Credit card number.  No spaces or punctuation.
+			'acct'           => $billing_info['credit_card'],
+			// Required.  Credit card expiration date.  Format is MMYYYY
+			'expdate'        => $billing_info['exp_month'] . $billing_info['exp_year'],
+			// Requirements determined by your PayPal account settings.  Security digits for credit card.
+			'cvv2'           => $billing_info['cvv'],
+		);
+		$PayerInfo = array(
+			// Email address of payer.
+			'email'       => $billing_info['email'],
+			// Unique PayPal customer ID for payer.
+			'payerid'     => '',
+			// Status of payer.  Values are verified or unverified
+			'payerstatus' => '',
+			// Payer's business name.
+			'business'    => '',
+		);
+		$PayerName = array(
+			// Payer's salutation.  20 char max.
+			'salutation' => '',
+			// Payer's first name.  25 char max.
+			'firstname'  => substr($billing_info['first_name'], 0, 25),
+			// Payer's middle name.  25 char max.
+			'middlename' => '',
+			// Payer's last name.  25 char max.
+			'lastname'   => substr($billing_info['last_name'], 0, 25),
+			// Payer's suffix.  12 char max.
+			'suffix'     => '',
+		);
+		$BillingAddress = array(
+			// Required.  First street address.
+			'street'      => $billing_info['address'],
+			// Second street address.
+			'street2'     => $billing_info['address2'],
+			// Required.  Name of City.
+			'city'        => $billing_info['city'],
+			// Required. Name of State or Province.
+			'state'       => substr($billing_info['state'], 0, 40),
+			// Required.  Country code.
+			'countrycode' => $billing_info['country'],
+			// Required.  Postal code of payer.
+			'zip'         => $billing_info['zip'],
+		);
+		// check if the registration info contains the needed fields for paypal pro
+		// (see https://developer.paypal.com/docs/classic/api/merchant/DoDirectPayment_API_Operation_NVP/)
+		if ($attendee->address() && $attendee->city() && $attendee->country_ID()) {
+			$use_registration_address_info = true;
+		} else {
+			$use_registration_address_info = false;
+		}
+		// so if the attendee has enough data to fill out PayPal Pro's shipping info, use it.
+		// If not, use the billing info again
+		$ShippingAddress = array(
+			'shiptoname'     => substr($use_registration_address_info
+				? $attendee->full_name()
+				: $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32),
+			'shiptostreet'   => substr($use_registration_address_info
+				? $attendee->address()
+				: $billing_info['address'], 0, 100),
+			'shiptostreet2'  => substr($use_registration_address_info
+				? $attendee->address2() : $billing_info['address2'], 0, 100),
+			'shiptocity'     => substr($use_registration_address_info
+				? $attendee->city()
+				: $billing_info['city'], 0, 40),
+			'state'          => substr($use_registration_address_info
+				? $attendee->state_name()
+				: $billing_info['state'], 0, 40),
+			'shiptocountry'  => $use_registration_address_info
+				? $attendee->country_ID()
+				: $billing_info['country'],
+			'shiptozip'      => substr($use_registration_address_info
+				? $attendee->zip()
+				: $billing_info['zip'], 0, 20),
+			'shiptophonenum' => substr($use_registration_address_info
+				? $attendee->phone()
+				: $billing_info['phone'], 0, 20),
+		);
+		$PaymentDetails = array(
+			// Required.  Total amount of order, including shipping, handling, and tax.
+			'amt'          => $gateway_formatter->formatCurrency($payment->amount()),
+			// Required.  Three-letter currency code.  Default is USD.
+			'currencycode' => $payment->currency_code(),
+			// Required if you include itemized cart details. (L_AMTn, etc.)
+			// Subtotal of items not including S&H, or tax.
+			'itemamt'      => $gateway_formatter->formatCurrency($item_amount),//
+			// Total shipping costs for the order.  If you specify shippingamt, you must also specify itemamt.
+			'shippingamt'  => '',
+			// Total handling costs for the order.  If you specify handlingamt, you must also specify itemamt.
+			'handlingamt'  => '',
+			// Required if you specify itemized cart tax details.
+			// Sum of tax for all items on the order.  Total sales tax.
+			'taxamt'       => $gateway_formatter->formatCurrency($tax_amount),
+			// Description of the order the customer is purchasing.  127 char max.
+			'desc'         => $order_description,
+			// Free-form field for your own use.  256 char max.
+			'custom'       => $primary_registrant ? $primary_registrant->ID() : '',
+			// Your own invoice or tracking number
+			'invnum'       => wp_generate_password(12, false),// $transaction->ID(),
+			// URL for receiving Instant Payment Notifications.  This overrides what your profile is set to use.
+			'notifyurl'    => '',
+			'buttonsource' => 'EventEspresso_SP',// EE will blow up if you change this
+		);
+		// Wrap all data arrays into a single, "master" array which will be passed into the class function.
+		$PayPalRequestData = array(
+			'DPFields'        => $DPFields,
+			'CCDetails'       => $CCDetails,
+			'PayerInfo'       => $PayerInfo,
+			'PayerName'       => $PayerName,
+			'BillingAddress'  => $BillingAddress,
+			'ShippingAddress' => $ShippingAddress,
+			'PaymentDetails'  => $PaymentDetails,
+			'OrderItems'      => $order_items,
+		);
+		$this->_log_clean_request($PayPalRequestData, $payment);
+		try {
+			$PayPalResult = $this->prep_and_curl_request($PayPalRequestData);
+			// remove PCI-sensitive data so it doesn't get stored
+			$PayPalResult = $this->_log_clean_response($PayPalResult, $payment);
+			if (isset($PayPalResult['L_ERRORCODE0']) && $PayPalResult['L_ERRORCODE0'] === '10002') {
+				$message = esc_html__('PayPal did not accept your API username, password, or signature. Please double-check these credentials and if debug mode is on.', 'event_espresso');
+			} elseif (isset($PayPalResult['L_LONGMESSAGE0'])) {
+				$message = $PayPalResult['L_LONGMESSAGE0'];
+			} else {
+				$message = $PayPalResult['ACK'];
+			}
+			if (empty($PayPalResult['RAWRESPONSE'])) {
+				$payment->set_status($this->_pay_model->failed_status());
+				$payment->set_gateway_response(__('No response received from Paypal Pro', 'event_espresso'));
+				$payment->set_details($PayPalResult);
+			} else {
+				if ($this->_APICallSuccessful($PayPalResult)) {
+					$payment->set_status($this->_pay_model->approved_status());
+				} else {
+					$payment->set_status($this->_pay_model->declined_status());
+				}
+				// make sure we interpret the AMT as a float, not an international string
+				// (where periods are thousand separators)
+				$payment->set_amount(isset($PayPalResult['AMT']) ? floatval($PayPalResult['AMT']) : 0);
+				$payment->set_gateway_response($message);
+				$payment->set_txn_id_chq_nmbr(isset($PayPalResult['TRANSACTIONID'])
+					? $PayPalResult['TRANSACTIONID']
+					: null);
+				$primary_registration_code = $primary_registrant instanceof EE_Registration
+					? $primary_registrant->reg_code()
+					: '';
+				$payment->set_extra_accntng($primary_registration_code);
+				$payment->set_details($PayPalResult);
+			}
+		} catch (Exception $e) {
+			$payment->set_status($this->_pay_model->failed_status());
+			$payment->set_gateway_response($e->getMessage());
+		}
+		// $payment->set_status( $this->_pay_model->declined_status() );
+		// $payment->set_gateway_response( '' );
+		return $payment;
+	}
+
+
+
+	/**
+	 * CLeans out sensitive CC data and then logs it, and returns the cleaned request
+	 *
+	 * @param array       $request
+	 * @param EEI_Payment $payment
+	 * @return void
+	 */
+	private function _log_clean_request($request, $payment)
+	{
+		$cleaned_request_data = $request;
+		unset($cleaned_request_data['CCDetails']['acct']);
+		unset($cleaned_request_data['CCDetails']['cvv2']);
+		unset($cleaned_request_data['CCDetails']['expdate']);
+		$this->log(array('Paypal Request' => $cleaned_request_data), $payment);
+	}
+
+
+
+	/**
+	 * Cleans the response, logs it, and returns it
+	 *
+	 * @param array       $response
+	 * @param EEI_Payment $payment
+	 * @return array cleaned
+	 */
+	private function _log_clean_response($response, $payment)
+	{
+		unset($response['REQUESTDATA']['CREDITCARDTYPE']);
+		unset($response['REQUESTDATA']['ACCT']);
+		unset($response['REQUESTDATA']['EXPDATE']);
+		unset($response['REQUESTDATA']['CVV2']);
+		unset($response['RAWREQUEST']);
+		$this->log(array('Paypal Response' => $response), $payment);
+		return $response;
+	}
+
+
+
+	/**
+	 * @param $DataArray
+	 * @return array
+	 */
+	private function prep_and_curl_request($DataArray)
+	{
+		// Create empty holders for each portion of the NVP string
+		$DPFieldsNVP = '&METHOD=DoDirectPayment&BUTTONSOURCE=AngellEYE_PHP_Class_DDP';
+		$CCDetailsNVP = '';
+		$PayerInfoNVP = '';
+		$PayerNameNVP = '';
+		$BillingAddressNVP = '';
+		$ShippingAddressNVP = '';
+		$PaymentDetailsNVP = '';
+		$OrderItemsNVP = '';
+		$Secure3DNVP = '';
+		// DP Fields
+		$DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array();
+		foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) {
+			$DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal);
+		}
+		// CC Details Fields
+		$CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array();
+		foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) {
+			$CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal);
+		}
+		// PayerInfo Type Fields
+		$PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array();
+		foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) {
+			$PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal);
+		}
+		// Payer Name Fields
+		$PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array();
+		foreach ($PayerName as $PayerNameVar => $PayerNameVal) {
+			$PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal);
+		}
+		// Address Fields (Billing)
+		$BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array();
+		foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) {
+			$BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal);
+		}
+		// Payment Details Type Fields
+		$PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array();
+		foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) {
+			$PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal);
+		}
+		// Payment Details Item Type Fields
+		$OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array();
+		$n = 0;
+		foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) {
+			$CurrentItem = $OrderItems[ $OrderItemsVar ];
+			foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) {
+				$OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal);
+			}
+			$n++;
+		}
+		// Ship To Address Fields
+		$ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array();
+		foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) {
+			$ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal);
+		}
+		// 3D Secure Fields
+		$Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array();
+		foreach ($Secure3D as $Secure3DVar => $Secure3DVal) {
+			$Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal);
+		}
+		// Now that we have each chunk we need to go ahead and append them all together for our entire NVP string
+		$NVPRequest = 'USER='
+					  . $this->_api_username
+					  . '&PWD='
+					  . $this->_api_password
+					  . '&VERSION=64.0'
+					  . '&SIGNATURE='
+					  . $this->_api_signature
+					  . $DPFieldsNVP
+					  . $CCDetailsNVP
+					  . $PayerInfoNVP
+					  . $PayerNameNVP
+					  . $BillingAddressNVP
+					  . $PaymentDetailsNVP
+					  . $OrderItemsNVP
+					  . $ShippingAddressNVP
+					  . $Secure3DNVP;
+		$NVPResponse = $this->_CURLRequest($NVPRequest);
+		$NVPRequestArray = $this->_NVPToArray($NVPRequest);
+		$NVPResponseArray = $this->_NVPToArray($NVPResponse);
+		$Errors = $this->_GetErrors($NVPResponseArray);
+		$NVPResponseArray['ERRORS'] = $Errors;
+		$NVPResponseArray['REQUESTDATA'] = $NVPRequestArray;
+		$NVPResponseArray['RAWREQUEST'] = $NVPRequest;
+		$NVPResponseArray['RAWRESPONSE'] = $NVPResponse;
+		return $NVPResponseArray;
+	}
+
+
+
+	/**
+	 * @param $Request
+	 * @return mixed
+	 */
+	private function _CURLRequest($Request)
+	{
+		$EndPointURL = $this->_debug_mode ? 'https://api-3t.sandbox.paypal.com/nvp' : 'https://api-3t.paypal.com/nvp';
+		$curl = curl_init();
+		curl_setopt($curl, CURLOPT_VERBOSE, apply_filters('FHEE__EEG_Paypal_Pro__CurlRequest__CURLOPT_VERBOSE', true));
+		curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
+		curl_setopt($curl, CURLOPT_TIMEOUT, 60);
+		curl_setopt($curl, CURLOPT_URL, $EndPointURL);
+		curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
+		curl_setopt($curl, CURLOPT_POSTFIELDS, $Request);
+		curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
+		// execute the curl POST
+		$Response = curl_exec($curl);
+		curl_close($curl);
+		return $Response;
+	}
+
+
+
+	/**
+	 * @param $NVPString
+	 * @return array
+	 */
+	private function _NVPToArray($NVPString)
+	{
+		// prepare responses into array
+		$proArray = array();
+		while (strlen($NVPString)) {
+			// name
+			$keypos = strpos($NVPString, '=');
+			$keyval = substr($NVPString, 0, $keypos);
+			// value
+			$valuepos = strpos($NVPString, '&') ? strpos($NVPString, '&') : strlen($NVPString);
+			$valval = substr($NVPString, $keypos + 1, $valuepos - $keypos - 1);
+			// decoding the response
+			$proArray[ $keyval ] = urldecode($valval);
+			$NVPString = substr($NVPString, $valuepos + 1, strlen($NVPString));
+		}
+		return $proArray;
+	}
+
+
+
+	/**
+	 * @param array $PayPalResult
+	 * @return bool
+	 */
+	private function _APICallSuccessful($PayPalResult)
+	{
+		$approved = false;
+		// check main response message from PayPal
+		if (isset($PayPalResult['ACK']) && ! empty($PayPalResult['ACK'])) {
+			$ack = strtoupper($PayPalResult['ACK']);
+			$approved = ($ack == 'SUCCESS' || $ack == 'SUCCESSWITHWARNING' || $ack == 'PARTIALSUCCESS') ? true : false;
+		}
+		return $approved;
+	}
+
+
+
+	/**
+	 * @param $DataArray
+	 * @return array
+	 */
+	private function _GetErrors($DataArray)
+	{
+		$Errors = array();
+		$n = 0;
+		while (isset($DataArray[ 'L_ERRORCODE' . $n . '' ])) {
+			$LErrorCode = isset($DataArray[ 'L_ERRORCODE' . $n . '' ]) ? $DataArray[ 'L_ERRORCODE' . $n . '' ] : '';
+			$LShortMessage = isset($DataArray[ 'L_SHORTMESSAGE' . $n . '' ])
+				? $DataArray[ 'L_SHORTMESSAGE' . $n . '' ]
+				: '';
+			$LLongMessage = isset($DataArray[ 'L_LONGMESSAGE' . $n . '' ])
+				? $DataArray[ 'L_LONGMESSAGE' . $n . '' ]
+				: '';
+			$LSeverityCode = isset($DataArray[ 'L_SEVERITYCODE' . $n . '' ])
+				? $DataArray[ 'L_SEVERITYCODE' . $n . '' ]
+				: '';
+			$CurrentItem = array(
+				'L_ERRORCODE'    => $LErrorCode,
+				'L_SHORTMESSAGE' => $LShortMessage,
+				'L_LONGMESSAGE'  => $LLongMessage,
+				'L_SEVERITYCODE' => $LSeverityCode,
+			);
+			array_push($Errors, $CurrentItem);
+			$n++;
+		}
+		return $Errors;
+	}
+
+
+
+	/**
+	 *        nothing to see here...  move along....
+	 *
+	 * @access protected
+	 * @param $Errors
+	 * @return string
+	 */
+	private function _DisplayErrors($Errors)
+	{
+		$error = '';
+		foreach ($Errors as $ErrorVar => $ErrorVal) {
+			$CurrentError = $Errors[ $ErrorVar ];
+			foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) {
+				$CurrentVarName = '';
+				if ($CurrentErrorVar == 'L_ERRORCODE') {
+					$CurrentVarName = 'Error Code';
+				} elseif ($CurrentErrorVar == 'L_SHORTMESSAGE') {
+					$CurrentVarName = 'Short Message';
+				} elseif ($CurrentErrorVar == 'L_LONGMESSAGE') {
+					$CurrentVarName = 'Long Message';
+				} elseif ($CurrentErrorVar == 'L_SEVERITYCODE') {
+					$CurrentVarName = 'Severity Code';
+				}
+				$error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal;
+			}
+		}
+		return $error;
+	}
 }

core/EE_Error.core.php

Doc Comments +3 added lines, -3 removed lines

@@ -73,7 +73,7 @@ 
     /**
      *    error_handler
      *
-     * @param $code
+     * @param integer $code
      * @param $message
      * @param $file
      * @param $line
@@ -177,7 +177,7 @@ 
     /**
      * _format_error
      *
-     * @param $code
+     * @param string $code
      * @param $message
      * @param $file
      * @param $line
@@ -210,7 +210,7 @@ 
 
 
     /**
-     * @return void
+     * @return string|null
      * @throws EE_Error
      * @throws ReflectionException
      */

Indentation +1126 added lines, -1126 removed lines

@@ -10,8 +10,8 @@ 
 // if you're a dev and want to receive all errors via email
 // add this to your wp-config.php: define( 'EE_ERROR_EMAILS', TRUE );
 if (defined('WP_DEBUG') && WP_DEBUG === true && defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS === true) {
-    set_error_handler(array('EE_Error', 'error_handler'));
-    register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
+	set_error_handler(array('EE_Error', 'error_handler'));
+	register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
 }
 
 
@@ -25,251 +25,251 @@ 
 class EE_Error extends Exception
 {
 
-    const OPTIONS_KEY_NOTICES = 'ee_notices';
-
-
-    /**
-     * name of the file to log exceptions to
-     *
-     * @var string
-     */
-    private static $_exception_log_file = 'espresso_error_log.txt';
-
-    /**
-     *    stores details for all exception
-     *
-     * @var array
-     */
-    private static $_all_exceptions = array();
-
-    /**
-     *    tracks number of errors
-     *
-     * @var int
-     */
-    private static $_error_count = 0;
-
-    /**
-     * @var array $_espresso_notices
-     */
-    private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false);
-
-
-    /**
-     * @override default exception handling
-     * @param string         $message
-     * @param int            $code
-     * @param Exception|null $previous
-     */
-    public function __construct($message, $code = 0, Exception $previous = null)
-    {
-        if (version_compare(PHP_VERSION, '5.3.0', '<')) {
-            parent::__construct($message, $code);
-        } else {
-            parent::__construct($message, $code, $previous);
-        }
-    }
-
-
-    /**
-     *    error_handler
-     *
-     * @param $code
-     * @param $message
-     * @param $file
-     * @param $line
-     * @return void
-     */
-    public static function error_handler($code, $message, $file, $line)
-    {
-        $type = EE_Error::error_type($code);
-        $site = site_url();
-        switch ($site) {
-            case 'http://ee4.eventespresso.com/':
-            case 'http://ee4decaf.eventespresso.com/':
-            case 'http://ee4hf.eventespresso.com/':
-            case 'http://ee4a.eventespresso.com/':
-            case 'http://ee4ad.eventespresso.com/':
-            case 'http://ee4b.eventespresso.com/':
-            case 'http://ee4bd.eventespresso.com/':
-            case 'http://ee4d.eventespresso.com/':
-            case 'http://ee4dd.eventespresso.com/':
-                $to = 'developers@eventespresso.com';
-                break;
-            default:
-                $to = get_option('admin_email');
-        }
-        $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
-        $msg = EE_Error::_format_error($type, $message, $file, $line);
-        if (function_exists('wp_mail')) {
-            add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
-            wp_mail($to, $subject, $msg);
-        }
-        echo '<div id="message" class="espresso-notices error"><p>';
-        echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
-        echo '<br /></p></div>';
-    }
-
-
-    /**
-     * error_type
-     * http://www.php.net/manual/en/errorfunc.constants.php#109430
-     *
-     * @param $code
-     * @return string
-     */
-    public static function error_type($code)
-    {
-        switch ($code) {
-            case E_ERROR: // 1 //
-                return 'E_ERROR';
-            case E_WARNING: // 2 //
-                return 'E_WARNING';
-            case E_PARSE: // 4 //
-                return 'E_PARSE';
-            case E_NOTICE: // 8 //
-                return 'E_NOTICE';
-            case E_CORE_ERROR: // 16 //
-                return 'E_CORE_ERROR';
-            case E_CORE_WARNING: // 32 //
-                return 'E_CORE_WARNING';
-            case E_COMPILE_ERROR: // 64 //
-                return 'E_COMPILE_ERROR';
-            case E_COMPILE_WARNING: // 128 //
-                return 'E_COMPILE_WARNING';
-            case E_USER_ERROR: // 256 //
-                return 'E_USER_ERROR';
-            case E_USER_WARNING: // 512 //
-                return 'E_USER_WARNING';
-            case E_USER_NOTICE: // 1024 //
-                return 'E_USER_NOTICE';
-            case E_STRICT: // 2048 //
-                return 'E_STRICT';
-            case E_RECOVERABLE_ERROR: // 4096 //
-                return 'E_RECOVERABLE_ERROR';
-            case E_DEPRECATED: // 8192 //
-                return 'E_DEPRECATED';
-            case E_USER_DEPRECATED: // 16384 //
-                return 'E_USER_DEPRECATED';
-            case E_ALL: // 16384 //
-                return 'E_ALL';
-        }
-        return '';
-    }
-
-
-    /**
-     *    fatal_error_handler
-     *
-     * @return void
-     */
-    public static function fatal_error_handler()
-    {
-        $last_error = error_get_last();
-        if ($last_error['type'] === E_ERROR) {
-            EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
-        }
-    }
-
-
-    /**
-     * _format_error
-     *
-     * @param $code
-     * @param $message
-     * @param $file
-     * @param $line
-     * @return string
-     */
-    private static function _format_error($code, $message, $file, $line)
-    {
-        $html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
-        $html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
-        $html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
-        $html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>";
-        $html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>";
-        $html .= '</tbody></table>';
-        return $html;
-    }
-
-
-    /**
-     * set_content_type
-     *
-     * @param $content_type
-     * @return string
-     */
-    public static function set_content_type($content_type)
-    {
-        return 'text/html';
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_error()
-    {
-        if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
-            throw $this;
-        }
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $this->getMessage());
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // add details to _all_exceptions array
-        $x_time = time();
-        self::$_all_exceptions[ $x_time ]['name'] = get_class($this);
-        self::$_all_exceptions[ $x_time ]['file'] = $this->getFile();
-        self::$_all_exceptions[ $x_time ]['line'] = $this->getLine();
-        self::$_all_exceptions[ $x_time ]['msg'] = $msg;
-        self::$_all_exceptions[ $x_time ]['code'] = $this->getCode();
-        self::$_all_exceptions[ $x_time ]['trace'] = $this->getTrace();
-        self::$_all_exceptions[ $x_time ]['string'] = $this->getTraceAsString();
-        self::$_error_count++;
-        // add_action( 'shutdown', array( $this, 'display_errors' ));
-        $this->display_errors();
-    }
-
-
-    /**
-     * @param bool   $check_stored
-     * @param string $type_to_check
-     * @return bool
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function has_error($check_stored = false, $type_to_check = 'errors')
-    {
-        $has_error = isset(self::$_espresso_notices[ $type_to_check ])
-                     && ! empty(self::$_espresso_notices[ $type_to_check ])
-            ? true
-            : false;
-        if ($check_stored && ! $has_error) {
-            $notices = EE_Error::getStoredNotices();
-            foreach ($notices as $type => $notice) {
-                if ($type === $type_to_check && $notice) {
-                    return true;
-                }
-            }
-        }
-        return $has_error;
-    }
-
-
-    /**
-     * @echo string
-     * @throws \ReflectionException
-     */
-    public function display_errors()
-    {
-        $trace_details = '';
-        $output = '
+	const OPTIONS_KEY_NOTICES = 'ee_notices';
+
+
+	/**
+	 * name of the file to log exceptions to
+	 *
+	 * @var string
+	 */
+	private static $_exception_log_file = 'espresso_error_log.txt';
+
+	/**
+	 *    stores details for all exception
+	 *
+	 * @var array
+	 */
+	private static $_all_exceptions = array();
+
+	/**
+	 *    tracks number of errors
+	 *
+	 * @var int
+	 */
+	private static $_error_count = 0;
+
+	/**
+	 * @var array $_espresso_notices
+	 */
+	private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false);
+
+
+	/**
+	 * @override default exception handling
+	 * @param string         $message
+	 * @param int            $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($message, $code = 0, Exception $previous = null)
+	{
+		if (version_compare(PHP_VERSION, '5.3.0', '<')) {
+			parent::__construct($message, $code);
+		} else {
+			parent::__construct($message, $code, $previous);
+		}
+	}
+
+
+	/**
+	 *    error_handler
+	 *
+	 * @param $code
+	 * @param $message
+	 * @param $file
+	 * @param $line
+	 * @return void
+	 */
+	public static function error_handler($code, $message, $file, $line)
+	{
+		$type = EE_Error::error_type($code);
+		$site = site_url();
+		switch ($site) {
+			case 'http://ee4.eventespresso.com/':
+			case 'http://ee4decaf.eventespresso.com/':
+			case 'http://ee4hf.eventespresso.com/':
+			case 'http://ee4a.eventespresso.com/':
+			case 'http://ee4ad.eventespresso.com/':
+			case 'http://ee4b.eventespresso.com/':
+			case 'http://ee4bd.eventespresso.com/':
+			case 'http://ee4d.eventespresso.com/':
+			case 'http://ee4dd.eventespresso.com/':
+				$to = 'developers@eventespresso.com';
+				break;
+			default:
+				$to = get_option('admin_email');
+		}
+		$subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
+		$msg = EE_Error::_format_error($type, $message, $file, $line);
+		if (function_exists('wp_mail')) {
+			add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
+			wp_mail($to, $subject, $msg);
+		}
+		echo '<div id="message" class="espresso-notices error"><p>';
+		echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
+		echo '<br /></p></div>';
+	}
+
+
+	/**
+	 * error_type
+	 * http://www.php.net/manual/en/errorfunc.constants.php#109430
+	 *
+	 * @param $code
+	 * @return string
+	 */
+	public static function error_type($code)
+	{
+		switch ($code) {
+			case E_ERROR: // 1 //
+				return 'E_ERROR';
+			case E_WARNING: // 2 //
+				return 'E_WARNING';
+			case E_PARSE: // 4 //
+				return 'E_PARSE';
+			case E_NOTICE: // 8 //
+				return 'E_NOTICE';
+			case E_CORE_ERROR: // 16 //
+				return 'E_CORE_ERROR';
+			case E_CORE_WARNING: // 32 //
+				return 'E_CORE_WARNING';
+			case E_COMPILE_ERROR: // 64 //
+				return 'E_COMPILE_ERROR';
+			case E_COMPILE_WARNING: // 128 //
+				return 'E_COMPILE_WARNING';
+			case E_USER_ERROR: // 256 //
+				return 'E_USER_ERROR';
+			case E_USER_WARNING: // 512 //
+				return 'E_USER_WARNING';
+			case E_USER_NOTICE: // 1024 //
+				return 'E_USER_NOTICE';
+			case E_STRICT: // 2048 //
+				return 'E_STRICT';
+			case E_RECOVERABLE_ERROR: // 4096 //
+				return 'E_RECOVERABLE_ERROR';
+			case E_DEPRECATED: // 8192 //
+				return 'E_DEPRECATED';
+			case E_USER_DEPRECATED: // 16384 //
+				return 'E_USER_DEPRECATED';
+			case E_ALL: // 16384 //
+				return 'E_ALL';
+		}
+		return '';
+	}
+
+
+	/**
+	 *    fatal_error_handler
+	 *
+	 * @return void
+	 */
+	public static function fatal_error_handler()
+	{
+		$last_error = error_get_last();
+		if ($last_error['type'] === E_ERROR) {
+			EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
+		}
+	}
+
+
+	/**
+	 * _format_error
+	 *
+	 * @param $code
+	 * @param $message
+	 * @param $file
+	 * @param $line
+	 * @return string
+	 */
+	private static function _format_error($code, $message, $file, $line)
+	{
+		$html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
+		$html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
+		$html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
+		$html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>";
+		$html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>";
+		$html .= '</tbody></table>';
+		return $html;
+	}
+
+
+	/**
+	 * set_content_type
+	 *
+	 * @param $content_type
+	 * @return string
+	 */
+	public static function set_content_type($content_type)
+	{
+		return 'text/html';
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_error()
+	{
+		if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
+			throw $this;
+		}
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $this->getMessage());
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// add details to _all_exceptions array
+		$x_time = time();
+		self::$_all_exceptions[ $x_time ]['name'] = get_class($this);
+		self::$_all_exceptions[ $x_time ]['file'] = $this->getFile();
+		self::$_all_exceptions[ $x_time ]['line'] = $this->getLine();
+		self::$_all_exceptions[ $x_time ]['msg'] = $msg;
+		self::$_all_exceptions[ $x_time ]['code'] = $this->getCode();
+		self::$_all_exceptions[ $x_time ]['trace'] = $this->getTrace();
+		self::$_all_exceptions[ $x_time ]['string'] = $this->getTraceAsString();
+		self::$_error_count++;
+		// add_action( 'shutdown', array( $this, 'display_errors' ));
+		$this->display_errors();
+	}
+
+
+	/**
+	 * @param bool   $check_stored
+	 * @param string $type_to_check
+	 * @return bool
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function has_error($check_stored = false, $type_to_check = 'errors')
+	{
+		$has_error = isset(self::$_espresso_notices[ $type_to_check ])
+					 && ! empty(self::$_espresso_notices[ $type_to_check ])
+			? true
+			: false;
+		if ($check_stored && ! $has_error) {
+			$notices = EE_Error::getStoredNotices();
+			foreach ($notices as $type => $notice) {
+				if ($type === $type_to_check && $notice) {
+					return true;
+				}
+			}
+		}
+		return $has_error;
+	}
+
+
+	/**
+	 * @echo string
+	 * @throws \ReflectionException
+	 */
+	public function display_errors()
+	{
+		$trace_details = '';
+		$output = '
 <style type="text/css">
 	#ee-error-message {
 		max-width:90% !important;
@@ -325,21 +325,21 @@ 
 	}
 </style>
 <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
-            $output .= '
+		if (! WP_DEBUG) {
+			$output .= '
 	<p>';
-        }
-        // cycle thru errors
-        foreach (self::$_all_exceptions as $time => $ex) {
-            $error_code = '';
-            // process trace info
-            if (empty($ex['trace'])) {
-                $trace_details .= __(
-                    'Sorry, but no trace information was available for this exception.',
-                    'event_espresso'
-                );
-            } else {
-                $trace_details .= '
+		}
+		// cycle thru errors
+		foreach (self::$_all_exceptions as $time => $ex) {
+			$error_code = '';
+			// process trace info
+			if (empty($ex['trace'])) {
+				$trace_details .= __(
+					'Sorry, but no trace information was available for this exception.',
+					'event_espresso'
+				);
+			} else {
+				$trace_details .= '
 			<div id="ee-trace-details">
 			<table width="100%" border="0" cellpadding="5" cellspacing="0">
 				<tr>
@@ -349,43 +349,43 @@ 
 					<th scope="col" align="left">Class</th>
 					<th scope="col" align="left">Method( arguments )</th>
 				</tr>';
-                $last_on_stack = count($ex['trace']) - 1;
-                // reverse array so that stack is in proper chronological order
-                $sorted_trace = array_reverse($ex['trace']);
-                foreach ($sorted_trace as $nmbr => $trace) {
-                    $file = isset($trace['file']) ? $trace['file'] : '';
-                    $class = isset($trace['class']) ? $trace['class'] : '';
-                    $type = isset($trace['type']) ? $trace['type'] : '';
-                    $function = isset($trace['function']) ? $trace['function'] : '';
-                    $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-                    $line = isset($trace['line']) ? $trace['line'] : '';
-                    $zebra = ($nmbr % 2) ? ' odd' : '';
-                    if (empty($file) && ! empty($class)) {
-                        $a = new ReflectionClass($class);
-                        $file = $a->getFileName();
-                        if (empty($line) && ! empty($function)) {
-                            try {
-                                // if $function is a closure, this throws an exception
-                                $b = new ReflectionMethod($class, $function);
-                                $line = $b->getStartLine();
-                            } catch (Exception $closure_exception) {
-                                $line = 'unknown';
-                            }
-                        }
-                    }
-                    if ($nmbr === $last_on_stack) {
-                        $file = $ex['file'] !== '' ? $ex['file'] : $file;
-                        $line = $ex['line'] !== '' ? $ex['line'] : $line;
-                        $error_code = self::generate_error_code($file, $trace['function'], $line);
-                    }
-                    $nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
-                    $line_dsply = ! empty($line) ? $line : '&nbsp;';
-                    $file_dsply = ! empty($file) ? $file : '&nbsp;';
-                    $class_dsply = ! empty($class) ? $class : '&nbsp;';
-                    $type_dsply = ! empty($type) ? $type : '&nbsp;';
-                    $function_dsply = ! empty($function) ? $function : '&nbsp;';
-                    $args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
-                    $trace_details .= '
+				$last_on_stack = count($ex['trace']) - 1;
+				// reverse array so that stack is in proper chronological order
+				$sorted_trace = array_reverse($ex['trace']);
+				foreach ($sorted_trace as $nmbr => $trace) {
+					$file = isset($trace['file']) ? $trace['file'] : '';
+					$class = isset($trace['class']) ? $trace['class'] : '';
+					$type = isset($trace['type']) ? $trace['type'] : '';
+					$function = isset($trace['function']) ? $trace['function'] : '';
+					$args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
+					$line = isset($trace['line']) ? $trace['line'] : '';
+					$zebra = ($nmbr % 2) ? ' odd' : '';
+					if (empty($file) && ! empty($class)) {
+						$a = new ReflectionClass($class);
+						$file = $a->getFileName();
+						if (empty($line) && ! empty($function)) {
+							try {
+								// if $function is a closure, this throws an exception
+								$b = new ReflectionMethod($class, $function);
+								$line = $b->getStartLine();
+							} catch (Exception $closure_exception) {
+								$line = 'unknown';
+							}
+						}
+					}
+					if ($nmbr === $last_on_stack) {
+						$file = $ex['file'] !== '' ? $ex['file'] : $file;
+						$line = $ex['line'] !== '' ? $ex['line'] : $line;
+						$error_code = self::generate_error_code($file, $trace['function'], $line);
+					}
+					$nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
+					$line_dsply = ! empty($line) ? $line : '&nbsp;';
+					$file_dsply = ! empty($file) ? $file : '&nbsp;';
+					$class_dsply = ! empty($class) ? $class : '&nbsp;';
+					$type_dsply = ! empty($type) ? $type : '&nbsp;';
+					$function_dsply = ! empty($function) ? $function : '&nbsp;';
+					$args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
+					$trace_details .= '
 					<tr>
 						<td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td>
 						<td align="right" class="' . $zebra . '">' . $line_dsply . '</td>
@@ -393,626 +393,626 @@ 
 						<td align="left" class="' . $zebra . '">' . $class_dsply . '</td>
 						<td align="left" class="' . $zebra . '">' . $type_dsply . $function_dsply . $args_dsply . '</td>
 					</tr>';
-                }
-                $trace_details .= '
+				}
+				$trace_details .= '
 			 </table>
 			</div>';
-            }
-            $ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
-            // add generic non-identifying messages for non-privileged users
-            if (! WP_DEBUG) {
-                $output .= '<span class="ee-error-user-msg-spn">'
-                           . trim($ex['msg'])
-                           . '</span> &nbsp; <sup>'
-                           . $ex['code']
-                           . '</sup><br />';
-            } else {
-                // or helpful developer messages if debugging is on
-                $output .= '
+			}
+			$ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
+			// add generic non-identifying messages for non-privileged users
+			if (! WP_DEBUG) {
+				$output .= '<span class="ee-error-user-msg-spn">'
+						   . trim($ex['msg'])
+						   . '</span> &nbsp; <sup>'
+						   . $ex['code']
+						   . '</sup><br />';
+			} else {
+				// or helpful developer messages if debugging is on
+				$output .= '
 		<div class="ee-error-dev-msg-dv">
 			<p class="ee-error-dev-msg-pg">
 				<strong class="ee-error-dev-msg-str">An '
-                           . $ex['name']
-                           . ' exception was thrown!</strong>  &nbsp; <span>code: '
-                           . $ex['code']
-                           . '</span><br />
+						   . $ex['name']
+						   . ' exception was thrown!</strong>  &nbsp; <span>code: '
+						   . $ex['code']
+						   . '</span><br />
 				<span class="big-text">"'
-                           . trim($ex['msg'])
-                           . '"</span><br/>
+						   . trim($ex['msg'])
+						   . '"</span><br/>
 				<a id="display-ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '">
+						   . self::$_error_count
+						   . $time
+						   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
+						   . self::$_error_count
+						   . $time
+						   . '">
 					'
-                           . __('click to view backtrace and class/method details', 'event_espresso')
-                           . '
+						   . __('click to view backtrace and class/method details', 'event_espresso')
+						   . '
 				</a><br />
 				<span class="small-text lt-grey-text">'
-                           . $ex['file']
-                           . ' &nbsp; ( line no: '
-                           . $ex['line']
-                           . ' )</span>
+						   . $ex['file']
+						   . ' &nbsp; ( line no: '
+						   . $ex['line']
+						   . ' )</span>
 			</p>
 			<div id="ee-error-trace-'
-                           . self::$_error_count
-                           . $time
-                           . '-dv" class="ee-error-trace-dv" style="display: none;">
+						   . self::$_error_count
+						   . $time
+						   . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
-                           . $trace_details;
-                if (! empty($class)) {
-                    $output .= '
+						   . $trace_details;
+				if (! empty($class)) {
+					$output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;">
 						<h3>Class Details</h3>';
-                    $a = new ReflectionClass($class);
-                    $output .= '
+					$a = new ReflectionClass($class);
+					$output .= '
 						<pre>' . $a . '</pre>
 					</div>
 				</div>';
-                }
-                $output .= '
+				}
+				$output .= '
 			</div>
 		</div>
 		<br />';
-            }
-            $this->write_to_error_log($time, $ex);
-        }
-        // remove last linebreak
-        $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
-            $output .= '
+			}
+			$this->write_to_error_log($time, $ex);
+		}
+		// remove last linebreak
+		$output = substr($output, 0, -6);
+		if (! WP_DEBUG) {
+			$output .= '
 	</p>';
-        }
-        $output .= '
+		}
+		$output .= '
 </div>';
-        $output .= self::_print_scripts(true);
-        if (defined('DOING_AJAX')) {
-            echo wp_json_encode(array('error' => $output));
-            exit();
-        }
-        echo $output;
-        die();
-    }
-
-
-    /**
-     *    generate string from exception trace args
-     *
-     * @param array $arguments
-     * @param bool  $array
-     * @return string
-     */
-    private function _convert_args_to_string($arguments = array(), $array = false)
-    {
-        $arg_string = '';
-        if (! empty($arguments)) {
-            $args = array();
-            foreach ($arguments as $arg) {
-                if (! empty($arg)) {
-                    if (is_string($arg)) {
-                        $args[] = " '" . $arg . "'";
-                    } elseif (is_array($arg)) {
-                        $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
-                    } elseif ($arg === null) {
-                        $args[] = ' NULL';
-                    } elseif (is_bool($arg)) {
-                        $args[] = ($arg) ? ' TRUE' : ' FALSE';
-                    } elseif (is_object($arg)) {
-                        $args[] = ' OBJECT ' . get_class($arg);
-                    } elseif (is_resource($arg)) {
-                        $args[] = get_resource_type($arg);
-                    } else {
-                        $args[] = $arg;
-                    }
-                }
-            }
-            $arg_string = implode(', ', $args);
-        }
-        if ($array) {
-            $arg_string .= ' )';
-        }
-        return $arg_string;
-    }
-
-
-    /**
-     *    add error message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_error($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('errors', $msg, $file, $func, $line);
-        self::$_error_count++;
-    }
-
-
-    /**
-     * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
-     * adds an error
-     *
-     * @param string $msg
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @throws EE_Error
-     */
-    public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null)
-    {
-        if (WP_DEBUG) {
-            throw new EE_Error($msg);
-        }
-        EE_Error::add_error($msg, $file, $func, $line);
-    }
-
-
-    /**
-     *    add success message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_success($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('success', $msg, $file, $func, $line);
-    }
-
-
-    /**
-     *    add attention message
-     *
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
-     *                            separate messages for user || dev
-     * @param        string $file the file that the error occurred in - just use __FILE__
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param        string $line the line number where the error occurred - just use __LINE__
-     * @return        void
-     */
-    public static function add_attention($msg = null, $file = null, $func = null, $line = null)
-    {
-        self::_add_notice('attention', $msg, $file, $func, $line);
-    }
-
-
-    /**
-     * @param string $type whether the message is for a success or error notification
-     * @param string $msg  the message to display to users or developers
-     *                     - adding a double pipe || (OR) creates separate messages for user || dev
-     * @param string $file the file that the error occurred in - just use __FILE__
-     * @param string $func the function/method that the error occurred in - just use __FUNCTION__
-     * @param string $line the line number where the error occurred - just use __LINE__
-     * @return void
-     */
-    private static function _add_notice($type = 'success', $msg = '', $file = '', $func = '', $line = '')
-    {
-        if (empty($msg)) {
-            EE_Error::doing_it_wrong(
-                'EE_Error::add_' . $type . '()',
-                sprintf(
-                    __(
-                        'Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
-                        'event_espresso'
-                    ),
-                    $type,
-                    $file,
-                    $line
-                ),
-                EVENT_ESPRESSO_VERSION
-            );
-        }
-        if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
-            EE_Error::doing_it_wrong(
-                'EE_Error::add_error()',
-                __(
-                    'You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
-                    'event_espresso'
-                ),
-                EVENT_ESPRESSO_VERSION
-            );
-        }
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $msg);
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        /**
-         * Do an action so other code can be triggered when a notice is created
-         *
-         * @param string $type     can be 'errors', 'attention', or 'success'
-         * @param string $user_msg message displayed to user when WP_DEBUG is off
-         * @param string $user_msg message displayed to user when WP_DEBUG is on
-         * @param string $file     file where error was generated
-         * @param string $func     function where error was generated
-         * @param string $line     line where error was generated
-         */
-        do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // add notice if message exists
-        if (! empty($msg)) {
-            // get error code
-            $notice_code = EE_Error::generate_error_code($file, $func, $line);
-            if (WP_DEBUG && $type === 'errors') {
-                $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
-            }
-            // add notice. Index by code if it's not blank
-            if ($notice_code) {
-                self::$_espresso_notices[ $type ][ $notice_code ] = $msg;
-            } else {
-                self::$_espresso_notices[ $type ][] = $msg;
-            }
-            add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
-        }
-    }
-
-
-    /**
-     * in some case it may be necessary to overwrite the existing success messages
-     *
-     * @return        void
-     */
-    public static function overwrite_success()
-    {
-        self::$_espresso_notices['success'] = false;
-    }
-
-
-    /**
-     * in some case it may be necessary to overwrite the existing attention messages
-     *
-     * @return void
-     */
-    public static function overwrite_attention()
-    {
-        self::$_espresso_notices['attention'] = false;
-    }
-
-
-    /**
-     * in some case it may be necessary to overwrite the existing error messages
-     *
-     * @return void
-     */
-    public static function overwrite_errors()
-    {
-        self::$_espresso_notices['errors'] = false;
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function reset_notices()
-    {
-        self::$_espresso_notices['success'] = false;
-        self::$_espresso_notices['attention'] = false;
-        self::$_espresso_notices['errors'] = false;
-    }
-
-
-    /**
-     * @return int
-     */
-    public static function has_notices()
-    {
-        $has_notices = 0;
-        // check for success messages
-        $has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])
-            ? 3
-            : $has_notices;
-        // check for attention messages
-        $has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])
-            ? 2
-            : $has_notices;
-        // check for error messages
-        $has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])
-            ? 1
-            : $has_notices;
-        return $has_notices;
-    }
-
-
-    /**
-     * This simply returns non formatted error notices as they were sent into the EE_Error object.
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    public static function get_vanilla_notices()
-    {
-        return array(
-            'success'   => isset(self::$_espresso_notices['success'])
-                ? self::$_espresso_notices['success']
-                : array(),
-            'attention' => isset(self::$_espresso_notices['attention'])
-                ? self::$_espresso_notices['attention']
-                : array(),
-            'errors'    => isset(self::$_espresso_notices['errors'])
-                ? self::$_espresso_notices['errors']
-                : array(),
-        );
-    }
-
-
-    /**
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function getStoredNotices()
-    {
-        if ($user_id = get_current_user_id()) {
-            // get notices for logged in user
-            $notices = get_user_option(EE_Error::OPTIONS_KEY_NOTICES, $user_id);
-            return is_array($notices) ? $notices : array();
-        }
-        if (EE_Session::isLoadedAndActive()) {
-            // get notices for user currently engaged in a session
-            $session_data = EE_Session::instance()->get_session_data(EE_Error::OPTIONS_KEY_NOTICES);
-            return is_array($session_data) ? $session_data : array();
-        }
-        // get global notices and hope they apply to the current site visitor
-        $notices = get_option(EE_Error::OPTIONS_KEY_NOTICES, array());
-        return is_array($notices) ? $notices : array();
-    }
-
-
-    /**
-     * @param array $notices
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function storeNotices(array $notices)
-    {
-        if ($user_id = get_current_user_id()) {
-            // store notices for logged in user
-            return (bool) update_user_option(
-                $user_id,
-                EE_Error::OPTIONS_KEY_NOTICES,
-                $notices
-            );
-        }
-        if (EE_Session::isLoadedAndActive()) {
-            // store notices for user currently engaged in a session
-            return EE_Session::instance()->set_session_data(
-                array(EE_Error::OPTIONS_KEY_NOTICES => $notices)
-            );
-        }
-        // store global notices and hope they apply to the same site visitor on the next request
-        return update_option(EE_Error::OPTIONS_KEY_NOTICES, $notices);
-    }
-
-
-    /**
-     * @return bool|TRUE
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function clearNotices()
-    {
-        if ($user_id = get_current_user_id()) {
-            // clear notices for logged in user
-            return (bool) update_user_option(
-                $user_id,
-                EE_Error::OPTIONS_KEY_NOTICES,
-                array()
-            );
-        }
-        if (EE_Session::isLoadedAndActive()) {
-            // clear notices for user currently engaged in a session
-            return EE_Session::instance()->reset_data(EE_Error::OPTIONS_KEY_NOTICES);
-        }
-        // clear global notices and hope none belonged to some for some other site visitor
-        return update_option(EE_Error::OPTIONS_KEY_NOTICES, array());
-    }
-
-
-    /**
-     * saves notices to the db for retrieval on next request
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function stashNoticesBeforeRedirect()
-    {
-        EE_Error::get_notices(false, true);
-    }
-
-
-    /**
-     * compile all error or success messages into one string
-     *
-     * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
-     * @param boolean $format_output            whether or not to format the messages for display in the WP admin
-     * @param boolean $save_to_transient        whether or not to save notices to the db for retrieval on next request
-     *                                          - ONLY do this just before redirecting
-     * @param boolean $remove_empty             whether or not to unset empty messages
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true)
-    {
-        $success_messages = '';
-        $attention_messages = '';
-        $error_messages = '';
-        // either save notices to the db
-        if ($save_to_transient || isset($_REQUEST['activate-selected'])) {
-            self::$_espresso_notices = array_merge(
-                EE_Error::getStoredNotices(),
-                self::$_espresso_notices
-            );
-            EE_Error::storeNotices(self::$_espresso_notices);
-            return array();
-        }
-        $print_scripts = EE_Error::combineExistingAndNewNotices();
-        // check for success messages
-        if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
-            // combine messages
-            $success_messages .= implode(self::$_espresso_notices['success'], '<br />');
-            $print_scripts = true;
-        }
-        // check for attention messages
-        if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
-            // combine messages
-            $attention_messages .= implode(self::$_espresso_notices['attention'], '<br />');
-            $print_scripts = true;
-        }
-        // check for error messages
-        if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
-            $error_messages .= count(self::$_espresso_notices['errors']) > 1
-                ? __('The following errors have occurred:<br />', 'event_espresso')
-                : __('An error has occurred:<br />', 'event_espresso');
-            // combine messages
-            $error_messages .= implode(self::$_espresso_notices['errors'], '<br />');
-            $print_scripts = true;
-        }
-        if ($format_output) {
-            $notices = EE_Error::formatNoticesOutput(
-                $success_messages,
-                $attention_messages,
-                $error_messages
-            );
-        } else {
-            $notices = array(
-                'success'   => $success_messages,
-                'attention' => $attention_messages,
-                'errors'    => $error_messages,
-            );
-            if ($remove_empty) {
-                // remove empty notices
-                foreach ($notices as $type => $notice) {
-                    if (empty($notice)) {
-                        unset($notices[ $type ]);
-                    }
-                }
-            }
-        }
-        if ($print_scripts) {
-            self::_print_scripts();
-        }
-        return $notices;
-    }
-
-
-    /**
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function combineExistingAndNewNotices()
-    {
-        $print_scripts = false;
-        // grab any notices that have been previously saved
-        $notices = EE_Error::getStoredNotices();
-        if (! empty($notices)) {
-            foreach ($notices as $type => $notice) {
-                if (is_array($notice) && ! empty($notice)) {
-                    // make sure that existing notice type is an array
-                    self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ])
-                                                        && ! empty(self::$_espresso_notices[ $type ])
-                        ? self::$_espresso_notices[ $type ]
-                        : array();
-                    // add newly created notices to existing ones
-                    self::$_espresso_notices[ $type ] += $notice;
-                    $print_scripts = true;
-                }
-            }
-            // now clear any stored notices
-            EE_Error::clearNotices();
-        }
-        return $print_scripts;
-    }
-
-
-    /**
-     * @param string $success_messages
-     * @param string $attention_messages
-     * @param string $error_messages
-     * @return string
-     */
-    private static function formatNoticesOutput($success_messages, $attention_messages, $error_messages)
-    {
-        $notices = '<div id="espresso-notices">';
-        $close = is_admin()
-            ? ''
-            : '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"/></a>';
-        if ($success_messages !== '') {
-            $css_id = is_admin() ? 'ee-success-message' : 'espresso-notices-success';
-            $css_class = is_admin() ? 'updated fade' : 'success fade-away';
-            // showMessage( $success_messages );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
-                        . 'style="display:none;">'
-                        . '<p>' . $success_messages . '</p>'
-                        . $close
-                        . '</div>';
-        }
-        if ($attention_messages !== '') {
-            $css_id = is_admin() ? 'ee-attention-message' : 'espresso-notices-attention';
-            $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
-            // showMessage( $error_messages, TRUE );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
-                        . 'style="display:none;">'
-                        . '<p>' . $attention_messages . '</p>'
-                        . $close
-                        . '</div>';
-        }
-        if ($error_messages !== '') {
-            $css_id = is_admin() ? 'ee-error-message' : 'espresso-notices-error';
-            $css_class = is_admin() ? 'error' : 'error fade-away';
-            // showMessage( $error_messages, TRUE );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
-                        . 'style="display:none;">'
-                        . '<p>' . $error_messages . '</p>'
-                        . $close
-                        . '</div>';
-        }
-        $notices .= '</div>';
-        return $notices;
-    }
-
-
-    /**
-     * _print_scripts
-     *
-     * @param    bool $force_print
-     * @return    string
-     */
-    private static function _print_scripts($force_print = false)
-    {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
-            if (wp_script_is('ee_error_js', 'registered')) {
-                wp_enqueue_style('espresso_default');
-                wp_enqueue_style('espresso_custom_css');
-                wp_enqueue_script('ee_error_js');
-            }
-            if (wp_script_is('ee_error_js', 'enqueued')) {
-                wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
-                return '';
-            }
-        } else {
-            return '
+		$output .= self::_print_scripts(true);
+		if (defined('DOING_AJAX')) {
+			echo wp_json_encode(array('error' => $output));
+			exit();
+		}
+		echo $output;
+		die();
+	}
+
+
+	/**
+	 *    generate string from exception trace args
+	 *
+	 * @param array $arguments
+	 * @param bool  $array
+	 * @return string
+	 */
+	private function _convert_args_to_string($arguments = array(), $array = false)
+	{
+		$arg_string = '';
+		if (! empty($arguments)) {
+			$args = array();
+			foreach ($arguments as $arg) {
+				if (! empty($arg)) {
+					if (is_string($arg)) {
+						$args[] = " '" . $arg . "'";
+					} elseif (is_array($arg)) {
+						$args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
+					} elseif ($arg === null) {
+						$args[] = ' NULL';
+					} elseif (is_bool($arg)) {
+						$args[] = ($arg) ? ' TRUE' : ' FALSE';
+					} elseif (is_object($arg)) {
+						$args[] = ' OBJECT ' . get_class($arg);
+					} elseif (is_resource($arg)) {
+						$args[] = get_resource_type($arg);
+					} else {
+						$args[] = $arg;
+					}
+				}
+			}
+			$arg_string = implode(', ', $args);
+		}
+		if ($array) {
+			$arg_string .= ' )';
+		}
+		return $arg_string;
+	}
+
+
+	/**
+	 *    add error message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_error($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('errors', $msg, $file, $func, $line);
+		self::$_error_count++;
+	}
+
+
+	/**
+	 * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
+	 * adds an error
+	 *
+	 * @param string $msg
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @throws EE_Error
+	 */
+	public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null)
+	{
+		if (WP_DEBUG) {
+			throw new EE_Error($msg);
+		}
+		EE_Error::add_error($msg, $file, $func, $line);
+	}
+
+
+	/**
+	 *    add success message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_success($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('success', $msg, $file, $func, $line);
+	}
+
+
+	/**
+	 *    add attention message
+	 *
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
+	 *                            separate messages for user || dev
+	 * @param        string $file the file that the error occurred in - just use __FILE__
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param        string $line the line number where the error occurred - just use __LINE__
+	 * @return        void
+	 */
+	public static function add_attention($msg = null, $file = null, $func = null, $line = null)
+	{
+		self::_add_notice('attention', $msg, $file, $func, $line);
+	}
+
+
+	/**
+	 * @param string $type whether the message is for a success or error notification
+	 * @param string $msg  the message to display to users or developers
+	 *                     - adding a double pipe || (OR) creates separate messages for user || dev
+	 * @param string $file the file that the error occurred in - just use __FILE__
+	 * @param string $func the function/method that the error occurred in - just use __FUNCTION__
+	 * @param string $line the line number where the error occurred - just use __LINE__
+	 * @return void
+	 */
+	private static function _add_notice($type = 'success', $msg = '', $file = '', $func = '', $line = '')
+	{
+		if (empty($msg)) {
+			EE_Error::doing_it_wrong(
+				'EE_Error::add_' . $type . '()',
+				sprintf(
+					__(
+						'Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
+						'event_espresso'
+					),
+					$type,
+					$file,
+					$line
+				),
+				EVENT_ESPRESSO_VERSION
+			);
+		}
+		if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
+			EE_Error::doing_it_wrong(
+				'EE_Error::add_error()',
+				__(
+					'You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
+					'event_espresso'
+				),
+				EVENT_ESPRESSO_VERSION
+			);
+		}
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $msg);
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		/**
+		 * Do an action so other code can be triggered when a notice is created
+		 *
+		 * @param string $type     can be 'errors', 'attention', or 'success'
+		 * @param string $user_msg message displayed to user when WP_DEBUG is off
+		 * @param string $user_msg message displayed to user when WP_DEBUG is on
+		 * @param string $file     file where error was generated
+		 * @param string $func     function where error was generated
+		 * @param string $line     line where error was generated
+		 */
+		do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// add notice if message exists
+		if (! empty($msg)) {
+			// get error code
+			$notice_code = EE_Error::generate_error_code($file, $func, $line);
+			if (WP_DEBUG && $type === 'errors') {
+				$msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
+			}
+			// add notice. Index by code if it's not blank
+			if ($notice_code) {
+				self::$_espresso_notices[ $type ][ $notice_code ] = $msg;
+			} else {
+				self::$_espresso_notices[ $type ][] = $msg;
+			}
+			add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
+		}
+	}
+
+
+	/**
+	 * in some case it may be necessary to overwrite the existing success messages
+	 *
+	 * @return        void
+	 */
+	public static function overwrite_success()
+	{
+		self::$_espresso_notices['success'] = false;
+	}
+
+
+	/**
+	 * in some case it may be necessary to overwrite the existing attention messages
+	 *
+	 * @return void
+	 */
+	public static function overwrite_attention()
+	{
+		self::$_espresso_notices['attention'] = false;
+	}
+
+
+	/**
+	 * in some case it may be necessary to overwrite the existing error messages
+	 *
+	 * @return void
+	 */
+	public static function overwrite_errors()
+	{
+		self::$_espresso_notices['errors'] = false;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function reset_notices()
+	{
+		self::$_espresso_notices['success'] = false;
+		self::$_espresso_notices['attention'] = false;
+		self::$_espresso_notices['errors'] = false;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public static function has_notices()
+	{
+		$has_notices = 0;
+		// check for success messages
+		$has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])
+			? 3
+			: $has_notices;
+		// check for attention messages
+		$has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])
+			? 2
+			: $has_notices;
+		// check for error messages
+		$has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])
+			? 1
+			: $has_notices;
+		return $has_notices;
+	}
+
+
+	/**
+	 * This simply returns non formatted error notices as they were sent into the EE_Error object.
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public static function get_vanilla_notices()
+	{
+		return array(
+			'success'   => isset(self::$_espresso_notices['success'])
+				? self::$_espresso_notices['success']
+				: array(),
+			'attention' => isset(self::$_espresso_notices['attention'])
+				? self::$_espresso_notices['attention']
+				: array(),
+			'errors'    => isset(self::$_espresso_notices['errors'])
+				? self::$_espresso_notices['errors']
+				: array(),
+		);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getStoredNotices()
+	{
+		if ($user_id = get_current_user_id()) {
+			// get notices for logged in user
+			$notices = get_user_option(EE_Error::OPTIONS_KEY_NOTICES, $user_id);
+			return is_array($notices) ? $notices : array();
+		}
+		if (EE_Session::isLoadedAndActive()) {
+			// get notices for user currently engaged in a session
+			$session_data = EE_Session::instance()->get_session_data(EE_Error::OPTIONS_KEY_NOTICES);
+			return is_array($session_data) ? $session_data : array();
+		}
+		// get global notices and hope they apply to the current site visitor
+		$notices = get_option(EE_Error::OPTIONS_KEY_NOTICES, array());
+		return is_array($notices) ? $notices : array();
+	}
+
+
+	/**
+	 * @param array $notices
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function storeNotices(array $notices)
+	{
+		if ($user_id = get_current_user_id()) {
+			// store notices for logged in user
+			return (bool) update_user_option(
+				$user_id,
+				EE_Error::OPTIONS_KEY_NOTICES,
+				$notices
+			);
+		}
+		if (EE_Session::isLoadedAndActive()) {
+			// store notices for user currently engaged in a session
+			return EE_Session::instance()->set_session_data(
+				array(EE_Error::OPTIONS_KEY_NOTICES => $notices)
+			);
+		}
+		// store global notices and hope they apply to the same site visitor on the next request
+		return update_option(EE_Error::OPTIONS_KEY_NOTICES, $notices);
+	}
+
+
+	/**
+	 * @return bool|TRUE
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function clearNotices()
+	{
+		if ($user_id = get_current_user_id()) {
+			// clear notices for logged in user
+			return (bool) update_user_option(
+				$user_id,
+				EE_Error::OPTIONS_KEY_NOTICES,
+				array()
+			);
+		}
+		if (EE_Session::isLoadedAndActive()) {
+			// clear notices for user currently engaged in a session
+			return EE_Session::instance()->reset_data(EE_Error::OPTIONS_KEY_NOTICES);
+		}
+		// clear global notices and hope none belonged to some for some other site visitor
+		return update_option(EE_Error::OPTIONS_KEY_NOTICES, array());
+	}
+
+
+	/**
+	 * saves notices to the db for retrieval on next request
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function stashNoticesBeforeRedirect()
+	{
+		EE_Error::get_notices(false, true);
+	}
+
+
+	/**
+	 * compile all error or success messages into one string
+	 *
+	 * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
+	 * @param boolean $format_output            whether or not to format the messages for display in the WP admin
+	 * @param boolean $save_to_transient        whether or not to save notices to the db for retrieval on next request
+	 *                                          - ONLY do this just before redirecting
+	 * @param boolean $remove_empty             whether or not to unset empty messages
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true)
+	{
+		$success_messages = '';
+		$attention_messages = '';
+		$error_messages = '';
+		// either save notices to the db
+		if ($save_to_transient || isset($_REQUEST['activate-selected'])) {
+			self::$_espresso_notices = array_merge(
+				EE_Error::getStoredNotices(),
+				self::$_espresso_notices
+			);
+			EE_Error::storeNotices(self::$_espresso_notices);
+			return array();
+		}
+		$print_scripts = EE_Error::combineExistingAndNewNotices();
+		// check for success messages
+		if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
+			// combine messages
+			$success_messages .= implode(self::$_espresso_notices['success'], '<br />');
+			$print_scripts = true;
+		}
+		// check for attention messages
+		if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
+			// combine messages
+			$attention_messages .= implode(self::$_espresso_notices['attention'], '<br />');
+			$print_scripts = true;
+		}
+		// check for error messages
+		if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
+			$error_messages .= count(self::$_espresso_notices['errors']) > 1
+				? __('The following errors have occurred:<br />', 'event_espresso')
+				: __('An error has occurred:<br />', 'event_espresso');
+			// combine messages
+			$error_messages .= implode(self::$_espresso_notices['errors'], '<br />');
+			$print_scripts = true;
+		}
+		if ($format_output) {
+			$notices = EE_Error::formatNoticesOutput(
+				$success_messages,
+				$attention_messages,
+				$error_messages
+			);
+		} else {
+			$notices = array(
+				'success'   => $success_messages,
+				'attention' => $attention_messages,
+				'errors'    => $error_messages,
+			);
+			if ($remove_empty) {
+				// remove empty notices
+				foreach ($notices as $type => $notice) {
+					if (empty($notice)) {
+						unset($notices[ $type ]);
+					}
+				}
+			}
+		}
+		if ($print_scripts) {
+			self::_print_scripts();
+		}
+		return $notices;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function combineExistingAndNewNotices()
+	{
+		$print_scripts = false;
+		// grab any notices that have been previously saved
+		$notices = EE_Error::getStoredNotices();
+		if (! empty($notices)) {
+			foreach ($notices as $type => $notice) {
+				if (is_array($notice) && ! empty($notice)) {
+					// make sure that existing notice type is an array
+					self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ])
+														&& ! empty(self::$_espresso_notices[ $type ])
+						? self::$_espresso_notices[ $type ]
+						: array();
+					// add newly created notices to existing ones
+					self::$_espresso_notices[ $type ] += $notice;
+					$print_scripts = true;
+				}
+			}
+			// now clear any stored notices
+			EE_Error::clearNotices();
+		}
+		return $print_scripts;
+	}
+
+
+	/**
+	 * @param string $success_messages
+	 * @param string $attention_messages
+	 * @param string $error_messages
+	 * @return string
+	 */
+	private static function formatNoticesOutput($success_messages, $attention_messages, $error_messages)
+	{
+		$notices = '<div id="espresso-notices">';
+		$close = is_admin()
+			? ''
+			: '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"/></a>';
+		if ($success_messages !== '') {
+			$css_id = is_admin() ? 'ee-success-message' : 'espresso-notices-success';
+			$css_class = is_admin() ? 'updated fade' : 'success fade-away';
+			// showMessage( $success_messages );
+			$notices .= '<div id="' . $css_id . '" '
+						. 'class="espresso-notices ' . $css_class . '" '
+						. 'style="display:none;">'
+						. '<p>' . $success_messages . '</p>'
+						. $close
+						. '</div>';
+		}
+		if ($attention_messages !== '') {
+			$css_id = is_admin() ? 'ee-attention-message' : 'espresso-notices-attention';
+			$css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
+			// showMessage( $error_messages, TRUE );
+			$notices .= '<div id="' . $css_id . '" '
+						. 'class="espresso-notices ' . $css_class . '" '
+						. 'style="display:none;">'
+						. '<p>' . $attention_messages . '</p>'
+						. $close
+						. '</div>';
+		}
+		if ($error_messages !== '') {
+			$css_id = is_admin() ? 'ee-error-message' : 'espresso-notices-error';
+			$css_class = is_admin() ? 'error' : 'error fade-away';
+			// showMessage( $error_messages, TRUE );
+			$notices .= '<div id="' . $css_id . '" '
+						. 'class="espresso-notices ' . $css_class . '" '
+						. 'style="display:none;">'
+						. '<p>' . $error_messages . '</p>'
+						. $close
+						. '</div>';
+		}
+		$notices .= '</div>';
+		return $notices;
+	}
+
+
+	/**
+	 * _print_scripts
+	 *
+	 * @param    bool $force_print
+	 * @return    string
+	 */
+	private static function _print_scripts($force_print = false)
+	{
+		if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+			if (wp_script_is('ee_error_js', 'registered')) {
+				wp_enqueue_style('espresso_default');
+				wp_enqueue_style('espresso_custom_css');
+				wp_enqueue_script('ee_error_js');
+			}
+			if (wp_script_is('ee_error_js', 'enqueued')) {
+				wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
+				return '';
+			}
+		} else {
+			return '
 <script>
 /* <![CDATA[ */
 var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
@@ -1022,221 +1022,221 @@ 
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
 ';
-        }
-        return '';
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function enqueue_error_scripts()
-    {
-        self::_print_scripts();
-    }
-
-
-    /**
-     * create error code from filepath, function name,
-     * and line number where exception or error was thrown
-     *
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @return string
-     */
-    public static function generate_error_code($file = '', $func = '', $line = '')
-    {
-        $file = explode('.', basename($file));
-        $error_code = ! empty($file[0]) ? $file[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
-        return $error_code;
-    }
-
-
-    /**
-     * write exception details to log file
-     * Since 4.9.53.rc.006 this writes to the standard PHP log file, not EE's custom log file
-     *
-     * @param int   $time
-     * @param array $ex
-     * @param bool  $clear
-     * @return void
-     */
-    public function write_to_error_log($time = 0, $ex = array(), $clear = false)
-    {
-        if (empty($ex)) {
-            return;
-        }
-        if (! $time) {
-            $time = time();
-        }
-        $exception_log = '----------------------------------------------------------------------------------------'
-                         . PHP_EOL;
-        $exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
-        $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
-        $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
-        $exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
-        $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
-        $exception_log .= 'Stack trace: ' . PHP_EOL;
-        $exception_log .= $ex['string'] . PHP_EOL;
-        $exception_log .= '----------------------------------------------------------------------------------------'
-                          . PHP_EOL;
-        try {
-            error_log($exception_log);
-        } catch (EE_Error $e) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'Event Espresso error logging could not be setup because: %s',
-                        'event_espresso'
-                    ),
-                    $e->getMessage()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
-     * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
-     * but the code execution is done in a manner that could lead to unexpected results
-     * (i.e. running to early, or too late in WP or EE loading process).
-     * A good test for knowing whether to use this method is:
-     * 1. Is there going to be a PHP error if something isn't setup/used correctly?
-     * Yes -> use EE_Error::add_error() or throw new EE_Error()
-     * 2. If this is loaded before something else, it won't break anything,
-     * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
-     *
-     * @uses   constant WP_DEBUG test if wp_debug is on or not
-     * @param string $function      The function that was called
-     * @param string $message       A message explaining what has been done incorrectly
-     * @param string $version       The version of Event Espresso where the error was added
-     * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
-     *                              for a deprecated function. This allows deprecation to occur during one version,
-     *                              but not have any notices appear until a later version. This allows developers
-     *                              extra time to update their code before notices appear.
-     * @param int    $error_type
-     */
-    public static function doing_it_wrong(
-        $function,
-        $message,
-        $version,
-        $applies_when = '',
-        $error_type = null
-    ) {
-        if (defined('WP_DEBUG') && WP_DEBUG) {
-            EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
-        }
-    }
-
-
-    /**
-     * Like get_notices, but returns an array of all the notices of the given type.
-     *
-     * @return array {
-     * @type array $success   all the success messages
-     * @type array $errors    all the error messages
-     * @type array $attention all the attention messages
-     * }
-     */
-    public static function get_raw_notices()
-    {
-        return self::$_espresso_notices;
-    }
-
-
-    /**
-     * @deprecated 4.9.27
-     * @param string $pan_name     the name, or key of the Persistent Admin Notice to be stored
-     * @param string $pan_message  the message to be stored persistently until dismissed
-     * @param bool   $force_update allows one to enforce the reappearance of a persistent message.
-     * @return void
-     * @throws InvalidDataTypeException
-     */
-    public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false)
-    {
-        new PersistentAdminNotice(
-            $pan_name,
-            $pan_message,
-            $force_update
-        );
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.27
-     * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
-     * @param bool   $purge
-     * @param bool   $return
-     * @throws DomainException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ServiceNotFoundException
-     * @throws InvalidArgumentException
-     */
-    public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return = false)
-    {
-        /** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
-        $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        $persistent_admin_notice_manager->dismissNotice($pan_name, $purge, $return);
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.27
-     * @param  string $pan_name    the name, or key of the Persistent Admin Notice to be stored
-     * @param  string $pan_message the message to be stored persistently until dismissed
-     * @param  string $return_url  URL to go back to after nag notice is dismissed
-     */
-    public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.27
-     * @param string $return_url
-     */
-    public static function get_persistent_admin_notices($return_url = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
+		}
+		return '';
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function enqueue_error_scripts()
+	{
+		self::_print_scripts();
+	}
+
+
+	/**
+	 * create error code from filepath, function name,
+	 * and line number where exception or error was thrown
+	 *
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @return string
+	 */
+	public static function generate_error_code($file = '', $func = '', $line = '')
+	{
+		$file = explode('.', basename($file));
+		$error_code = ! empty($file[0]) ? $file[0] : '';
+		$error_code .= ! empty($func) ? ' - ' . $func : '';
+		$error_code .= ! empty($line) ? ' - ' . $line : '';
+		return $error_code;
+	}
+
+
+	/**
+	 * write exception details to log file
+	 * Since 4.9.53.rc.006 this writes to the standard PHP log file, not EE's custom log file
+	 *
+	 * @param int   $time
+	 * @param array $ex
+	 * @param bool  $clear
+	 * @return void
+	 */
+	public function write_to_error_log($time = 0, $ex = array(), $clear = false)
+	{
+		if (empty($ex)) {
+			return;
+		}
+		if (! $time) {
+			$time = time();
+		}
+		$exception_log = '----------------------------------------------------------------------------------------'
+						 . PHP_EOL;
+		$exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
+		$exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
+		$exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
+		$exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
+		$exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
+		$exception_log .= 'Stack trace: ' . PHP_EOL;
+		$exception_log .= $ex['string'] . PHP_EOL;
+		$exception_log .= '----------------------------------------------------------------------------------------'
+						  . PHP_EOL;
+		try {
+			error_log($exception_log);
+		} catch (EE_Error $e) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'Event Espresso error logging could not be setup because: %s',
+						'event_espresso'
+					),
+					$e->getMessage()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
+	 * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
+	 * but the code execution is done in a manner that could lead to unexpected results
+	 * (i.e. running to early, or too late in WP or EE loading process).
+	 * A good test for knowing whether to use this method is:
+	 * 1. Is there going to be a PHP error if something isn't setup/used correctly?
+	 * Yes -> use EE_Error::add_error() or throw new EE_Error()
+	 * 2. If this is loaded before something else, it won't break anything,
+	 * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
+	 *
+	 * @uses   constant WP_DEBUG test if wp_debug is on or not
+	 * @param string $function      The function that was called
+	 * @param string $message       A message explaining what has been done incorrectly
+	 * @param string $version       The version of Event Espresso where the error was added
+	 * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
+	 *                              for a deprecated function. This allows deprecation to occur during one version,
+	 *                              but not have any notices appear until a later version. This allows developers
+	 *                              extra time to update their code before notices appear.
+	 * @param int    $error_type
+	 */
+	public static function doing_it_wrong(
+		$function,
+		$message,
+		$version,
+		$applies_when = '',
+		$error_type = null
+	) {
+		if (defined('WP_DEBUG') && WP_DEBUG) {
+			EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
+		}
+	}
+
+
+	/**
+	 * Like get_notices, but returns an array of all the notices of the given type.
+	 *
+	 * @return array {
+	 * @type array $success   all the success messages
+	 * @type array $errors    all the error messages
+	 * @type array $attention all the attention messages
+	 * }
+	 */
+	public static function get_raw_notices()
+	{
+		return self::$_espresso_notices;
+	}
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @param string $pan_name     the name, or key of the Persistent Admin Notice to be stored
+	 * @param string $pan_message  the message to be stored persistently until dismissed
+	 * @param bool   $force_update allows one to enforce the reappearance of a persistent message.
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 */
+	public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false)
+	{
+		new PersistentAdminNotice(
+			$pan_name,
+			$pan_message,
+			$force_update
+		);
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
+			),
+			'4.9.27'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
+	 * @param bool   $purge
+	 * @param bool   $return
+	 * @throws DomainException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ServiceNotFoundException
+	 * @throws InvalidArgumentException
+	 */
+	public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return = false)
+	{
+		/** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
+		$persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		$persistent_admin_notice_manager->dismissNotice($pan_name, $purge, $return);
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @param  string $pan_name    the name, or key of the Persistent Admin Notice to be stored
+	 * @param  string $pan_message the message to be stored persistently until dismissed
+	 * @param  string $return_url  URL to go back to after nag notice is dismissed
+	 */
+	public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @param string $return_url
+	 */
+	public static function get_persistent_admin_notices($return_url = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
 }
 
 // end of Class EE_Exceptions
@@ -1249,27 +1249,27 @@ 
  */
 function espresso_error_enqueue_scripts()
 {
-    // js for error handling
-    wp_register_script(
-        'espresso_core',
-        EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-        array('jquery'),
-        EVENT_ESPRESSO_VERSION,
-        false
-    );
-    wp_register_script(
-        'ee_error_js',
-        EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-        array('espresso_core'),
-        EVENT_ESPRESSO_VERSION,
-        false
-    );
+	// js for error handling
+	wp_register_script(
+		'espresso_core',
+		EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+		array('jquery'),
+		EVENT_ESPRESSO_VERSION,
+		false
+	);
+	wp_register_script(
+		'ee_error_js',
+		EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+		array('espresso_core'),
+		EVENT_ESPRESSO_VERSION,
+		false
+	);
 }
 
 if (is_admin()) {
-    add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
+	add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
 } else {
-    add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
+	add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
 }
 
 

Spacing +64 added lines, -64 removed lines

@@ -99,14 +99,14 @@ 
             default:
                 $to = get_option('admin_email');
         }
-        $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
+        $subject = $type.' '.$message.' in '.EVENT_ESPRESSO_VERSION.' on '.site_url();
         $msg = EE_Error::_format_error($type, $message, $file, $line);
         if (function_exists('wp_mail')) {
             add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
             wp_mail($to, $subject, $msg);
         }
         echo '<div id="message" class="espresso-notices error"><p>';
-        echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
+        echo $type.': '.$message.'<br />'.$file.' line '.$line;
         echo '<br /></p></div>';
     }
 
@@ -222,13 +222,13 @@ 
         $msg = WP_DEBUG ? $dev_msg : $user_msg;
         // add details to _all_exceptions array
         $x_time = time();
-        self::$_all_exceptions[ $x_time ]['name'] = get_class($this);
-        self::$_all_exceptions[ $x_time ]['file'] = $this->getFile();
-        self::$_all_exceptions[ $x_time ]['line'] = $this->getLine();
-        self::$_all_exceptions[ $x_time ]['msg'] = $msg;
-        self::$_all_exceptions[ $x_time ]['code'] = $this->getCode();
-        self::$_all_exceptions[ $x_time ]['trace'] = $this->getTrace();
-        self::$_all_exceptions[ $x_time ]['string'] = $this->getTraceAsString();
+        self::$_all_exceptions[$x_time]['name'] = get_class($this);
+        self::$_all_exceptions[$x_time]['file'] = $this->getFile();
+        self::$_all_exceptions[$x_time]['line'] = $this->getLine();
+        self::$_all_exceptions[$x_time]['msg'] = $msg;
+        self::$_all_exceptions[$x_time]['code'] = $this->getCode();
+        self::$_all_exceptions[$x_time]['trace'] = $this->getTrace();
+        self::$_all_exceptions[$x_time]['string'] = $this->getTraceAsString();
         self::$_error_count++;
         // add_action( 'shutdown', array( $this, 'display_errors' ));
         $this->display_errors();
@@ -246,8 +246,8 @@ 
      */
     public static function has_error($check_stored = false, $type_to_check = 'errors')
     {
-        $has_error = isset(self::$_espresso_notices[ $type_to_check ])
-                     && ! empty(self::$_espresso_notices[ $type_to_check ])
+        $has_error = isset(self::$_espresso_notices[$type_to_check])
+                     && ! empty(self::$_espresso_notices[$type_to_check])
             ? true
             : false;
         if ($check_stored && ! $has_error) {
@@ -325,7 +325,7 @@ 
 	}
 </style>
 <div id="ee-error-message" class="error">';
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '
 	<p>';
         }
@@ -384,14 +384,14 @@ 
                     $class_dsply = ! empty($class) ? $class : '&nbsp;';
                     $type_dsply = ! empty($type) ? $type : '&nbsp;';
                     $function_dsply = ! empty($function) ? $function : '&nbsp;';
-                    $args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
+                    $args_dsply = ! empty($args) ? '( '.$args.' )' : '';
                     $trace_details .= '
 					<tr>
-						<td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td>
-						<td align="right" class="' . $zebra . '">' . $line_dsply . '</td>
-						<td align="left" class="' . $zebra . '">' . $file_dsply . '</td>
-						<td align="left" class="' . $zebra . '">' . $class_dsply . '</td>
-						<td align="left" class="' . $zebra . '">' . $type_dsply . $function_dsply . $args_dsply . '</td>
+						<td align="right" class="' . $zebra.'">'.$nmbr_dsply.'</td>
+						<td align="right" class="' . $zebra.'">'.$line_dsply.'</td>
+						<td align="left" class="' . $zebra.'">'.$file_dsply.'</td>
+						<td align="left" class="' . $zebra.'">'.$class_dsply.'</td>
+						<td align="left" class="' . $zebra.'">'.$type_dsply.$function_dsply.$args_dsply.'</td>
 					</tr>';
                 }
                 $trace_details .= '
@@ -400,7 +400,7 @@ 
             }
             $ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
             // add generic non-identifying messages for non-privileged users
-            if (! WP_DEBUG) {
+            if ( ! WP_DEBUG) {
                 $output .= '<span class="ee-error-user-msg-spn">'
                            . trim($ex['msg'])
                            . '</span> &nbsp; <sup>'
@@ -442,14 +442,14 @@ 
                            . '-dv" class="ee-error-trace-dv" style="display: none;">
 				'
                            . $trace_details;
-                if (! empty($class)) {
+                if ( ! empty($class)) {
                     $output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;">
 						<h3>Class Details</h3>';
                     $a = new ReflectionClass($class);
                     $output .= '
-						<pre>' . $a . '</pre>
+						<pre>' . $a.'</pre>
 					</div>
 				</div>';
                 }
@@ -462,7 +462,7 @@ 
         }
         // remove last linebreak
         $output = substr($output, 0, -6);
-        if (! WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             $output .= '
 	</p>';
         }
@@ -488,20 +488,20 @@ 
     private function _convert_args_to_string($arguments = array(), $array = false)
     {
         $arg_string = '';
-        if (! empty($arguments)) {
+        if ( ! empty($arguments)) {
             $args = array();
             foreach ($arguments as $arg) {
-                if (! empty($arg)) {
+                if ( ! empty($arg)) {
                     if (is_string($arg)) {
-                        $args[] = " '" . $arg . "'";
+                        $args[] = " '".$arg."'";
                     } elseif (is_array($arg)) {
-                        $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
+                        $args[] = 'ARRAY('.$this->_convert_args_to_string($arg, true);
                     } elseif ($arg === null) {
                         $args[] = ' NULL';
                     } elseif (is_bool($arg)) {
                         $args[] = ($arg) ? ' TRUE' : ' FALSE';
                     } elseif (is_object($arg)) {
-                        $args[] = ' OBJECT ' . get_class($arg);
+                        $args[] = ' OBJECT '.get_class($arg);
                     } elseif (is_resource($arg)) {
                         $args[] = get_resource_type($arg);
                     } else {
@@ -599,7 +599,7 @@ 
     {
         if (empty($msg)) {
             EE_Error::doing_it_wrong(
-                'EE_Error::add_' . $type . '()',
+                'EE_Error::add_'.$type.'()',
                 sprintf(
                     __(
                         'Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
@@ -639,17 +639,17 @@ 
         do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
         $msg = WP_DEBUG ? $dev_msg : $user_msg;
         // add notice if message exists
-        if (! empty($msg)) {
+        if ( ! empty($msg)) {
             // get error code
             $notice_code = EE_Error::generate_error_code($file, $func, $line);
             if (WP_DEBUG && $type === 'errors') {
-                $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
+                $msg .= '<br/><span class="tiny-text">'.$notice_code.'</span>';
             }
             // add notice. Index by code if it's not blank
             if ($notice_code) {
-                self::$_espresso_notices[ $type ][ $notice_code ] = $msg;
+                self::$_espresso_notices[$type][$notice_code] = $msg;
             } else {
-                self::$_espresso_notices[ $type ][] = $msg;
+                self::$_espresso_notices[$type][] = $msg;
             }
             add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
         }
@@ -900,7 +900,7 @@ 
                 // remove empty notices
                 foreach ($notices as $type => $notice) {
                     if (empty($notice)) {
-                        unset($notices[ $type ]);
+                        unset($notices[$type]);
                     }
                 }
             }
@@ -923,16 +923,16 @@ 
         $print_scripts = false;
         // grab any notices that have been previously saved
         $notices = EE_Error::getStoredNotices();
-        if (! empty($notices)) {
+        if ( ! empty($notices)) {
             foreach ($notices as $type => $notice) {
                 if (is_array($notice) && ! empty($notice)) {
                     // make sure that existing notice type is an array
-                    self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ])
-                                                        && ! empty(self::$_espresso_notices[ $type ])
-                        ? self::$_espresso_notices[ $type ]
+                    self::$_espresso_notices[$type] = is_array(self::$_espresso_notices[$type])
+                                                        && ! empty(self::$_espresso_notices[$type])
+                        ? self::$_espresso_notices[$type]
                         : array();
                     // add newly created notices to existing ones
-                    self::$_espresso_notices[ $type ] += $notice;
+                    self::$_espresso_notices[$type] += $notice;
                     $print_scripts = true;
                 }
             }
@@ -959,10 +959,10 @@ 
             $css_id = is_admin() ? 'ee-success-message' : 'espresso-notices-success';
             $css_class = is_admin() ? 'updated fade' : 'success fade-away';
             // showMessage( $success_messages );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
+            $notices .= '<div id="'.$css_id.'" '
+                        . 'class="espresso-notices '.$css_class.'" '
                         . 'style="display:none;">'
-                        . '<p>' . $success_messages . '</p>'
+                        . '<p>'.$success_messages.'</p>'
                         . $close
                         . '</div>';
         }
@@ -970,10 +970,10 @@ 
             $css_id = is_admin() ? 'ee-attention-message' : 'espresso-notices-attention';
             $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
             // showMessage( $error_messages, TRUE );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
+            $notices .= '<div id="'.$css_id.'" '
+                        . 'class="espresso-notices '.$css_class.'" '
                         . 'style="display:none;">'
-                        . '<p>' . $attention_messages . '</p>'
+                        . '<p>'.$attention_messages.'</p>'
                         . $close
                         . '</div>';
         }
@@ -981,10 +981,10 @@ 
             $css_id = is_admin() ? 'ee-error-message' : 'espresso-notices-error';
             $css_class = is_admin() ? 'error' : 'error fade-away';
             // showMessage( $error_messages, TRUE );
-            $notices .= '<div id="' . $css_id . '" '
-                        . 'class="espresso-notices ' . $css_class . '" '
+            $notices .= '<div id="'.$css_id.'" '
+                        . 'class="espresso-notices '.$css_class.'" '
                         . 'style="display:none;">'
-                        . '<p>' . $error_messages . '</p>'
+                        . '<p>'.$error_messages.'</p>'
                         . $close
                         . '</div>';
         }
@@ -1001,7 +1001,7 @@ 
      */
     private static function _print_scripts($force_print = false)
     {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+        if ( ! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
             if (wp_script_is('ee_error_js', 'registered')) {
                 wp_enqueue_style('espresso_default');
                 wp_enqueue_style('espresso_custom_css');
@@ -1015,12 +1015,12 @@ 
             return '
 <script>
 /* <![CDATA[ */
-var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
+var ee_settings = {"wp_debug":"' . WP_DEBUG.'"};
 /* ]]> */
 </script>
-<script src="' . includes_url() . 'js/jquery/jquery.js" type="text/javascript"></script>
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
+<script src="' . includes_url().'js/jquery/jquery.js" type="text/javascript"></script>
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
 ';
         }
         return '';
@@ -1049,8 +1049,8 @@ 
     {
         $file = explode('.', basename($file));
         $error_code = ! empty($file[0]) ? $file[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
+        $error_code .= ! empty($func) ? ' - '.$func : '';
+        $error_code .= ! empty($line) ? ' - '.$line : '';
         return $error_code;
     }
 
@@ -1069,18 +1069,18 @@ 
         if (empty($ex)) {
             return;
         }
-        if (! $time) {
+        if ( ! $time) {
             $time = time();
         }
         $exception_log = '----------------------------------------------------------------------------------------'
                          . PHP_EOL;
-        $exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
-        $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
-        $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
-        $exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
-        $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
-        $exception_log .= 'Stack trace: ' . PHP_EOL;
-        $exception_log .= $ex['string'] . PHP_EOL;
+        $exception_log .= '['.date('Y-m-d H:i:s', $time).']  Exception Details'.PHP_EOL;
+        $exception_log .= 'Message: '.$ex['msg'].PHP_EOL;
+        $exception_log .= 'Code: '.$ex['code'].PHP_EOL;
+        $exception_log .= 'File: '.$ex['file'].PHP_EOL;
+        $exception_log .= 'Line No: '.$ex['line'].PHP_EOL;
+        $exception_log .= 'Stack trace: '.PHP_EOL;
+        $exception_log .= $ex['string'].PHP_EOL;
         $exception_log .= '----------------------------------------------------------------------------------------'
                           . PHP_EOL;
         try {
@@ -1252,14 +1252,14 @@ 
     // js for error handling
     wp_register_script(
         'espresso_core',
-        EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+        EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js',
         array('jquery'),
         EVENT_ESPRESSO_VERSION,
         false
     );
     wp_register_script(
         'ee_error_js',
-        EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+        EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js',
         array('espresso_core'),
         EVENT_ESPRESSO_VERSION,
         false

core/EE_Encryption.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -396,7 +396,7 @@
 
     /**
      * @see http://stackoverflow.com/questions/2556345/detect-base64-encoding-in-php#30231906
-     * @param $string
+     * @param string $string
      * @return bool
      */
     protected function valid_base_64($string)

Indentation +671 added lines, -671 removed lines

@@ -26,675 +26,675 @@
 class EE_Encryption implements InterminableInterface
 {
 
-    /**
-     * key used for saving the encryption key to the wp_options table
-     */
-    const ENCRYPTION_OPTION_KEY = 'ee_encryption_key';
-
-    /**
-     * the OPENSSL cipher method used
-     */
-    const OPENSSL_CIPHER_METHOD = 'AES-128-CBC';
-
-    /**
-     * WP "options_name" used to store a verified available cipher method
-     */
-    const OPENSSL_CIPHER_METHOD_OPTION_NAME = 'ee_openssl_cipher_method';
-
-    /**
-     * the OPENSSL digest method used
-     */
-    const OPENSSL_DIGEST_METHOD = 'sha512';
-
-    /**
-     * separates the encrypted text from the initialization vector
-     */
-    const OPENSSL_IV_DELIMITER = ':iv:';
-
-    /**
-     * appended to text encrypted using the acme encryption
-     */
-    const ACME_ENCRYPTION_FLAG = '::ae';
-
-
-    /**
-     * instance of the EE_Encryption object
-     */
-    protected static $_instance;
-
-    /**
-     * @var string $_encryption_key
-     */
-    protected $_encryption_key;
-
-    /**
-     * @var string $cipher_method
-     */
-    private $cipher_method = '';
-
-    /**
-     * @var array $cipher_methods
-     */
-    private $cipher_methods = array();
-
-    /**
-     * @var array $digest_methods
-     */
-    private $digest_methods = array();
-
-    /**
-     * @var boolean $_use_openssl_encrypt
-     */
-    protected $_use_openssl_encrypt = false;
-
-    /**
-     * @var boolean $_use_mcrypt
-     */
-    protected $_use_mcrypt = false;
-
-    /**
-     * @var boolean $_use_base64_encode
-     */
-    protected $_use_base64_encode = false;
-
-
-    /**
-     * protected constructor to prevent direct creation
-     */
-    protected function __construct()
-    {
-        if (! defined('ESPRESSO_ENCRYPT')) {
-            define('ESPRESSO_ENCRYPT', true);
-        }
-        if (extension_loaded('openssl')) {
-            $this->_use_openssl_encrypt = true;
-        } elseif (extension_loaded('mcrypt')) {
-            $this->_use_mcrypt = true;
-        }
-        if (function_exists('base64_encode')) {
-            $this->_use_base64_encode = true;
-        }
-    }
-
-
-    /**
-     * singleton method used to instantiate class object
-     *
-     * @return EE_Encryption
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! EE_Encryption::$_instance instanceof EE_Encryption) {
-            EE_Encryption::$_instance = new self();
-        }
-        return EE_Encryption::$_instance;
-    }
-
-
-    /**
-     * get encryption key
-     *
-     * @return string
-     */
-    public function get_encryption_key()
-    {
-        // if encryption key has not been set
-        if (empty($this->_encryption_key)) {
-            // retrieve encryption_key from db
-            $this->_encryption_key = get_option(EE_Encryption::ENCRYPTION_OPTION_KEY, '');
-            // WHAT?? No encryption_key in the db ??
-            if ($this->_encryption_key === '') {
-                // let's make one. And md5 it to make it just the right size for a key
-                $new_key = md5($this->generate_random_string());
-                // now save it to the db for later
-                add_option(EE_Encryption::ENCRYPTION_OPTION_KEY, $new_key);
-                // here's the key - FINALLY !
-                $this->_encryption_key = $new_key;
-            }
-        }
-        return $this->_encryption_key;
-    }
-
-
-    /**
-     * encrypts data
-     *
-     * @param string $text_string - the text to be encrypted
-     * @return string
-     * @throws RuntimeException
-     */
-    public function encrypt($text_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string)) {
-            return $text_string;
-        }
-        if ($this->_use_openssl_encrypt) {
-            $encrypted_text = $this->openssl_encrypt($text_string);
-        } else {
-            $encrypted_text = $this->acme_encrypt($text_string);
-        }
-        return $encrypted_text;
-    }
-
-
-    /**
-     * decrypts data
-     *
-     * @param string $encrypted_text - the text to be decrypted
-     * @return string
-     * @throws RuntimeException
-     */
-    public function decrypt($encrypted_text = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($encrypted_text)) {
-            return $encrypted_text;
-        }
-        // if PHP's mcrypt functions are installed then we'll use them
-        if ($this->_use_openssl_encrypt) {
-            $decrypted_text = $this->openssl_decrypt($encrypted_text);
-        } else {
-            $decrypted_text = $this->acme_decrypt($encrypted_text);
-        }
-        return $decrypted_text;
-    }
-
-
-    /**
-     * encodes string with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $text_string the text to be encoded
-     * @return string
-     */
-    public function base64_string_encode($text_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string) || ! $this->_use_base64_encode) {
-            return $text_string;
-        }
-        // encode
-        return base64_encode($text_string);
-    }
-
-
-    /**
-     * decodes string that has been encoded with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $encoded_string the text to be decoded
-     * @return string
-     * @throws RuntimeException
-     */
-    public function base64_string_decode($encoded_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($encoded_string) || ! $this->valid_base_64($encoded_string)) {
-            return $encoded_string;
-        }
-        // decode
-        $decoded_string = base64_decode($encoded_string);
-        if ($decoded_string === false) {
-            throw new RuntimeException(
-                esc_html__('Base 64 decoding failed.', 'event_espresso')
-            );
-        }
-        return $decoded_string;
-    }
-
-
-    /**
-     * encodes  url string with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $text_string the text to be encoded
-     * @return string
-     */
-    public function base64_url_encode($text_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string) || ! $this->_use_base64_encode) {
-            return $text_string;
-        }
-        // encode
-        $encoded_string = base64_encode($text_string);
-        // remove chars to make encoding more URL friendly
-        return strtr($encoded_string, '+/=', '-_,');
-    }
-
-
-    /**
-     * decodes  url string that has been encoded with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $encoded_string the text to be decoded
-     * @return string
-     * @throws RuntimeException
-     */
-    public function base64_url_decode($encoded_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($encoded_string) || ! $this->valid_base_64($encoded_string)) {
-            return $encoded_string;
-        }
-        // replace previously removed characters
-        $encoded_string = strtr($encoded_string, '-_,', '+/=');
-        // decode
-        $decoded_string = base64_decode($encoded_string);
-        if ($decoded_string === false) {
-            throw new RuntimeException(
-                esc_html__('Base 64 decoding failed.', 'event_espresso')
-            );
-        }
-        return $decoded_string;
-    }
-
-
-    /**
-     * encrypts data using PHP's openssl functions
-     *
-     * @param string $text_string the text to be encrypted
-     * @param string $cipher_method
-     * @param string $encryption_key
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function openssl_encrypt(
-        $text_string = '',
-        $cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD,
-        $encryption_key = ''
-    ) {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string)) {
-            return $text_string;
-        }
-        $this->cipher_method = $this->getCipherMethod($cipher_method);
-        // get initialization vector size
-        $iv_size = openssl_cipher_iv_length($this->cipher_method);
-        // generate initialization vector.
-        // The second parameter ("crypto_strong") is passed by reference,
-        // and is used to determines if the algorithm used was "cryptographically strong"
-        // openssl_random_pseudo_bytes() will toggle it to either true or false
-        $iv = openssl_random_pseudo_bytes($iv_size, $is_strong);
-        if ($iv === false || $is_strong === false) {
-            throw new RuntimeException(
-                esc_html__('Failed to generate OpenSSL initialization vector.', 'event_espresso')
-            );
-        }
-        // encrypt it
-        $encrypted_text = openssl_encrypt(
-            $text_string,
-            $this->cipher_method,
-            $this->getDigestHashValue(EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key),
-            0,
-            $iv
-        );
-        // append the initialization vector
-        $encrypted_text .= EE_Encryption::OPENSSL_IV_DELIMITER . $iv;
-        // trim and maybe encode
-        return $this->_use_base64_encode
-            ? trim(base64_encode($encrypted_text))
-            : trim($encrypted_text);
-    }
-
-
-    /**
-     * Returns a cipher method that has been verified to work.
-     * First checks if the cached cipher has been set already and if so, returns that.
-     * Then tests the incoming default and returns that if it's good.
-     * If not, then it retrieves the previously tested and saved cipher method.
-     * But if that doesn't exist, then calls getAvailableCipherMethod()
-     * to see what is available on the server, and returns the results.
-     *
-     * @param string $cipher_method
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function getCipherMethod($cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD)
-    {
-        if ($this->cipher_method !== '') {
-            return $this->cipher_method;
-        }
-        // verify that the default cipher method can produce an initialization vector
-        if (openssl_cipher_iv_length($cipher_method) === false) {
-            // nope? okay let's get what we found in the past to work
-            $cipher_method = get_option(EE_Encryption::OPENSSL_CIPHER_METHOD_OPTION_NAME, '');
-            // oops... haven't tested available cipher methods yet
-            if ($cipher_method === '' || openssl_cipher_iv_length($cipher_method) === false) {
-                $cipher_method = $this->getAvailableCipherMethod($cipher_method);
-            }
-        }
-        return $cipher_method;
-    }
-
-
-    /**
-     * @param string $cipher_method
-     * @return string
-     * @throws \RuntimeException
-     */
-    protected function getAvailableCipherMethod($cipher_method)
-    {
-        // verify that the incoming cipher method can produce an initialization vector
-        if (openssl_cipher_iv_length($cipher_method) === false) {
-            // nope? then check the next cipher in the list of available cipher methods
-            $cipher_method = next($this->cipher_methods);
-            // what? there's no list? then generate that list and cache it,
-            if (empty($this->cipher_methods)) {
-                $this->cipher_methods = openssl_get_cipher_methods();
-                // then grab the first item from the list
-                $cipher_method = reset($this->cipher_methods);
-            }
-            if ($cipher_method === false) {
-                throw new RuntimeException(
-                    esc_html__(
-                        'OpenSSL support appears to be enabled on the server, but no cipher methods are available. Please contact the server administrator.',
-                        'event_espresso'
-                    )
-                );
-            }
-            // verify that the next cipher method works
-            return $this->getAvailableCipherMethod($cipher_method);
-        }
-        // if we've gotten this far, then we found an available cipher method that works
-        // so save that for next time
-        update_option(
-            EE_Encryption::OPENSSL_CIPHER_METHOD_OPTION_NAME,
-            $cipher_method
-        );
-        return $cipher_method;
-    }
-
-
-    /**
-     * decrypts data that has been encrypted with PHP's openssl functions
-     *
-     * @param string $encrypted_text the text to be decrypted
-     * @param string $cipher_method
-     * @param string $encryption_key
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function openssl_decrypt(
-        $encrypted_text = '',
-        $cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD,
-        $encryption_key = ''
-    ) {
-        // you give me nothing??? GET OUT !
-        if (empty($encrypted_text)) {
-            return $encrypted_text;
-        }
-        // decode
-        $encrypted_text = $this->valid_base_64($encrypted_text)
-            ? $this->base64_url_decode($encrypted_text)
-            : $encrypted_text;
-        $encrypted_components = explode(
-            EE_Encryption::OPENSSL_IV_DELIMITER,
-            $encrypted_text,
-            2
-        );
-        // check that iv exists, and if not, maybe text was encoded using mcrypt?
-        if ($this->_use_mcrypt && ! isset($encrypted_components[1])) {
-            return $this->m_decrypt($encrypted_text);
-        }
-        // decrypt it
-        $decrypted_text = openssl_decrypt(
-            $encrypted_components[0],
-            $this->getCipherMethod($cipher_method),
-            $this->getDigestHashValue(EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key),
-            0,
-            $encrypted_components[1]
-        );
-        $decrypted_text = trim($decrypted_text);
-        return $decrypted_text;
-    }
-
-
-    /**
-     * Computes the digest hash value using the specified digest method.
-     * If that digest method fails to produce a valid hash value,
-     * then we'll grab the next digest method and recursively try again until something works.
-     *
-     * @param string $digest_method
-     * @param string $encryption_key
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function getDigestHashValue($digest_method = EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key = '')
-    {
-        $encryption_key = $encryption_key !== ''
-            ? $encryption_key
-            : $this->get_encryption_key();
-        $digest_hash_value = openssl_digest($encryption_key, $digest_method);
-        if ($digest_hash_value === false) {
-            return $this->getDigestHashValue($this->getDigestMethod());
-        }
-        return $digest_hash_value;
-    }
-
-
-    /**
-     * Returns the NEXT element in the $digest_methods array.
-     * If the $digest_methods array is empty, then we populate it
-     * with the available values returned from openssl_get_md_methods().
-     *
-     * @return string
-     * @throws \RuntimeException
-     */
-    protected function getDigestMethod()
-    {
-        $digest_method = prev($this->digest_methods);
-        if (empty($this->digest_methods)) {
-            $this->digest_methods = openssl_get_md_methods();
-            $digest_method = end($this->digest_methods);
-        }
-        if ($digest_method === false) {
-            throw new RuntimeException(
-                esc_html__(
-                    'OpenSSL support appears to be enabled on the server, but no digest methods are available. Please contact the server administrator.',
-                    'event_espresso'
-                )
-            );
-        }
-        return $digest_method;
-    }
-
-
-    /**
-     * encrypts data for acme servers that didn't bother to install PHP mcrypt
-     *
-     * @see http://stackoverflow.com/questions/800922/how-to-encrypt-string-without-mcrypt-library-in-php
-     * @param string $text_string the text to be decrypted
-     * @return string
-     */
-    protected function acme_encrypt($text_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string)) {
-            return $text_string;
-        }
-        $key_bits = str_split(
-            str_pad(
-                '',
-                strlen($text_string),
-                $this->get_encryption_key(),
-                STR_PAD_RIGHT
-            )
-        );
-        $string_bits = str_split($text_string);
-        foreach ($string_bits as $k => $v) {
-            $temp = ord($v) + ord($key_bits[ $k ]);
-            $string_bits[ $k ] = chr($temp > 255 ? ($temp - 256) : $temp);
-        }
-        $encrypted_text = implode('', $string_bits);
-        $encrypted_text .= EE_Encryption::ACME_ENCRYPTION_FLAG;
-        return $this->_use_base64_encode
-            ? base64_encode($encrypted_text)
-            : $encrypted_text;
-    }
-
-
-    /**
-     * decrypts data for acme servers that didn't bother to install PHP mcrypt
-     *
-     * @see http://stackoverflow.com/questions/800922/how-to-encrypt-string-without-mcrypt-library-in-php
-     * @param string $encrypted_text the text to be decrypted
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function acme_decrypt($encrypted_text = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($encrypted_text)) {
-            return $encrypted_text;
-        }
-        // decode the data ?
-        $encrypted_text = $this->valid_base_64($encrypted_text)
-            ? $this->base64_url_decode($encrypted_text)
-            : $encrypted_text;
-        if ($this->_use_mcrypt
-            && strpos($encrypted_text, EE_Encryption::ACME_ENCRYPTION_FLAG) === false
-        ) {
-            return $this->m_decrypt($encrypted_text);
-        }
-        $encrypted_text = substr($encrypted_text, 0, -4);
-        $key_bits = str_split(
-            str_pad(
-                '',
-                strlen($encrypted_text),
-                $this->get_encryption_key(),
-                STR_PAD_RIGHT
-            )
-        );
-        $string_bits = str_split($encrypted_text);
-        foreach ($string_bits as $k => $v) {
-            $temp = ord($v) - ord($key_bits[ $k ]);
-            $string_bits[ $k ] = chr($temp < 0 ? ($temp + 256) : $temp);
-        }
-        return implode('', $string_bits);
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/2556345/detect-base64-encoding-in-php#30231906
-     * @param $string
-     * @return bool
-     */
-    protected function valid_base_64($string)
-    {
-        // ensure data is a string
-        if (! is_string($string) || ! $this->_use_base64_encode) {
-            return false;
-        }
-        $decoded = base64_decode($string, true);
-        // Check if there is no invalid character in string
-        if (! preg_match('/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string)) {
-            return false;
-        }
-        // Decode the string in strict mode and send the response
-        if (! base64_decode($string, true)) {
-            return false;
-        }
-        // Encode and compare it to original one
-        return base64_encode($decoded) === $string;
-    }
-
-
-    /**
-     * generate random string
-     *
-     * @see http://stackoverflow.com/questions/637278/what-is-the-best-way-to-generate-a-random-key-within-php
-     * @param int $length number of characters for random string
-     * @return string
-     */
-    public function generate_random_string($length = 40)
-    {
-        $iterations = ceil($length / 40);
-        $random_string = '';
-        for ($i = 0; $i < $iterations; $i++) {
-            $random_string .= sha1(microtime(true) . mt_rand(10000, 90000));
-        }
-        $random_string = substr($random_string, 0, $length);
-        return $random_string;
-    }
-
-
-    /**
-     * encrypts data using PHP's mcrypt functions
-     *
-     * @deprecated 4.9.39
-     * @param string $text_string
-     * @internal   param $string - the text to be encrypted
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function m_encrypt($text_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string)) {
-            return $text_string;
-        }
-        // get the initialization vector size
-        $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
-        // initialization vector
-        $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
-        if ($iv === false) {
-            throw new RuntimeException(
-                esc_html__('Failed to generate mcrypt initialization vector.', 'event_espresso')
-            );
-        }
-        // encrypt it
-        $encrypted_text = mcrypt_encrypt(
-            MCRYPT_RIJNDAEL_256,
-            $this->get_encryption_key(),
-            $text_string,
-            MCRYPT_MODE_ECB,
-            $iv
-        );
-        // trim and maybe encode
-        return $this->_use_base64_encode
-            ? trim(base64_encode($encrypted_text))
-            : trim($encrypted_text);
-    }
-
-
-    /**
-     * decrypts data that has been encrypted with PHP's mcrypt functions
-     *
-     * @deprecated 4.9.39
-     * @param string $encrypted_text the text to be decrypted
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function m_decrypt($encrypted_text = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($encrypted_text)) {
-            return $encrypted_text;
-        }
-        // decode
-        $encrypted_text = $this->valid_base_64($encrypted_text)
-            ? $this->base64_url_decode($encrypted_text)
-            : $encrypted_text;
-        // get the initialization vector size
-        $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
-        $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
-        if ($iv === false) {
-            throw new RuntimeException(
-                esc_html__('Failed to generate mcrypt initialization vector.', 'event_espresso')
-            );
-        }
-        // decrypt it
-        $decrypted_text = mcrypt_decrypt(
-            MCRYPT_RIJNDAEL_256,
-            $this->get_encryption_key(),
-            $encrypted_text,
-            MCRYPT_MODE_ECB,
-            $iv
-        );
-        $decrypted_text = trim($decrypted_text);
-        return $decrypted_text;
-    }
+	/**
+	 * key used for saving the encryption key to the wp_options table
+	 */
+	const ENCRYPTION_OPTION_KEY = 'ee_encryption_key';
+
+	/**
+	 * the OPENSSL cipher method used
+	 */
+	const OPENSSL_CIPHER_METHOD = 'AES-128-CBC';
+
+	/**
+	 * WP "options_name" used to store a verified available cipher method
+	 */
+	const OPENSSL_CIPHER_METHOD_OPTION_NAME = 'ee_openssl_cipher_method';
+
+	/**
+	 * the OPENSSL digest method used
+	 */
+	const OPENSSL_DIGEST_METHOD = 'sha512';
+
+	/**
+	 * separates the encrypted text from the initialization vector
+	 */
+	const OPENSSL_IV_DELIMITER = ':iv:';
+
+	/**
+	 * appended to text encrypted using the acme encryption
+	 */
+	const ACME_ENCRYPTION_FLAG = '::ae';
+
+
+	/**
+	 * instance of the EE_Encryption object
+	 */
+	protected static $_instance;
+
+	/**
+	 * @var string $_encryption_key
+	 */
+	protected $_encryption_key;
+
+	/**
+	 * @var string $cipher_method
+	 */
+	private $cipher_method = '';
+
+	/**
+	 * @var array $cipher_methods
+	 */
+	private $cipher_methods = array();
+
+	/**
+	 * @var array $digest_methods
+	 */
+	private $digest_methods = array();
+
+	/**
+	 * @var boolean $_use_openssl_encrypt
+	 */
+	protected $_use_openssl_encrypt = false;
+
+	/**
+	 * @var boolean $_use_mcrypt
+	 */
+	protected $_use_mcrypt = false;
+
+	/**
+	 * @var boolean $_use_base64_encode
+	 */
+	protected $_use_base64_encode = false;
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 */
+	protected function __construct()
+	{
+		if (! defined('ESPRESSO_ENCRYPT')) {
+			define('ESPRESSO_ENCRYPT', true);
+		}
+		if (extension_loaded('openssl')) {
+			$this->_use_openssl_encrypt = true;
+		} elseif (extension_loaded('mcrypt')) {
+			$this->_use_mcrypt = true;
+		}
+		if (function_exists('base64_encode')) {
+			$this->_use_base64_encode = true;
+		}
+	}
+
+
+	/**
+	 * singleton method used to instantiate class object
+	 *
+	 * @return EE_Encryption
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! EE_Encryption::$_instance instanceof EE_Encryption) {
+			EE_Encryption::$_instance = new self();
+		}
+		return EE_Encryption::$_instance;
+	}
+
+
+	/**
+	 * get encryption key
+	 *
+	 * @return string
+	 */
+	public function get_encryption_key()
+	{
+		// if encryption key has not been set
+		if (empty($this->_encryption_key)) {
+			// retrieve encryption_key from db
+			$this->_encryption_key = get_option(EE_Encryption::ENCRYPTION_OPTION_KEY, '');
+			// WHAT?? No encryption_key in the db ??
+			if ($this->_encryption_key === '') {
+				// let's make one. And md5 it to make it just the right size for a key
+				$new_key = md5($this->generate_random_string());
+				// now save it to the db for later
+				add_option(EE_Encryption::ENCRYPTION_OPTION_KEY, $new_key);
+				// here's the key - FINALLY !
+				$this->_encryption_key = $new_key;
+			}
+		}
+		return $this->_encryption_key;
+	}
+
+
+	/**
+	 * encrypts data
+	 *
+	 * @param string $text_string - the text to be encrypted
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function encrypt($text_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($text_string)) {
+			return $text_string;
+		}
+		if ($this->_use_openssl_encrypt) {
+			$encrypted_text = $this->openssl_encrypt($text_string);
+		} else {
+			$encrypted_text = $this->acme_encrypt($text_string);
+		}
+		return $encrypted_text;
+	}
+
+
+	/**
+	 * decrypts data
+	 *
+	 * @param string $encrypted_text - the text to be decrypted
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function decrypt($encrypted_text = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($encrypted_text)) {
+			return $encrypted_text;
+		}
+		// if PHP's mcrypt functions are installed then we'll use them
+		if ($this->_use_openssl_encrypt) {
+			$decrypted_text = $this->openssl_decrypt($encrypted_text);
+		} else {
+			$decrypted_text = $this->acme_decrypt($encrypted_text);
+		}
+		return $decrypted_text;
+	}
+
+
+	/**
+	 * encodes string with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $text_string the text to be encoded
+	 * @return string
+	 */
+	public function base64_string_encode($text_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($text_string) || ! $this->_use_base64_encode) {
+			return $text_string;
+		}
+		// encode
+		return base64_encode($text_string);
+	}
+
+
+	/**
+	 * decodes string that has been encoded with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $encoded_string the text to be decoded
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function base64_string_decode($encoded_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($encoded_string) || ! $this->valid_base_64($encoded_string)) {
+			return $encoded_string;
+		}
+		// decode
+		$decoded_string = base64_decode($encoded_string);
+		if ($decoded_string === false) {
+			throw new RuntimeException(
+				esc_html__('Base 64 decoding failed.', 'event_espresso')
+			);
+		}
+		return $decoded_string;
+	}
+
+
+	/**
+	 * encodes  url string with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $text_string the text to be encoded
+	 * @return string
+	 */
+	public function base64_url_encode($text_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($text_string) || ! $this->_use_base64_encode) {
+			return $text_string;
+		}
+		// encode
+		$encoded_string = base64_encode($text_string);
+		// remove chars to make encoding more URL friendly
+		return strtr($encoded_string, '+/=', '-_,');
+	}
+
+
+	/**
+	 * decodes  url string that has been encoded with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $encoded_string the text to be decoded
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function base64_url_decode($encoded_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($encoded_string) || ! $this->valid_base_64($encoded_string)) {
+			return $encoded_string;
+		}
+		// replace previously removed characters
+		$encoded_string = strtr($encoded_string, '-_,', '+/=');
+		// decode
+		$decoded_string = base64_decode($encoded_string);
+		if ($decoded_string === false) {
+			throw new RuntimeException(
+				esc_html__('Base 64 decoding failed.', 'event_espresso')
+			);
+		}
+		return $decoded_string;
+	}
+
+
+	/**
+	 * encrypts data using PHP's openssl functions
+	 *
+	 * @param string $text_string the text to be encrypted
+	 * @param string $cipher_method
+	 * @param string $encryption_key
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function openssl_encrypt(
+		$text_string = '',
+		$cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD,
+		$encryption_key = ''
+	) {
+		// you give me nothing??? GET OUT !
+		if (empty($text_string)) {
+			return $text_string;
+		}
+		$this->cipher_method = $this->getCipherMethod($cipher_method);
+		// get initialization vector size
+		$iv_size = openssl_cipher_iv_length($this->cipher_method);
+		// generate initialization vector.
+		// The second parameter ("crypto_strong") is passed by reference,
+		// and is used to determines if the algorithm used was "cryptographically strong"
+		// openssl_random_pseudo_bytes() will toggle it to either true or false
+		$iv = openssl_random_pseudo_bytes($iv_size, $is_strong);
+		if ($iv === false || $is_strong === false) {
+			throw new RuntimeException(
+				esc_html__('Failed to generate OpenSSL initialization vector.', 'event_espresso')
+			);
+		}
+		// encrypt it
+		$encrypted_text = openssl_encrypt(
+			$text_string,
+			$this->cipher_method,
+			$this->getDigestHashValue(EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key),
+			0,
+			$iv
+		);
+		// append the initialization vector
+		$encrypted_text .= EE_Encryption::OPENSSL_IV_DELIMITER . $iv;
+		// trim and maybe encode
+		return $this->_use_base64_encode
+			? trim(base64_encode($encrypted_text))
+			: trim($encrypted_text);
+	}
+
+
+	/**
+	 * Returns a cipher method that has been verified to work.
+	 * First checks if the cached cipher has been set already and if so, returns that.
+	 * Then tests the incoming default and returns that if it's good.
+	 * If not, then it retrieves the previously tested and saved cipher method.
+	 * But if that doesn't exist, then calls getAvailableCipherMethod()
+	 * to see what is available on the server, and returns the results.
+	 *
+	 * @param string $cipher_method
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function getCipherMethod($cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD)
+	{
+		if ($this->cipher_method !== '') {
+			return $this->cipher_method;
+		}
+		// verify that the default cipher method can produce an initialization vector
+		if (openssl_cipher_iv_length($cipher_method) === false) {
+			// nope? okay let's get what we found in the past to work
+			$cipher_method = get_option(EE_Encryption::OPENSSL_CIPHER_METHOD_OPTION_NAME, '');
+			// oops... haven't tested available cipher methods yet
+			if ($cipher_method === '' || openssl_cipher_iv_length($cipher_method) === false) {
+				$cipher_method = $this->getAvailableCipherMethod($cipher_method);
+			}
+		}
+		return $cipher_method;
+	}
+
+
+	/**
+	 * @param string $cipher_method
+	 * @return string
+	 * @throws \RuntimeException
+	 */
+	protected function getAvailableCipherMethod($cipher_method)
+	{
+		// verify that the incoming cipher method can produce an initialization vector
+		if (openssl_cipher_iv_length($cipher_method) === false) {
+			// nope? then check the next cipher in the list of available cipher methods
+			$cipher_method = next($this->cipher_methods);
+			// what? there's no list? then generate that list and cache it,
+			if (empty($this->cipher_methods)) {
+				$this->cipher_methods = openssl_get_cipher_methods();
+				// then grab the first item from the list
+				$cipher_method = reset($this->cipher_methods);
+			}
+			if ($cipher_method === false) {
+				throw new RuntimeException(
+					esc_html__(
+						'OpenSSL support appears to be enabled on the server, but no cipher methods are available. Please contact the server administrator.',
+						'event_espresso'
+					)
+				);
+			}
+			// verify that the next cipher method works
+			return $this->getAvailableCipherMethod($cipher_method);
+		}
+		// if we've gotten this far, then we found an available cipher method that works
+		// so save that for next time
+		update_option(
+			EE_Encryption::OPENSSL_CIPHER_METHOD_OPTION_NAME,
+			$cipher_method
+		);
+		return $cipher_method;
+	}
+
+
+	/**
+	 * decrypts data that has been encrypted with PHP's openssl functions
+	 *
+	 * @param string $encrypted_text the text to be decrypted
+	 * @param string $cipher_method
+	 * @param string $encryption_key
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function openssl_decrypt(
+		$encrypted_text = '',
+		$cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD,
+		$encryption_key = ''
+	) {
+		// you give me nothing??? GET OUT !
+		if (empty($encrypted_text)) {
+			return $encrypted_text;
+		}
+		// decode
+		$encrypted_text = $this->valid_base_64($encrypted_text)
+			? $this->base64_url_decode($encrypted_text)
+			: $encrypted_text;
+		$encrypted_components = explode(
+			EE_Encryption::OPENSSL_IV_DELIMITER,
+			$encrypted_text,
+			2
+		);
+		// check that iv exists, and if not, maybe text was encoded using mcrypt?
+		if ($this->_use_mcrypt && ! isset($encrypted_components[1])) {
+			return $this->m_decrypt($encrypted_text);
+		}
+		// decrypt it
+		$decrypted_text = openssl_decrypt(
+			$encrypted_components[0],
+			$this->getCipherMethod($cipher_method),
+			$this->getDigestHashValue(EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key),
+			0,
+			$encrypted_components[1]
+		);
+		$decrypted_text = trim($decrypted_text);
+		return $decrypted_text;
+	}
+
+
+	/**
+	 * Computes the digest hash value using the specified digest method.
+	 * If that digest method fails to produce a valid hash value,
+	 * then we'll grab the next digest method and recursively try again until something works.
+	 *
+	 * @param string $digest_method
+	 * @param string $encryption_key
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function getDigestHashValue($digest_method = EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key = '')
+	{
+		$encryption_key = $encryption_key !== ''
+			? $encryption_key
+			: $this->get_encryption_key();
+		$digest_hash_value = openssl_digest($encryption_key, $digest_method);
+		if ($digest_hash_value === false) {
+			return $this->getDigestHashValue($this->getDigestMethod());
+		}
+		return $digest_hash_value;
+	}
+
+
+	/**
+	 * Returns the NEXT element in the $digest_methods array.
+	 * If the $digest_methods array is empty, then we populate it
+	 * with the available values returned from openssl_get_md_methods().
+	 *
+	 * @return string
+	 * @throws \RuntimeException
+	 */
+	protected function getDigestMethod()
+	{
+		$digest_method = prev($this->digest_methods);
+		if (empty($this->digest_methods)) {
+			$this->digest_methods = openssl_get_md_methods();
+			$digest_method = end($this->digest_methods);
+		}
+		if ($digest_method === false) {
+			throw new RuntimeException(
+				esc_html__(
+					'OpenSSL support appears to be enabled on the server, but no digest methods are available. Please contact the server administrator.',
+					'event_espresso'
+				)
+			);
+		}
+		return $digest_method;
+	}
+
+
+	/**
+	 * encrypts data for acme servers that didn't bother to install PHP mcrypt
+	 *
+	 * @see http://stackoverflow.com/questions/800922/how-to-encrypt-string-without-mcrypt-library-in-php
+	 * @param string $text_string the text to be decrypted
+	 * @return string
+	 */
+	protected function acme_encrypt($text_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($text_string)) {
+			return $text_string;
+		}
+		$key_bits = str_split(
+			str_pad(
+				'',
+				strlen($text_string),
+				$this->get_encryption_key(),
+				STR_PAD_RIGHT
+			)
+		);
+		$string_bits = str_split($text_string);
+		foreach ($string_bits as $k => $v) {
+			$temp = ord($v) + ord($key_bits[ $k ]);
+			$string_bits[ $k ] = chr($temp > 255 ? ($temp - 256) : $temp);
+		}
+		$encrypted_text = implode('', $string_bits);
+		$encrypted_text .= EE_Encryption::ACME_ENCRYPTION_FLAG;
+		return $this->_use_base64_encode
+			? base64_encode($encrypted_text)
+			: $encrypted_text;
+	}
+
+
+	/**
+	 * decrypts data for acme servers that didn't bother to install PHP mcrypt
+	 *
+	 * @see http://stackoverflow.com/questions/800922/how-to-encrypt-string-without-mcrypt-library-in-php
+	 * @param string $encrypted_text the text to be decrypted
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function acme_decrypt($encrypted_text = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($encrypted_text)) {
+			return $encrypted_text;
+		}
+		// decode the data ?
+		$encrypted_text = $this->valid_base_64($encrypted_text)
+			? $this->base64_url_decode($encrypted_text)
+			: $encrypted_text;
+		if ($this->_use_mcrypt
+			&& strpos($encrypted_text, EE_Encryption::ACME_ENCRYPTION_FLAG) === false
+		) {
+			return $this->m_decrypt($encrypted_text);
+		}
+		$encrypted_text = substr($encrypted_text, 0, -4);
+		$key_bits = str_split(
+			str_pad(
+				'',
+				strlen($encrypted_text),
+				$this->get_encryption_key(),
+				STR_PAD_RIGHT
+			)
+		);
+		$string_bits = str_split($encrypted_text);
+		foreach ($string_bits as $k => $v) {
+			$temp = ord($v) - ord($key_bits[ $k ]);
+			$string_bits[ $k ] = chr($temp < 0 ? ($temp + 256) : $temp);
+		}
+		return implode('', $string_bits);
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/2556345/detect-base64-encoding-in-php#30231906
+	 * @param $string
+	 * @return bool
+	 */
+	protected function valid_base_64($string)
+	{
+		// ensure data is a string
+		if (! is_string($string) || ! $this->_use_base64_encode) {
+			return false;
+		}
+		$decoded = base64_decode($string, true);
+		// Check if there is no invalid character in string
+		if (! preg_match('/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string)) {
+			return false;
+		}
+		// Decode the string in strict mode and send the response
+		if (! base64_decode($string, true)) {
+			return false;
+		}
+		// Encode and compare it to original one
+		return base64_encode($decoded) === $string;
+	}
+
+
+	/**
+	 * generate random string
+	 *
+	 * @see http://stackoverflow.com/questions/637278/what-is-the-best-way-to-generate-a-random-key-within-php
+	 * @param int $length number of characters for random string
+	 * @return string
+	 */
+	public function generate_random_string($length = 40)
+	{
+		$iterations = ceil($length / 40);
+		$random_string = '';
+		for ($i = 0; $i < $iterations; $i++) {
+			$random_string .= sha1(microtime(true) . mt_rand(10000, 90000));
+		}
+		$random_string = substr($random_string, 0, $length);
+		return $random_string;
+	}
+
+
+	/**
+	 * encrypts data using PHP's mcrypt functions
+	 *
+	 * @deprecated 4.9.39
+	 * @param string $text_string
+	 * @internal   param $string - the text to be encrypted
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function m_encrypt($text_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($text_string)) {
+			return $text_string;
+		}
+		// get the initialization vector size
+		$iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
+		// initialization vector
+		$iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
+		if ($iv === false) {
+			throw new RuntimeException(
+				esc_html__('Failed to generate mcrypt initialization vector.', 'event_espresso')
+			);
+		}
+		// encrypt it
+		$encrypted_text = mcrypt_encrypt(
+			MCRYPT_RIJNDAEL_256,
+			$this->get_encryption_key(),
+			$text_string,
+			MCRYPT_MODE_ECB,
+			$iv
+		);
+		// trim and maybe encode
+		return $this->_use_base64_encode
+			? trim(base64_encode($encrypted_text))
+			: trim($encrypted_text);
+	}
+
+
+	/**
+	 * decrypts data that has been encrypted with PHP's mcrypt functions
+	 *
+	 * @deprecated 4.9.39
+	 * @param string $encrypted_text the text to be decrypted
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function m_decrypt($encrypted_text = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($encrypted_text)) {
+			return $encrypted_text;
+		}
+		// decode
+		$encrypted_text = $this->valid_base_64($encrypted_text)
+			? $this->base64_url_decode($encrypted_text)
+			: $encrypted_text;
+		// get the initialization vector size
+		$iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
+		$iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
+		if ($iv === false) {
+			throw new RuntimeException(
+				esc_html__('Failed to generate mcrypt initialization vector.', 'event_espresso')
+			);
+		}
+		// decrypt it
+		$decrypted_text = mcrypt_decrypt(
+			MCRYPT_RIJNDAEL_256,
+			$this->get_encryption_key(),
+			$encrypted_text,
+			MCRYPT_MODE_ECB,
+			$iv
+		);
+		$decrypted_text = trim($decrypted_text);
+		return $decrypted_text;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -103,7 +103,7 @@ 
      */
     protected function __construct()
     {
-        if (! defined('ESPRESSO_ENCRYPT')) {
+        if ( ! defined('ESPRESSO_ENCRYPT')) {
             define('ESPRESSO_ENCRYPT', true);
         }
         if (extension_loaded('openssl')) {
@@ -125,7 +125,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! EE_Encryption::$_instance instanceof EE_Encryption) {
+        if ( ! EE_Encryption::$_instance instanceof EE_Encryption) {
             EE_Encryption::$_instance = new self();
         }
         return EE_Encryption::$_instance;
@@ -332,7 +332,7 @@ 
             $iv
         );
         // append the initialization vector
-        $encrypted_text .= EE_Encryption::OPENSSL_IV_DELIMITER . $iv;
+        $encrypted_text .= EE_Encryption::OPENSSL_IV_DELIMITER.$iv;
         // trim and maybe encode
         return $this->_use_base64_encode
             ? trim(base64_encode($encrypted_text))
@@ -525,8 +525,8 @@ 
         );
         $string_bits = str_split($text_string);
         foreach ($string_bits as $k => $v) {
-            $temp = ord($v) + ord($key_bits[ $k ]);
-            $string_bits[ $k ] = chr($temp > 255 ? ($temp - 256) : $temp);
+            $temp = ord($v) + ord($key_bits[$k]);
+            $string_bits[$k] = chr($temp > 255 ? ($temp - 256) : $temp);
         }
         $encrypted_text = implode('', $string_bits);
         $encrypted_text .= EE_Encryption::ACME_ENCRYPTION_FLAG;
@@ -570,8 +570,8 @@ 
         );
         $string_bits = str_split($encrypted_text);
         foreach ($string_bits as $k => $v) {
-            $temp = ord($v) - ord($key_bits[ $k ]);
-            $string_bits[ $k ] = chr($temp < 0 ? ($temp + 256) : $temp);
+            $temp = ord($v) - ord($key_bits[$k]);
+            $string_bits[$k] = chr($temp < 0 ? ($temp + 256) : $temp);
         }
         return implode('', $string_bits);
     }
@@ -585,16 +585,16 @@ 
     protected function valid_base_64($string)
     {
         // ensure data is a string
-        if (! is_string($string) || ! $this->_use_base64_encode) {
+        if ( ! is_string($string) || ! $this->_use_base64_encode) {
             return false;
         }
         $decoded = base64_decode($string, true);
         // Check if there is no invalid character in string
-        if (! preg_match('/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string)) {
+        if ( ! preg_match('/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string)) {
             return false;
         }
         // Decode the string in strict mode and send the response
-        if (! base64_decode($string, true)) {
+        if ( ! base64_decode($string, true)) {
             return false;
         }
         // Encode and compare it to original one
@@ -614,7 +614,7 @@ 
         $iterations = ceil($length / 40);
         $random_string = '';
         for ($i = 0; $i < $iterations; $i++) {
-            $random_string .= sha1(microtime(true) . mt_rand(10000, 90000));
+            $random_string .= sha1(microtime(true).mt_rand(10000, 90000));
         }
         $random_string = substr($random_string, 0, $length);
         return $random_string;

core/libraries/form_sections/form_handlers/SequentialStepFormManager.php

Doc Comments +2 added lines, -2 removed lines

@@ -203,7 +203,7 @@ 
 
 
     /**
-     * @param $default_form_step
+     * @param string $default_form_step
      * @throws InvalidDataTypeException
      */
     protected function setDefaultFormStep($default_form_step)
@@ -242,7 +242,7 @@ 
 
 
     /**
-     * @return object|SequentialStepFormInterface
+     * @return SequentialStepForm
      * @throws InvalidFormHandlerException
      */
     public function getCurrentStep()

Spacing +12 added lines, -12 removed lines

@@ -141,7 +141,7 @@ 
      */
     protected function setBaseUrl($base_url)
     {
-        if (! is_string($base_url)) {
+        if ( ! is_string($base_url)) {
             throw new InvalidDataTypeException('$base_url', $base_url, 'string');
         }
         if (empty($base_url)) {
@@ -172,7 +172,7 @@ 
      */
     public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
     {
-        if (! is_string($form_step_url_key)) {
+        if ( ! is_string($form_step_url_key)) {
             throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
         }
         $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
@@ -194,7 +194,7 @@ 
      */
     protected function setDefaultFormStep($default_form_step)
     {
-        if (! is_string($default_form_step)) {
+        if ( ! is_string($default_form_step)) {
             throw new InvalidDataTypeException('$default_form_step', $default_form_step, 'string');
         }
         $this->default_form_step = $default_form_step;
@@ -209,7 +209,7 @@ 
     protected function setCurrentStepFromRequest()
     {
         $current_step_slug = $this->request()->get($this->formStepUrlKey(), $this->defaultFormStep());
-        if (! $this->form_steps->setCurrent($current_step_slug)) {
+        if ( ! $this->form_steps->setCurrent($current_step_slug)) {
             throw new InvalidIdentifierException(
                 $current_step_slug,
                 $this->defaultFormStep(),
@@ -231,7 +231,7 @@ 
      */
     public function getCurrentStep()
     {
-        if (! $this->form_steps->current() instanceof SequentialStepForm) {
+        if ( ! $this->form_steps->current() instanceof SequentialStepForm) {
             throw new InvalidFormHandlerException($this->form_steps->current());
         }
         return $this->form_steps->current();
@@ -244,7 +244,7 @@ 
      */
     public function formAction()
     {
-        if (! is_string($this->form_action) || empty($this->form_action)) {
+        if ( ! is_string($this->form_action) || empty($this->form_action)) {
             $this->form_action = $this->baseUrl();
         }
         return $this->form_action;
@@ -257,7 +257,7 @@ 
      */
     public function setFormAction($form_action)
     {
-        if (! is_string($form_action)) {
+        if ( ! is_string($form_action)) {
             throw new InvalidDataTypeException('$form_action', $form_action, 'string');
         }
         $this->form_action = $form_action;
@@ -271,7 +271,7 @@ 
      */
     public function addFormActionArgs($form_action_args = array())
     {
-        if (! is_array($form_action_args)) {
+        if ( ! is_array($form_action_args)) {
             throw new InvalidDataTypeException('$form_action_args', $form_action_args, 'array');
         }
         $form_action_args = ! empty($form_action_args)
@@ -336,7 +336,7 @@ 
     protected function getProgressStepsCollection()
     {
         static $collection = null;
-        if (! $collection instanceof ProgressStepCollection) {
+        if ( ! $collection instanceof ProgressStepCollection) {
             $collection = new ProgressStepCollection();
         }
         return $collection;
@@ -358,7 +358,7 @@ 
         /** @var SequentialStepForm $form_step */
         foreach ($this->form_steps as $form_step) {
             // is this step active ?
-            if (! $form_step->initialize()) {
+            if ( ! $form_step->initialize()) {
                 continue;
             }
             $progress_steps_collection->add(
@@ -427,7 +427,7 @@ 
     {
         $form_step = $this->buildCurrentStepForm();
         // no displayable content ? then skip straight to processing
-        if (! $form_step->displayable()) {
+        if ( ! $form_step->displayable()) {
             $this->addFormActionArgs();
             $form_step->setFormAction($this->formAction());
             wp_safe_redirect($form_step->formAction());
@@ -503,7 +503,7 @@ 
     public function displayProgressSteps($return_as_string = true)
     {
         $form_step = $this->getCurrentStep();
-        if (! $form_step->displayable()) {
+        if ( ! $form_step->displayable()) {
             return '';
         }
         $progress_steps = apply_filters(

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use EE_Error;
 use EE_Request;
-use EventEspresso\core\exceptions\ExceptionStackTraceDisplay;
 use EventEspresso\core\exceptions\InvalidClassException;
 use EventEspresso\core\exceptions\InvalidDataTypeException;
 use EventEspresso\core\exceptions\InvalidEntityException;

Indentation +580 added lines, -580 removed lines

@@ -29,584 +29,584 @@
 abstract class SequentialStepFormManager
 {
 
-    /**
-     * a simplified URL with no form related parameters
-     * that will be used to build the form's redirect URLs
-     *
-     * @var string $base_url
-     */
-    private $base_url = '';
-
-    /**
-     * the key used for the URL param that denotes the current form step
-     * defaults to 'ee-form-step'
-     *
-     * @var string $form_step_url_key
-     */
-    private $form_step_url_key = '';
-
-    /**
-     * @var string $default_form_step
-     */
-    private $default_form_step = '';
-
-    /**
-     * @var string $form_action
-     */
-    private $form_action;
-
-    /**
-     * value of one of the string constant above
-     *
-     * @var string $form_config
-     */
-    private $form_config;
-
-    /**
-     * @var string $progress_step_style
-     */
-    private $progress_step_style = '';
-
-    /**
-     * @var EE_Request $request
-     */
-    private $request;
-
-    /**
-     * @var Collection $form_steps
-     */
-    protected $form_steps;
-
-    /**
-     * @var ProgressStepManager $progress_step_manager
-     */
-    protected $progress_step_manager;
-
-
-    /**
-     * @return Collection|null
-     */
-    abstract protected function getFormStepsCollection();
-
-    // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
-    /**
-     * StepsManager constructor
-     *
-     * @param string     $base_url
-     * @param string     $default_form_step
-     * @param string     $form_action
-     * @param string     $form_config
-     * @param EE_Request $request
-     * @param string     $progress_step_style
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $base_url,
-        $default_form_step,
-        $form_action = '',
-        $form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-        $progress_step_style = 'number_bubbles',
-        EE_Request $request
-    ) {
-        $this->setBaseUrl($base_url);
-        $this->setDefaultFormStep($default_form_step);
-        $this->setFormAction($form_action);
-        $this->setFormConfig($form_config);
-        $this->setProgressStepStyle($progress_step_style);
-        $this->request = $request;
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function baseUrl()
-    {
-        if (strpos($this->base_url, $this->getCurrentStep()->slug()) === false) {
-            add_query_arg(
-                array($this->form_step_url_key => $this->getCurrentStep()->slug()),
-                $this->base_url
-            );
-        }
-        return $this->base_url;
-    }
-
-
-    /**
-     * @param string $base_url
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function setBaseUrl($base_url)
-    {
-        if (! is_string($base_url)) {
-            throw new InvalidDataTypeException('$base_url', $base_url, 'string');
-        }
-        if (empty($base_url)) {
-            throw new InvalidArgumentException(
-                esc_html__('The base URL can not be an empty string.', 'event_espresso')
-            );
-        }
-        $this->base_url = $base_url;
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidDataTypeException
-     */
-    public function formStepUrlKey()
-    {
-        if (empty($this->form_step_url_key)) {
-            $this->setFormStepUrlKey();
-        }
-        return $this->form_step_url_key;
-    }
-
-
-    /**
-     * @param string $form_step_url_key
-     * @throws InvalidDataTypeException
-     */
-    public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
-    {
-        if (! is_string($form_step_url_key)) {
-            throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
-        }
-        $this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function defaultFormStep()
-    {
-        return $this->default_form_step;
-    }
-
-
-    /**
-     * @param $default_form_step
-     * @throws InvalidDataTypeException
-     */
-    protected function setDefaultFormStep($default_form_step)
-    {
-        if (! is_string($default_form_step)) {
-            throw new InvalidDataTypeException('$default_form_step', $default_form_step, 'string');
-        }
-        $this->default_form_step = $default_form_step;
-    }
-
-
-    /**
-     * @return void
-     * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
-     * @throws InvalidDataTypeException
-     */
-    protected function setCurrentStepFromRequest()
-    {
-        $current_step_slug = $this->request()->get($this->formStepUrlKey(), $this->defaultFormStep());
-        if (! $this->form_steps->setCurrent($current_step_slug)) {
-            throw new InvalidIdentifierException(
-                $current_step_slug,
-                $this->defaultFormStep(),
-                $message = sprintf(
-                    esc_html__(
-                        'The "%1$s" form step could not be set.',
-                        'event_espresso'
-                    ),
-                    $current_step_slug
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return object|SequentialStepFormInterface
-     * @throws InvalidFormHandlerException
-     */
-    public function getCurrentStep()
-    {
-        if (! $this->form_steps->current() instanceof SequentialStepForm) {
-            throw new InvalidFormHandlerException($this->form_steps->current());
-        }
-        return $this->form_steps->current();
-    }
-
-
-    /**
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function formAction()
-    {
-        if (! is_string($this->form_action) || empty($this->form_action)) {
-            $this->form_action = $this->baseUrl();
-        }
-        return $this->form_action;
-    }
-
-
-    /**
-     * @param string $form_action
-     * @throws InvalidDataTypeException
-     */
-    public function setFormAction($form_action)
-    {
-        if (! is_string($form_action)) {
-            throw new InvalidDataTypeException('$form_action', $form_action, 'string');
-        }
-        $this->form_action = $form_action;
-    }
-
-
-    /**
-     * @param array $form_action_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function addFormActionArgs($form_action_args = array())
-    {
-        if (! is_array($form_action_args)) {
-            throw new InvalidDataTypeException('$form_action_args', $form_action_args, 'array');
-        }
-        $form_action_args = ! empty($form_action_args)
-            ? $form_action_args
-            : array($this->formStepUrlKey() => $this->form_steps->current()->slug());
-        $this->getCurrentStep()->setFormAction(
-            add_query_arg($form_action_args, $this->formAction())
-        );
-        $this->form_action = $this->getCurrentStep()->formAction();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formConfig()
-    {
-        return $this->form_config;
-    }
-
-
-    /**
-     * @param string $form_config
-     */
-    public function setFormConfig($form_config)
-    {
-        $this->form_config = $form_config;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function progressStepStyle()
-    {
-        return $this->progress_step_style;
-    }
-
-
-    /**
-     * @param string $progress_step_style
-     */
-    public function setProgressStepStyle($progress_step_style)
-    {
-        $this->progress_step_style = $progress_step_style;
-    }
-
-
-    /**
-     * @return EE_Request
-     */
-    public function request()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @return Collection|null
-     * @throws InvalidInterfaceException
-     */
-    protected function getProgressStepsCollection()
-    {
-        static $collection = null;
-        if (! $collection instanceof ProgressStepCollection) {
-            $collection = new ProgressStepCollection();
-        }
-        return $collection;
-    }
-
-
-    /**
-     * @param Collection $progress_steps_collection
-     * @return ProgressStepManager
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     */
-    protected function generateProgressSteps(Collection $progress_steps_collection)
-    {
-        $current_step = $this->getCurrentStep();
-        /** @var SequentialStepForm $form_step */
-        foreach ($this->form_steps as $form_step) {
-            // is this step active ?
-            if (! $form_step->initialize()) {
-                continue;
-            }
-            $progress_steps_collection->add(
-                new ProgressStep(
-                    $form_step->order(),
-                    $form_step->slug(),
-                    $form_step->slug(),
-                    $form_step->formName()
-                ),
-                $form_step->slug()
-            );
-        }
-        // set collection pointer back to current step
-        $this->form_steps->setCurrentUsingObject($current_step);
-        return new ProgressStepManager(
-            $this->progressStepStyle(),
-            $this->defaultFormStep(),
-            $this->formStepUrlKey(),
-            $progress_steps_collection
-        );
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildForm()
-    {
-        $this->buildCurrentStepFormForDisplay();
-    }
-
-
-    /**
-     * @param array $form_data
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    public function processForm($form_data = array())
-    {
-        $this->buildCurrentStepFormForProcessing();
-        $this->processCurrentStepForm($form_data);
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildCurrentStepFormForDisplay()
-    {
-        $form_step = $this->buildCurrentStepForm();
-        // no displayable content ? then skip straight to processing
-        if (! $form_step->displayable()) {
-            $this->addFormActionArgs();
-            $form_step->setFormAction($this->formAction());
-            wp_safe_redirect($form_step->formAction());
-        }
-    }
-
-
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidFormHandlerException
-     */
-    public function buildCurrentStepFormForProcessing()
-    {
-        $this->buildCurrentStepForm(false);
-    }
-
-
-    /**
-     * @param bool $for_display
-     * @return SequentialStepFormInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidFormHandlerException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    private function buildCurrentStepForm($for_display = true)
-    {
-        $this->form_steps = $this->getFormStepsCollection();
-        $this->setCurrentStepFromRequest();
-        $form_step = $this->getCurrentStep();
-        if ($form_step->submitBtnText() === esc_html__('Submit', 'event_espresso')) {
-            $form_step->setSubmitBtnText(esc_html__('Next Step', 'event_espresso'));
-        }
-        if ($for_display && $form_step->displayable()) {
-            $this->progress_step_manager = $this->generateProgressSteps(
-                $this->getProgressStepsCollection()
-            );
-            $this->progress_step_manager->setCurrentStep(
-                $form_step->slug()
-            );
-            // mark all previous progress steps as completed
-            $this->progress_step_manager->setPreviousStepsCompleted();
-            $this->progress_step_manager->enqueueStylesAndScripts();
-            $this->addFormActionArgs();
-            $form_step->setFormAction($this->formAction());
-        } else {
-            $form_step->setRedirectUrl($this->baseUrl());
-            $form_step->addRedirectArgs(
-                array($this->formStepUrlKey() => $this->form_steps->current()->slug())
-            );
-        }
-        $form_step->generate();
-        if ($for_display) {
-            $form_step->enqueueStylesAndScripts();
-        }
-        return $form_step;
-    }
-
-
-    /**
-     * @param bool $return_as_string
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function displayProgressSteps($return_as_string = true)
-    {
-        $form_step = $this->getCurrentStep();
-        if (! $form_step->displayable()) {
-            return '';
-        }
-        $progress_steps = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__before_steps',
-            ''
-        );
-        $progress_steps .= $this->progress_step_manager->displaySteps();
-        $progress_steps .= apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__after_steps',
-            ''
-        );
-        if ($return_as_string) {
-            return $progress_steps;
-        }
-        echo $progress_steps;
-        return '';
-    }
-
-
-    /**
-     * @param bool $return_as_string
-     * @return string
-     * @throws InvalidFormHandlerException
-     */
-    public function displayCurrentStepForm($return_as_string = true)
-    {
-        if ($return_as_string) {
-            return $this->getCurrentStep()->display();
-        }
-        echo $this->getCurrentStep()->display();
-        return '';
-    }
-
-
-    /**
-     * @param array $form_data
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function processCurrentStepForm($form_data = array())
-    {
-        // grab instance of current step because after calling next() below,
-        // any calls to getCurrentStep() will return the "next" step because we advanced
-        $current_step = $this->getCurrentStep();
-        try {
-            // form processing should either throw exceptions or return true
-            $current_step->process($form_data);
-        } catch (Exception $e) {
-            // something went wrong, convert the Exception to an EE_Error
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            // prevent redirect to next step or other if exception was thrown
-            if ($current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_NEXT_STEP
-                || $current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_OTHER
-            ) {
-                $current_step->setRedirectTo(SequentialStepForm::REDIRECT_TO_CURRENT_STEP);
-            }
-        }
-        // save notices to a transient so that when we redirect back
-        // to the display portion for this step
-        // those notices can be displayed
-        EE_Error::get_notices(false, true);
-        $this->redirectForm($current_step);
-    }
-
-
-    /**
-     * handles where to go to next
-     *
-     * @param SequentialStepFormInterface $current_step
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormHandlerException
-     */
-    public function redirectForm(SequentialStepFormInterface $current_step)
-    {
-        $redirect_step = $current_step;
-        switch ($current_step->redirectTo()) {
-            case SequentialStepForm::REDIRECT_TO_OTHER:
-                // going somewhere else, so just check out now
-                wp_safe_redirect($redirect_step->redirectUrl());
-                exit();
-                break;
-            case SequentialStepForm::REDIRECT_TO_PREV_STEP:
-                $redirect_step = $this->form_steps->previous();
-                break;
-            case SequentialStepForm::REDIRECT_TO_NEXT_STEP:
-                $this->form_steps->next();
-                if ($this->form_steps->valid()) {
-                    $redirect_step = $this->form_steps->current();
-                }
-                break;
-            case SequentialStepForm::REDIRECT_TO_CURRENT_STEP:
-            default:
-                // $redirect_step is already set
-        }
-        $current_step->setRedirectUrl($this->baseUrl());
-        $current_step->addRedirectArgs(
-            // use the slug for whatever step we are redirecting too
-            array($this->formStepUrlKey() => $redirect_step->slug())
-        );
-        wp_safe_redirect($current_step->redirectUrl());
-        exit();
-    }
+	/**
+	 * a simplified URL with no form related parameters
+	 * that will be used to build the form's redirect URLs
+	 *
+	 * @var string $base_url
+	 */
+	private $base_url = '';
+
+	/**
+	 * the key used for the URL param that denotes the current form step
+	 * defaults to 'ee-form-step'
+	 *
+	 * @var string $form_step_url_key
+	 */
+	private $form_step_url_key = '';
+
+	/**
+	 * @var string $default_form_step
+	 */
+	private $default_form_step = '';
+
+	/**
+	 * @var string $form_action
+	 */
+	private $form_action;
+
+	/**
+	 * value of one of the string constant above
+	 *
+	 * @var string $form_config
+	 */
+	private $form_config;
+
+	/**
+	 * @var string $progress_step_style
+	 */
+	private $progress_step_style = '';
+
+	/**
+	 * @var EE_Request $request
+	 */
+	private $request;
+
+	/**
+	 * @var Collection $form_steps
+	 */
+	protected $form_steps;
+
+	/**
+	 * @var ProgressStepManager $progress_step_manager
+	 */
+	protected $progress_step_manager;
+
+
+	/**
+	 * @return Collection|null
+	 */
+	abstract protected function getFormStepsCollection();
+
+	// phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
+	/**
+	 * StepsManager constructor
+	 *
+	 * @param string     $base_url
+	 * @param string     $default_form_step
+	 * @param string     $form_action
+	 * @param string     $form_config
+	 * @param EE_Request $request
+	 * @param string     $progress_step_style
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$base_url,
+		$default_form_step,
+		$form_action = '',
+		$form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+		$progress_step_style = 'number_bubbles',
+		EE_Request $request
+	) {
+		$this->setBaseUrl($base_url);
+		$this->setDefaultFormStep($default_form_step);
+		$this->setFormAction($form_action);
+		$this->setFormConfig($form_config);
+		$this->setProgressStepStyle($progress_step_style);
+		$this->request = $request;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function baseUrl()
+	{
+		if (strpos($this->base_url, $this->getCurrentStep()->slug()) === false) {
+			add_query_arg(
+				array($this->form_step_url_key => $this->getCurrentStep()->slug()),
+				$this->base_url
+			);
+		}
+		return $this->base_url;
+	}
+
+
+	/**
+	 * @param string $base_url
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function setBaseUrl($base_url)
+	{
+		if (! is_string($base_url)) {
+			throw new InvalidDataTypeException('$base_url', $base_url, 'string');
+		}
+		if (empty($base_url)) {
+			throw new InvalidArgumentException(
+				esc_html__('The base URL can not be an empty string.', 'event_espresso')
+			);
+		}
+		$this->base_url = $base_url;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidDataTypeException
+	 */
+	public function formStepUrlKey()
+	{
+		if (empty($this->form_step_url_key)) {
+			$this->setFormStepUrlKey();
+		}
+		return $this->form_step_url_key;
+	}
+
+
+	/**
+	 * @param string $form_step_url_key
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormStepUrlKey($form_step_url_key = 'ee-form-step')
+	{
+		if (! is_string($form_step_url_key)) {
+			throw new InvalidDataTypeException('$form_step_key', $form_step_url_key, 'string');
+		}
+		$this->form_step_url_key = ! empty($form_step_url_key) ? $form_step_url_key : 'ee-form-step';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function defaultFormStep()
+	{
+		return $this->default_form_step;
+	}
+
+
+	/**
+	 * @param $default_form_step
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setDefaultFormStep($default_form_step)
+	{
+		if (! is_string($default_form_step)) {
+			throw new InvalidDataTypeException('$default_form_step', $default_form_step, 'string');
+		}
+		$this->default_form_step = $default_form_step;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setCurrentStepFromRequest()
+	{
+		$current_step_slug = $this->request()->get($this->formStepUrlKey(), $this->defaultFormStep());
+		if (! $this->form_steps->setCurrent($current_step_slug)) {
+			throw new InvalidIdentifierException(
+				$current_step_slug,
+				$this->defaultFormStep(),
+				$message = sprintf(
+					esc_html__(
+						'The "%1$s" form step could not be set.',
+						'event_espresso'
+					),
+					$current_step_slug
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return object|SequentialStepFormInterface
+	 * @throws InvalidFormHandlerException
+	 */
+	public function getCurrentStep()
+	{
+		if (! $this->form_steps->current() instanceof SequentialStepForm) {
+			throw new InvalidFormHandlerException($this->form_steps->current());
+		}
+		return $this->form_steps->current();
+	}
+
+
+	/**
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function formAction()
+	{
+		if (! is_string($this->form_action) || empty($this->form_action)) {
+			$this->form_action = $this->baseUrl();
+		}
+		return $this->form_action;
+	}
+
+
+	/**
+	 * @param string $form_action
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormAction($form_action)
+	{
+		if (! is_string($form_action)) {
+			throw new InvalidDataTypeException('$form_action', $form_action, 'string');
+		}
+		$this->form_action = $form_action;
+	}
+
+
+	/**
+	 * @param array $form_action_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function addFormActionArgs($form_action_args = array())
+	{
+		if (! is_array($form_action_args)) {
+			throw new InvalidDataTypeException('$form_action_args', $form_action_args, 'array');
+		}
+		$form_action_args = ! empty($form_action_args)
+			? $form_action_args
+			: array($this->formStepUrlKey() => $this->form_steps->current()->slug());
+		$this->getCurrentStep()->setFormAction(
+			add_query_arg($form_action_args, $this->formAction())
+		);
+		$this->form_action = $this->getCurrentStep()->formAction();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formConfig()
+	{
+		return $this->form_config;
+	}
+
+
+	/**
+	 * @param string $form_config
+	 */
+	public function setFormConfig($form_config)
+	{
+		$this->form_config = $form_config;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function progressStepStyle()
+	{
+		return $this->progress_step_style;
+	}
+
+
+	/**
+	 * @param string $progress_step_style
+	 */
+	public function setProgressStepStyle($progress_step_style)
+	{
+		$this->progress_step_style = $progress_step_style;
+	}
+
+
+	/**
+	 * @return EE_Request
+	 */
+	public function request()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @return Collection|null
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getProgressStepsCollection()
+	{
+		static $collection = null;
+		if (! $collection instanceof ProgressStepCollection) {
+			$collection = new ProgressStepCollection();
+		}
+		return $collection;
+	}
+
+
+	/**
+	 * @param Collection $progress_steps_collection
+	 * @return ProgressStepManager
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 */
+	protected function generateProgressSteps(Collection $progress_steps_collection)
+	{
+		$current_step = $this->getCurrentStep();
+		/** @var SequentialStepForm $form_step */
+		foreach ($this->form_steps as $form_step) {
+			// is this step active ?
+			if (! $form_step->initialize()) {
+				continue;
+			}
+			$progress_steps_collection->add(
+				new ProgressStep(
+					$form_step->order(),
+					$form_step->slug(),
+					$form_step->slug(),
+					$form_step->formName()
+				),
+				$form_step->slug()
+			);
+		}
+		// set collection pointer back to current step
+		$this->form_steps->setCurrentUsingObject($current_step);
+		return new ProgressStepManager(
+			$this->progressStepStyle(),
+			$this->defaultFormStep(),
+			$this->formStepUrlKey(),
+			$progress_steps_collection
+		);
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildForm()
+	{
+		$this->buildCurrentStepFormForDisplay();
+	}
+
+
+	/**
+	 * @param array $form_data
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	public function processForm($form_data = array())
+	{
+		$this->buildCurrentStepFormForProcessing();
+		$this->processCurrentStepForm($form_data);
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildCurrentStepFormForDisplay()
+	{
+		$form_step = $this->buildCurrentStepForm();
+		// no displayable content ? then skip straight to processing
+		if (! $form_step->displayable()) {
+			$this->addFormActionArgs();
+			$form_step->setFormAction($this->formAction());
+			wp_safe_redirect($form_step->formAction());
+		}
+	}
+
+
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function buildCurrentStepFormForProcessing()
+	{
+		$this->buildCurrentStepForm(false);
+	}
+
+
+	/**
+	 * @param bool $for_display
+	 * @return SequentialStepFormInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidFormHandlerException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	private function buildCurrentStepForm($for_display = true)
+	{
+		$this->form_steps = $this->getFormStepsCollection();
+		$this->setCurrentStepFromRequest();
+		$form_step = $this->getCurrentStep();
+		if ($form_step->submitBtnText() === esc_html__('Submit', 'event_espresso')) {
+			$form_step->setSubmitBtnText(esc_html__('Next Step', 'event_espresso'));
+		}
+		if ($for_display && $form_step->displayable()) {
+			$this->progress_step_manager = $this->generateProgressSteps(
+				$this->getProgressStepsCollection()
+			);
+			$this->progress_step_manager->setCurrentStep(
+				$form_step->slug()
+			);
+			// mark all previous progress steps as completed
+			$this->progress_step_manager->setPreviousStepsCompleted();
+			$this->progress_step_manager->enqueueStylesAndScripts();
+			$this->addFormActionArgs();
+			$form_step->setFormAction($this->formAction());
+		} else {
+			$form_step->setRedirectUrl($this->baseUrl());
+			$form_step->addRedirectArgs(
+				array($this->formStepUrlKey() => $this->form_steps->current()->slug())
+			);
+		}
+		$form_step->generate();
+		if ($for_display) {
+			$form_step->enqueueStylesAndScripts();
+		}
+		return $form_step;
+	}
+
+
+	/**
+	 * @param bool $return_as_string
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function displayProgressSteps($return_as_string = true)
+	{
+		$form_step = $this->getCurrentStep();
+		if (! $form_step->displayable()) {
+			return '';
+		}
+		$progress_steps = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__before_steps',
+			''
+		);
+		$progress_steps .= $this->progress_step_manager->displaySteps();
+		$progress_steps .= apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_SequentialStepFormManager__displayProgressSteps__after_steps',
+			''
+		);
+		if ($return_as_string) {
+			return $progress_steps;
+		}
+		echo $progress_steps;
+		return '';
+	}
+
+
+	/**
+	 * @param bool $return_as_string
+	 * @return string
+	 * @throws InvalidFormHandlerException
+	 */
+	public function displayCurrentStepForm($return_as_string = true)
+	{
+		if ($return_as_string) {
+			return $this->getCurrentStep()->display();
+		}
+		echo $this->getCurrentStep()->display();
+		return '';
+	}
+
+
+	/**
+	 * @param array $form_data
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function processCurrentStepForm($form_data = array())
+	{
+		// grab instance of current step because after calling next() below,
+		// any calls to getCurrentStep() will return the "next" step because we advanced
+		$current_step = $this->getCurrentStep();
+		try {
+			// form processing should either throw exceptions or return true
+			$current_step->process($form_data);
+		} catch (Exception $e) {
+			// something went wrong, convert the Exception to an EE_Error
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			// prevent redirect to next step or other if exception was thrown
+			if ($current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_NEXT_STEP
+				|| $current_step->redirectTo() === SequentialStepForm::REDIRECT_TO_OTHER
+			) {
+				$current_step->setRedirectTo(SequentialStepForm::REDIRECT_TO_CURRENT_STEP);
+			}
+		}
+		// save notices to a transient so that when we redirect back
+		// to the display portion for this step
+		// those notices can be displayed
+		EE_Error::get_notices(false, true);
+		$this->redirectForm($current_step);
+	}
+
+
+	/**
+	 * handles where to go to next
+	 *
+	 * @param SequentialStepFormInterface $current_step
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormHandlerException
+	 */
+	public function redirectForm(SequentialStepFormInterface $current_step)
+	{
+		$redirect_step = $current_step;
+		switch ($current_step->redirectTo()) {
+			case SequentialStepForm::REDIRECT_TO_OTHER:
+				// going somewhere else, so just check out now
+				wp_safe_redirect($redirect_step->redirectUrl());
+				exit();
+				break;
+			case SequentialStepForm::REDIRECT_TO_PREV_STEP:
+				$redirect_step = $this->form_steps->previous();
+				break;
+			case SequentialStepForm::REDIRECT_TO_NEXT_STEP:
+				$this->form_steps->next();
+				if ($this->form_steps->valid()) {
+					$redirect_step = $this->form_steps->current();
+				}
+				break;
+			case SequentialStepForm::REDIRECT_TO_CURRENT_STEP:
+			default:
+				// $redirect_step is already set
+		}
+		$current_step->setRedirectUrl($this->baseUrl());
+		$current_step->addRedirectArgs(
+			// use the slug for whatever step we are redirecting too
+			array($this->formStepUrlKey() => $redirect_step->slug())
+		);
+		wp_safe_redirect($current_step->redirectUrl());
+		exit();
+	}
 }

acceptance_tests/Helpers/TicketSelector.php

Doc Comments +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
     /**
      * Use to select a quantity from the first ticket for the given event (so this can be used on a event archive page).
      * @param int|string $event_id
-     * @param int|string $quantity
+     * @param integer $quantity
      */
     public function selectQuantityOfFirstTicketForEventId($event_id, $quantity = 1)
     {

Indentation +17 added lines, -17 removed lines

@@ -12,23 +12,23 @@
 trait TicketSelector
 {
 
-    /**
-     * Use to select a quantity from the first ticket for the given event (so this can be used on a event archive page).
-     * @param int|string $event_id
-     * @param int|string $quantity
-     */
-    public function selectQuantityOfFirstTicketForEventId($event_id, $quantity = 1)
-    {
-        $this->actor()->selectOption(TicketSelectorElements::ticketOptionByEventIdSelector($event_id), $quantity);
-    }
+	/**
+	 * Use to select a quantity from the first ticket for the given event (so this can be used on a event archive page).
+	 * @param int|string $event_id
+	 * @param int|string $quantity
+	 */
+	public function selectQuantityOfFirstTicketForEventId($event_id, $quantity = 1)
+	{
+		$this->actor()->selectOption(TicketSelectorElements::ticketOptionByEventIdSelector($event_id), $quantity);
+	}
 
 
-    /**
-     * Used to submit the ticket selection for the given event id (so this can be used on an event archive page).
-     * @param int|string $event_id
-     */
-    public function submitTicketSelectionsForEventId($event_id)
-    {
-        $this->actor()->click(TicketSelectorElements::ticketSelectionSubmitSelectorByEventId($event_id));
-    }
+	/**
+	 * Used to submit the ticket selection for the given event id (so this can be used on an event archive page).
+	 * @param int|string $event_id
+	 */
+	public function submitTicketSelectionsForEventId($event_id)
+	{
+		$this->actor()->click(TicketSelectorElements::ticketSelectionSubmitSelectorByEventId($event_id));
+	}
 }
\ No newline at end of file

acceptance_tests/Page/MessagesAdmin.php

Spacing +2 added lines, -2 removed lines

@@ -103,8 +103,8 @@
     public static function editMessageTemplateClassByMessageType($message_type_slug, $context = '')
     {
         return $context
-            ? '.' . $message_type_slug . '-' . $context . '-edit-link'
-            : '.' . $message_type_slug . '-edit-link';
+            ? '.'.$message_type_slug.'-'.$context.'-edit-link'
+            : '.'.$message_type_slug.'-edit-link';
     }
 
 

Indentation +267 added lines, -267 removed lines

@@ -14,292 +14,292 @@
 class MessagesAdmin extends CoreAdmin
 {
 
-    /**
-     * Context slug for the admin messages context.
-     */
-    const ADMIN_CONTEXT_SLUG = 'admin';
+	/**
+	 * Context slug for the admin messages context.
+	 */
+	const ADMIN_CONTEXT_SLUG = 'admin';
 
-    /**
-     * Context slug for the primary attendee messages context
-     */
-    const PRIMARY_ATTENDEE_CONTEXT_SLUG = 'primary_attendee';
+	/**
+	 * Context slug for the primary attendee messages context
+	 */
+	const PRIMARY_ATTENDEE_CONTEXT_SLUG = 'primary_attendee';
 
 
-    /**
-     * Context slug for the attendee messages context
-     */
-    const ATTENDEE_CONTEXT_SLUG = 'attendee';
+	/**
+	 * Context slug for the attendee messages context
+	 */
+	const ATTENDEE_CONTEXT_SLUG = 'attendee';
 
 
-    /**
-     * Status reference for the EEM_Message::status_sent status.
-     */
-    const MESSAGE_STATUS_SENT = 'MSN';
+	/**
+	 * Status reference for the EEM_Message::status_sent status.
+	 */
+	const MESSAGE_STATUS_SENT = 'MSN';
 
 
-    /**
-     * Message type slug for the Payment Failed message type
-     */
-    const PAYMENT_FAILED_MESSAGE_TYPE_SLUG = 'payment_failed';
+	/**
+	 * Message type slug for the Payment Failed message type
+	 */
+	const PAYMENT_FAILED_MESSAGE_TYPE_SLUG = 'payment_failed';
 
 
-    /**
-     * Message type slug for the Registration Pending Payment message type
-     */
-    const MESSAGE_TYPE_PENDING_PAYMENT = 'pending_approval';
+	/**
+	 * Message type slug for the Registration Pending Payment message type
+	 */
+	const MESSAGE_TYPE_PENDING_PAYMENT = 'pending_approval';
 
 
-    /**
-     * Selector for the Global Messages "Send on same request" field in the Messages Settings tab.
-     */
-    const GLOBAL_MESSAGES_SETTINGS_ON_REQUEST_SELECTION_SELECTOR =
-        '#global_messages_settings-do-messages-on-same-request';
+	/**
+	 * Selector for the Global Messages "Send on same request" field in the Messages Settings tab.
+	 */
+	const GLOBAL_MESSAGES_SETTINGS_ON_REQUEST_SELECTION_SELECTOR =
+		'#global_messages_settings-do-messages-on-same-request';
 
 
-    /**
-     * Selector for the Global Messages Settings submit button in the Messages Settings tab.
-     */
-    const GLOBAL_MESSAGES_SETTINGS_SUBMIT_SELECTOR = '#global_messages_settings-update-settings-submit';
+	/**
+	 * Selector for the Global Messages Settings submit button in the Messages Settings tab.
+	 */
+	const GLOBAL_MESSAGES_SETTINGS_SUBMIT_SELECTOR = '#global_messages_settings-update-settings-submit';
 
 
-    /**
-     * This is the container where active message types for a messenger are found/dragged to.
-     */
-    const MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR = '#active-message-types';
+	/**
+	 * This is the container where active message types for a messenger are found/dragged to.
+	 */
+	const MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR = '#active-message-types';
 
 
-    /**
-     * Locator for the context switcher selector on the Message Template Editor page.
-     */
-    const MESSAGES_CONTEXT_SWITCHER_SELECTOR = "//form[@id='ee-msg-context-switcher-frm']/select";
+	/**
+	 * Locator for the context switcher selector on the Message Template Editor page.
+	 */
+	const MESSAGES_CONTEXT_SWITCHER_SELECTOR = "//form[@id='ee-msg-context-switcher-frm']/select";
 
 
-    /**
-     * Locator for the context switcher submit button in the Message Template Editor page.
-     */
-    const MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR = "#submit-msg-context-switcher-sbmt";
+	/**
+	 * Locator for the context switcher submit button in the Message Template Editor page.
+	 */
+	const MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR = "#submit-msg-context-switcher-sbmt";
 
 
-    /**
-     * Locator for the dialog container used for housing viewed messages in the message activity list table.
-     */
-    const MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR = '.ee-admin-dialog-container-inner-content';
-
-
-    /**
-     * Returns the selector for the on/off toggle for context on the message template editor.
-     */
-    const MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE =
-        "//div[@class='activate_context_on_off_toggle_container']/div[@class='switch']/label";
-
-
-    const SELECTOR_LINK_FINALIZE_PAYMENT_PENDING_PAYMENT_MESSAGE = "//td/p[@class='callout']/a";
-
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function messageActivityListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'default', $additional_params);
-    }
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function defaultMessageTemplateListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'global_mtps', $additional_params);
-    }
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function customMessageTemplateListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'custom_mtps', $additional_params);
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function messageSettingsUrl()
-    {
-        return self::adminUrl('espresso_messages', 'settings');
-    }
-
-
-
-    public static function draggableSettingsBoxSelectorForMessageTypeAndMessenger(
-        $message_type_slug,
-        $messenger_slug = 'email'
-    ) {
-        return "#$message_type_slug-messagetype-$messenger_slug";
-    }
-
-
-    /**
-     * @param string $message_type_slug
-     * @param string $context
-     * @return string
-     */
-    public static function editMessageTemplateClassByMessageType($message_type_slug, $context = '')
-    {
-        return $context
-            ? '.' . $message_type_slug . '-' . $context . '-edit-link'
-            : '.' . $message_type_slug . '-edit-link';
-    }
-
-
-    /**
-     * Selector for (a) specific table cell(s) in the Messages Activity list table for the given parameters.
-     *
-     * @param        $field
-     * @param        $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param string $table_cell_content_for_field
-     * @param int    $number_in_set   It's possible that the given parameters could match multiple items in the view.
-     *                                This allows you to indicate which item from the set to match.  If this is set to 0
-     *                                then all matches for the locator will be returned.
-     * @return string
-     * @throws \InvalidArgumentException
-     */
-    public static function messagesActivityListTableCellSelectorFor(
-        $field,
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $table_cell_content_for_field = '',
-        $number_in_set = 1
-    ) {
-        $selector = "//tbody[@id='the-list']";
-        $selector .= "//tr[contains(@class, 'msg-status-$message_status')]"
-                     . "//td[contains(@class, 'message_type') and text()='$message_type_label']";
-        if ($messenger) {
-            $selector .= "/ancestor::tr/td[contains(@class, 'messenger') and text()='$messenger']";
-        }
-        $selector .= "/ancestor::tr/td[contains(@class, 'column-context') and text()='$context']";
-        $selector .= $table_cell_content_for_field
-            ? "/ancestor::tr/td[contains(@class, 'column-$field') and text()='$table_cell_content_for_field']"
-            : "/ancestor::tr/td[contains(@class, 'column-$field')]";
-        return $number_in_set > 0 ? Locator::elementAt($selector, $number_in_set) : $selector;
-    }
-
-
-    /**
-     * Selector for the Create Custom button found in the message template list table.
-     * @param string $message_type_label
-     * @param string $messenger_label
-     * @return string
-     */
-    public static function createCustomButtonForMessageTypeAndMessenger($message_type_label, $messenger_label)
-    {
-        $selector = "//tr/td[contains(@class, 'message_type') and text()='$message_type_label']"
-                    . "//ancestor::tr/td[contains(@class, 'messenger') and contains(., '$messenger_label')]"
-                    . "//ancestor::tr/td/a[@class='button button-small']";
-        return $selector;
-    }
-
-
-    /**
-     * Note, this could potentially match multiple buttons in the view so the selector is intentionally restricted to
-     * the FIRST match (which will be the latest message sent if the table is default sorted).
-     *
-     * @param string $message_type_label    The visible message type label for the row you want to match
-     * @param string $message_status        The status of the message for the row you want to match.
-     * @param string $messenger             The visible messenger label for the row you want to match.
-     * @param string $context               The visible context label for the row you want to match.
-     * @param int    $number_in_set         It's possible that the given parameters could match multiple items in the
-     *                                      view. This allows you to indicate which item from the set to match.
-     * @return string
-     * @throws \InvalidArgumentException
-     */
-    public static function messagesActivityListTableViewButtonSelectorFor(
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $selector = self::messagesActivityListTableCellSelectorFor(
-            'action',
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            '',
-            $number_in_set
-        );
-        $selector .= "/a/span[contains(@class, 'ee-message-action-link-view')"
-                     . " and not(contains(@class, 'ee-message-action-link-view_transaction'))]";
-        return $selector;
-    }
-
-
-    /**
-     * Locator for the delete action link for a message item in the message activity list table.
-     * Note: The link is not visible by default, so the column would need hovered over for the link to appear.
-     *
-     * @param        $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     * @return string
-     * @throws \InvalidArgumentException
-     */
-    public static function messagesActivityListTableDeleteActionSelectorFor(
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $selector = self::messagesActivityListTableCellSelectorFor(
-            'to',
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            '',
-            $number_in_set
-        );
-        $selector .= "/div/span[@class='delete']/a";
-        return $selector;
-    }
-
-
-
-    /**
-     * Returns the input selector for a given field in the message template editor.
-     * Assumes one is already viewing the Message Template Editor.
-     * @param string     $field
-     * @return string
-     */
-    public static function messageInputFieldSelectorFor($field)
-    {
-        return "//div[@id='post-body']//input[@id='$field-content']";
-    }
-
-
-    /**
-     * Wrapper for self::messageInputFieldSelectorFor('to') that takes care of getting the input for the To field.
-     */
-    public static function messageTemplateToFieldSelector()
-    {
-        return self::messageInputFieldSelectorFor('to');
-    }
+	/**
+	 * Locator for the dialog container used for housing viewed messages in the message activity list table.
+	 */
+	const MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR = '.ee-admin-dialog-container-inner-content';
+
+
+	/**
+	 * Returns the selector for the on/off toggle for context on the message template editor.
+	 */
+	const MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE =
+		"//div[@class='activate_context_on_off_toggle_container']/div[@class='switch']/label";
+
+
+	const SELECTOR_LINK_FINALIZE_PAYMENT_PENDING_PAYMENT_MESSAGE = "//td/p[@class='callout']/a";
+
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function messageActivityListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'default', $additional_params);
+	}
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function defaultMessageTemplateListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'global_mtps', $additional_params);
+	}
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function customMessageTemplateListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'custom_mtps', $additional_params);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function messageSettingsUrl()
+	{
+		return self::adminUrl('espresso_messages', 'settings');
+	}
+
+
+
+	public static function draggableSettingsBoxSelectorForMessageTypeAndMessenger(
+		$message_type_slug,
+		$messenger_slug = 'email'
+	) {
+		return "#$message_type_slug-messagetype-$messenger_slug";
+	}
+
+
+	/**
+	 * @param string $message_type_slug
+	 * @param string $context
+	 * @return string
+	 */
+	public static function editMessageTemplateClassByMessageType($message_type_slug, $context = '')
+	{
+		return $context
+			? '.' . $message_type_slug . '-' . $context . '-edit-link'
+			: '.' . $message_type_slug . '-edit-link';
+	}
+
+
+	/**
+	 * Selector for (a) specific table cell(s) in the Messages Activity list table for the given parameters.
+	 *
+	 * @param        $field
+	 * @param        $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param string $table_cell_content_for_field
+	 * @param int    $number_in_set   It's possible that the given parameters could match multiple items in the view.
+	 *                                This allows you to indicate which item from the set to match.  If this is set to 0
+	 *                                then all matches for the locator will be returned.
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 */
+	public static function messagesActivityListTableCellSelectorFor(
+		$field,
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$table_cell_content_for_field = '',
+		$number_in_set = 1
+	) {
+		$selector = "//tbody[@id='the-list']";
+		$selector .= "//tr[contains(@class, 'msg-status-$message_status')]"
+					 . "//td[contains(@class, 'message_type') and text()='$message_type_label']";
+		if ($messenger) {
+			$selector .= "/ancestor::tr/td[contains(@class, 'messenger') and text()='$messenger']";
+		}
+		$selector .= "/ancestor::tr/td[contains(@class, 'column-context') and text()='$context']";
+		$selector .= $table_cell_content_for_field
+			? "/ancestor::tr/td[contains(@class, 'column-$field') and text()='$table_cell_content_for_field']"
+			: "/ancestor::tr/td[contains(@class, 'column-$field')]";
+		return $number_in_set > 0 ? Locator::elementAt($selector, $number_in_set) : $selector;
+	}
+
+
+	/**
+	 * Selector for the Create Custom button found in the message template list table.
+	 * @param string $message_type_label
+	 * @param string $messenger_label
+	 * @return string
+	 */
+	public static function createCustomButtonForMessageTypeAndMessenger($message_type_label, $messenger_label)
+	{
+		$selector = "//tr/td[contains(@class, 'message_type') and text()='$message_type_label']"
+					. "//ancestor::tr/td[contains(@class, 'messenger') and contains(., '$messenger_label')]"
+					. "//ancestor::tr/td/a[@class='button button-small']";
+		return $selector;
+	}
+
+
+	/**
+	 * Note, this could potentially match multiple buttons in the view so the selector is intentionally restricted to
+	 * the FIRST match (which will be the latest message sent if the table is default sorted).
+	 *
+	 * @param string $message_type_label    The visible message type label for the row you want to match
+	 * @param string $message_status        The status of the message for the row you want to match.
+	 * @param string $messenger             The visible messenger label for the row you want to match.
+	 * @param string $context               The visible context label for the row you want to match.
+	 * @param int    $number_in_set         It's possible that the given parameters could match multiple items in the
+	 *                                      view. This allows you to indicate which item from the set to match.
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 */
+	public static function messagesActivityListTableViewButtonSelectorFor(
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$selector = self::messagesActivityListTableCellSelectorFor(
+			'action',
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			'',
+			$number_in_set
+		);
+		$selector .= "/a/span[contains(@class, 'ee-message-action-link-view')"
+					 . " and not(contains(@class, 'ee-message-action-link-view_transaction'))]";
+		return $selector;
+	}
+
+
+	/**
+	 * Locator for the delete action link for a message item in the message activity list table.
+	 * Note: The link is not visible by default, so the column would need hovered over for the link to appear.
+	 *
+	 * @param        $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 */
+	public static function messagesActivityListTableDeleteActionSelectorFor(
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$selector = self::messagesActivityListTableCellSelectorFor(
+			'to',
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			'',
+			$number_in_set
+		);
+		$selector .= "/div/span[@class='delete']/a";
+		return $selector;
+	}
+
+
+
+	/**
+	 * Returns the input selector for a given field in the message template editor.
+	 * Assumes one is already viewing the Message Template Editor.
+	 * @param string     $field
+	 * @return string
+	 */
+	public static function messageInputFieldSelectorFor($field)
+	{
+		return "//div[@id='post-body']//input[@id='$field-content']";
+	}
+
+
+	/**
+	 * Wrapper for self::messageInputFieldSelectorFor('to') that takes care of getting the input for the To field.
+	 */
+	public static function messageTemplateToFieldSelector()
+	{
+		return self::messageInputFieldSelectorFor('to');
+	}
 }
\ No newline at end of file

core/db_models/EEM_Registration.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -467,7 +467,7 @@
      * @param    int $ATT_ID
      * @param    int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the
      *                         attendee number is required
-     * @return        mixed        array on success, FALSE on fail
+     * @return        null|EE_Base_Class        array on success, FALSE on fail
      * @throws EE_Error
      */
     public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0)

Unused Use Statements -1 removed lines

@@ -1,5 +1,4 @@
 <?php
-use EventEspresso\core\exceptions\InvalidIdentifierException;
 use EventEspresso\core\exceptions\InvalidStatusException;
 use EventEspresso\core\services\database\TableAnalysis;
 

Spacing +25 added lines, -25 removed lines

@@ -369,14 +369,14 @@ 
         // and the table hasn't actually been created, this could have an error
         /** @type WPDB $wpdb */
         global $wpdb;
-        if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
+        if ($this->_get_table_analysis()->tableExists($wpdb->prefix.'esp_status')) {
             $results = $wpdb->get_results(
                 "SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
             );
             self::$_reg_status = array();
             foreach ($results as $status) {
-                if (!in_array($status->STS_ID, $exclude, true)) {
-                    self::$_reg_status[ $status->STS_ID ] = $status->STS_code;
+                if ( ! in_array($status->STS_ID, $exclude, true)) {
+                    self::$_reg_status[$status->STS_ID] = $status->STS_code;
                 }
             }
         }
@@ -433,7 +433,7 @@ 
      */
     public function get_all_registrations_for_attendee($ATT_ID = 0)
     {
-        if (!$ATT_ID) {
+        if ( ! $ATT_ID) {
             return null;
         }
         return $this->get_all(array(array('ATT_ID' => $ATT_ID)));
@@ -450,7 +450,7 @@ 
      */
     public function get_registration_for_reg_url_link($REG_url_link)
     {
-        if (!$REG_url_link) {
+        if ( ! $REG_url_link) {
             return null;
         }
         return $this->get_one(array(array('REG_url_link' => $REG_url_link)));
@@ -501,7 +501,7 @@ 
             'REG_date' => array('>=', $sql_date),
             'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
         );
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
             $where['Event.EVT_wp_user'] = get_current_user_id();
         }
         $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
@@ -513,7 +513,7 @@ 
             ),
             OBJECT,
             array(
-                'regDate' => array('DATE(' . $query_interval . ')', '%s'),
+                'regDate' => array('DATE('.$query_interval.')', '%s'),
                 'total' => array('count(REG_ID)', '%d'),
             )
         );
@@ -533,7 +533,7 @@ 
     public function get_registrations_per_day_and_per_status_report($period = '-1 month')
     {
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $event_table = $wpdb->posts;
         $sql_date = date('Y-m-d H:i:s', strtotime($period));
         // prepare the query interval for displaying offset
@@ -542,9 +542,9 @@ 
         $inner_date_query = "SELECT DISTINCT REG_date from {$registration_table} ";
         $inner_where = ' WHERE';
         // exclude events not authored by user if permissions in effect
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
             $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
-            $inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
+            $inner_where .= ' post_author = '.get_current_user_id().' AND';
         }
         $inner_where .= " REG_date >= '{$sql_date}'";
         $inner_date_query .= $inner_where;
@@ -567,7 +567,7 @@ 
         // setup the joins
         $join .= implode(' LEFT JOIN ', $join_parts);
         // now let's put it all together
-        $query = $select . $join . ' GROUP BY Registration_REG_date';
+        $query = $select.$join.' GROUP BY Registration_REG_date';
         // and execute it
         return $wpdb->get_results($query, ARRAY_A);
     }
@@ -593,7 +593,7 @@ 
             'REG_date' => array('>=', $date_sql),
             'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
         );
-        if (!EE_Registry::instance()->CAP->current_user_can(
+        if ( ! EE_Registry::instance()->CAP->current_user_can(
             'ee_read_others_registrations',
             'reg_per_event_report'
         )
@@ -629,16 +629,16 @@ 
     public function get_registrations_per_event_and_per_status_report($period = '-1 month')
     {
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $event_table = $wpdb->posts;
         $sql_date = date('Y-m-d H:i:s', strtotime($period));
         // inner date query
         $inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
         $inner_where = ' WHERE';
         // exclude events not authored by user if permissions in effect
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
             $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
-            $inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
+            $inner_where .= ' post_author = '.get_current_user_id().' AND';
         }
         $inner_where .= " REG_date >= '{$sql_date}'";
         $inner_date_query .= $inner_where;
@@ -661,7 +661,7 @@ 
         // setup remaining joins
         $join .= implode(' LEFT JOIN ', $join_parts);
         // now put it all together
-        $query = $select . $join . ' GROUP BY Registration_Event';
+        $query = $select.$join.' GROUP BY Registration_Event';
         // and execute
         return $wpdb->get_results($query, ARRAY_A);
     }
@@ -676,7 +676,7 @@ 
      */
     public function get_primary_registration_for_transaction_ID($TXN_ID = 0)
     {
-        if (!$TXN_ID) {
+        if ( ! $TXN_ID) {
             return null;
         }
         return $this->get_one(array(
@@ -745,11 +745,11 @@ 
         $query = $wpdb->prepare(
             'SELECT '
             . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+            . 'FROM '.EEM_Checkin::instance()->table().' AS checkins INNER JOIN'
             . '( SELECT '
             . 'max( CHK_timestamp ) AS latest_checkin, '
             . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' '
+            . 'FROM '.EEM_Checkin::instance()->table().' '
             . 'WHERE DTT_ID=%d '
             . 'GROUP BY REG_ID'
             . ') AS most_recent_checkin_per_reg '
@@ -779,12 +779,12 @@ 
         $query = $wpdb->prepare(
             'SELECT '
             . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+            . 'FROM '.EEM_Checkin::instance()->table().' AS checkins INNER JOIN'
             . '( SELECT '
             . 'max( CHK_timestamp ) AS latest_checkin, '
             . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
-            . 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
+            . 'FROM '.EEM_Checkin::instance()->table().' AS c '
+            . 'INNER JOIN '.EEM_Datetime::instance()->table().' AS d '
             . 'ON c.DTT_ID=d.DTT_ID '
             . 'WHERE d.EVT_ID=%d '
             . 'GROUP BY REG_ID'
@@ -813,7 +813,7 @@ 
     {
         // first do a native wp_query to get the latest REG_ID's matching these attendees.
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $attendee_table = $wpdb->posts;
         $attendee_ids = is_array($attendee_ids)
             ? array_map('absint', $attendee_ids)
@@ -868,7 +868,7 @@ 
     public function event_reg_count_for_statuses($EVT_ID, $statuses = array())
     {
         $EVT_ID = absint($EVT_ID);
-        if (! $EVT_ID) {
+        if ( ! $EVT_ID) {
             throw new InvalidArgumentException(
                 esc_html__('An invalid Event ID was supplied.', 'event_espresso')
             );
@@ -877,7 +877,7 @@ 
         $statuses = ! empty($statuses) ? $statuses : array(EEM_Registration::status_id_approved);
         $valid_reg_statuses = EEM_Registration::reg_statuses();
         foreach ($statuses as $status) {
-            if (! in_array($status, $valid_reg_statuses, true)) {
+            if ( ! in_array($status, $valid_reg_statuses, true)) {
                 throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso'));
             }
         }

Indentation +866 added lines, -866 removed lines

@@ -13,815 +13,815 @@ 
 class EEM_Registration extends EEM_Soft_Delete_Base
 {
 
-    /**
-     * @var EEM_Registration $_instance
-     */
-    protected static $_instance;
-
-    /**
-     * Keys are the status IDs for registrations (eg, RAP, RCN, etc), and the values
-     * are status codes (eg, approved, cancelled, etc)
-     *
-     * @var array
-     */
-    private static $_reg_status;
-
-    /**
-     * The value of REG_count for a primary registrant
-     */
-    const PRIMARY_REGISTRANT_COUNT = 1;
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an INCOMPLETE registration.
-     * Initial status for registrations when they are first created
-     * Payments are NOT allowed.
-     * Automatically toggled to whatever the default Event registration status is upon completion of the attendee
-     * information reg step NO space reserved. Registration is NOT active
-     */
-    const status_id_incomplete = 'RIC';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an UNAPPROVED registration.
-     * Payments are NOT allowed.
-     * Event Admin must manually toggle STS_ID for it to change
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_not_approved = 'RNA';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate registration is PENDING_PAYMENT .
-     * Payments are allowed.
-     * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_pending_payment = 'RPP';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate registration is on the WAIT_LIST .
-     * Payments are allowed.
-     * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_wait_list = 'RWL';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an APPROVED registration.
-     * the TXN may or may not be completed ( paid in full )
-     * Payments are allowed.
-     * A space IS reserved.
-     * Registration is active
-     */
-    const status_id_approved = 'RAP';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a registration was CANCELLED by the attendee.
-     * Payments are NOT allowed.
-     * NO space reserved.
-     * Registration is NOT active
-     */
-    const status_id_cancelled = 'RCN';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a registration was DECLINED by the Event Admin
-     * Payments are NOT allowed.
-     * No space reserved.
-     * Registration is NOT active
-     */
-    const status_id_declined = 'RDC';
-
-    /**
-     * @var TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-
-    /**
-     *    private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access protected
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
-     *                         incoming timezone data that gets saved). Note this just sends the timezone info to the
-     *                         date time model field objects.  Default is NULL (and will be assumed using the set
-     *                         timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-        $this->singular_item = esc_html__('Registration', 'event_espresso');
-        $this->plural_item = esc_html__('Registrations', 'event_espresso');
-        $this->_tables = array(
-            'Registration' => new EE_Primary_Table('esp_registration', 'REG_ID'),
-        );
-        $this->_fields = array(
-            'Registration' => array(
-                'REG_ID' => new EE_Primary_Key_Int_Field(
-                    'REG_ID',
-                    esc_html__('Registration ID', 'event_espresso')
-                ),
-                'EVT_ID' => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Event ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'ATT_ID' => new EE_Foreign_Key_Int_Field(
-                    'ATT_ID',
-                    esc_html__('Attendee ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Attendee'
-                ),
-                'TXN_ID' => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__('Transaction ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Transaction'
-                ),
-                'TKT_ID' => new EE_Foreign_Key_Int_Field(
-                    'TKT_ID',
-                    esc_html__('Ticket ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Ticket'
-                ),
-                'STS_ID' => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    esc_html__('Status ID', 'event_espresso'),
-                    false,
-                    EEM_Registration::status_id_incomplete,
-                    'Status'
-                ),
-                'REG_date' => new EE_Datetime_Field(
-                    'REG_date',
-                    esc_html__('Time registration occurred', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'REG_final_price' => new EE_Money_Field(
-                    'REG_final_price',
-                    esc_html__('Registration\'s share of the transaction total', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'REG_paid' => new EE_Money_Field(
-                    'REG_paid',
-                    esc_html__('Amount paid to date towards registration', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'REG_session' => new EE_Plain_Text_Field(
-                    'REG_session',
-                    esc_html__('Session ID of registration', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'REG_code' => new EE_Plain_Text_Field(
-                    'REG_code',
-                    esc_html__('Unique Code for this registration', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'REG_url_link' => new EE_Plain_Text_Field(
-                    'REG_url_link',
-                    esc_html__('String to be used in URL for identifying registration', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'REG_count' => new EE_Integer_Field(
-                    'REG_count',
-                    esc_html__('Count of this registration in the group registration ', 'event_espresso'),
-                    true,
-                    1
-                ),
-                'REG_group_size' => new EE_Integer_Field(
-                    'REG_group_size',
-                    esc_html__('Number of registrations on this group', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'REG_att_is_going' => new EE_Boolean_Field(
-                    'REG_att_is_going',
-                    esc_html__('Flag indicating the registrant plans on attending', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'REG_deleted' => new EE_Trashed_Flag_Field(
-                    'REG_deleted',
-                    esc_html__('Flag indicating if registration has been archived or not.', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Event' => new EE_Belongs_To_Relation(),
-            'Attendee' => new EE_Belongs_To_Relation(),
-            'Transaction' => new EE_Belongs_To_Relation(),
-            'Ticket' => new EE_Belongs_To_Relation(),
-            'Status' => new EE_Belongs_To_Relation(),
-            'Answer' => new EE_Has_Many_Relation(),
-            'Checkin' => new EE_Has_Many_Relation(),
-            'Registration_Payment' => new EE_Has_Many_Relation(),
-            'Payment' => new EE_HABTM_Relation('Registration_Payment'),
-            'Message' => new EE_Has_Many_Any_Relation(false)
-            // allow deletes even if there are messages in the queue related
-        );
-        $this->_model_chain_to_wp_user = 'Event';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * a list of ALL valid registration statuses currently in use within the system
-     * generated by combining the filterable active and inactive reg status arrays
-     *
-     * @return array
-     */
-    public static function reg_statuses()
-    {
-        return array_unique(
-            array_merge(
-                EEM_Registration::active_reg_statuses(),
-                EEM_Registration::inactive_reg_statuses()
-            )
-        );
-    }
-
-
-    /**
-     * reg_statuses_that_allow_payment
-     * a filterable list of registration statuses that allow a registrant to make a payment
-     *
-     * @access public
-     * @return array
-     */
-    public static function reg_statuses_that_allow_payment()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__reg_statuses_that_allow_payment',
-            array(
-                EEM_Registration::status_id_approved,
-                EEM_Registration::status_id_pending_payment,
-            )
-        );
-    }
-
-
-    /**
-     * active_reg_statuses
-     * a filterable list of registration statuses that are considered active
-     *
-     * @access public
-     * @return array
-     */
-    public static function active_reg_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__active_reg_statuses',
-            array(
-                EEM_Registration::status_id_approved,
-                EEM_Registration::status_id_pending_payment,
-                EEM_Registration::status_id_wait_list,
-                EEM_Registration::status_id_not_approved,
-            )
-        );
-    }
-
-
-    /**
-     * inactive_reg_statuses
-     * a filterable list of registration statuses that are not considered active
-     *
-     * @access public
-     * @return array
-     */
-    public static function inactive_reg_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__inactive_reg_statuses',
-            array(
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-            )
-        );
-    }
-
-
-    /**
-     *    closed_reg_statuses
-     *    a filterable list of registration statuses that are considered "closed"
-     * meaning they should not be considered in any calculations involving monies owing
-     *
-     * @access public
-     * @return array
-     */
-    public static function closed_reg_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__closed_reg_statuses',
-            array(
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_wait_list,
-            )
-        );
-    }
-
-
-    /**
-     *        get list of registration statuses
-     *
-     * @access public
-     * @param array $exclude The status ids to exclude from the returned results
-     * @param bool $translated If true will return the values as singular localized strings
-     * @return array
-     * @throws EE_Error
-     */
-    public static function reg_status_array($exclude = array(), $translated = false)
-    {
-        EEM_Registration::instance()->_get_registration_status_array($exclude);
-        return $translated
-            ? EEM_Status::instance()->localized_status(self::$_reg_status, false, 'sentence')
-            : self::$_reg_status;
-    }
-
-
-    /**
-     *    get list of registration statuses
-     *
-     * @access private
-     * @param array $exclude
-     * @return void
-     * @throws EE_Error
-     */
-    private function _get_registration_status_array($exclude = array())
-    {
-        // in the very rare circumstance that we are deleting a model's table's data
-        // and the table hasn't actually been created, this could have an error
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
-            $results = $wpdb->get_results(
-                "SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
-            );
-            self::$_reg_status = array();
-            foreach ($results as $status) {
-                if (!in_array($status->STS_ID, $exclude, true)) {
-                    self::$_reg_status[ $status->STS_ID ] = $status->STS_code;
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * This returns a wpdb->results array of all registration date month and years matching the incoming query params
-     * and grouped by month and year.
-     *
-     * @param  array $where_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_reg_months_and_years($where_params)
-    {
-        $query_params[0] = $where_params;
-        $query_params['group_by'] = array('reg_year', 'reg_month');
-        $query_params['order_by'] = array('REG_date' => 'DESC');
-        $columns_to_select = array(
-            'reg_year' => array('YEAR(REG_date)', '%s'),
-            'reg_month' => array('MONTHNAME(REG_date)', '%s'),
-        );
-        return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
-    }
-
-
-    /**
-     * retrieve ALL registrations for a particular Attendee from db
-     *
-     * @param int $ATT_ID
-     * @return EE_Base_Class[]|EE_Registration[]|null
-     * @throws EE_Error
-     */
-    public function get_all_registrations_for_attendee($ATT_ID = 0)
-    {
-        if (!$ATT_ID) {
-            return null;
-        }
-        return $this->get_all(array(array('ATT_ID' => $ATT_ID)));
-    }
-
-
-    /**
-     * Gets a registration given their REG_url_link. Yes, this should usually
-     * be passed via a GET parameter.
-     *
-     * @param string $REG_url_link
-     * @return EE_Base_Class|EE_Registration|null
-     * @throws EE_Error
-     */
-    public function get_registration_for_reg_url_link($REG_url_link)
-    {
-        if (!$REG_url_link) {
-            return null;
-        }
-        return $this->get_one(array(array('REG_url_link' => $REG_url_link)));
-    }
-
-
-    /**
-     *        retrieve registration for a specific transaction attendee from db
-     *
-     * @access        public
-     * @param    int $TXN_ID
-     * @param    int $ATT_ID
-     * @param    int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the
-     *                         attendee number is required
-     * @return        mixed        array on success, FALSE on fail
-     * @throws EE_Error
-     */
-    public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0)
-    {
-        return $this->get_one(array(
-            array(
-                'TXN_ID' => $TXN_ID,
-                'ATT_ID' => $ATT_ID,
-            ),
-            'limit' => array(min($att_nmbr - 1, 0), 1),
-        ));
-    }
-
-
-    /**
-     *        get the number of registrations per day  for the Registration Admin page Reports Tab.
-     *        (doesn't utilize models because it's a fairly specialized query)
-     *
-     * @access        public
-     * @param $period string which can be passed to php's strtotime function (eg "-1 month")
-     * @return stdClass[] with properties regDate and total
-     * @throws EE_Error
-     */
-    public function get_registrations_per_day_report($period = '-1 month')
-    {
-        $sql_date = $this->convert_datetime_for_query(
-            'REG_date',
-            date('Y-m-d H:i:s', strtotime($period)),
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where = array(
-            'REG_date' => array('>=', $sql_date),
-            'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
-        );
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
-            $where['Event.EVT_wp_user'] = get_current_user_id();
-        }
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
-        $results = $this->_get_all_wpdb_results(
-            array(
-                $where,
-                'group_by' => 'regDate',
-                'order_by' => array('REG_date' => 'ASC'),
-            ),
-            OBJECT,
-            array(
-                'regDate' => array('DATE(' . $query_interval . ')', '%s'),
-                'total' => array('count(REG_ID)', '%d'),
-            )
-        );
-        return $results;
-    }
-
-
-    /**
-     * Get the number of registrations per day including the count of registrations for each Registration Status.
-     * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
-     *
-     * @param string $period
-     * @return stdClass[] with properties Registration_REG_date and a column for each registration status as the STS_ID
-     * @throws EE_Error
-     *                    (i.e. RAP)
-     */
-    public function get_registrations_per_day_and_per_status_report($period = '-1 month')
-    {
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $event_table = $wpdb->posts;
-        $sql_date = date('Y-m-d H:i:s', strtotime($period));
-        // prepare the query interval for displaying offset
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'dates.REG_date');
-        // inner date query
-        $inner_date_query = "SELECT DISTINCT REG_date from {$registration_table} ";
-        $inner_where = ' WHERE';
-        // exclude events not authored by user if permissions in effect
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
-            $inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
-        }
-        $inner_where .= " REG_date >= '{$sql_date}'";
-        $inner_date_query .= $inner_where;
-        // start main query
-        $select = "SELECT DATE({$query_interval}) as Registration_REG_date, ";
-        $join = '';
-        $join_parts = array();
-        $select_parts = array();
-        // loop through registration stati to do parts for each status.
-        foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
-            if ($STS_ID === EEM_Registration::status_id_incomplete) {
-                continue;
-            }
-            $select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}";
-            $join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.REG_date = dates.REG_date AND {$STS_code}.STS_ID = '{$STS_ID}'";
-        }
-        // setup the selects
-        $select .= implode(', ', $select_parts);
-        $select .= " FROM ($inner_date_query) AS dates LEFT JOIN ";
-        // setup the joins
-        $join .= implode(' LEFT JOIN ', $join_parts);
-        // now let's put it all together
-        $query = $select . $join . ' GROUP BY Registration_REG_date';
-        // and execute it
-        return $wpdb->get_results($query, ARRAY_A);
-    }
-
-
-    /**
-     *        get the number of registrations per event  for the Registration Admin page Reports Tab
-     *
-     * @access        public
-     * @param $period string which can be passed to php's strtotime function (eg "-1 month")
-     * @return stdClass[] each with properties event_name, reg_limit, and total
-     * @throws EE_Error
-     */
-    public function get_registrations_per_event_report($period = '-1 month')
-    {
-        $date_sql = $this->convert_datetime_for_query(
-            'REG_date',
-            date('Y-m-d H:i:s', strtotime($period)),
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where = array(
-            'REG_date' => array('>=', $date_sql),
-            'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
-        );
-        if (!EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_others_registrations',
-            'reg_per_event_report'
-        )
-        ) {
-            $where['Event.EVT_wp_user'] = get_current_user_id();
-        }
-        $results = $this->_get_all_wpdb_results(
-            array(
-            $where,
-            'group_by' => 'Event.EVT_name',
-            'order_by' => 'Event.EVT_name',
-            'limit' => array(0, 24),
-            ),
-            OBJECT,
-            array(
-                'event_name' => array('Event_CPT.post_title', '%s'),
-                'total' => array('COUNT(REG_ID)', '%s'),
-            )
-        );
-        return $results;
-    }
-
-
-    /**
-     * Get the number of registrations per event grouped by registration status.
-     * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
-     *
-     * @param string $period
-     * @return stdClass[] with properties `Registration_Event` and a column for each registration status as the STS_ID
-     * @throws EE_Error
-     *                    (i.e. RAP)
-     */
-    public function get_registrations_per_event_and_per_status_report($period = '-1 month')
-    {
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $event_table = $wpdb->posts;
-        $sql_date = date('Y-m-d H:i:s', strtotime($period));
-        // inner date query
-        $inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
-        $inner_where = ' WHERE';
-        // exclude events not authored by user if permissions in effect
-        if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
-            $inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
-        }
-        $inner_where .= " REG_date >= '{$sql_date}'";
-        $inner_date_query .= $inner_where;
-        // build main query
-        $select = 'SELECT Event.post_title as Registration_Event, ';
-        $join = '';
-        $join_parts = array();
-        $select_parts = array();
-        // loop through registration stati to do parts for each status.
-        foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
-            if ($STS_ID === EEM_Registration::status_id_incomplete) {
-                continue;
-            }
-            $select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}";
-            $join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.EVT_ID = dates.EVT_ID AND {$STS_code}.STS_ID = '{$STS_ID}' AND {$STS_code}.REG_date = dates.REG_date";
-        }
-        // setup the selects
-        $select .= implode(', ', $select_parts);
-        $select .= " FROM ($inner_date_query) AS dates LEFT JOIN $event_table as Event ON Event.ID = dates.EVT_ID LEFT JOIN ";
-        // setup remaining joins
-        $join .= implode(' LEFT JOIN ', $join_parts);
-        // now put it all together
-        $query = $select . $join . ' GROUP BY Registration_Event';
-        // and execute
-        return $wpdb->get_results($query, ARRAY_A);
-    }
-
-
-    /**
-     * Returns the EE_Registration of the primary attendee on the transaction id provided
-     *
-     * @param int $TXN_ID
-     * @return EE_Base_Class|EE_Registration|null
-     * @throws EE_Error
-     */
-    public function get_primary_registration_for_transaction_ID($TXN_ID = 0)
-    {
-        if (!$TXN_ID) {
-            return null;
-        }
-        return $this->get_one(array(
-            array(
-                'TXN_ID' => $TXN_ID,
-                'REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT,
-            ),
-        ));
-    }
-
-
-    /**
-     *        get_event_registration_count
-     *
-     * @access public
-     * @param int $EVT_ID
-     * @param boolean $for_incomplete_payments
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_event_registration_count($EVT_ID, $for_incomplete_payments = false)
-    {
-        // we only count approved registrations towards registration limits
-        $query_params = array(array('EVT_ID' => $EVT_ID, 'STS_ID' => self::status_id_approved));
-        if ($for_incomplete_payments) {
-            $query_params[0]['Transaction.STS_ID'] = array('!=', EEM_Transaction::complete_status_code);
-        }
-        return $this->count($query_params);
-    }
-
-
-    /**
-     * Deletes all registrations with no transactions. Note that this needs to be very efficient
-     * and so it uses wpdb directly
-     *
-     * @global WPDB $wpdb
-     * @return int number deleted
-     * @throws EE_Error
-     */
-    public function delete_registrations_with_no_transaction()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        return $wpdb->query(
-            'DELETE r FROM '
-            . $this->table()
-            . ' r LEFT JOIN '
-            . EEM_Transaction::instance()->table()
-            . ' t ON r.TXN_ID = t.TXN_ID WHERE t.TXN_ID IS NULL'
-        );
-    }
-
-
-    /**
-     *  Count registrations checked into (or out of) a datetime
-     *
-     * @param int $DTT_ID datetime ID
-     * @param boolean $checked_in whether to count registrations checked IN or OUT
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_registrations_checked_into_datetime($DTT_ID, $checked_in = true)
-    {
-        global $wpdb;
-        // subquery to get latest checkin
-        $query = $wpdb->prepare(
-            'SELECT '
-            . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
-            . '( SELECT '
-            . 'max( CHK_timestamp ) AS latest_checkin, '
-            . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' '
-            . 'WHERE DTT_ID=%d '
-            . 'GROUP BY REG_ID'
-            . ') AS most_recent_checkin_per_reg '
-            . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
-            . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
-            . 'WHERE '
-            . 'checkins.CHK_in=%d',
-            $DTT_ID,
-            $checked_in
-        );
-        return (int) $wpdb->get_var($query);
-    }
-
-
-    /**
-     *  Count registrations checked into (or out of) an event.
-     *
-     * @param int $EVT_ID event ID
-     * @param boolean $checked_in whether to count registrations checked IN or OUT
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_registrations_checked_into_event($EVT_ID, $checked_in = true)
-    {
-        global $wpdb;
-        // subquery to get latest checkin
-        $query = $wpdb->prepare(
-            'SELECT '
-            . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
-            . '( SELECT '
-            . 'max( CHK_timestamp ) AS latest_checkin, '
-            . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
-            . 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
-            . 'ON c.DTT_ID=d.DTT_ID '
-            . 'WHERE d.EVT_ID=%d '
-            . 'GROUP BY REG_ID'
-            . ') AS most_recent_checkin_per_reg '
-            . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
-            . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
-            . 'WHERE '
-            . 'checkins.CHK_in=%d',
-            $EVT_ID,
-            $checked_in
-        );
-        return (int) $wpdb->get_var($query);
-    }
-
-
-    /**
-     * The purpose of this method is to retrieve an array of
-     * EE_Registration objects that represent the latest registration
-     * for each ATT_ID given in the function argument.
-     *
-     * @param array $attendee_ids
-     * @return EE_Base_Class[]|EE_Registration[]
-     * @throws EE_Error
-     */
-    public function get_latest_registration_for_each_of_given_contacts($attendee_ids = array())
-    {
-        // first do a native wp_query to get the latest REG_ID's matching these attendees.
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $attendee_table = $wpdb->posts;
-        $attendee_ids = is_array($attendee_ids)
-            ? array_map('absint', $attendee_ids)
-            : array((int) $attendee_ids);
-        $ATT_IDs = implode(',', $attendee_ids);
-        // first we do a query to get the registration ids
-        // (because a group by before order by causes the order by to be ignored.)
-        $registration_id_query = "
+	/**
+	 * @var EEM_Registration $_instance
+	 */
+	protected static $_instance;
+
+	/**
+	 * Keys are the status IDs for registrations (eg, RAP, RCN, etc), and the values
+	 * are status codes (eg, approved, cancelled, etc)
+	 *
+	 * @var array
+	 */
+	private static $_reg_status;
+
+	/**
+	 * The value of REG_count for a primary registrant
+	 */
+	const PRIMARY_REGISTRANT_COUNT = 1;
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an INCOMPLETE registration.
+	 * Initial status for registrations when they are first created
+	 * Payments are NOT allowed.
+	 * Automatically toggled to whatever the default Event registration status is upon completion of the attendee
+	 * information reg step NO space reserved. Registration is NOT active
+	 */
+	const status_id_incomplete = 'RIC';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an UNAPPROVED registration.
+	 * Payments are NOT allowed.
+	 * Event Admin must manually toggle STS_ID for it to change
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_not_approved = 'RNA';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate registration is PENDING_PAYMENT .
+	 * Payments are allowed.
+	 * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_pending_payment = 'RPP';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate registration is on the WAIT_LIST .
+	 * Payments are allowed.
+	 * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_wait_list = 'RWL';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an APPROVED registration.
+	 * the TXN may or may not be completed ( paid in full )
+	 * Payments are allowed.
+	 * A space IS reserved.
+	 * Registration is active
+	 */
+	const status_id_approved = 'RAP';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a registration was CANCELLED by the attendee.
+	 * Payments are NOT allowed.
+	 * NO space reserved.
+	 * Registration is NOT active
+	 */
+	const status_id_cancelled = 'RCN';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a registration was DECLINED by the Event Admin
+	 * Payments are NOT allowed.
+	 * No space reserved.
+	 * Registration is NOT active
+	 */
+	const status_id_declined = 'RDC';
+
+	/**
+	 * @var TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+
+	/**
+	 *    private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access protected
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
+	 *                         incoming timezone data that gets saved). Note this just sends the timezone info to the
+	 *                         date time model field objects.  Default is NULL (and will be assumed using the set
+	 *                         timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+		$this->singular_item = esc_html__('Registration', 'event_espresso');
+		$this->plural_item = esc_html__('Registrations', 'event_espresso');
+		$this->_tables = array(
+			'Registration' => new EE_Primary_Table('esp_registration', 'REG_ID'),
+		);
+		$this->_fields = array(
+			'Registration' => array(
+				'REG_ID' => new EE_Primary_Key_Int_Field(
+					'REG_ID',
+					esc_html__('Registration ID', 'event_espresso')
+				),
+				'EVT_ID' => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('Event ID', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'ATT_ID' => new EE_Foreign_Key_Int_Field(
+					'ATT_ID',
+					esc_html__('Attendee ID', 'event_espresso'),
+					false,
+					0,
+					'Attendee'
+				),
+				'TXN_ID' => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__('Transaction ID', 'event_espresso'),
+					false,
+					0,
+					'Transaction'
+				),
+				'TKT_ID' => new EE_Foreign_Key_Int_Field(
+					'TKT_ID',
+					esc_html__('Ticket ID', 'event_espresso'),
+					false,
+					0,
+					'Ticket'
+				),
+				'STS_ID' => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					esc_html__('Status ID', 'event_espresso'),
+					false,
+					EEM_Registration::status_id_incomplete,
+					'Status'
+				),
+				'REG_date' => new EE_Datetime_Field(
+					'REG_date',
+					esc_html__('Time registration occurred', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'REG_final_price' => new EE_Money_Field(
+					'REG_final_price',
+					esc_html__('Registration\'s share of the transaction total', 'event_espresso'),
+					false,
+					0
+				),
+				'REG_paid' => new EE_Money_Field(
+					'REG_paid',
+					esc_html__('Amount paid to date towards registration', 'event_espresso'),
+					false,
+					0
+				),
+				'REG_session' => new EE_Plain_Text_Field(
+					'REG_session',
+					esc_html__('Session ID of registration', 'event_espresso'),
+					false,
+					''
+				),
+				'REG_code' => new EE_Plain_Text_Field(
+					'REG_code',
+					esc_html__('Unique Code for this registration', 'event_espresso'),
+					false,
+					''
+				),
+				'REG_url_link' => new EE_Plain_Text_Field(
+					'REG_url_link',
+					esc_html__('String to be used in URL for identifying registration', 'event_espresso'),
+					false,
+					''
+				),
+				'REG_count' => new EE_Integer_Field(
+					'REG_count',
+					esc_html__('Count of this registration in the group registration ', 'event_espresso'),
+					true,
+					1
+				),
+				'REG_group_size' => new EE_Integer_Field(
+					'REG_group_size',
+					esc_html__('Number of registrations on this group', 'event_espresso'),
+					false,
+					1
+				),
+				'REG_att_is_going' => new EE_Boolean_Field(
+					'REG_att_is_going',
+					esc_html__('Flag indicating the registrant plans on attending', 'event_espresso'),
+					false,
+					false
+				),
+				'REG_deleted' => new EE_Trashed_Flag_Field(
+					'REG_deleted',
+					esc_html__('Flag indicating if registration has been archived or not.', 'event_espresso'),
+					false,
+					false
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Event' => new EE_Belongs_To_Relation(),
+			'Attendee' => new EE_Belongs_To_Relation(),
+			'Transaction' => new EE_Belongs_To_Relation(),
+			'Ticket' => new EE_Belongs_To_Relation(),
+			'Status' => new EE_Belongs_To_Relation(),
+			'Answer' => new EE_Has_Many_Relation(),
+			'Checkin' => new EE_Has_Many_Relation(),
+			'Registration_Payment' => new EE_Has_Many_Relation(),
+			'Payment' => new EE_HABTM_Relation('Registration_Payment'),
+			'Message' => new EE_Has_Many_Any_Relation(false)
+			// allow deletes even if there are messages in the queue related
+		);
+		$this->_model_chain_to_wp_user = 'Event';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * a list of ALL valid registration statuses currently in use within the system
+	 * generated by combining the filterable active and inactive reg status arrays
+	 *
+	 * @return array
+	 */
+	public static function reg_statuses()
+	{
+		return array_unique(
+			array_merge(
+				EEM_Registration::active_reg_statuses(),
+				EEM_Registration::inactive_reg_statuses()
+			)
+		);
+	}
+
+
+	/**
+	 * reg_statuses_that_allow_payment
+	 * a filterable list of registration statuses that allow a registrant to make a payment
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function reg_statuses_that_allow_payment()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__reg_statuses_that_allow_payment',
+			array(
+				EEM_Registration::status_id_approved,
+				EEM_Registration::status_id_pending_payment,
+			)
+		);
+	}
+
+
+	/**
+	 * active_reg_statuses
+	 * a filterable list of registration statuses that are considered active
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function active_reg_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__active_reg_statuses',
+			array(
+				EEM_Registration::status_id_approved,
+				EEM_Registration::status_id_pending_payment,
+				EEM_Registration::status_id_wait_list,
+				EEM_Registration::status_id_not_approved,
+			)
+		);
+	}
+
+
+	/**
+	 * inactive_reg_statuses
+	 * a filterable list of registration statuses that are not considered active
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function inactive_reg_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__inactive_reg_statuses',
+			array(
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+			)
+		);
+	}
+
+
+	/**
+	 *    closed_reg_statuses
+	 *    a filterable list of registration statuses that are considered "closed"
+	 * meaning they should not be considered in any calculations involving monies owing
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function closed_reg_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__closed_reg_statuses',
+			array(
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_wait_list,
+			)
+		);
+	}
+
+
+	/**
+	 *        get list of registration statuses
+	 *
+	 * @access public
+	 * @param array $exclude The status ids to exclude from the returned results
+	 * @param bool $translated If true will return the values as singular localized strings
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function reg_status_array($exclude = array(), $translated = false)
+	{
+		EEM_Registration::instance()->_get_registration_status_array($exclude);
+		return $translated
+			? EEM_Status::instance()->localized_status(self::$_reg_status, false, 'sentence')
+			: self::$_reg_status;
+	}
+
+
+	/**
+	 *    get list of registration statuses
+	 *
+	 * @access private
+	 * @param array $exclude
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _get_registration_status_array($exclude = array())
+	{
+		// in the very rare circumstance that we are deleting a model's table's data
+		// and the table hasn't actually been created, this could have an error
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
+			$results = $wpdb->get_results(
+				"SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
+			);
+			self::$_reg_status = array();
+			foreach ($results as $status) {
+				if (!in_array($status->STS_ID, $exclude, true)) {
+					self::$_reg_status[ $status->STS_ID ] = $status->STS_code;
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * This returns a wpdb->results array of all registration date month and years matching the incoming query params
+	 * and grouped by month and year.
+	 *
+	 * @param  array $where_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_reg_months_and_years($where_params)
+	{
+		$query_params[0] = $where_params;
+		$query_params['group_by'] = array('reg_year', 'reg_month');
+		$query_params['order_by'] = array('REG_date' => 'DESC');
+		$columns_to_select = array(
+			'reg_year' => array('YEAR(REG_date)', '%s'),
+			'reg_month' => array('MONTHNAME(REG_date)', '%s'),
+		);
+		return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
+	}
+
+
+	/**
+	 * retrieve ALL registrations for a particular Attendee from db
+	 *
+	 * @param int $ATT_ID
+	 * @return EE_Base_Class[]|EE_Registration[]|null
+	 * @throws EE_Error
+	 */
+	public function get_all_registrations_for_attendee($ATT_ID = 0)
+	{
+		if (!$ATT_ID) {
+			return null;
+		}
+		return $this->get_all(array(array('ATT_ID' => $ATT_ID)));
+	}
+
+
+	/**
+	 * Gets a registration given their REG_url_link. Yes, this should usually
+	 * be passed via a GET parameter.
+	 *
+	 * @param string $REG_url_link
+	 * @return EE_Base_Class|EE_Registration|null
+	 * @throws EE_Error
+	 */
+	public function get_registration_for_reg_url_link($REG_url_link)
+	{
+		if (!$REG_url_link) {
+			return null;
+		}
+		return $this->get_one(array(array('REG_url_link' => $REG_url_link)));
+	}
+
+
+	/**
+	 *        retrieve registration for a specific transaction attendee from db
+	 *
+	 * @access        public
+	 * @param    int $TXN_ID
+	 * @param    int $ATT_ID
+	 * @param    int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the
+	 *                         attendee number is required
+	 * @return        mixed        array on success, FALSE on fail
+	 * @throws EE_Error
+	 */
+	public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0)
+	{
+		return $this->get_one(array(
+			array(
+				'TXN_ID' => $TXN_ID,
+				'ATT_ID' => $ATT_ID,
+			),
+			'limit' => array(min($att_nmbr - 1, 0), 1),
+		));
+	}
+
+
+	/**
+	 *        get the number of registrations per day  for the Registration Admin page Reports Tab.
+	 *        (doesn't utilize models because it's a fairly specialized query)
+	 *
+	 * @access        public
+	 * @param $period string which can be passed to php's strtotime function (eg "-1 month")
+	 * @return stdClass[] with properties regDate and total
+	 * @throws EE_Error
+	 */
+	public function get_registrations_per_day_report($period = '-1 month')
+	{
+		$sql_date = $this->convert_datetime_for_query(
+			'REG_date',
+			date('Y-m-d H:i:s', strtotime($period)),
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where = array(
+			'REG_date' => array('>=', $sql_date),
+			'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
+		);
+		if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
+			$where['Event.EVT_wp_user'] = get_current_user_id();
+		}
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
+		$results = $this->_get_all_wpdb_results(
+			array(
+				$where,
+				'group_by' => 'regDate',
+				'order_by' => array('REG_date' => 'ASC'),
+			),
+			OBJECT,
+			array(
+				'regDate' => array('DATE(' . $query_interval . ')', '%s'),
+				'total' => array('count(REG_ID)', '%d'),
+			)
+		);
+		return $results;
+	}
+
+
+	/**
+	 * Get the number of registrations per day including the count of registrations for each Registration Status.
+	 * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
+	 *
+	 * @param string $period
+	 * @return stdClass[] with properties Registration_REG_date and a column for each registration status as the STS_ID
+	 * @throws EE_Error
+	 *                    (i.e. RAP)
+	 */
+	public function get_registrations_per_day_and_per_status_report($period = '-1 month')
+	{
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$event_table = $wpdb->posts;
+		$sql_date = date('Y-m-d H:i:s', strtotime($period));
+		// prepare the query interval for displaying offset
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'dates.REG_date');
+		// inner date query
+		$inner_date_query = "SELECT DISTINCT REG_date from {$registration_table} ";
+		$inner_where = ' WHERE';
+		// exclude events not authored by user if permissions in effect
+		if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
+			$inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
+		}
+		$inner_where .= " REG_date >= '{$sql_date}'";
+		$inner_date_query .= $inner_where;
+		// start main query
+		$select = "SELECT DATE({$query_interval}) as Registration_REG_date, ";
+		$join = '';
+		$join_parts = array();
+		$select_parts = array();
+		// loop through registration stati to do parts for each status.
+		foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
+			if ($STS_ID === EEM_Registration::status_id_incomplete) {
+				continue;
+			}
+			$select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}";
+			$join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.REG_date = dates.REG_date AND {$STS_code}.STS_ID = '{$STS_ID}'";
+		}
+		// setup the selects
+		$select .= implode(', ', $select_parts);
+		$select .= " FROM ($inner_date_query) AS dates LEFT JOIN ";
+		// setup the joins
+		$join .= implode(' LEFT JOIN ', $join_parts);
+		// now let's put it all together
+		$query = $select . $join . ' GROUP BY Registration_REG_date';
+		// and execute it
+		return $wpdb->get_results($query, ARRAY_A);
+	}
+
+
+	/**
+	 *        get the number of registrations per event  for the Registration Admin page Reports Tab
+	 *
+	 * @access        public
+	 * @param $period string which can be passed to php's strtotime function (eg "-1 month")
+	 * @return stdClass[] each with properties event_name, reg_limit, and total
+	 * @throws EE_Error
+	 */
+	public function get_registrations_per_event_report($period = '-1 month')
+	{
+		$date_sql = $this->convert_datetime_for_query(
+			'REG_date',
+			date('Y-m-d H:i:s', strtotime($period)),
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where = array(
+			'REG_date' => array('>=', $date_sql),
+			'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
+		);
+		if (!EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_others_registrations',
+			'reg_per_event_report'
+		)
+		) {
+			$where['Event.EVT_wp_user'] = get_current_user_id();
+		}
+		$results = $this->_get_all_wpdb_results(
+			array(
+			$where,
+			'group_by' => 'Event.EVT_name',
+			'order_by' => 'Event.EVT_name',
+			'limit' => array(0, 24),
+			),
+			OBJECT,
+			array(
+				'event_name' => array('Event_CPT.post_title', '%s'),
+				'total' => array('COUNT(REG_ID)', '%s'),
+			)
+		);
+		return $results;
+	}
+
+
+	/**
+	 * Get the number of registrations per event grouped by registration status.
+	 * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
+	 *
+	 * @param string $period
+	 * @return stdClass[] with properties `Registration_Event` and a column for each registration status as the STS_ID
+	 * @throws EE_Error
+	 *                    (i.e. RAP)
+	 */
+	public function get_registrations_per_event_and_per_status_report($period = '-1 month')
+	{
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$event_table = $wpdb->posts;
+		$sql_date = date('Y-m-d H:i:s', strtotime($period));
+		// inner date query
+		$inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
+		$inner_where = ' WHERE';
+		// exclude events not authored by user if permissions in effect
+		if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID";
+			$inner_where .= ' post_author = ' . get_current_user_id() . ' AND';
+		}
+		$inner_where .= " REG_date >= '{$sql_date}'";
+		$inner_date_query .= $inner_where;
+		// build main query
+		$select = 'SELECT Event.post_title as Registration_Event, ';
+		$join = '';
+		$join_parts = array();
+		$select_parts = array();
+		// loop through registration stati to do parts for each status.
+		foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
+			if ($STS_ID === EEM_Registration::status_id_incomplete) {
+				continue;
+			}
+			$select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}";
+			$join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.EVT_ID = dates.EVT_ID AND {$STS_code}.STS_ID = '{$STS_ID}' AND {$STS_code}.REG_date = dates.REG_date";
+		}
+		// setup the selects
+		$select .= implode(', ', $select_parts);
+		$select .= " FROM ($inner_date_query) AS dates LEFT JOIN $event_table as Event ON Event.ID = dates.EVT_ID LEFT JOIN ";
+		// setup remaining joins
+		$join .= implode(' LEFT JOIN ', $join_parts);
+		// now put it all together
+		$query = $select . $join . ' GROUP BY Registration_Event';
+		// and execute
+		return $wpdb->get_results($query, ARRAY_A);
+	}
+
+
+	/**
+	 * Returns the EE_Registration of the primary attendee on the transaction id provided
+	 *
+	 * @param int $TXN_ID
+	 * @return EE_Base_Class|EE_Registration|null
+	 * @throws EE_Error
+	 */
+	public function get_primary_registration_for_transaction_ID($TXN_ID = 0)
+	{
+		if (!$TXN_ID) {
+			return null;
+		}
+		return $this->get_one(array(
+			array(
+				'TXN_ID' => $TXN_ID,
+				'REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT,
+			),
+		));
+	}
+
+
+	/**
+	 *        get_event_registration_count
+	 *
+	 * @access public
+	 * @param int $EVT_ID
+	 * @param boolean $for_incomplete_payments
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_event_registration_count($EVT_ID, $for_incomplete_payments = false)
+	{
+		// we only count approved registrations towards registration limits
+		$query_params = array(array('EVT_ID' => $EVT_ID, 'STS_ID' => self::status_id_approved));
+		if ($for_incomplete_payments) {
+			$query_params[0]['Transaction.STS_ID'] = array('!=', EEM_Transaction::complete_status_code);
+		}
+		return $this->count($query_params);
+	}
+
+
+	/**
+	 * Deletes all registrations with no transactions. Note that this needs to be very efficient
+	 * and so it uses wpdb directly
+	 *
+	 * @global WPDB $wpdb
+	 * @return int number deleted
+	 * @throws EE_Error
+	 */
+	public function delete_registrations_with_no_transaction()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		return $wpdb->query(
+			'DELETE r FROM '
+			. $this->table()
+			. ' r LEFT JOIN '
+			. EEM_Transaction::instance()->table()
+			. ' t ON r.TXN_ID = t.TXN_ID WHERE t.TXN_ID IS NULL'
+		);
+	}
+
+
+	/**
+	 *  Count registrations checked into (or out of) a datetime
+	 *
+	 * @param int $DTT_ID datetime ID
+	 * @param boolean $checked_in whether to count registrations checked IN or OUT
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_registrations_checked_into_datetime($DTT_ID, $checked_in = true)
+	{
+		global $wpdb;
+		// subquery to get latest checkin
+		$query = $wpdb->prepare(
+			'SELECT '
+			. 'COUNT( DISTINCT checkins.REG_ID ) '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+			. '( SELECT '
+			. 'max( CHK_timestamp ) AS latest_checkin, '
+			. 'REG_ID AS REG_ID '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' '
+			. 'WHERE DTT_ID=%d '
+			. 'GROUP BY REG_ID'
+			. ') AS most_recent_checkin_per_reg '
+			. 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
+			. 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
+			. 'WHERE '
+			. 'checkins.CHK_in=%d',
+			$DTT_ID,
+			$checked_in
+		);
+		return (int) $wpdb->get_var($query);
+	}
+
+
+	/**
+	 *  Count registrations checked into (or out of) an event.
+	 *
+	 * @param int $EVT_ID event ID
+	 * @param boolean $checked_in whether to count registrations checked IN or OUT
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_registrations_checked_into_event($EVT_ID, $checked_in = true)
+	{
+		global $wpdb;
+		// subquery to get latest checkin
+		$query = $wpdb->prepare(
+			'SELECT '
+			. 'COUNT( DISTINCT checkins.REG_ID ) '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+			. '( SELECT '
+			. 'max( CHK_timestamp ) AS latest_checkin, '
+			. 'REG_ID AS REG_ID '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
+			. 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
+			. 'ON c.DTT_ID=d.DTT_ID '
+			. 'WHERE d.EVT_ID=%d '
+			. 'GROUP BY REG_ID'
+			. ') AS most_recent_checkin_per_reg '
+			. 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
+			. 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
+			. 'WHERE '
+			. 'checkins.CHK_in=%d',
+			$EVT_ID,
+			$checked_in
+		);
+		return (int) $wpdb->get_var($query);
+	}
+
+
+	/**
+	 * The purpose of this method is to retrieve an array of
+	 * EE_Registration objects that represent the latest registration
+	 * for each ATT_ID given in the function argument.
+	 *
+	 * @param array $attendee_ids
+	 * @return EE_Base_Class[]|EE_Registration[]
+	 * @throws EE_Error
+	 */
+	public function get_latest_registration_for_each_of_given_contacts($attendee_ids = array())
+	{
+		// first do a native wp_query to get the latest REG_ID's matching these attendees.
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$attendee_table = $wpdb->posts;
+		$attendee_ids = is_array($attendee_ids)
+			? array_map('absint', $attendee_ids)
+			: array((int) $attendee_ids);
+		$ATT_IDs = implode(',', $attendee_ids);
+		// first we do a query to get the registration ids
+		// (because a group by before order by causes the order by to be ignored.)
+		$registration_id_query = "
 			SELECT registrations.registration_ids as registration_id
 			FROM (
 				SELECT
@@ -835,61 +835,61 @@ 
 			  ) AS registrations
 			  GROUP BY registrations.attendee_ids
 		";
-        $registration_ids = $wpdb->get_results($registration_id_query, ARRAY_A);
-        if (empty($registration_ids)) {
-            return array();
-        }
-        $ids_for_model_query = array();
-        // let's flatten the ids so they can be used in the model query.
-        foreach ($registration_ids as $registration_id) {
-            if (isset($registration_id['registration_id'])) {
-                $ids_for_model_query[] = $registration_id['registration_id'];
-            }
-        }
-        // construct query
-        $_where = array(
-            'REG_ID' => array('IN', $ids_for_model_query),
-        );
-        return $this->get_all(array($_where));
-    }
-
-
-
-    /**
-     * returns a count of registrations for the supplied event having the status as specified
-     *
-     * @param int $EVT_ID
-     * @param array $statuses
-     * @return int
-     * @throws InvalidArgumentException
-     * @throws InvalidStatusException
-     * @throws EE_Error
-     */
-    public function event_reg_count_for_statuses($EVT_ID, $statuses = array())
-    {
-        $EVT_ID = absint($EVT_ID);
-        if (! $EVT_ID) {
-            throw new InvalidArgumentException(
-                esc_html__('An invalid Event ID was supplied.', 'event_espresso')
-            );
-        }
-        $statuses = is_array($statuses) ? $statuses : array($statuses);
-        $statuses = ! empty($statuses) ? $statuses : array(EEM_Registration::status_id_approved);
-        $valid_reg_statuses = EEM_Registration::reg_statuses();
-        foreach ($statuses as $status) {
-            if (! in_array($status, $valid_reg_statuses, true)) {
-                throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso'));
-            }
-        }
-        return $this->count(
-            array(
-                array(
-                    'EVT_ID' => $EVT_ID,
-                    'STS_ID' => array('IN', $statuses),
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
+		$registration_ids = $wpdb->get_results($registration_id_query, ARRAY_A);
+		if (empty($registration_ids)) {
+			return array();
+		}
+		$ids_for_model_query = array();
+		// let's flatten the ids so they can be used in the model query.
+		foreach ($registration_ids as $registration_id) {
+			if (isset($registration_id['registration_id'])) {
+				$ids_for_model_query[] = $registration_id['registration_id'];
+			}
+		}
+		// construct query
+		$_where = array(
+			'REG_ID' => array('IN', $ids_for_model_query),
+		);
+		return $this->get_all(array($_where));
+	}
+
+
+
+	/**
+	 * returns a count of registrations for the supplied event having the status as specified
+	 *
+	 * @param int $EVT_ID
+	 * @param array $statuses
+	 * @return int
+	 * @throws InvalidArgumentException
+	 * @throws InvalidStatusException
+	 * @throws EE_Error
+	 */
+	public function event_reg_count_for_statuses($EVT_ID, $statuses = array())
+	{
+		$EVT_ID = absint($EVT_ID);
+		if (! $EVT_ID) {
+			throw new InvalidArgumentException(
+				esc_html__('An invalid Event ID was supplied.', 'event_espresso')
+			);
+		}
+		$statuses = is_array($statuses) ? $statuses : array($statuses);
+		$statuses = ! empty($statuses) ? $statuses : array(EEM_Registration::status_id_approved);
+		$valid_reg_statuses = EEM_Registration::reg_statuses();
+		foreach ($statuses as $status) {
+			if (! in_array($status, $valid_reg_statuses, true)) {
+				throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso'));
+			}
+		}
+		return $this->count(
+			array(
+				array(
+					'EVT_ID' => $EVT_ID,
+					'STS_ID' => array('IN', $statuses),
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
 }

core/exceptions/InvalidStatusException.php

Indentation +22 added lines, -22 removed lines

@@ -8,26 +8,26 @@
 
 class InvalidStatusException extends InvalidArgumentException
 {
-    /**
-     * InvalidStatusException constructor.
-     * @param string $status the invalid status id that was supplied
-     * @param string $domain the name of the domain, model, or class that the status belongs to
-     * @param string $message custom message
-     * @param int $code
-     * @param Exception|null $previous
-     */
-    public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    '"%1$s" is not a valid %2$s status',
-                    'event_espresso'
-                ),
-                $status,
-                $domain
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidStatusException constructor.
+	 * @param string $status the invalid status id that was supplied
+	 * @param string $domain the name of the domain, model, or class that the status belongs to
+	 * @param string $message custom message
+	 * @param int $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'"%1$s" is not a valid %2$s status',
+					'event_espresso'
+				),
+				$status,
+				$domain
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/domain/services/admin/AdminToolBar.php

Spacing +10 added lines, -10 removed lines

@@ -120,7 +120,7 @@ 
     {
         wp_register_style(
             'espresso-admin-toolbar',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
+            EE_GLOBAL_ASSETS_URL.'css/espresso-admin-toolbar.css',
             array('dashicons'),
             EVENT_ESPRESSO_VERSION
         );
@@ -143,7 +143,7 @@ 
                 'href'  => $this->events_admin_url,
                 'meta'  => array(
                     'title' => esc_html__('Event Espresso', 'event_espresso'),
-                    'class' => $this->menu_class . 'first',
+                    'class' => $this->menu_class.'first',
                 ),
             )
         );
@@ -491,7 +491,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Approved', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-approved',
                     ),
                 )
             );
@@ -528,7 +528,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Pending Payment', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-pending',
                     ),
                 )
             );
@@ -565,7 +565,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Not Approved', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-not-approved',
                     ),
                 )
             );
@@ -602,7 +602,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Cancelled', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-cancelled',
                     ),
                 )
             );
@@ -674,7 +674,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Approved', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-approved',
                     ),
                 )
             );
@@ -711,7 +711,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Pending', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-pending',
                     ),
                 )
             );
@@ -748,7 +748,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Not Approved', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-not-approved',
                     ),
                 )
             );
@@ -785,7 +785,7 @@ 
                     'meta'   => array(
                         'title'  => esc_html__('Cancelled', 'event_espresso'),
                         'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+                        'class'  => $this->menu_class.' ee-toolbar-icon-cancelled',
                     ),
                 )
             );

Indentation +737 added lines, -737 removed lines

@@ -19,741 +19,741 @@
 class AdminToolBar
 {
 
-    /**
-     * @var WP_Admin_Bar $admin_bar
-     */
-    private $admin_bar;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var string $events_admin_url
-     */
-    private $events_admin_url;
-
-    /**
-     * @var string $menu_class
-     */
-    private $menu_class = 'espresso_menu_item_class';
-
-    /**
-     * @var string $reg_admin_url
-     */
-    private $reg_admin_url;
-
-
-    /**
-     * AdminToolBar constructor.
-     *
-     * @param EE_Capabilities $capabilities
-     */
-    public function __construct(EE_Capabilities $capabilities)
-    {
-        $this->capabilities = $capabilities;
-        add_action('admin_bar_menu', array($this, 'espressoToolbarItems'), 100);
-        $this->enqueueAssets();
-    }
-
-
-    /**
-     *    espresso_toolbar_items
-     *
-     * @access public
-     * @param  WP_Admin_Bar $admin_bar
-     * @return void
-     */
-    public function espressoToolbarItems(WP_Admin_Bar $admin_bar)
-    {
-        // if its an AJAX request, or user is NOT an admin, or in full M-Mode
-        if (defined('DOING_AJAX')
-            || ! $this->capabilities->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
-            || EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
-        ) {
-            return;
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->admin_bar = $admin_bar;
-        // we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
-        // because they're only defined in each of their respective constructors
-        // and this might be a frontend request, in which case they aren't available
-        $this->events_admin_url = admin_url('admin.php?page=espresso_events');
-        $this->reg_admin_url = admin_url('admin.php?page=espresso_registrations');
-        // now let's add all of the menu items
-        $this->addTopLevelMenu();
-        $this->addEventsSubMenu();
-        $this->addEventsAddEditHeader();
-        $this->addEventsAddNew();
-        $this->addEventsEditCurrentEvent();
-        $this->addEventsViewHeader();
-        $this->addEventsViewAll();
-        $this->addEventsViewToday();
-        $this->addEventsViewThisMonth();
-        $this->addRegistrationSubMenu();
-        $this->addRegistrationOverviewToday();
-        $this->addRegistrationOverviewTodayApproved();
-        $this->addRegistrationOverviewTodayPendingPayment();
-        $this->addRegistrationOverviewTodayNotApproved();
-        $this->addRegistrationOverviewTodayCancelled();
-        $this->addRegistrationOverviewThisMonth();
-        $this->addRegistrationOverviewThisMonthApproved();
-        $this->addRegistrationOverviewThisMonthPending();
-        $this->addRegistrationOverviewThisMonthNotApproved();
-        $this->addRegistrationOverviewThisMonthCancelled();
-        $this->addExtensionsAndServices();
-    }
-
-
-    /**
-     * @return void
-     */
-    private function enqueueAssets()
-    {
-        wp_register_style(
-            'espresso-admin-toolbar',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
-            array('dashicons'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso-admin-toolbar');
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addTopLevelMenu()
-    {
-        $this->admin_bar->add_menu(
-            array(
-                'id'    => 'espresso-toolbar',
-                'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
-                           . esc_html_x('Event Espresso', 'admin bar menu group label', 'event_espresso')
-                           . '</span>',
-                'href'  => $this->events_admin_url,
-                'meta'  => array(
-                    'title' => esc_html__('Event Espresso', 'event_espresso'),
-                    'class' => $this->menu_class . 'first',
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsSubMenu()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events'
-        )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Events', 'event_espresso'),
-                    'href'   => $this->events_admin_url,
-                    'meta'   => array(
-                        'title'  => esc_html__('Events', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsAddEditHeader()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-view'
-        )
-        ) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-add-edit',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => esc_html__('Add / Edit', 'event_espresso'),
-                    'href'   => '',
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsAddNew()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_edit_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-new'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-new',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Add New', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array('action' => 'create_new'),
-                        $this->events_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Add New', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsEditCurrentEvent()
-    {
-        if (is_single() && (get_post_type() === 'espresso_events')) {
-            // Current post
-            global $post;
-            if ($this->capabilities->current_user_can(
-                'ee_edit_event',
-                'ee_admin_bar_menu_espresso-toolbar-events-edit',
-                $post->ID
-            )) {
-                $this->admin_bar->add_menu(
-                    array(
-                        'id'     => 'espresso-toolbar-events-edit',
-                        'parent' => 'espresso-toolbar-events',
-                        'title'  => '<span class="ee-toolbar-icon"></span>'
-                                    . esc_html__('Edit Event', 'event_espresso'),
-                        'href'   => EEH_URL::add_query_args_and_nonce(
-                            array(
-                                'action' => 'edit',
-                                'post'   => $post->ID,
-                            ),
-                            $this->events_admin_url
-                        ),
-                        'meta'   => array(
-                            'title'  => esc_html__('Edit Event', 'event_espresso'),
-                            'target' => '',
-                            'class'  => $this->menu_class,
-                        ),
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewHeader()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-view'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-view',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => esc_html__('View', 'event_espresso'),
-                    'href'   => '',
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewAll()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-all'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-all',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('All', 'event_espresso'),
-                    'href'   => $this->events_admin_url,
-                    'meta'   => array(
-                        'title'  => esc_html__('All', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewToday()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-today'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-today',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Today', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action' => 'default',
-                            'status' => 'today',
-                        ),
-                        $this->events_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Today', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addEventsViewThisMonth()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-month'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-events-month',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('This Month', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action' => 'default',
-                            'status' => 'month',
-                        ),
-                        $this->events_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('This Month', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationSubMenu()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Registrations', 'event_espresso'),
-                    'href'   => $this->reg_admin_url,
-                    'meta'   => array(
-                        'title'  => esc_html__('Registrations', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewToday()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => esc_html__('Today', 'event_espresso'),
-                    'href'   => '',
-                    'meta'   => array(
-                        'title'  => esc_html__('Today', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayApproved()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayPendingPayment()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-pending',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Pending', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_pending_payment,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Pending Payment', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayNotApproved()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-not-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Not Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_not_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Not Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewTodayCancelled()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-today-cancelled',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Cancelled', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'today',
-                            '_reg_status' => EEM_Registration::status_id_cancelled,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Cancelled', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonth()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => esc_html__('This Month', 'event_espresso'),
-                    'href'   => '', // EEH_URL::add_query_args_and_nonce(
-                    //     array(
-                    //         'action' => 'default',
-                    //         'status' => 'month'
-                    //     ),
-                    //     $this->reg_admin_url
-                    // ),
-                    'meta'   => array(
-                        'title'  => esc_html__('This Month', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthApproved()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthPending()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-pending',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Pending', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_pending_payment,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Pending', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthNotApproved()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-not-approved',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Not Approved', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_not_approved,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Not Approved', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addRegistrationOverviewThisMonthCancelled()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-registrations-month-cancelled',
-                    'parent' => 'espresso-toolbar-registrations',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Cancelled', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(
-                        array(
-                            'action'      => 'default',
-                            'status'      => 'month',
-                            '_reg_status' => EEM_Registration::status_id_cancelled,
-                        ),
-                        $this->reg_admin_url
-                    ),
-                    'meta'   => array(
-                        'title'  => esc_html__('Cancelled', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
-                    ),
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function addExtensionsAndServices()
-    {
-        if ($this->capabilities->current_user_can(
-            'ee_read_ee',
-            'ee_admin_bar_menu_espresso-toolbar-extensions-and-services'
-        )) {
-            $this->admin_bar->add_menu(
-                array(
-                    'id'     => 'espresso-toolbar-extensions-and-services',
-                    'parent' => 'espresso-toolbar',
-                    'title'  => '<span class="ee-toolbar-icon"></span>'
-                                . esc_html__('Extensions & Services', 'event_espresso'),
-                    'href'   => admin_url('admin.php?page=espresso_packages'),
-                    'meta'   => array(
-                        'title'  => esc_html__('Extensions & Services', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $this->menu_class,
-                    ),
-                )
-            );
-        }
-    }
+	/**
+	 * @var WP_Admin_Bar $admin_bar
+	 */
+	private $admin_bar;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var string $events_admin_url
+	 */
+	private $events_admin_url;
+
+	/**
+	 * @var string $menu_class
+	 */
+	private $menu_class = 'espresso_menu_item_class';
+
+	/**
+	 * @var string $reg_admin_url
+	 */
+	private $reg_admin_url;
+
+
+	/**
+	 * AdminToolBar constructor.
+	 *
+	 * @param EE_Capabilities $capabilities
+	 */
+	public function __construct(EE_Capabilities $capabilities)
+	{
+		$this->capabilities = $capabilities;
+		add_action('admin_bar_menu', array($this, 'espressoToolbarItems'), 100);
+		$this->enqueueAssets();
+	}
+
+
+	/**
+	 *    espresso_toolbar_items
+	 *
+	 * @access public
+	 * @param  WP_Admin_Bar $admin_bar
+	 * @return void
+	 */
+	public function espressoToolbarItems(WP_Admin_Bar $admin_bar)
+	{
+		// if its an AJAX request, or user is NOT an admin, or in full M-Mode
+		if (defined('DOING_AJAX')
+			|| ! $this->capabilities->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
+			|| EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
+		) {
+			return;
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->admin_bar = $admin_bar;
+		// we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
+		// because they're only defined in each of their respective constructors
+		// and this might be a frontend request, in which case they aren't available
+		$this->events_admin_url = admin_url('admin.php?page=espresso_events');
+		$this->reg_admin_url = admin_url('admin.php?page=espresso_registrations');
+		// now let's add all of the menu items
+		$this->addTopLevelMenu();
+		$this->addEventsSubMenu();
+		$this->addEventsAddEditHeader();
+		$this->addEventsAddNew();
+		$this->addEventsEditCurrentEvent();
+		$this->addEventsViewHeader();
+		$this->addEventsViewAll();
+		$this->addEventsViewToday();
+		$this->addEventsViewThisMonth();
+		$this->addRegistrationSubMenu();
+		$this->addRegistrationOverviewToday();
+		$this->addRegistrationOverviewTodayApproved();
+		$this->addRegistrationOverviewTodayPendingPayment();
+		$this->addRegistrationOverviewTodayNotApproved();
+		$this->addRegistrationOverviewTodayCancelled();
+		$this->addRegistrationOverviewThisMonth();
+		$this->addRegistrationOverviewThisMonthApproved();
+		$this->addRegistrationOverviewThisMonthPending();
+		$this->addRegistrationOverviewThisMonthNotApproved();
+		$this->addRegistrationOverviewThisMonthCancelled();
+		$this->addExtensionsAndServices();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function enqueueAssets()
+	{
+		wp_register_style(
+			'espresso-admin-toolbar',
+			EE_GLOBAL_ASSETS_URL . 'css/espresso-admin-toolbar.css',
+			array('dashicons'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso-admin-toolbar');
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addTopLevelMenu()
+	{
+		$this->admin_bar->add_menu(
+			array(
+				'id'    => 'espresso-toolbar',
+				'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
+						   . esc_html_x('Event Espresso', 'admin bar menu group label', 'event_espresso')
+						   . '</span>',
+				'href'  => $this->events_admin_url,
+				'meta'  => array(
+					'title' => esc_html__('Event Espresso', 'event_espresso'),
+					'class' => $this->menu_class . 'first',
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsSubMenu()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events'
+		)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Events', 'event_espresso'),
+					'href'   => $this->events_admin_url,
+					'meta'   => array(
+						'title'  => esc_html__('Events', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsAddEditHeader()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-view'
+		)
+		) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-add-edit',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => esc_html__('Add / Edit', 'event_espresso'),
+					'href'   => '',
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsAddNew()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_edit_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-new'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-new',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Add New', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array('action' => 'create_new'),
+						$this->events_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Add New', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsEditCurrentEvent()
+	{
+		if (is_single() && (get_post_type() === 'espresso_events')) {
+			// Current post
+			global $post;
+			if ($this->capabilities->current_user_can(
+				'ee_edit_event',
+				'ee_admin_bar_menu_espresso-toolbar-events-edit',
+				$post->ID
+			)) {
+				$this->admin_bar->add_menu(
+					array(
+						'id'     => 'espresso-toolbar-events-edit',
+						'parent' => 'espresso-toolbar-events',
+						'title'  => '<span class="ee-toolbar-icon"></span>'
+									. esc_html__('Edit Event', 'event_espresso'),
+						'href'   => EEH_URL::add_query_args_and_nonce(
+							array(
+								'action' => 'edit',
+								'post'   => $post->ID,
+							),
+							$this->events_admin_url
+						),
+						'meta'   => array(
+							'title'  => esc_html__('Edit Event', 'event_espresso'),
+							'target' => '',
+							'class'  => $this->menu_class,
+						),
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewHeader()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-view'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-view',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => esc_html__('View', 'event_espresso'),
+					'href'   => '',
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewAll()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-all'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-all',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('All', 'event_espresso'),
+					'href'   => $this->events_admin_url,
+					'meta'   => array(
+						'title'  => esc_html__('All', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewToday()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-today'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-today',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Today', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action' => 'default',
+							'status' => 'today',
+						),
+						$this->events_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Today', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addEventsViewThisMonth()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-month'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-events-month',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('This Month', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action' => 'default',
+							'status' => 'month',
+						),
+						$this->events_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('This Month', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationSubMenu()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Registrations', 'event_espresso'),
+					'href'   => $this->reg_admin_url,
+					'meta'   => array(
+						'title'  => esc_html__('Registrations', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewToday()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => esc_html__('Today', 'event_espresso'),
+					'href'   => '',
+					'meta'   => array(
+						'title'  => esc_html__('Today', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayApproved()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayPendingPayment()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-pending',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Pending', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_pending_payment,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Pending Payment', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayNotApproved()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-not-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Not Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_not_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Not Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewTodayCancelled()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-today-cancelled',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Cancelled', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'today',
+							'_reg_status' => EEM_Registration::status_id_cancelled,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Cancelled', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonth()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => esc_html__('This Month', 'event_espresso'),
+					'href'   => '', // EEH_URL::add_query_args_and_nonce(
+					//     array(
+					//         'action' => 'default',
+					//         'status' => 'month'
+					//     ),
+					//     $this->reg_admin_url
+					// ),
+					'meta'   => array(
+						'title'  => esc_html__('This Month', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthApproved()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthPending()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-pending',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Pending', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_pending_payment,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Pending', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-pending',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthNotApproved()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-not-approved',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Not Approved', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_not_approved,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Not Approved', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-not-approved',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addRegistrationOverviewThisMonthCancelled()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-registrations-month-cancelled',
+					'parent' => 'espresso-toolbar-registrations',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Cancelled', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(
+						array(
+							'action'      => 'default',
+							'status'      => 'month',
+							'_reg_status' => EEM_Registration::status_id_cancelled,
+						),
+						$this->reg_admin_url
+					),
+					'meta'   => array(
+						'title'  => esc_html__('Cancelled', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class . ' ee-toolbar-icon-cancelled',
+					),
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function addExtensionsAndServices()
+	{
+		if ($this->capabilities->current_user_can(
+			'ee_read_ee',
+			'ee_admin_bar_menu_espresso-toolbar-extensions-and-services'
+		)) {
+			$this->admin_bar->add_menu(
+				array(
+					'id'     => 'espresso-toolbar-extensions-and-services',
+					'parent' => 'espresso-toolbar',
+					'title'  => '<span class="ee-toolbar-icon"></span>'
+								. esc_html__('Extensions & Services', 'event_espresso'),
+					'href'   => admin_url('admin.php?page=espresso_packages'),
+					'meta'   => array(
+						'title'  => esc_html__('Extensions & Services', 'event_espresso'),
+						'target' => '',
+						'class'  => $this->menu_class,
+					),
+				)
+			);
+		}
+	}
 }