eventespresso / event-espresso-core

core/db_classes/EE_Taxes.class.php

Spacing +3 added lines, -3 removed lines

@@ -40,7 +40,7 @@ 
         $tax       = 0;
         $total_tax = 0;
         // This first checks to see if the given ticket is taxable.
-        if (! $ticket->get('TKT_taxable')) {
+        if ( ! $ticket->get('TKT_taxable')) {
             return $tax;
         }
         // get subtotal (notice we're only retrieving a subtotal if there isn't one given)
@@ -84,8 +84,8 @@ 
     public static function get_subtotal_for_admin(EE_Ticket $ticket)
     {
         $TKT_ID = $ticket->ID();
-        return isset(self::$_subtotal[ $TKT_ID ])
-            ? self::$_subtotal[ $TKT_ID ]
+        return isset(self::$_subtotal[$TKT_ID])
+            ? self::$_subtotal[$TKT_ID]
             : self::_get_subtotal_for_admin($ticket);
     }
 

Indentation +130 added lines, -130 removed lines

@@ -9,145 +9,145 @@
  */
 class EE_Taxes extends EE_Base
 {
-    /**
-     * This is used for when EE_Taxes is used statically by the admin
-     *
-     * @var array
-     */
-    private static $_subtotal = [];
+	/**
+	 * This is used for when EE_Taxes is used statically by the admin
+	 *
+	 * @var array
+	 */
+	private static $_subtotal = [];
 
-    /**
-     * This holds an array of EE_Price objects that are of PRT_ID == 4 (tax price types)
-     *
-     * @var EE_Price[]
-     */
-    private static $_default_taxes = [];
+	/**
+	 * This holds an array of EE_Price objects that are of PRT_ID == 4 (tax price types)
+	 *
+	 * @var EE_Price[]
+	 */
+	private static $_default_taxes = [];
 
 
-    /**
-     * This method simply calculates the total taxes for a given ticket (by pulling the prices attached to the ticket
-     * and applying default taxes to it). Note: this is just an intermediary helper method added to facilitate quick
-     * calc of taxes for tickets listed in the event editor.
-     *
-     * @param EE_Ticket $ticket incoming EE_Ticket
-     * @return float             total taxes to apply to ticket.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_total_taxes_for_admin(EE_Ticket $ticket)
-    {
-        $tax       = 0;
-        $total_tax = 0;
-        // This first checks to see if the given ticket is taxable.
-        if (! $ticket->get('TKT_taxable')) {
-            return $tax;
-        }
-        // get subtotal (notice we're only retrieving a subtotal if there isn't one given)
-        $subtotal = self::get_subtotal_for_admin($ticket);
-        // get taxes
-        $taxes = self::get_taxes_for_admin();
-        // apply taxes to subtotal
-        foreach ($taxes as $tax) {
-            // assuming taxes are not cumulative
-            $total_tax += $subtotal * $tax->get('PRC_amount') / 100;
-        }
-        return $total_tax;
-    }
+	/**
+	 * This method simply calculates the total taxes for a given ticket (by pulling the prices attached to the ticket
+	 * and applying default taxes to it). Note: this is just an intermediary helper method added to facilitate quick
+	 * calc of taxes for tickets listed in the event editor.
+	 *
+	 * @param EE_Ticket $ticket incoming EE_Ticket
+	 * @return float             total taxes to apply to ticket.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_total_taxes_for_admin(EE_Ticket $ticket)
+	{
+		$tax       = 0;
+		$total_tax = 0;
+		// This first checks to see if the given ticket is taxable.
+		if (! $ticket->get('TKT_taxable')) {
+			return $tax;
+		}
+		// get subtotal (notice we're only retrieving a subtotal if there isn't one given)
+		$subtotal = self::get_subtotal_for_admin($ticket);
+		// get taxes
+		$taxes = self::get_taxes_for_admin();
+		// apply taxes to subtotal
+		foreach ($taxes as $tax) {
+			// assuming taxes are not cumulative
+			$total_tax += $subtotal * $tax->get('PRC_amount') / 100;
+		}
+		return $total_tax;
+	}
 
 
-    /**
-     * Gets the total percentage of tax that should be applied to taxable line items
-     *
-     * @return float the percentage of tax that should be added to taxable items
-     * @throws EE_Error eg 20 for %20 tax (NOT 0.20, which
-     * @throws ReflectionException
-     */
-    public static function get_total_taxes_percentage()
-    {
-        $total_tax_percent = 0;
-        foreach (self::get_taxes_for_admin() as $tax_price) {
-            if ($tax_price instanceof EE_Price) {
-                $total_tax_percent += $tax_price->amount();
-            }
-        }
-        return $total_tax_percent;
-    }
+	/**
+	 * Gets the total percentage of tax that should be applied to taxable line items
+	 *
+	 * @return float the percentage of tax that should be added to taxable items
+	 * @throws EE_Error eg 20 for %20 tax (NOT 0.20, which
+	 * @throws ReflectionException
+	 */
+	public static function get_total_taxes_percentage()
+	{
+		$total_tax_percent = 0;
+		foreach (self::get_taxes_for_admin() as $tax_price) {
+			if ($tax_price instanceof EE_Price) {
+				$total_tax_percent += $tax_price->amount();
+			}
+		}
+		return $total_tax_percent;
+	}
 
 
-    /**
-     * @param EE_Ticket $ticket
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_subtotal_for_admin(EE_Ticket $ticket)
-    {
-        $TKT_ID = $ticket->ID();
-        return isset(self::$_subtotal[ $TKT_ID ])
-            ? self::$_subtotal[ $TKT_ID ]
-            : self::_get_subtotal_for_admin($ticket);
-    }
+	/**
+	 * @param EE_Ticket $ticket
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_subtotal_for_admin(EE_Ticket $ticket)
+	{
+		$TKT_ID = $ticket->ID();
+		return isset(self::$_subtotal[ $TKT_ID ])
+			? self::$_subtotal[ $TKT_ID ]
+			: self::_get_subtotal_for_admin($ticket);
+	}
 
 
-    /**
-     * simply take an incoming ticket and calculate the subtotal for the ticket
-     *
-     * @param EE_Ticket $ticket
-     * @return float     subtotal calculated from all EE_Price[] on Ticket.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private static function _get_subtotal_for_admin(EE_Ticket $ticket)
-    {
-        $subtotal = 0;
-        // get all prices
-        $prices = $ticket->get_many_related(
-            'Price',
-            [
-                'default_where_conditions' => 'none',
-                'order_by'                 => ['PRC_order' => 'ASC'],
-            ]
-        );
-        // let's loop through them (base price is always the first item)
-        foreach ($prices as $price) {
-            if ($price instanceof EE_Price) {
-                $price_type = $price->type_obj();
-                if ($price_type instanceof EE_Price_Type) {
-                    switch ($price->type_obj()->base_type()) {
-                        case 1: // base price
-                        case 3: // surcharges
-                            $subtotal += $price->is_percent()
-                                ? $subtotal * $price->amount() / 100
-                                : $price->amount();
-                            break;
-                        case 2: // discounts
-                            $subtotal -= $price->is_percent()
-                                ? $subtotal * $price->amount() / 100
-                                : $price->amount();
-                            break;
-                    }
-                }
-            }
-        }
-        $TKT_ID          = $ticket->ID();
-        self::$_subtotal = [$TKT_ID => $subtotal];
-        return $subtotal;
-    }
+	/**
+	 * simply take an incoming ticket and calculate the subtotal for the ticket
+	 *
+	 * @param EE_Ticket $ticket
+	 * @return float     subtotal calculated from all EE_Price[] on Ticket.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private static function _get_subtotal_for_admin(EE_Ticket $ticket)
+	{
+		$subtotal = 0;
+		// get all prices
+		$prices = $ticket->get_many_related(
+			'Price',
+			[
+				'default_where_conditions' => 'none',
+				'order_by'                 => ['PRC_order' => 'ASC'],
+			]
+		);
+		// let's loop through them (base price is always the first item)
+		foreach ($prices as $price) {
+			if ($price instanceof EE_Price) {
+				$price_type = $price->type_obj();
+				if ($price_type instanceof EE_Price_Type) {
+					switch ($price->type_obj()->base_type()) {
+						case 1: // base price
+						case 3: // surcharges
+							$subtotal += $price->is_percent()
+								? $subtotal * $price->amount() / 100
+								: $price->amount();
+							break;
+						case 2: // discounts
+							$subtotal -= $price->is_percent()
+								? $subtotal * $price->amount() / 100
+								: $price->amount();
+							break;
+					}
+				}
+			}
+		}
+		$TKT_ID          = $ticket->ID();
+		self::$_subtotal = [$TKT_ID => $subtotal];
+		return $subtotal;
+	}
 
 
-    /**
-     * get all default prices that are a Tax price type (PRT_ID = 4) and return
-     *
-     * @return EE_Price[] EE_Price objects that have PRT_ID == 4
-     * @throws EE_Error
-     */
-    public static function get_taxes_for_admin()
-    {
-        if (empty(self::$_default_taxes)) {
-            self::$_default_taxes = EEM_Price::instance()->get_all(
-                [['Price_Type.PBT_ID' => 4]]
-            );
-        }
-        return self::$_default_taxes;
-    }
+	/**
+	 * get all default prices that are a Tax price type (PRT_ID = 4) and return
+	 *
+	 * @return EE_Price[] EE_Price objects that have PRT_ID == 4
+	 * @throws EE_Error
+	 */
+	public static function get_taxes_for_admin()
+	{
+		if (empty(self::$_default_taxes)) {
+			self::$_default_taxes = EEM_Price::instance()->get_all(
+				[['Price_Type.PBT_ID' => 4]]
+			);
+		}
+		return self::$_default_taxes;
+	}
 }

core/db_classes/EE_Payment.class.php

Spacing +10 added lines, -10 removed lines

@@ -31,7 +31,7 @@ 
     public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
     {
         $payment = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             $payment = new EE_Payment($props_n_values, false, $timezone, $date_formats);
         }
         return $payment;
@@ -66,7 +66,7 @@ 
     {
         parent::__construct($props_n_values, $bydb, $timezone, $date_formats);
         // in a better world this would have been injected upon construction
-        if (! $this->currency_formatter instanceof CurrencyFormatter) {
+        if ( ! $this->currency_formatter instanceof CurrencyFormatter) {
             $this->currency_formatter = LoaderFactory::getLoader()->getShared(CurrencyFormatter::class);
         }
     }
@@ -330,7 +330,7 @@ 
      */
     public function timestamp($date_format = '', $time_format = '')
     {
-        return $this->get_i18n_datetime('PAY_timestamp', trim($date_format . ' ' . $time_format));
+        return $this->get_i18n_datetime('PAY_timestamp', trim($date_format.' '.$time_format));
     }
 
 
@@ -525,7 +525,7 @@ 
                     : '';
                 break;
         }
-        return $icon . $status[ $this->STS_ID() ];
+        return $icon.$status[$this->STS_ID()];
     }
 
 
@@ -704,13 +704,13 @@ 
             $get_params = null;
             parse_str($querystring, $get_params);
             $inside_form_html .= $this->_args_as_inputs($get_params);
-            $redirect_url = str_replace('?' . $querystring, '', $redirect_url);
+            $redirect_url = str_replace('?'.$querystring, '', $redirect_url);
         }
         $form = EEH_HTML::nl(1)
-                . '<form method="' . $method . '" name="gateway_form" action="' . $redirect_url . '">';
-        $form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
+                . '<form method="'.$method.'" name="gateway_form" action="'.$redirect_url.'">';
+        $form .= EEH_HTML::nl(1).$this->redirect_args_as_inputs();
         $form .= $inside_form_html;
-        $form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
+        $form .= EEH_HTML::nl(-1).'</form>'.EEH_HTML::nl(-1);
         return $form;
     }
 
@@ -765,8 +765,8 @@ 
             return $html;
         }
         return EEH_HTML::nl()
-            . '<input type="hidden" name="' . $name . '"'
-            . ' value="' . esc_attr($value) . '"/>';
+            . '<input type="hidden" name="'.$name.'"'
+            . ' value="'.esc_attr($value).'"/>';
     }
 
 

Indentation +918 added lines, -918 removed lines

@@ -13,922 +13,922 @@
  */
 class EE_Payment extends EE_Base_Class implements EEI_Payment
 {
-    /**
-     * @var CurrencyFormatter
-     * @since $VID:$
-     */
-    protected $currency_formatter;
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Payment
-     * @throws EE_Error|ReflectionException
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $payment = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        if (! $payment instanceof EE_Payment) {
-            $payment = new EE_Payment($props_n_values, false, $timezone, $date_formats);
-        }
-        return $payment;
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Payment
-     * @throws EE_Error|ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new EE_Payment($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Adds some defaults if they're not specified
-     *
-     * @param array  $props_n_values
-     * @param bool   $bydb
-     * @param string $timezone
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct($props_n_values = [], $bydb = false, $timezone = '', $date_formats = [])
-    {
-        parent::__construct($props_n_values, $bydb, $timezone, $date_formats);
-        // in a better world this would have been injected upon construction
-        if (! $this->currency_formatter instanceof CurrencyFormatter) {
-            $this->currency_formatter = LoaderFactory::getLoader()->getShared(CurrencyFormatter::class);
-        }
-    }
-
-
-    /**
-     * Set Transaction ID
-     *
-     * @access public
-     * @param int $TXN_ID
-     * @throws EE_Error|ReflectionException
-     */
-    public function set_transaction_id($TXN_ID = 0)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets the transaction related to this payment
-     *
-     * @return EE_Base_Class|EE_Transaction
-     * @throws EE_Error|ReflectionException
-     */
-    public function transaction()
-    {
-        return $this->get_first_related('Transaction');
-    }
-
-
-    /**
-     * Set Status
-     *
-     * @access public
-     * @param string $STS_ID
-     * @throws EE_Error|ReflectionException
-     */
-    public function set_status($STS_ID = '')
-    {
-        $this->set('STS_ID', $STS_ID);
-    }
-
-
-    /**
-     * Set Payment Timestamp
-     *
-     * @access public
-     * @param int $timestamp
-     * @throws EE_Error|ReflectionException
-     */
-    public function set_timestamp($timestamp = 0)
-    {
-        $this->set('PAY_timestamp', $timestamp);
-    }
-
-
-    /**
-     * Set Payment Method
-     *
-     * @access public
-     * @param string $PAY_source
-     * @throws EE_Error|ReflectionException
-     */
-    public function set_source($PAY_source = '')
-    {
-        $this->set('PAY_source', $PAY_source);
-    }
-
-
-    /**
-     * Set Payment Amount
-     *
-     * @access public
-     * @param float $amount
-     * @throws EE_Error|ReflectionException
-     */
-    public function set_amount($amount = 0.00)
-    {
-        $this->set('PAY_amount', $amount);
-    }
-
-
-    /**
-     * Set Payment Gateway Response
-     *
-     * @access public
-     * @param string $gateway_response
-     * @throws EE_Error|ReflectionException
-     */
-    public function set_gateway_response($gateway_response = '')
-    {
-        $this->set('PAY_gateway_response', $gateway_response);
-    }
-
-
-    /**
-     * Returns the name of the payment method used on this payment (previously known merely as 'gateway')
-     * but since 4.6.0, payment methods are models and the payment keeps a foreign key to the payment method
-     * used on it
-     *
-     * @return string
-     * @throws EE_Error|ReflectionException
-     *@deprecated
-     */
-    public function gateway()
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Payment::gateway',
-            esc_html__(
-                'The method EE_Payment::gateway() has been deprecated. Consider instead using EE_Payment::payment_method()->name()',
-                'event_espresso'
-            ),
-            '4.6.0'
-        );
-        return $this->payment_method() ? $this->payment_method()->name() : esc_html__('Unknown', 'event_espresso');
-    }
-
-
-    /**
-     * Set Gateway Transaction ID
-     *
-     * @access public
-     * @param string $txn_id_chq_nmbr
-     * @throws EE_Error|ReflectionException
-     */
-    public function set_txn_id_chq_nmbr($txn_id_chq_nmbr = '')
-    {
-        $this->set('PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr);
-    }
-
-
-    /**
-     * Set Purchase Order Number
-     *
-     * @access public
-     * @param string $po_number
-     * @throws EE_Error|ReflectionException
-     */
-    public function set_po_number($po_number = '')
-    {
-        $this->set('PAY_po_number', $po_number);
-    }
-
-
-    /**
-     * Set Extra Accounting Field
-     *
-     * @access public
-     * @param string $extra_accntng
-     * @throws EE_Error|ReflectionException
-     */
-    public function set_extra_accntng($extra_accntng = '')
-    {
-        $this->set('PAY_extra_accntng', $extra_accntng);
-    }
-
-
-    /**
-     * Set Payment made via admin flag
-     *
-     * @access public
-     * @param bool $via_admin
-     * @throws EE_Error|ReflectionException
-     */
-    public function set_payment_made_via_admin($via_admin = false)
-    {
-        if ($via_admin) {
-            $this->set('PAY_source', EEM_Payment_Method::scope_admin);
-        } else {
-            $this->set('PAY_source', EEM_Payment_Method::scope_cart);
-        }
-    }
-
-
-    /**
-     * Set Payment Details
-     *
-     * @access public
-     * @param string|array $details
-     * @throws EE_Error|ReflectionException
-     */
-    public function set_details($details = '')
-    {
-        if (is_array($details)) {
-            array_walk_recursive($details, array($this, '_strip_all_tags_within_array'));
-        } else {
-            $details = wp_strip_all_tags($details);
-        }
-        $this->set('PAY_details', $details);
-    }
-
-
-    /**
-     * Sets redirect_url
-     *
-     * @param string $redirect_url
-     * @throws EE_Error|ReflectionException
-     */
-    public function set_redirect_url($redirect_url)
-    {
-        $this->set('PAY_redirect_url', $redirect_url);
-    }
-
-
-    /**
-     * Sets redirect_args
-     *
-     * @param array $redirect_args
-     * @throws EE_Error|ReflectionException
-     */
-    public function set_redirect_args($redirect_args)
-    {
-        $this->set('PAY_redirect_args', $redirect_args);
-    }
-
-
-    /**
-     * get Payment Transaction ID
-     *
-     * @access public
-     * @throws EE_Error|ReflectionException
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * get Payment Status
-     *
-     * @access public
-     * @throws EE_Error|ReflectionException
-     */
-    public function status()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * get Payment Status
-     *
-     * @access public
-     * @throws EE_Error|ReflectionException
-     */
-    public function STS_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * get Payment Timestamp
-     *
-     * @access public
-     * @param string $date_format
-     * @param string $time_format
-     * @return string
-     * @throws EE_Error|ReflectionException
-     */
-    public function timestamp($date_format = '', $time_format = '')
-    {
-        return $this->get_i18n_datetime('PAY_timestamp', trim($date_format . ' ' . $time_format));
-    }
-
-
-    /**
-     * get Payment Source
-     *
-     * @access public
-     * @throws EE_Error|ReflectionException
-     */
-    public function source()
-    {
-        return $this->get('PAY_source');
-    }
-
-
-    /**
-     * get Payment Amount
-     *
-     * @access public
-     * @return float
-     * @throws EE_Error|ReflectionException
-     */
-    public function amount()
-    {
-        return (float) $this->get('PAY_amount');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error|ReflectionException
-     */
-    public function amount_no_code()
-    {
-        return $this->get_pretty('PAY_amount', 'no_currency_code');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error|ReflectionException
-     */
-    public function prettyAmount()
-    {
-        return $this->get_pretty('PAY_amount', 'localized_currency');
-    }
-
-
-    /**
-     * get Payment Gateway Response
-     *
-     * @access public
-     * @throws EE_Error|ReflectionException
-     */
-    public function gateway_response()
-    {
-        return $this->get('PAY_gateway_response');
-    }
-
-
-    /**
-     * get Payment Gateway Transaction ID
-     *
-     * @access public
-     * @throws EE_Error|ReflectionException
-     */
-    public function txn_id_chq_nmbr()
-    {
-        return $this->get('PAY_txn_id_chq_nmbr');
-    }
-
-
-    /**
-     * get Purchase Order Number
-     *
-     * @access public
-     * @throws EE_Error|ReflectionException
-     */
-    public function po_number()
-    {
-        return $this->get('PAY_po_number');
-    }
-
-
-    /**
-     * get Extra Accounting Field
-     *
-     * @access public
-     * @throws EE_Error|ReflectionException
-     */
-    public function extra_accntng()
-    {
-        return $this->get('PAY_extra_accntng');
-    }
-
-
-    /**
-     * get Payment made via admin source
-     *
-     * @access public
-     * @throws EE_Error|ReflectionException
-     */
-    public function payment_made_via_admin()
-    {
-        return ($this->get('PAY_source') === EEM_Payment_Method::scope_admin);
-    }
-
-
-    /**
-     * get Payment Details
-     *
-     * @access public
-     * @throws EE_Error|ReflectionException
-     */
-    public function details()
-    {
-        return $this->get('PAY_details');
-    }
-
-
-    /**
-     * Gets redirect_url
-     *
-     * @return string
-     * @throws EE_Error|ReflectionException
-     */
-    public function redirect_url()
-    {
-        return $this->get('PAY_redirect_url');
-    }
-
-
-    /**
-     * Gets redirect_args
-     *
-     * @return array
-     * @throws EE_Error|ReflectionException
-     */
-    public function redirect_args()
-    {
-        return $this->get('PAY_redirect_args');
-    }
-
-
-    /**
-     * echoes $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @return void
-     * @throws EE_Error|ReflectionException
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
-    }
-
-
-    /**
-     * returns a pretty version of the status, good for displaying to users
-     *
-     * @param bool $show_icons
-     * @return string
-     * @throws EE_Error|ReflectionException
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(
-            array($this->STS_ID() => esc_html__('unknown', 'event_espresso')),
-            false,
-            'sentence'
-        );
-        $icon = '';
-        switch ($this->STS_ID()) {
-            case EEM_Payment::status_id_approved:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_pending:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-clock ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_cancelled:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_declined:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
-                    : '';
-                break;
-        }
-        return $icon . $status[ $this->STS_ID() ];
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean whether the payment is approved or not
-     * @throws EE_Error|ReflectionException
-     */
-    public function is_approved()
-    {
-        return $this->status_is(EEM_Payment::status_id_approved);
-    }
-
-
-    /**
-     * Generally determines if the status of this payment equals
-     * the $STS_ID string
-     *
-     * @param string $STS_ID an ID from the esp_status table/
-     *                       one of the status_id_* on the EEM_Payment model
-     * @return boolean whether the status of this payment equals the status id
-     * @throws EE_Error|ReflectionException
-     */
-    protected function status_is($STS_ID)
-    {
-        return $STS_ID === $this->STS_ID();
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean whether the payment is pending or not
-     * @throws EE_Error|ReflectionException
-     */
-    public function is_pending()
-    {
-        return $this->status_is(EEM_Payment::status_id_pending);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws EE_Error|ReflectionException
-     */
-    public function is_cancelled()
-    {
-        return $this->status_is(EEM_Payment::status_id_cancelled);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws EE_Error|ReflectionException
-     */
-    public function is_declined()
-    {
-        return $this->status_is(EEM_Payment::status_id_declined);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws EE_Error|ReflectionException
-     */
-    public function is_failed()
-    {
-        return $this->status_is(EEM_Payment::status_id_failed);
-    }
-
-
-    /**
-     * For determining if the payment is actually a refund ( ie: has a negative value )
-     *
-     * @return boolean
-     * @throws EE_Error|ReflectionException
-     */
-    public function is_a_refund()
-    {
-        return $this->amount() < 0;
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Base_Class|EE_Status
-     * @throws EE_Error|ReflectionException
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Gets all the extra meta info on this payment
-     *
-     * @param array $query_params
-     * @return array[]|EE_Base_Class[]|EE_Extra_Meta
-     * @throws EE_Error|ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function extra_meta($query_params = array())
-    {
-        return $this->get_many_related('Extra_Meta', $query_params);
-    }
-
-
-    /**
-     * Gets the last-used payment method on this transaction
-     * (we COULD just use the last-made payment, but some payment methods, namely
-     * offline ones, dont' create payments)
-     *
-     * @return EE_Base_Class|EE_Payment_Method
-     * @throws EE_Error|ReflectionException
-     */
-    public function payment_method()
-    {
-        return $this->get_first_related('Payment_Method');
-    }
-
-
-    /**
-     * Gets the HTML for redirecting the user to an offsite gateway
-     * You can pass it special content to put inside the form, or use
-     * the default inner content (or possibly generate this all yourself using
-     * redirect_url() and redirect_args() or redirect_args_as_inputs()).
-     * Creates a POST request by default, but if no redirect args are specified, creates a GET request instead
-     * (and any querystring variables in the redirect_url are converted into html inputs
-     * so browsers submit them properly)
-     *
-     * @param string $inside_form_html
-     * @return string html
-     * @throws EE_Error|ReflectionException
-     */
-    public function redirect_form($inside_form_html = null)
-    {
-        $redirect_url = $this->redirect_url();
-
-        if (empty($redirect_url)) {
-            return null;
-        }
-
-        // what ? no inner form content?
-        if ($inside_form_html === null) {
-            $inside_form_html = EEH_HTML::p(
-                sprintf(
-                    esc_html__(
-                        'If you are not automatically redirected to the payment website within 10 seconds... %1$s %2$s Click Here %3$s',
-                        'event_espresso'
-                    ),
-                    EEH_HTML::br(2),
-                    '<input type="submit" value="',
-                    '">'
-                ),
-                '',
-                '',
-                'text-align:center;'
-            );
-        }
-
-        $method = apply_filters(
-            'FHEE__EE_Payment__redirect_form__method',
-            $this->redirect_args() ? 'POST' : 'GET',
-            $this
-        );
-
-        // if it's a GET request, we need to remove all the GET params in the querystring
-        // and put them into the form instead
-        if ($method === 'GET') {
-            $querystring = parse_url($redirect_url, PHP_URL_QUERY);
-            $get_params = null;
-            parse_str($querystring, $get_params);
-            $inside_form_html .= $this->_args_as_inputs($get_params);
-            $redirect_url = str_replace('?' . $querystring, '', $redirect_url);
-        }
-
-        $form = EEH_HTML::nl(1)
-                . '<form method="' . $method . '" name="gateway_form" action="' . $redirect_url . '">';
-        $form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
-        $form .= $inside_form_html;
-        $form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
-        return $form;
-    }
-
-
-    /**
-     * Changes all the name-value pairs of the redirect args into html inputs
-     * and returns the html as a string
-     *
-     * @return string
-     * @throws EE_Error|ReflectionException
-     */
-    public function redirect_args_as_inputs()
-    {
-        return $this->_args_as_inputs($this->redirect_args());
-    }
-
-
-    /**
-     * Converts a 2d array of key-value pairs into html hidden inputs
-     * and returns the string of html
-     *
-     * @param array $args key-value pairs
-     * @return string
-     */
-    protected function _args_as_inputs($args)
-    {
-        $html = '';
-        if ($args !== null && is_array($args)) {
-            foreach ($args as $name => $value) {
-                $html .= $this->generateInput($name, $value);
-            }
-        }
-        return $html;
-    }
-
-    /**
-     * Converts either a single name and value or array of values into html hidden inputs
-     * and returns the string of html
-     *
-     * @param string $name
-     * @param string|array $value
-     * @return string
-     */
-    private function generateInput($name, $value)
-    {
-        if (is_array($value)) {
-            $html = '';
-            $name = "{$name}[]";
-            foreach ($value as $array_value) {
-                $html .= $this->generateInput($name, $array_value);
-            }
-            return $html;
-        }
-        return EEH_HTML::nl()
-            . '<input type="hidden" name="' . $name . '"'
-            . ' value="' . esc_attr($value) . '"/>';
-    }
-
-
-    /**
-     * Returns the currency of the payment.
-     * (At the time of writing, this will always be the currency in the configuration;
-     * however in the future it is anticipated that this will be stored on the payment
-     * object itself)
-     *
-     * @return string for the currency code
-     */
-    public function currency_code()
-    {
-        return $this->currency_formatter->getCurrencyIsoCodeForLocale();
-    }
-
-
-    /**
-     * apply wp_strip_all_tags to all elements within an array
-     *
-     * @access private
-     * @param mixed $item
-     */
-    private function _strip_all_tags_within_array(&$item)
-    {
-        if (is_object($item)) {
-            $item = (array) $item;
-        }
-        if (is_array($item)) {
-            array_walk_recursive($item, array($this, '_strip_all_tags_within_array'));
-        } else {
-            $item = wp_strip_all_tags($item);
-        }
-    }
-
-
-    /**
-     * Returns TRUE is this payment was set to approved during this request (or
-     * is approved and was created during this request). False otherwise.
-     *
-     * @return boolean
-     * @throws EE_Error|ReflectionException
-     */
-    public function just_approved()
-    {
-        $original_status = EEH_Array::is_set(
-            $this->_props_n_values_provided_in_constructor,
-            'STS_ID',
-            $this->get_model()->field_settings_for('STS_ID')->get_default_value()
-        );
-        $current_status = $this->status();
-        if (
-            $original_status !== EEM_Payment::status_id_approved
-            && $current_status === EEM_Payment::status_id_approved
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Overrides parents' get_pretty() function just for legacy reasons
-     * (to allow ticket https://events.codebasehq.com/projects/event-espresso/tickets/7420)
-     *
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws EE_Error|ReflectionException
-     */
-    public function get_pretty($field_name, $extra_cache_ref = null)
-    {
-        if ($field_name === 'PAY_gateway') {
-            return $this->payment_method() ? $this->payment_method()->name() : esc_html__('Unknown', 'event_espresso');
-        }
-        return $this->_get_cached_property($field_name, true, $extra_cache_ref);
-    }
-
-
-    /**
-     * Gets details regarding which registrations this payment was applied to
-     *
-     * @param array $query_params
-     * @return array[]|EE_Base_Class[]|EE_Registration_Payment[]
-     * @throws EE_Error|ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function registration_payments($query_params = array())
-    {
-        return $this->get_many_related('Registration_Payment', $query_params);
-    }
-
-
-    /**
-     * Gets the first event for this payment (it's possible that it could be for multiple)
-     *
-     * @return EE_Event|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_first_event()
-    {
-        $transaction = $this->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            $primary_registrant = $transaction->primary_registration();
-            if ($primary_registrant instanceof EE_Registration) {
-                return $primary_registrant->event_obj();
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the name of the first event for which is being paid
-     *
-     * @return string
-     * @throws EE_Error|ReflectionException
-     */
-    public function get_first_event_name()
-    {
-        $event = $this->get_first_event();
-        return $event instanceof EE_Event ? $event->name() : esc_html__('Event', 'event_espresso');
-    }
-
-
-    /**
-     * Returns the payment's transaction's primary registration
-     *
-     * @return EE_Registration|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_primary_registration()
-    {
-        if ($this->transaction() instanceof EE_Transaction) {
-            return $this->transaction()->primary_registration();
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the payment's transaction's primary registration's attendee, or null
-     *
-     * @return EE_Attendee|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_primary_attendee()
-    {
-        $primary_reg = $this->get_primary_registration();
-        if ($primary_reg instanceof EE_Registration) {
-            return $primary_reg->attendee();
-        }
-        return null;
-    }
+	/**
+	 * @var CurrencyFormatter
+	 * @since $VID:$
+	 */
+	protected $currency_formatter;
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Payment
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$payment = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		if (! $payment instanceof EE_Payment) {
+			$payment = new EE_Payment($props_n_values, false, $timezone, $date_formats);
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Payment
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new EE_Payment($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Adds some defaults if they're not specified
+	 *
+	 * @param array  $props_n_values
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct($props_n_values = [], $bydb = false, $timezone = '', $date_formats = [])
+	{
+		parent::__construct($props_n_values, $bydb, $timezone, $date_formats);
+		// in a better world this would have been injected upon construction
+		if (! $this->currency_formatter instanceof CurrencyFormatter) {
+			$this->currency_formatter = LoaderFactory::getLoader()->getShared(CurrencyFormatter::class);
+		}
+	}
+
+
+	/**
+	 * Set Transaction ID
+	 *
+	 * @access public
+	 * @param int $TXN_ID
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function set_transaction_id($TXN_ID = 0)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets the transaction related to this payment
+	 *
+	 * @return EE_Base_Class|EE_Transaction
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function transaction()
+	{
+		return $this->get_first_related('Transaction');
+	}
+
+
+	/**
+	 * Set Status
+	 *
+	 * @access public
+	 * @param string $STS_ID
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function set_status($STS_ID = '')
+	{
+		$this->set('STS_ID', $STS_ID);
+	}
+
+
+	/**
+	 * Set Payment Timestamp
+	 *
+	 * @access public
+	 * @param int $timestamp
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function set_timestamp($timestamp = 0)
+	{
+		$this->set('PAY_timestamp', $timestamp);
+	}
+
+
+	/**
+	 * Set Payment Method
+	 *
+	 * @access public
+	 * @param string $PAY_source
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function set_source($PAY_source = '')
+	{
+		$this->set('PAY_source', $PAY_source);
+	}
+
+
+	/**
+	 * Set Payment Amount
+	 *
+	 * @access public
+	 * @param float $amount
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function set_amount($amount = 0.00)
+	{
+		$this->set('PAY_amount', $amount);
+	}
+
+
+	/**
+	 * Set Payment Gateway Response
+	 *
+	 * @access public
+	 * @param string $gateway_response
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function set_gateway_response($gateway_response = '')
+	{
+		$this->set('PAY_gateway_response', $gateway_response);
+	}
+
+
+	/**
+	 * Returns the name of the payment method used on this payment (previously known merely as 'gateway')
+	 * but since 4.6.0, payment methods are models and the payment keeps a foreign key to the payment method
+	 * used on it
+	 *
+	 * @return string
+	 * @throws EE_Error|ReflectionException
+	 *@deprecated
+	 */
+	public function gateway()
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Payment::gateway',
+			esc_html__(
+				'The method EE_Payment::gateway() has been deprecated. Consider instead using EE_Payment::payment_method()->name()',
+				'event_espresso'
+			),
+			'4.6.0'
+		);
+		return $this->payment_method() ? $this->payment_method()->name() : esc_html__('Unknown', 'event_espresso');
+	}
+
+
+	/**
+	 * Set Gateway Transaction ID
+	 *
+	 * @access public
+	 * @param string $txn_id_chq_nmbr
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function set_txn_id_chq_nmbr($txn_id_chq_nmbr = '')
+	{
+		$this->set('PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr);
+	}
+
+
+	/**
+	 * Set Purchase Order Number
+	 *
+	 * @access public
+	 * @param string $po_number
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function set_po_number($po_number = '')
+	{
+		$this->set('PAY_po_number', $po_number);
+	}
+
+
+	/**
+	 * Set Extra Accounting Field
+	 *
+	 * @access public
+	 * @param string $extra_accntng
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function set_extra_accntng($extra_accntng = '')
+	{
+		$this->set('PAY_extra_accntng', $extra_accntng);
+	}
+
+
+	/**
+	 * Set Payment made via admin flag
+	 *
+	 * @access public
+	 * @param bool $via_admin
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function set_payment_made_via_admin($via_admin = false)
+	{
+		if ($via_admin) {
+			$this->set('PAY_source', EEM_Payment_Method::scope_admin);
+		} else {
+			$this->set('PAY_source', EEM_Payment_Method::scope_cart);
+		}
+	}
+
+
+	/**
+	 * Set Payment Details
+	 *
+	 * @access public
+	 * @param string|array $details
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function set_details($details = '')
+	{
+		if (is_array($details)) {
+			array_walk_recursive($details, array($this, '_strip_all_tags_within_array'));
+		} else {
+			$details = wp_strip_all_tags($details);
+		}
+		$this->set('PAY_details', $details);
+	}
+
+
+	/**
+	 * Sets redirect_url
+	 *
+	 * @param string $redirect_url
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function set_redirect_url($redirect_url)
+	{
+		$this->set('PAY_redirect_url', $redirect_url);
+	}
+
+
+	/**
+	 * Sets redirect_args
+	 *
+	 * @param array $redirect_args
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function set_redirect_args($redirect_args)
+	{
+		$this->set('PAY_redirect_args', $redirect_args);
+	}
+
+
+	/**
+	 * get Payment Transaction ID
+	 *
+	 * @access public
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * get Payment Status
+	 *
+	 * @access public
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function status()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * get Payment Status
+	 *
+	 * @access public
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function STS_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * get Payment Timestamp
+	 *
+	 * @access public
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @return string
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function timestamp($date_format = '', $time_format = '')
+	{
+		return $this->get_i18n_datetime('PAY_timestamp', trim($date_format . ' ' . $time_format));
+	}
+
+
+	/**
+	 * get Payment Source
+	 *
+	 * @access public
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function source()
+	{
+		return $this->get('PAY_source');
+	}
+
+
+	/**
+	 * get Payment Amount
+	 *
+	 * @access public
+	 * @return float
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function amount()
+	{
+		return (float) $this->get('PAY_amount');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function amount_no_code()
+	{
+		return $this->get_pretty('PAY_amount', 'no_currency_code');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function prettyAmount()
+	{
+		return $this->get_pretty('PAY_amount', 'localized_currency');
+	}
+
+
+	/**
+	 * get Payment Gateway Response
+	 *
+	 * @access public
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function gateway_response()
+	{
+		return $this->get('PAY_gateway_response');
+	}
+
+
+	/**
+	 * get Payment Gateway Transaction ID
+	 *
+	 * @access public
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function txn_id_chq_nmbr()
+	{
+		return $this->get('PAY_txn_id_chq_nmbr');
+	}
+
+
+	/**
+	 * get Purchase Order Number
+	 *
+	 * @access public
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function po_number()
+	{
+		return $this->get('PAY_po_number');
+	}
+
+
+	/**
+	 * get Extra Accounting Field
+	 *
+	 * @access public
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function extra_accntng()
+	{
+		return $this->get('PAY_extra_accntng');
+	}
+
+
+	/**
+	 * get Payment made via admin source
+	 *
+	 * @access public
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function payment_made_via_admin()
+	{
+		return ($this->get('PAY_source') === EEM_Payment_Method::scope_admin);
+	}
+
+
+	/**
+	 * get Payment Details
+	 *
+	 * @access public
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function details()
+	{
+		return $this->get('PAY_details');
+	}
+
+
+	/**
+	 * Gets redirect_url
+	 *
+	 * @return string
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function redirect_url()
+	{
+		return $this->get('PAY_redirect_url');
+	}
+
+
+	/**
+	 * Gets redirect_args
+	 *
+	 * @return array
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function redirect_args()
+	{
+		return $this->get('PAY_redirect_args');
+	}
+
+
+	/**
+	 * echoes $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @return void
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
+	}
+
+
+	/**
+	 * returns a pretty version of the status, good for displaying to users
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(
+			array($this->STS_ID() => esc_html__('unknown', 'event_espresso')),
+			false,
+			'sentence'
+		);
+		$icon = '';
+		switch ($this->STS_ID()) {
+			case EEM_Payment::status_id_approved:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_pending:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-clock ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_cancelled:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_declined:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
+					: '';
+				break;
+		}
+		return $icon . $status[ $this->STS_ID() ];
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean whether the payment is approved or not
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function is_approved()
+	{
+		return $this->status_is(EEM_Payment::status_id_approved);
+	}
+
+
+	/**
+	 * Generally determines if the status of this payment equals
+	 * the $STS_ID string
+	 *
+	 * @param string $STS_ID an ID from the esp_status table/
+	 *                       one of the status_id_* on the EEM_Payment model
+	 * @return boolean whether the status of this payment equals the status id
+	 * @throws EE_Error|ReflectionException
+	 */
+	protected function status_is($STS_ID)
+	{
+		return $STS_ID === $this->STS_ID();
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean whether the payment is pending or not
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function is_pending()
+	{
+		return $this->status_is(EEM_Payment::status_id_pending);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function is_cancelled()
+	{
+		return $this->status_is(EEM_Payment::status_id_cancelled);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function is_declined()
+	{
+		return $this->status_is(EEM_Payment::status_id_declined);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function is_failed()
+	{
+		return $this->status_is(EEM_Payment::status_id_failed);
+	}
+
+
+	/**
+	 * For determining if the payment is actually a refund ( ie: has a negative value )
+	 *
+	 * @return boolean
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function is_a_refund()
+	{
+		return $this->amount() < 0;
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Base_Class|EE_Status
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Gets all the extra meta info on this payment
+	 *
+	 * @param array $query_params
+	 * @return array[]|EE_Base_Class[]|EE_Extra_Meta
+	 * @throws EE_Error|ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function extra_meta($query_params = array())
+	{
+		return $this->get_many_related('Extra_Meta', $query_params);
+	}
+
+
+	/**
+	 * Gets the last-used payment method on this transaction
+	 * (we COULD just use the last-made payment, but some payment methods, namely
+	 * offline ones, dont' create payments)
+	 *
+	 * @return EE_Base_Class|EE_Payment_Method
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function payment_method()
+	{
+		return $this->get_first_related('Payment_Method');
+	}
+
+
+	/**
+	 * Gets the HTML for redirecting the user to an offsite gateway
+	 * You can pass it special content to put inside the form, or use
+	 * the default inner content (or possibly generate this all yourself using
+	 * redirect_url() and redirect_args() or redirect_args_as_inputs()).
+	 * Creates a POST request by default, but if no redirect args are specified, creates a GET request instead
+	 * (and any querystring variables in the redirect_url are converted into html inputs
+	 * so browsers submit them properly)
+	 *
+	 * @param string $inside_form_html
+	 * @return string html
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function redirect_form($inside_form_html = null)
+	{
+		$redirect_url = $this->redirect_url();
+
+		if (empty($redirect_url)) {
+			return null;
+		}
+
+		// what ? no inner form content?
+		if ($inside_form_html === null) {
+			$inside_form_html = EEH_HTML::p(
+				sprintf(
+					esc_html__(
+						'If you are not automatically redirected to the payment website within 10 seconds... %1$s %2$s Click Here %3$s',
+						'event_espresso'
+					),
+					EEH_HTML::br(2),
+					'<input type="submit" value="',
+					'">'
+				),
+				'',
+				'',
+				'text-align:center;'
+			);
+		}
+
+		$method = apply_filters(
+			'FHEE__EE_Payment__redirect_form__method',
+			$this->redirect_args() ? 'POST' : 'GET',
+			$this
+		);
+
+		// if it's a GET request, we need to remove all the GET params in the querystring
+		// and put them into the form instead
+		if ($method === 'GET') {
+			$querystring = parse_url($redirect_url, PHP_URL_QUERY);
+			$get_params = null;
+			parse_str($querystring, $get_params);
+			$inside_form_html .= $this->_args_as_inputs($get_params);
+			$redirect_url = str_replace('?' . $querystring, '', $redirect_url);
+		}
+
+		$form = EEH_HTML::nl(1)
+				. '<form method="' . $method . '" name="gateway_form" action="' . $redirect_url . '">';
+		$form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
+		$form .= $inside_form_html;
+		$form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
+		return $form;
+	}
+
+
+	/**
+	 * Changes all the name-value pairs of the redirect args into html inputs
+	 * and returns the html as a string
+	 *
+	 * @return string
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function redirect_args_as_inputs()
+	{
+		return $this->_args_as_inputs($this->redirect_args());
+	}
+
+
+	/**
+	 * Converts a 2d array of key-value pairs into html hidden inputs
+	 * and returns the string of html
+	 *
+	 * @param array $args key-value pairs
+	 * @return string
+	 */
+	protected function _args_as_inputs($args)
+	{
+		$html = '';
+		if ($args !== null && is_array($args)) {
+			foreach ($args as $name => $value) {
+				$html .= $this->generateInput($name, $value);
+			}
+		}
+		return $html;
+	}
+
+	/**
+	 * Converts either a single name and value or array of values into html hidden inputs
+	 * and returns the string of html
+	 *
+	 * @param string $name
+	 * @param string|array $value
+	 * @return string
+	 */
+	private function generateInput($name, $value)
+	{
+		if (is_array($value)) {
+			$html = '';
+			$name = "{$name}[]";
+			foreach ($value as $array_value) {
+				$html .= $this->generateInput($name, $array_value);
+			}
+			return $html;
+		}
+		return EEH_HTML::nl()
+			. '<input type="hidden" name="' . $name . '"'
+			. ' value="' . esc_attr($value) . '"/>';
+	}
+
+
+	/**
+	 * Returns the currency of the payment.
+	 * (At the time of writing, this will always be the currency in the configuration;
+	 * however in the future it is anticipated that this will be stored on the payment
+	 * object itself)
+	 *
+	 * @return string for the currency code
+	 */
+	public function currency_code()
+	{
+		return $this->currency_formatter->getCurrencyIsoCodeForLocale();
+	}
+
+
+	/**
+	 * apply wp_strip_all_tags to all elements within an array
+	 *
+	 * @access private
+	 * @param mixed $item
+	 */
+	private function _strip_all_tags_within_array(&$item)
+	{
+		if (is_object($item)) {
+			$item = (array) $item;
+		}
+		if (is_array($item)) {
+			array_walk_recursive($item, array($this, '_strip_all_tags_within_array'));
+		} else {
+			$item = wp_strip_all_tags($item);
+		}
+	}
+
+
+	/**
+	 * Returns TRUE is this payment was set to approved during this request (or
+	 * is approved and was created during this request). False otherwise.
+	 *
+	 * @return boolean
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function just_approved()
+	{
+		$original_status = EEH_Array::is_set(
+			$this->_props_n_values_provided_in_constructor,
+			'STS_ID',
+			$this->get_model()->field_settings_for('STS_ID')->get_default_value()
+		);
+		$current_status = $this->status();
+		if (
+			$original_status !== EEM_Payment::status_id_approved
+			&& $current_status === EEM_Payment::status_id_approved
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Overrides parents' get_pretty() function just for legacy reasons
+	 * (to allow ticket https://events.codebasehq.com/projects/event-espresso/tickets/7420)
+	 *
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function get_pretty($field_name, $extra_cache_ref = null)
+	{
+		if ($field_name === 'PAY_gateway') {
+			return $this->payment_method() ? $this->payment_method()->name() : esc_html__('Unknown', 'event_espresso');
+		}
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
+	}
+
+
+	/**
+	 * Gets details regarding which registrations this payment was applied to
+	 *
+	 * @param array $query_params
+	 * @return array[]|EE_Base_Class[]|EE_Registration_Payment[]
+	 * @throws EE_Error|ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function registration_payments($query_params = array())
+	{
+		return $this->get_many_related('Registration_Payment', $query_params);
+	}
+
+
+	/**
+	 * Gets the first event for this payment (it's possible that it could be for multiple)
+	 *
+	 * @return EE_Event|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_first_event()
+	{
+		$transaction = $this->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			$primary_registrant = $transaction->primary_registration();
+			if ($primary_registrant instanceof EE_Registration) {
+				return $primary_registrant->event_obj();
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the name of the first event for which is being paid
+	 *
+	 * @return string
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function get_first_event_name()
+	{
+		$event = $this->get_first_event();
+		return $event instanceof EE_Event ? $event->name() : esc_html__('Event', 'event_espresso');
+	}
+
+
+	/**
+	 * Returns the payment's transaction's primary registration
+	 *
+	 * @return EE_Registration|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_primary_registration()
+	{
+		if ($this->transaction() instanceof EE_Transaction) {
+			return $this->transaction()->primary_registration();
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the payment's transaction's primary registration's attendee, or null
+	 *
+	 * @return EE_Attendee|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_primary_attendee()
+	{
+		$primary_reg = $this->get_primary_registration();
+		if ($primary_reg instanceof EE_Registration) {
+			return $primary_reg->attendee();
+		}
+		return null;
+	}
 }

core/services/formatters/FormatterBase.php

Spacing +2 added lines, -2 removed lines

@@ -24,14 +24,14 @@
      */
     public function formatArray(array $input): array
     {
-        if (! is_array($input)) {
+        if ( ! is_array($input)) {
             throw new InvalidDataTypeException('input', $input, 'array');
         }
         // we can use $this inside the closure in PHP 5.3, so pass in a variable pointing to this instead
         $formatter = $this;
         array_walk_recursive(
             $input,
-            function (&$value) use ($formatter) {
+            function(&$value) use ($formatter) {
                 $value = $formatter->format($value);
             }
         );

Indentation +22 added lines, -22 removed lines

@@ -14,26 +14,26 @@
  */
 abstract class FormatterBase implements FormatterInterface
 {
-    /**
-     * Recursively applies the formatting to all VALUES in this multi-dimensional array
-     *
-     * @param array $input
-     * @return array
-     * @throws InvalidDataTypeException if $input is not an array
-     */
-    public function formatArray(array $input): array
-    {
-        if (! is_array($input)) {
-            throw new InvalidDataTypeException('input', $input, 'array');
-        }
-        // we can use $this inside the closure in PHP 5.3, so pass in a variable pointing to this instead
-        $formatter = $this;
-        array_walk_recursive(
-            $input,
-            function (&$value) use ($formatter) {
-                $value = $formatter->format($value);
-            }
-        );
-        return $input;
-    }
+	/**
+	 * Recursively applies the formatting to all VALUES in this multi-dimensional array
+	 *
+	 * @param array $input
+	 * @return array
+	 * @throws InvalidDataTypeException if $input is not an array
+	 */
+	public function formatArray(array $input): array
+	{
+		if (! is_array($input)) {
+			throw new InvalidDataTypeException('input', $input, 'array');
+		}
+		// we can use $this inside the closure in PHP 5.3, so pass in a variable pointing to this instead
+		$formatter = $this;
+		array_walk_recursive(
+			$input,
+			function (&$value) use ($formatter) {
+				$value = $formatter->format($value);
+			}
+		);
+		return $input;
+	}
 }

core/services/formatters/NumberFormatter.php

Spacing +2 added lines, -2 removed lines

@@ -89,7 +89,7 @@ 
     public function parseForLocale($number, $locale = ''): float
     {
         // just return the value if it's not a string
-        if (! is_string($number)) {
+        if ( ! is_string($number)) {
             return (float) $number;
         }
         $locale = $this->locales->getLocale($locale);
@@ -100,7 +100,7 @@ 
                     $locale->decimalPoint(),
                 ],
                 [
-                    '',  // remove thousands separator
+                    '', // remove thousands separator
                     '.', // convert decimal mark to what PHP expects
                 ],
                 $number

Indentation +95 added lines, -95 removed lines

@@ -6,105 +6,105 @@
 
 class NumberFormatter extends LocaleFloatFormatter
 {
-    /**
-     * formats the provided number for the selected locale (defaults to site locale) and returns a string
-     *
-     * @param Locale   $locale
-     * @param float    $number    unformatted number value, ex: 1234.56789
-     * @param int|null $precision the number of decimal places to round to
-     * @return string             formatted value, ex: '1,234.57'
-     */
-    protected function format(Locale $locale, float $number, ?int $precision = null)
-    {
-        $is_negative = $number < 0;
-        $precision   = $precision !== null
-            ? absint($precision)
-            : $locale->decimalPrecision();
-        return $this->formatSymbolAndSignPositions(
-            $locale,
-            $this->formatGroupings(
-                $number,
-                $precision,
-                $locale->decimalPoint(),
-                $locale->grouping(),
-                $locale->thousandsSeparator()
-            ),
-            $is_negative
-        );
-    }
+	/**
+	 * formats the provided number for the selected locale (defaults to site locale) and returns a string
+	 *
+	 * @param Locale   $locale
+	 * @param float    $number    unformatted number value, ex: 1234.56789
+	 * @param int|null $precision the number of decimal places to round to
+	 * @return string             formatted value, ex: '1,234.57'
+	 */
+	protected function format(Locale $locale, float $number, ?int $precision = null)
+	{
+		$is_negative = $number < 0;
+		$precision   = $precision !== null
+			? absint($precision)
+			: $locale->decimalPrecision();
+		return $this->formatSymbolAndSignPositions(
+			$locale,
+			$this->formatGroupings(
+				$number,
+				$precision,
+				$locale->decimalPoint(),
+				$locale->grouping(),
+				$locale->thousandsSeparator()
+			),
+			$is_negative
+		);
+	}
 
 
-    /**
-     * @param Locale           $locale
-     * @param int|float|string $number
-     * @param bool             $is_negative
-     * @return string
-     */
-    protected function formatSymbolAndSignPositions(Locale $locale, $number, bool $is_negative)
-    {
-        // format for positive or negative values
-        if ($is_negative) {
-            $sign     = $locale->negativeSign();
-            $position = $locale->negativeSignPosition();
-        } else {
-            $sign     = $locale->positiveSign();
-            $position = $locale->positiveSignPosition();
-        }
-        switch ($position) {
-            case LocaleFloatFormatter::PARENTHESES:
-                return "({$number})";
-            case LocaleFloatFormatter::SIGN_BEFORE_ALL:
-            case LocaleFloatFormatter::SIGN_BEFORE_CURRENCY:
-            case LocaleFloatFormatter::SIGN_AFTER_CURRENCY:
-                return "{$sign}{$number}";
-            case LocaleFloatFormatter::SIGN_AFTER_ALL:
-                return "{$number}{$sign}";
-        }
-        return $number;
-    }
+	/**
+	 * @param Locale           $locale
+	 * @param int|float|string $number
+	 * @param bool             $is_negative
+	 * @return string
+	 */
+	protected function formatSymbolAndSignPositions(Locale $locale, $number, bool $is_negative)
+	{
+		// format for positive or negative values
+		if ($is_negative) {
+			$sign     = $locale->negativeSign();
+			$position = $locale->negativeSignPosition();
+		} else {
+			$sign     = $locale->positiveSign();
+			$position = $locale->positiveSignPosition();
+		}
+		switch ($position) {
+			case LocaleFloatFormatter::PARENTHESES:
+				return "({$number})";
+			case LocaleFloatFormatter::SIGN_BEFORE_ALL:
+			case LocaleFloatFormatter::SIGN_BEFORE_CURRENCY:
+			case LocaleFloatFormatter::SIGN_AFTER_CURRENCY:
+				return "{$sign}{$number}";
+			case LocaleFloatFormatter::SIGN_AFTER_ALL:
+				return "{$number}{$sign}";
+		}
+		return $number;
+	}
 
 
-    /**
-     * formats the provided number for the selected locale (defaults to site locale) and returns a string
-     *
-     * @param float|int|string $number    unformatted number value, ex: 1234.56789
-     * @param int|null         $precision the number of decimal places to round to
-     * @param string|Locale    $locale    ex: 'en_US' or Locale object
-     * @return string                     formatted value, ex: '1,234.57'
-     */
-    public function formatForLocale($number, ?int $precision = null, $locale = ''): string
-    {
-        $locale = $this->locales->getLocale($locale);
-        return $this->format($locale, (float) $number, $precision);
-    }
+	/**
+	 * formats the provided number for the selected locale (defaults to site locale) and returns a string
+	 *
+	 * @param float|int|string $number    unformatted number value, ex: 1234.56789
+	 * @param int|null         $precision the number of decimal places to round to
+	 * @param string|Locale    $locale    ex: 'en_US' or Locale object
+	 * @return string                     formatted value, ex: '1,234.57'
+	 */
+	public function formatForLocale($number, ?int $precision = null, $locale = ''): string
+	{
+		$locale = $this->locales->getLocale($locale);
+		return $this->format($locale, (float) $number, $precision);
+	}
 
 
-    /**
-     * This removes all localized formatting from the incoming value and returns a float
-     *
-     * @param float|int|string $number formatted numeric value as string, ex: '1,234,567.89'
-     * @param string|Locale    $locale ex: 'en_US' or Locale object
-     * @return float                   unformatted number value, ex: 1234567.89
-     */
-    public function parseForLocale($number, $locale = ''): float
-    {
-        // just return the value if it's not a string
-        if (! is_string($number)) {
-            return (float) $number;
-        }
-        $locale = $this->locales->getLocale($locale);
-        return $this->filterNumericValue(
-            str_replace(
-                [
-                    $locale->thousandsSeparator(),
-                    $locale->decimalPoint(),
-                ],
-                [
-                    '',  // remove thousands separator
-                    '.', // convert decimal mark to what PHP expects
-                ],
-                $number
-            )
-        );
-    }
+	/**
+	 * This removes all localized formatting from the incoming value and returns a float
+	 *
+	 * @param float|int|string $number formatted numeric value as string, ex: '1,234,567.89'
+	 * @param string|Locale    $locale ex: 'en_US' or Locale object
+	 * @return float                   unformatted number value, ex: 1234567.89
+	 */
+	public function parseForLocale($number, $locale = ''): float
+	{
+		// just return the value if it's not a string
+		if (! is_string($number)) {
+			return (float) $number;
+		}
+		$locale = $this->locales->getLocale($locale);
+		return $this->filterNumericValue(
+			str_replace(
+				[
+					$locale->thousandsSeparator(),
+					$locale->decimalPoint(),
+				],
+				[
+					'',  // remove thousands separator
+					'.', // convert decimal mark to what PHP expects
+				],
+				$number
+			)
+		);
+	}
 }

core/services/formatters/AsciiOnly.php

Spacing +9 added lines, -9 removed lines

@@ -36,29 +36,29 @@
     protected function convertAscii($string): string
     {
         // Replace Single Curly Quotes
-        $search[] = chr(226) . chr(128) . chr(152);
+        $search[] = chr(226).chr(128).chr(152);
         $replace[] = "'";
-        $search[] = chr(226) . chr(128) . chr(153);
+        $search[] = chr(226).chr(128).chr(153);
         $replace[] = "'";
         // Replace Smart Double Curly Quotes
-        $search[] = chr(226) . chr(128) . chr(156);
+        $search[] = chr(226).chr(128).chr(156);
         $replace[] = '"';
-        $search[] = chr(226) . chr(128) . chr(157);
+        $search[] = chr(226).chr(128).chr(157);
         $replace[] = '"';
         // Replace En Dash
-        $search[] = chr(226) . chr(128) . chr(147);
+        $search[] = chr(226).chr(128).chr(147);
         $replace[] = '--';
         // Replace Em Dash
-        $search[] = chr(226) . chr(128) . chr(148);
+        $search[] = chr(226).chr(128).chr(148);
         $replace[] = '---';
         // Replace Bullet
-        $search[] = chr(226) . chr(128) . chr(162);
+        $search[] = chr(226).chr(128).chr(162);
         $replace[] = '*';
         // Replace Middle Dot
-        $search[] = chr(194) . chr(183);
+        $search[] = chr(194).chr(183);
         $replace[] = '*';
         // Replace Ellipsis with three consecutive dots
-        $search[] = chr(226) . chr(128) . chr(166);
+        $search[] = chr(226).chr(128).chr(166);
         $replace[] = '...';
         // Apply Replacements
         $string = str_replace($search, $replace, $string);

Indentation +50 added lines, -50 removed lines

@@ -12,56 +12,56 @@
  */
 class AsciiOnly extends FormatterBase
 {
-    /**
-     * Removes all non Ascii characters from string
-     *
-     * @param string|int|float $input anything easily cast into a string
-     * @return string
-     */
-    public function format($input): string
-    {
-        // in case an int or float etc was passed in
-        $input = (string) $input;
-        return $this->convertAscii($input);
-    }
+	/**
+	 * Removes all non Ascii characters from string
+	 *
+	 * @param string|int|float $input anything easily cast into a string
+	 * @return string
+	 */
+	public function format($input): string
+	{
+		// in case an int or float etc was passed in
+		$input = (string) $input;
+		return $this->convertAscii($input);
+	}
 
 
-    /**
-     * Taken from https://gist.github.com/jaywilliams/119517
-     *
-     * @param $string
-     * @return string
-     */
-    protected function convertAscii($string): string
-    {
-        // Replace Single Curly Quotes
-        $search[] = chr(226) . chr(128) . chr(152);
-        $replace[] = "'";
-        $search[] = chr(226) . chr(128) . chr(153);
-        $replace[] = "'";
-        // Replace Smart Double Curly Quotes
-        $search[] = chr(226) . chr(128) . chr(156);
-        $replace[] = '"';
-        $search[] = chr(226) . chr(128) . chr(157);
-        $replace[] = '"';
-        // Replace En Dash
-        $search[] = chr(226) . chr(128) . chr(147);
-        $replace[] = '--';
-        // Replace Em Dash
-        $search[] = chr(226) . chr(128) . chr(148);
-        $replace[] = '---';
-        // Replace Bullet
-        $search[] = chr(226) . chr(128) . chr(162);
-        $replace[] = '*';
-        // Replace Middle Dot
-        $search[] = chr(194) . chr(183);
-        $replace[] = '*';
-        // Replace Ellipsis with three consecutive dots
-        $search[] = chr(226) . chr(128) . chr(166);
-        $replace[] = '...';
-        // Apply Replacements
-        $string = str_replace($search, $replace, $string);
-        // Remove any non-ASCII Characters
-        return preg_replace("/[^\x01-\x7F]/", "", $string);
-    }
+	/**
+	 * Taken from https://gist.github.com/jaywilliams/119517
+	 *
+	 * @param $string
+	 * @return string
+	 */
+	protected function convertAscii($string): string
+	{
+		// Replace Single Curly Quotes
+		$search[] = chr(226) . chr(128) . chr(152);
+		$replace[] = "'";
+		$search[] = chr(226) . chr(128) . chr(153);
+		$replace[] = "'";
+		// Replace Smart Double Curly Quotes
+		$search[] = chr(226) . chr(128) . chr(156);
+		$replace[] = '"';
+		$search[] = chr(226) . chr(128) . chr(157);
+		$replace[] = '"';
+		// Replace En Dash
+		$search[] = chr(226) . chr(128) . chr(147);
+		$replace[] = '--';
+		// Replace Em Dash
+		$search[] = chr(226) . chr(128) . chr(148);
+		$replace[] = '---';
+		// Replace Bullet
+		$search[] = chr(226) . chr(128) . chr(162);
+		$replace[] = '*';
+		// Replace Middle Dot
+		$search[] = chr(194) . chr(183);
+		$replace[] = '*';
+		// Replace Ellipsis with three consecutive dots
+		$search[] = chr(226) . chr(128) . chr(166);
+		$replace[] = '...';
+		// Apply Replacements
+		$string = str_replace($search, $replace, $string);
+		// Remove any non-ASCII Characters
+		return preg_replace("/[^\x01-\x7F]/", "", $string);
+	}
 }

core/services/editor/BlockRegistrationManager.php

Spacing +7 added lines, -7 removed lines

@@ -162,7 +162,7 @@ 
                 $block->initialize();
                 $this->trackAssetManagersForBlocks($block);
                 $asset_manager = $block->assetManager();
-                if (! $this->block_asset_manager_collection->contains($asset_manager)) {
+                if ( ! $this->block_asset_manager_collection->contains($asset_manager)) {
                     $this->block_asset_manager_collection->add($asset_manager, get_class($asset_manager));
                     $block->assetManager()->setAssetHandles();
                 }
@@ -184,7 +184,7 @@ 
         $supported_routes = $block->supportedRoutes();
         foreach ($supported_routes as $supported_route) {
             if ($this->route_manager->routeMatchesCurrentRequest($supported_route)) {
-                $this->block_asset_managers[ $block->blockType() ] = $block->assetManager()->assetNamespace();
+                $this->block_asset_managers[$block->blockType()] = $block->assetManager()->assetNamespace();
             }
         }
     }
@@ -200,10 +200,10 @@ 
      */
     public function matchesRoute(BlockInterface $block)
     {
-        if (isset($this->block_asset_managers[ $block->blockType() ])) {
+        if (isset($this->block_asset_managers[$block->blockType()])) {
             return true;
         }
-        unset($this->block_asset_managers[ $block->blockType() ]);
+        unset($this->block_asset_managers[$block->blockType()]);
         return false;
     }
 
@@ -219,12 +219,12 @@ 
         try {
             // cycle thru block loader folders
             foreach ($this->blocks as $block) {
-                if (! $this->matchesRoute($block)) {
+                if ( ! $this->matchesRoute($block)) {
                     continue;
                 }
                 // perform any setup required for the block
                 $block_type = $block->registerBlock();
-                if (! $block_type instanceof WP_Block_Type) {
+                if ( ! $block_type instanceof WP_Block_Type) {
                     throw new InvalidEntityException($block_type, 'WP_Block_Type');
                 }
                 do_action(
@@ -243,7 +243,7 @@ 
         $assets = array_flip($this->block_asset_managers);
         foreach ($this->block_asset_manager_collection as $asset_manager) {
             // if there are no longer any blocks that require these assets,
-            if (! isset($assets[ $asset_manager->assetNamespace() ])) {
+            if ( ! isset($assets[$asset_manager->assetNamespace()])) {
                 // then unset asset enqueueing and bail
                 remove_action('wp_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0);
                 remove_action('admin_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0);

Indentation +220 added lines, -220 removed lines

@@ -31,224 +31,224 @@
  */
 class BlockRegistrationManager extends BlockManager
 {
-    /**
-     * @var BlockAssetManagerCollection $block_asset_manager_collection
-     */
-    protected $block_asset_manager_collection;
-
-    /**
-     * @var RouteMatchSpecificationManager $route_manager
-     */
-    protected $route_manager;
-
-    /**
-     * array for tracking asset managers required by blocks for the current route
-     *
-     * @var array $block_asset_managers
-     */
-    protected $block_asset_managers = array();
-
-
-    /**
-     * BlockRegistrationManager constructor.
-     *
-     * @param BlockAssetManagerCollection    $block_asset_manager_collection
-     * @param BlockCollection                $blocks
-     * @param RouteMatchSpecificationManager $route_manager
-     * @param RequestInterface               $request
-     */
-    public function __construct(
-        BlockAssetManagerCollection $block_asset_manager_collection,
-        BlockCollection $blocks,
-        RouteMatchSpecificationManager $route_manager,
-        RequestInterface $request
-    ) {
-        $this->block_asset_manager_collection = $block_asset_manager_collection;
-        $this->route_manager = $route_manager;
-        parent::__construct($blocks, $request);
-    }
-
-
-    /**
-     *  Returns the name of a hookpoint to be used to call initialize()
-     *
-     * @return string
-     */
-    public function initHook()
-    {
-        return 'AHEE__EE_System__initialize';
-    }
-
-
-    /**
-     * Perform any early setup required for block editors to functions
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function initialize()
-    {
-        $this->initializeBlocks();
-        add_action('AHEE__EE_System__initialize_last', array($this, 'registerBlocks'));
-        add_action('wp_loaded', array($this, 'unloadAssets'));
-        add_filter('block_categories_all', array($this, 'addEspressoBlockCategories'));
-    }
-
-
-    /**
-     * @param array $categories
-     * @since 4.9.71.p
-     * @return array
-     */
-    public function addEspressoBlockCategories(array $categories)
-    {
-        return array_merge(
-            $categories,
-            array(
-                array(
-                    'slug' => 'event-espresso',
-                    'title' => esc_html__('Event Espresso', 'event_espresso'),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return CollectionInterface|BlockInterface[]
-     * @throws CollectionLoaderException
-     * @throws CollectionDetailsException
-     */
-    protected function populateBlockCollection()
-    {
-        $loader = new CollectionLoader(
-            new CollectionDetails(
-                // collection name
-                'editor_blocks',
-                // collection interface
-                'EventEspresso\core\domain\entities\editor\BlockInterface',
-                // FQCNs for classes to add (all classes within each namespace will be loaded)
-                apply_filters(
-                    'FHEE__EventEspresso_core_services_editor_BlockManager__populateBlockCollection__collection_FQCNs',
-                    array('EventEspresso\core\domain\entities\editor\blocks')
-                ),
-                // filepaths to classes to add
-                array(),
-                // file mask to use if parsing folder for files to add
-                '',
-                // what to use as identifier for collection entities
-                // using CLASS NAME prevents duplicates (works like a singleton)
-                CollectionDetails::ID_CLASS_NAME
-            ),
-            $this->blocks
-        );
-        return $loader->getCollection();
-    }
-
-
-    /**
-     * populates the BlockCollection and calls initialize() on all installed blocks
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function initializeBlocks()
-    {
-        try {
-            $this->populateBlockCollection();
-            // cycle thru block loaders and initialize each loader
-            foreach ($this->blocks as $block) {
-                $block->initialize();
-                $this->trackAssetManagersForBlocks($block);
-                $asset_manager = $block->assetManager();
-                if (! $this->block_asset_manager_collection->contains($asset_manager)) {
-                    $this->block_asset_manager_collection->add($asset_manager, get_class($asset_manager));
-                    $block->assetManager()->setAssetHandles();
-                }
-            }
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * track blocks with routes that match the current request
-     *
-     * @param BlockInterface $block
-     * @throws InvalidClassException
-     */
-    private function trackAssetManagersForBlocks(BlockInterface $block)
-    {
-        $supported_routes = $block->supportedRoutes();
-        foreach ($supported_routes as $supported_route) {
-            if ($this->route_manager->routeMatchesCurrentRequest($supported_route)) {
-                $this->block_asset_managers[ $block->blockType() ] = $block->assetManager()->assetNamespace();
-            }
-        }
-    }
-
-
-    /**
-     * returns true if the block should be registered for the current request
-     * else removes block from block_routes array and returns false
-     *
-     * @param BlockInterface $block
-     * @return boolean
-     * @throws InvalidClassException
-     */
-    public function matchesRoute(BlockInterface $block)
-    {
-        if (isset($this->block_asset_managers[ $block->blockType() ])) {
-            return true;
-        }
-        unset($this->block_asset_managers[ $block->blockType() ]);
-        return false;
-    }
-
-
-    /**
-     * calls registerBlock() and load assets for all installed blocks
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function registerBlocks()
-    {
-        try {
-            // cycle thru block loader folders
-            foreach ($this->blocks as $block) {
-                if (! $this->matchesRoute($block)) {
-                    continue;
-                }
-                // perform any setup required for the block
-                $block_type = $block->registerBlock();
-                if (! $block_type instanceof WP_Block_Type) {
-                    throw new InvalidEntityException($block_type, 'WP_Block_Type');
-                }
-                do_action(
-                    'FHEE__EventEspresso_core_services_editor_BlockManager__registerBlocks__block_type_registered',
-                    $block,
-                    $block_type
-                );
-            }
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-    public function unloadAssets()
-    {
-        $assets = array_flip($this->block_asset_managers);
-        foreach ($this->block_asset_manager_collection as $asset_manager) {
-            // if there are no longer any blocks that require these assets,
-            if (! isset($assets[ $asset_manager->assetNamespace() ])) {
-                // then unset asset enqueueing and bail
-                remove_action('wp_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0);
-                remove_action('admin_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0);
-                remove_action('wp_enqueue_scripts', array($asset_manager, 'addAssets'), 2);
-                remove_action('admin_enqueue_scripts', array($asset_manager, 'addAssets'), 2);
-            }
-        }
-    }
+	/**
+	 * @var BlockAssetManagerCollection $block_asset_manager_collection
+	 */
+	protected $block_asset_manager_collection;
+
+	/**
+	 * @var RouteMatchSpecificationManager $route_manager
+	 */
+	protected $route_manager;
+
+	/**
+	 * array for tracking asset managers required by blocks for the current route
+	 *
+	 * @var array $block_asset_managers
+	 */
+	protected $block_asset_managers = array();
+
+
+	/**
+	 * BlockRegistrationManager constructor.
+	 *
+	 * @param BlockAssetManagerCollection    $block_asset_manager_collection
+	 * @param BlockCollection                $blocks
+	 * @param RouteMatchSpecificationManager $route_manager
+	 * @param RequestInterface               $request
+	 */
+	public function __construct(
+		BlockAssetManagerCollection $block_asset_manager_collection,
+		BlockCollection $blocks,
+		RouteMatchSpecificationManager $route_manager,
+		RequestInterface $request
+	) {
+		$this->block_asset_manager_collection = $block_asset_manager_collection;
+		$this->route_manager = $route_manager;
+		parent::__construct($blocks, $request);
+	}
+
+
+	/**
+	 *  Returns the name of a hookpoint to be used to call initialize()
+	 *
+	 * @return string
+	 */
+	public function initHook()
+	{
+		return 'AHEE__EE_System__initialize';
+	}
+
+
+	/**
+	 * Perform any early setup required for block editors to functions
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function initialize()
+	{
+		$this->initializeBlocks();
+		add_action('AHEE__EE_System__initialize_last', array($this, 'registerBlocks'));
+		add_action('wp_loaded', array($this, 'unloadAssets'));
+		add_filter('block_categories_all', array($this, 'addEspressoBlockCategories'));
+	}
+
+
+	/**
+	 * @param array $categories
+	 * @since 4.9.71.p
+	 * @return array
+	 */
+	public function addEspressoBlockCategories(array $categories)
+	{
+		return array_merge(
+			$categories,
+			array(
+				array(
+					'slug' => 'event-espresso',
+					'title' => esc_html__('Event Espresso', 'event_espresso'),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return CollectionInterface|BlockInterface[]
+	 * @throws CollectionLoaderException
+	 * @throws CollectionDetailsException
+	 */
+	protected function populateBlockCollection()
+	{
+		$loader = new CollectionLoader(
+			new CollectionDetails(
+				// collection name
+				'editor_blocks',
+				// collection interface
+				'EventEspresso\core\domain\entities\editor\BlockInterface',
+				// FQCNs for classes to add (all classes within each namespace will be loaded)
+				apply_filters(
+					'FHEE__EventEspresso_core_services_editor_BlockManager__populateBlockCollection__collection_FQCNs',
+					array('EventEspresso\core\domain\entities\editor\blocks')
+				),
+				// filepaths to classes to add
+				array(),
+				// file mask to use if parsing folder for files to add
+				'',
+				// what to use as identifier for collection entities
+				// using CLASS NAME prevents duplicates (works like a singleton)
+				CollectionDetails::ID_CLASS_NAME
+			),
+			$this->blocks
+		);
+		return $loader->getCollection();
+	}
+
+
+	/**
+	 * populates the BlockCollection and calls initialize() on all installed blocks
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function initializeBlocks()
+	{
+		try {
+			$this->populateBlockCollection();
+			// cycle thru block loaders and initialize each loader
+			foreach ($this->blocks as $block) {
+				$block->initialize();
+				$this->trackAssetManagersForBlocks($block);
+				$asset_manager = $block->assetManager();
+				if (! $this->block_asset_manager_collection->contains($asset_manager)) {
+					$this->block_asset_manager_collection->add($asset_manager, get_class($asset_manager));
+					$block->assetManager()->setAssetHandles();
+				}
+			}
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * track blocks with routes that match the current request
+	 *
+	 * @param BlockInterface $block
+	 * @throws InvalidClassException
+	 */
+	private function trackAssetManagersForBlocks(BlockInterface $block)
+	{
+		$supported_routes = $block->supportedRoutes();
+		foreach ($supported_routes as $supported_route) {
+			if ($this->route_manager->routeMatchesCurrentRequest($supported_route)) {
+				$this->block_asset_managers[ $block->blockType() ] = $block->assetManager()->assetNamespace();
+			}
+		}
+	}
+
+
+	/**
+	 * returns true if the block should be registered for the current request
+	 * else removes block from block_routes array and returns false
+	 *
+	 * @param BlockInterface $block
+	 * @return boolean
+	 * @throws InvalidClassException
+	 */
+	public function matchesRoute(BlockInterface $block)
+	{
+		if (isset($this->block_asset_managers[ $block->blockType() ])) {
+			return true;
+		}
+		unset($this->block_asset_managers[ $block->blockType() ]);
+		return false;
+	}
+
+
+	/**
+	 * calls registerBlock() and load assets for all installed blocks
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function registerBlocks()
+	{
+		try {
+			// cycle thru block loader folders
+			foreach ($this->blocks as $block) {
+				if (! $this->matchesRoute($block)) {
+					continue;
+				}
+				// perform any setup required for the block
+				$block_type = $block->registerBlock();
+				if (! $block_type instanceof WP_Block_Type) {
+					throw new InvalidEntityException($block_type, 'WP_Block_Type');
+				}
+				do_action(
+					'FHEE__EventEspresso_core_services_editor_BlockManager__registerBlocks__block_type_registered',
+					$block,
+					$block_type
+				);
+			}
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+	public function unloadAssets()
+	{
+		$assets = array_flip($this->block_asset_managers);
+		foreach ($this->block_asset_manager_collection as $asset_manager) {
+			// if there are no longer any blocks that require these assets,
+			if (! isset($assets[ $asset_manager->assetNamespace() ])) {
+				// then unset asset enqueueing and bail
+				remove_action('wp_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0);
+				remove_action('admin_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0);
+				remove_action('wp_enqueue_scripts', array($asset_manager, 'addAssets'), 2);
+				remove_action('admin_enqueue_scripts', array($asset_manager, 'addAssets'), 2);
+			}
+		}
+	}
 }

core/services/locale/LocaleSwitcher.php

Spacing +4 added lines, -4 removed lines

@@ -36,7 +36,7 @@ 
         if ($locale_changed !== false) {
             $locale = localeconv();
             $locale['locale_name'] = $locale_name;
-            $this->locales[ $locale_name ] = $locale;
+            $this->locales[$locale_name] = $locale;
             return true;
         }
         return false;
@@ -108,7 +108,7 @@ 
      */
     public function getLocale(string $locale_name, int $allow_recurse = 2): array
     {
-        if (! isset($this->locales[ $locale_name ])) {
+        if ( ! isset($this->locales[$locale_name])) {
             $this->stashCurrentSystemLocales();
             $charsets         = $this->getLocaleCharsets();
             // some systems use dashes and some use underscores for the locale names, ie: "en_US" vs "en-US"
@@ -124,8 +124,8 @@ 
             }
             $this->resetSystemLocales();
         }
-        if (isset($this->locales[ $locale_name ])) {
-            return $this->locales[ $locale_name ];
+        if (isset($this->locales[$locale_name])) {
+            return $this->locales[$locale_name];
         }
         // if our second attempt to get a locale failed, then try one more time using the site locale
         if ($allow_recurse === 2) {

Indentation +112 added lines, -112 removed lines

@@ -16,127 +16,127 @@
  */
 class LocaleSwitcher implements InterminableInterface
 {
-    /**
-     * @var array
-     */
-    protected $current_system_locales = [];
+	/**
+	 * @var array
+	 */
+	protected $current_system_locales = [];
 
-    /**
-     * @var array
-     */
-    protected $locales = [];
+	/**
+	 * @var array
+	 */
+	protected $locales = [];
 
 
-    /**
-     * @param string $locale_name
-     * @param string $charset
-     * @return bool
-     */
-    private function changeLocale(string $locale_name, string $charset): bool
-    {
-        $locale_changed = setlocale(LC_ALL, "{$locale_name}.{$charset}");
-        if ($locale_changed !== false) {
-            $locale = localeconv();
-            $locale['locale_name'] = $locale_name;
-            $this->locales[ $locale_name ] = $locale;
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * @param string $locale_name
+	 * @param string $charset
+	 * @return bool
+	 */
+	private function changeLocale(string $locale_name, string $charset): bool
+	{
+		$locale_changed = setlocale(LC_ALL, "{$locale_name}.{$charset}");
+		if ($locale_changed !== false) {
+			$locale = localeconv();
+			$locale['locale_name'] = $locale_name;
+			$this->locales[ $locale_name ] = $locale;
+			return true;
+		}
+		return false;
+	}
 
 
-    /**
-     * @return array
-     */
-    private function getLocaleCharsets(): array
-    {
-        return (array) apply_filters(
-            'FHEE_EventEspresso_core_services_formatters_Locale__getLocaleCharsets__charsets',
-            [
-                'UTF-8',
-                'UTF8',
-                'utf-8',
-                'utf8',
-                'iso88591',
-            ]
-        );
-    }
+	/**
+	 * @return array
+	 */
+	private function getLocaleCharsets(): array
+	{
+		return (array) apply_filters(
+			'FHEE_EventEspresso_core_services_formatters_Locale__getLocaleCharsets__charsets',
+			[
+				'UTF-8',
+				'UTF8',
+				'utf-8',
+				'utf8',
+				'iso88591',
+			]
+		);
+	}
 
 
-    /**
-     * returns the locale settings to their previous value
-     *
-     * @link https://www.php.net/manual/en/function.setlocale.php#106811
-     */
-    private function resetSystemLocales()
-    {
-        foreach ($this->current_system_locales as $locale_setting) {
-            if (strpos($locale_setting, '=') !== false) {
-                [$category, $locale] = explode('=', $locale_setting);
-            } else {
-                $category = LC_ALL;
-                $locale   = $locale_setting;
-            }
-            setlocale(absint($category), $locale);
-        }
-    }
+	/**
+	 * returns the locale settings to their previous value
+	 *
+	 * @link https://www.php.net/manual/en/function.setlocale.php#106811
+	 */
+	private function resetSystemLocales()
+	{
+		foreach ($this->current_system_locales as $locale_setting) {
+			if (strpos($locale_setting, '=') !== false) {
+				[$category, $locale] = explode('=', $locale_setting);
+			} else {
+				$category = LC_ALL;
+				$locale   = $locale_setting;
+			}
+			setlocale(absint($category), $locale);
+		}
+	}
 
 
-    /**
-     * stashes the current locale settings so that they can be reset later
-     *
-     * @link https://www.php.net/manual/en/function.setlocale.php#106811
-     */
-    private function stashCurrentSystemLocales()
-    {
-        // passing "0" for second parameter of setlocale()
-        // returns the current settings as opposed to setting anything ¯\_(ツ)_/¯
-        $current_system_locales       = setlocale(LC_ALL, 0);
-        $this->current_system_locales = explode(';', $current_system_locales);
-    }
+	/**
+	 * stashes the current locale settings so that they can be reset later
+	 *
+	 * @link https://www.php.net/manual/en/function.setlocale.php#106811
+	 */
+	private function stashCurrentSystemLocales()
+	{
+		// passing "0" for second parameter of setlocale()
+		// returns the current settings as opposed to setting anything ¯\_(ツ)_/¯
+		$current_system_locales       = setlocale(LC_ALL, 0);
+		$this->current_system_locales = explode(';', $current_system_locales);
+	}
 
 
-    /**
-     * stashes the current locale settings
-     * switches to the provided locale
-     * retrieves ALL details for the provided locale
-     * caches the retrieved data using the provided locale value as the key
-     * resets the locale to its original value
-     * returns the requested locale data
-     *
-     * @param string $locale_name
-     * @param int    $allow_recurse
-     * @return array
-     */
-    public function getLocale(string $locale_name, int $allow_recurse = 2): array
-    {
-        if (! isset($this->locales[ $locale_name ])) {
-            $this->stashCurrentSystemLocales();
-            $charsets         = $this->getLocaleCharsets();
-            // some systems use dashes and some use underscores for the locale names, ie: "en_US" vs "en-US"
-            $alternate_locale = strpos($locale_name, '_')
-                ? str_replace('_', '-', $locale_name)
-                : str_replace('-', '_', $locale_name);
-            foreach ($charsets as $charset) {
-                // if the first locale gets set, then the conditional will short-circuit and break the loop
-                // otherwise we'll try again with the alternate locale name
-                if ($this->changeLocale($locale_name, $charset) || $this->changeLocale($alternate_locale, $charset)) {
-                    break;
-                }
-            }
-            $this->resetSystemLocales();
-        }
-        if (isset($this->locales[ $locale_name ])) {
-            return $this->locales[ $locale_name ];
-        }
-        // if our second attempt to get a locale failed, then try one more time using the site locale
-        if ($allow_recurse === 2) {
-            return $this->getLocale(get_locale(), 1);
-        }
-        // if the above doesn't work then the locale likely isn't installed on the server.
-        // we'll try "en_US" and if that doesn't work then the server is definitely not configured properly,
-        // or the customer is trying to use a language on a server in a country that doesn't speak that language...
-        // like trying to use English on a server in Australia! :drop-bear-emoji:
-        return $allow_recurse ? $this->getLocale('en_US', 0) : [];
-    }
+	/**
+	 * stashes the current locale settings
+	 * switches to the provided locale
+	 * retrieves ALL details for the provided locale
+	 * caches the retrieved data using the provided locale value as the key
+	 * resets the locale to its original value
+	 * returns the requested locale data
+	 *
+	 * @param string $locale_name
+	 * @param int    $allow_recurse
+	 * @return array
+	 */
+	public function getLocale(string $locale_name, int $allow_recurse = 2): array
+	{
+		if (! isset($this->locales[ $locale_name ])) {
+			$this->stashCurrentSystemLocales();
+			$charsets         = $this->getLocaleCharsets();
+			// some systems use dashes and some use underscores for the locale names, ie: "en_US" vs "en-US"
+			$alternate_locale = strpos($locale_name, '_')
+				? str_replace('_', '-', $locale_name)
+				: str_replace('-', '_', $locale_name);
+			foreach ($charsets as $charset) {
+				// if the first locale gets set, then the conditional will short-circuit and break the loop
+				// otherwise we'll try again with the alternate locale name
+				if ($this->changeLocale($locale_name, $charset) || $this->changeLocale($alternate_locale, $charset)) {
+					break;
+				}
+			}
+			$this->resetSystemLocales();
+		}
+		if (isset($this->locales[ $locale_name ])) {
+			return $this->locales[ $locale_name ];
+		}
+		// if our second attempt to get a locale failed, then try one more time using the site locale
+		if ($allow_recurse === 2) {
+			return $this->getLocale(get_locale(), 1);
+		}
+		// if the above doesn't work then the locale likely isn't installed on the server.
+		// we'll try "en_US" and if that doesn't work then the server is definitely not configured properly,
+		// or the customer is trying to use a language on a server in a country that doesn't speak that language...
+		// like trying to use English on a server in Australia! :drop-bear-emoji:
+		return $allow_recurse ? $this->getLocale('en_US', 0) : [];
+	}
 }

core/services/locale/Locale.php

Indentation +458 added lines, -458 removed lines

@@ -14,462 +14,462 @@
  */
 class Locale
 {
-    /**
-     * Monetary decimal point character
-     */
-    const CURRENCY_DECIMAL_POINT = 'mon_decimal_point';
-
-    /**
-     * Array containing monetary groupings
-     */
-    const CURRENCY_GROUPING = 'mon_grouping';
-
-    /**
-     * International currency code (ex: USD)
-     */
-    const CURRENCY_ISO_CODE = 'int_curr_symbol';
-
-    /**
-     * Local currency symbol (ex: $)
-     */
-    const CURRENCY_SYMBOL = 'currency_symbol';
-
-    /**
-     * true if currency_symbol precedes a positive value, false if it succeeds one
-     */
-    const CURRENCY_SYMBOL_B4_POSITIVE = 'p_cs_precedes';
-
-    /**
-     * true if a space separates currency_symbol from a positive value, false otherwise
-     */
-    const CURRENCY_SYMBOL_SPACE_B4_POSITIVE = 'p_sep_by_space';
-
-    /**
-     * true if currency_symbol precedes a negative value, false if it succeeds one
-     */
-    const CURRENCY_SYMBOL_B4_NEGATIVE = 'n_cs_precedes';
-
-    /**
-     * true if a space separates currency_symbol from a negative value, false otherwise
-     */
-    const CURRENCY_SYMBOL_SPACE_B4_NEGATIVE = 'n_sep_by_space';
-
-    /**
-     * Monetary thousands separator
-     */
-    const CURRENCY_THOUSANDS_SEP = 'mon_thousands_sep';
-
-    /**
-     * International fractional digits (number of decimal places)
-     */
-    const INTL_DECIMAL_PRECISION = 'int_frac_digits';
-
-    /**
-     * Local fractional digits (number of decimal places)
-     */
-    const LOCAL_DECIMAL_PRECISION = 'frac_digits';
-
-    /**
-     * Sign for negative values
-     */
-    const NEGATIVE_SIGN = 'negative_sign';
-
-    /**
-     * 0 - Parentheses surround the quantity and currency_symbol
-     * 1 - The sign string precedes the quantity and currency_symbol
-     * 2 - The sign string succeeds the quantity and currency_symbol
-     * 3 - The sign string immediately precedes the currency_symbol
-     * 4 - The sign string immediately succeeds the currency_symbol
-     */
-    const NEGATIVE_SIGN_POSITION = 'n_sign_posn';
-
-    /**
-     * Decimal point character
-     */
-    const NUMBER_DECIMAL_POINT = 'decimal_point';
-
-    /**
-     * Array containing numeric groupings
-     */
-    const NUMBER_GROUPING = 'grouping';
-
-    /**
-     * Thousands separator
-     */
-    const NUMBER_THOUSANDS_SEP = 'thousands_sep';
-
-    /**
-     * Sign for positive values
-     */
-    const POSITIVE_SIGN = 'positive_sign';
-
-    /**
-     * 0 - Parentheses surround the quantity and currency_symbol
-     * 1 - The sign string precedes the quantity and currency_symbol
-     * 2 - The sign string succeeds the quantity and currency_symbol
-     * 3 - The sign string immediately precedes the currency_symbol
-     * 4 - The sign string immediately succeeds the currency_symbol
-     */
-    const POSITIVE_SIGN_POSITION = 'p_sign_posn';
-
-    /**
-     * @var array
-     */
-    protected $locale_info;
-
-    /**
-     * @var string
-     */
-    protected $locale_name;
-
-    /**
-     * @var string
-     */
-    protected $currency_decimal_point;
-
-    /**
-     * @var int
-     */
-    protected $currency_grouping;
-
-    /**
-     * @var string
-     */
-    protected $currency_iso_code;
-
-    /**
-     * @var string
-     */
-    protected $currency_symbol;
-
-    /**
-     * @var bool
-     */
-    protected $currency_symbol_b4_negative;
-
-    /**
-     * @var bool
-     */
-    protected $currency_symbol_b4_positive;
-
-    /**
-     * @var bool
-     */
-    protected $currency_symbol_space_b4_negative;
-
-    /**
-     * @var bool
-     */
-    protected $currency_symbol_space_b4_positive;
-
-    /**
-     * @var string
-     */
-    protected $currency_thousands_separator;
-
-    /**
-     * @var int
-     */
-    protected $intl_decimal_precision;
-
-    /**
-     * @var int
-     */
-    protected $local_decimal_precision;
-
-    /**
-     * @var string
-     */
-    protected $negative_sign;
-
-    /**
-     * @var int
-     */
-    protected $negative_sign_position;
-
-    /**
-     * @var string
-     */
-    protected $number_decimal_point;
-
-    /**
-     * @var int
-     */
-    protected $number_grouping;
-
-    /**
-     * @var string
-     */
-    protected $number_thousands_separator;
-
-    /**
-     * @var string
-     */
-    protected $positive_sign;
-
-    /**
-     * @var int
-     */
-    protected $positive_sign_position;
-
-
-    protected static $property_key_map = [
-        Locale::CURRENCY_DECIMAL_POINT            => 'currency_decimal_point',
-        Locale::CURRENCY_GROUPING                 => 'currency_grouping',
-        Locale::CURRENCY_ISO_CODE                 => 'currency_iso_code',
-        Locale::CURRENCY_SYMBOL                   => 'currency_symbol',
-        Locale::CURRENCY_SYMBOL_B4_NEGATIVE       => 'currency_symbol_b4_negative',
-        Locale::CURRENCY_SYMBOL_B4_POSITIVE       => 'currency_symbol_b4_positive',
-        Locale::CURRENCY_SYMBOL_SPACE_B4_NEGATIVE => 'currency_symbol_space_b4_negative',
-        Locale::CURRENCY_SYMBOL_SPACE_B4_POSITIVE => 'currency_symbol_space_b4_positive',
-        Locale::CURRENCY_THOUSANDS_SEP            => 'currency_thousands_separator',
-        Locale::INTL_DECIMAL_PRECISION            => 'intl_decimal_precision',
-        Locale::LOCAL_DECIMAL_PRECISION           => 'local_decimal_precision',
-        Locale::NUMBER_DECIMAL_POINT              => 'number_decimal_point',
-        Locale::NUMBER_GROUPING                   => 'number_grouping',
-        Locale::NUMBER_THOUSANDS_SEP              => 'number_thousands_separator',
-        Locale::NEGATIVE_SIGN                     => 'negative_sign',
-        Locale::NEGATIVE_SIGN_POSITION            => 'negative_sign_position',
-        Locale::POSITIVE_SIGN                     => 'positive_sign',
-        Locale::POSITIVE_SIGN_POSITION            => 'positive_sign_position',
-    ];
-
-
-    /**
-     * Locale constructor.
-     *
-     * @param string $locale_name
-     * @param array  $locale_info
-     * @param array  $defaults
-     */
-    public function __construct(string $locale_name, array $locale_info, array $defaults)
-    {
-        $this->locale_info = $locale_info;
-        $this->locale_name = $this->locale_info['locale_name'] ?? $locale_name;
-
-        foreach (Locale::$property_key_map as $key => $property) {
-            $value = '';
-            if (isset($key, $this->locale_info)) {
-                $value = $this->locale_info[ $key ];
-            } elseif (isset($key, $defaults)) {
-                $value = $defaults[ $key ];
-            }
-            $value = is_array($value) ? reset($value) : $value;
-            // replace any space characters (nbsp, NNBSP, etc) with regular spaces
-            $value = preg_replace('/[\s]+/mu', " ", $value);
-            $this->{$property} = trim($value);
-        }
-    }
-
-
-    /**
-     * @return string[]
-     */
-    private function validLocaleInfoKeys(): array
-    {
-        return array_keys(Locale::$property_key_map);
-    }
-
-
-    /**
-     * @param string $info_key
-     * @throws DomainException
-     */
-    private function validateLocaleInfoKeys(string $info_key)
-    {
-        if (! in_array($info_key, $this->validLocaleInfoKeys())) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '"%1$s" is not a valid key for retrieving locale information. Please use one of the "Locale::*" constants.',
-                        'event_espresso'
-                    ),
-                    $info_key
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param string           $key
-     * @param int|float|string $default
-     * @return string
-     */
-    public function getLocaleInfo(string $key = '', $default = '')
-    {
-        $this->validateLocaleInfoKeys($key);
-        return array_key_exists($key, $this->locale_info) ? $this->locale_info[ $key ] : $default;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function currencyDecimalPoint(): string
-    {
-        return $this->currency_decimal_point;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function currencyGrouping(): int
-    {
-        return $this->currency_grouping;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function currencyIsoCode(): string
-    {
-        return $this->currency_iso_code;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function currencySymbol(): string
-    {
-        return $this->currency_symbol;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function currencySymbolB4Negative(): bool
-    {
-        return $this->currency_symbol_b4_negative;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function currencySymbolB4Positive(): bool
-    {
-        return $this->currency_symbol_b4_positive;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function currencySymbolSpaceB4Negative(): bool
-    {
-        return $this->currency_symbol_space_b4_negative;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function currencySymbolSpaceB4Positive(): bool
-    {
-        return $this->currency_symbol_space_b4_positive;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function currencyThousandsSeparator(): string
-    {
-        return $this->currency_thousands_separator;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function decimalPoint(): string
-    {
-        return $this->number_decimal_point;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function decimalPrecision(): int
-    {
-        return $this->local_decimal_precision;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function internationalDecimalPrecision(): int
-    {
-        return $this->intl_decimal_precision;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function grouping(): int
-    {
-        return $this->number_grouping;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function name(): string
-    {
-        return $this->locale_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function negativeSign(): string
-    {
-        return $this->negative_sign;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function negativeSignPosition(): int
-    {
-        return $this->negative_sign_position;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function positiveSign(): string
-    {
-        return $this->positive_sign;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function positiveSignPosition(): int
-    {
-        return $this->positive_sign_position;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function thousandsSeparator(): string
-    {
-        return $this->number_thousands_separator;
-    }
+	/**
+	 * Monetary decimal point character
+	 */
+	const CURRENCY_DECIMAL_POINT = 'mon_decimal_point';
+
+	/**
+	 * Array containing monetary groupings
+	 */
+	const CURRENCY_GROUPING = 'mon_grouping';
+
+	/**
+	 * International currency code (ex: USD)
+	 */
+	const CURRENCY_ISO_CODE = 'int_curr_symbol';
+
+	/**
+	 * Local currency symbol (ex: $)
+	 */
+	const CURRENCY_SYMBOL = 'currency_symbol';
+
+	/**
+	 * true if currency_symbol precedes a positive value, false if it succeeds one
+	 */
+	const CURRENCY_SYMBOL_B4_POSITIVE = 'p_cs_precedes';
+
+	/**
+	 * true if a space separates currency_symbol from a positive value, false otherwise
+	 */
+	const CURRENCY_SYMBOL_SPACE_B4_POSITIVE = 'p_sep_by_space';
+
+	/**
+	 * true if currency_symbol precedes a negative value, false if it succeeds one
+	 */
+	const CURRENCY_SYMBOL_B4_NEGATIVE = 'n_cs_precedes';
+
+	/**
+	 * true if a space separates currency_symbol from a negative value, false otherwise
+	 */
+	const CURRENCY_SYMBOL_SPACE_B4_NEGATIVE = 'n_sep_by_space';
+
+	/**
+	 * Monetary thousands separator
+	 */
+	const CURRENCY_THOUSANDS_SEP = 'mon_thousands_sep';
+
+	/**
+	 * International fractional digits (number of decimal places)
+	 */
+	const INTL_DECIMAL_PRECISION = 'int_frac_digits';
+
+	/**
+	 * Local fractional digits (number of decimal places)
+	 */
+	const LOCAL_DECIMAL_PRECISION = 'frac_digits';
+
+	/**
+	 * Sign for negative values
+	 */
+	const NEGATIVE_SIGN = 'negative_sign';
+
+	/**
+	 * 0 - Parentheses surround the quantity and currency_symbol
+	 * 1 - The sign string precedes the quantity and currency_symbol
+	 * 2 - The sign string succeeds the quantity and currency_symbol
+	 * 3 - The sign string immediately precedes the currency_symbol
+	 * 4 - The sign string immediately succeeds the currency_symbol
+	 */
+	const NEGATIVE_SIGN_POSITION = 'n_sign_posn';
+
+	/**
+	 * Decimal point character
+	 */
+	const NUMBER_DECIMAL_POINT = 'decimal_point';
+
+	/**
+	 * Array containing numeric groupings
+	 */
+	const NUMBER_GROUPING = 'grouping';
+
+	/**
+	 * Thousands separator
+	 */
+	const NUMBER_THOUSANDS_SEP = 'thousands_sep';
+
+	/**
+	 * Sign for positive values
+	 */
+	const POSITIVE_SIGN = 'positive_sign';
+
+	/**
+	 * 0 - Parentheses surround the quantity and currency_symbol
+	 * 1 - The sign string precedes the quantity and currency_symbol
+	 * 2 - The sign string succeeds the quantity and currency_symbol
+	 * 3 - The sign string immediately precedes the currency_symbol
+	 * 4 - The sign string immediately succeeds the currency_symbol
+	 */
+	const POSITIVE_SIGN_POSITION = 'p_sign_posn';
+
+	/**
+	 * @var array
+	 */
+	protected $locale_info;
+
+	/**
+	 * @var string
+	 */
+	protected $locale_name;
+
+	/**
+	 * @var string
+	 */
+	protected $currency_decimal_point;
+
+	/**
+	 * @var int
+	 */
+	protected $currency_grouping;
+
+	/**
+	 * @var string
+	 */
+	protected $currency_iso_code;
+
+	/**
+	 * @var string
+	 */
+	protected $currency_symbol;
+
+	/**
+	 * @var bool
+	 */
+	protected $currency_symbol_b4_negative;
+
+	/**
+	 * @var bool
+	 */
+	protected $currency_symbol_b4_positive;
+
+	/**
+	 * @var bool
+	 */
+	protected $currency_symbol_space_b4_negative;
+
+	/**
+	 * @var bool
+	 */
+	protected $currency_symbol_space_b4_positive;
+
+	/**
+	 * @var string
+	 */
+	protected $currency_thousands_separator;
+
+	/**
+	 * @var int
+	 */
+	protected $intl_decimal_precision;
+
+	/**
+	 * @var int
+	 */
+	protected $local_decimal_precision;
+
+	/**
+	 * @var string
+	 */
+	protected $negative_sign;
+
+	/**
+	 * @var int
+	 */
+	protected $negative_sign_position;
+
+	/**
+	 * @var string
+	 */
+	protected $number_decimal_point;
+
+	/**
+	 * @var int
+	 */
+	protected $number_grouping;
+
+	/**
+	 * @var string
+	 */
+	protected $number_thousands_separator;
+
+	/**
+	 * @var string
+	 */
+	protected $positive_sign;
+
+	/**
+	 * @var int
+	 */
+	protected $positive_sign_position;
+
+
+	protected static $property_key_map = [
+		Locale::CURRENCY_DECIMAL_POINT            => 'currency_decimal_point',
+		Locale::CURRENCY_GROUPING                 => 'currency_grouping',
+		Locale::CURRENCY_ISO_CODE                 => 'currency_iso_code',
+		Locale::CURRENCY_SYMBOL                   => 'currency_symbol',
+		Locale::CURRENCY_SYMBOL_B4_NEGATIVE       => 'currency_symbol_b4_negative',
+		Locale::CURRENCY_SYMBOL_B4_POSITIVE       => 'currency_symbol_b4_positive',
+		Locale::CURRENCY_SYMBOL_SPACE_B4_NEGATIVE => 'currency_symbol_space_b4_negative',
+		Locale::CURRENCY_SYMBOL_SPACE_B4_POSITIVE => 'currency_symbol_space_b4_positive',
+		Locale::CURRENCY_THOUSANDS_SEP            => 'currency_thousands_separator',
+		Locale::INTL_DECIMAL_PRECISION            => 'intl_decimal_precision',
+		Locale::LOCAL_DECIMAL_PRECISION           => 'local_decimal_precision',
+		Locale::NUMBER_DECIMAL_POINT              => 'number_decimal_point',
+		Locale::NUMBER_GROUPING                   => 'number_grouping',
+		Locale::NUMBER_THOUSANDS_SEP              => 'number_thousands_separator',
+		Locale::NEGATIVE_SIGN                     => 'negative_sign',
+		Locale::NEGATIVE_SIGN_POSITION            => 'negative_sign_position',
+		Locale::POSITIVE_SIGN                     => 'positive_sign',
+		Locale::POSITIVE_SIGN_POSITION            => 'positive_sign_position',
+	];
+
+
+	/**
+	 * Locale constructor.
+	 *
+	 * @param string $locale_name
+	 * @param array  $locale_info
+	 * @param array  $defaults
+	 */
+	public function __construct(string $locale_name, array $locale_info, array $defaults)
+	{
+		$this->locale_info = $locale_info;
+		$this->locale_name = $this->locale_info['locale_name'] ?? $locale_name;
+
+		foreach (Locale::$property_key_map as $key => $property) {
+			$value = '';
+			if (isset($key, $this->locale_info)) {
+				$value = $this->locale_info[ $key ];
+			} elseif (isset($key, $defaults)) {
+				$value = $defaults[ $key ];
+			}
+			$value = is_array($value) ? reset($value) : $value;
+			// replace any space characters (nbsp, NNBSP, etc) with regular spaces
+			$value = preg_replace('/[\s]+/mu', " ", $value);
+			$this->{$property} = trim($value);
+		}
+	}
+
+
+	/**
+	 * @return string[]
+	 */
+	private function validLocaleInfoKeys(): array
+	{
+		return array_keys(Locale::$property_key_map);
+	}
+
+
+	/**
+	 * @param string $info_key
+	 * @throws DomainException
+	 */
+	private function validateLocaleInfoKeys(string $info_key)
+	{
+		if (! in_array($info_key, $this->validLocaleInfoKeys())) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'"%1$s" is not a valid key for retrieving locale information. Please use one of the "Locale::*" constants.',
+						'event_espresso'
+					),
+					$info_key
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param string           $key
+	 * @param int|float|string $default
+	 * @return string
+	 */
+	public function getLocaleInfo(string $key = '', $default = '')
+	{
+		$this->validateLocaleInfoKeys($key);
+		return array_key_exists($key, $this->locale_info) ? $this->locale_info[ $key ] : $default;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function currencyDecimalPoint(): string
+	{
+		return $this->currency_decimal_point;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function currencyGrouping(): int
+	{
+		return $this->currency_grouping;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function currencyIsoCode(): string
+	{
+		return $this->currency_iso_code;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function currencySymbol(): string
+	{
+		return $this->currency_symbol;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function currencySymbolB4Negative(): bool
+	{
+		return $this->currency_symbol_b4_negative;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function currencySymbolB4Positive(): bool
+	{
+		return $this->currency_symbol_b4_positive;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function currencySymbolSpaceB4Negative(): bool
+	{
+		return $this->currency_symbol_space_b4_negative;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function currencySymbolSpaceB4Positive(): bool
+	{
+		return $this->currency_symbol_space_b4_positive;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function currencyThousandsSeparator(): string
+	{
+		return $this->currency_thousands_separator;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function decimalPoint(): string
+	{
+		return $this->number_decimal_point;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function decimalPrecision(): int
+	{
+		return $this->local_decimal_precision;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function internationalDecimalPrecision(): int
+	{
+		return $this->intl_decimal_precision;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function grouping(): int
+	{
+		return $this->number_grouping;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function name(): string
+	{
+		return $this->locale_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function negativeSign(): string
+	{
+		return $this->negative_sign;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function negativeSignPosition(): int
+	{
+		return $this->negative_sign_position;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function positiveSign(): string
+	{
+		return $this->positive_sign;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function positiveSignPosition(): int
+	{
+		return $this->positive_sign_position;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function thousandsSeparator(): string
+	{
+		return $this->number_thousands_separator;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -250,9 +250,9 @@ 
         foreach (Locale::$property_key_map as $key => $property) {
             $value = '';
             if (isset($key, $this->locale_info)) {
-                $value = $this->locale_info[ $key ];
+                $value = $this->locale_info[$key];
             } elseif (isset($key, $defaults)) {
-                $value = $defaults[ $key ];
+                $value = $defaults[$key];
             }
             $value = is_array($value) ? reset($value) : $value;
             // replace any space characters (nbsp, NNBSP, etc) with regular spaces
@@ -277,7 +277,7 @@ 
      */
     private function validateLocaleInfoKeys(string $info_key)
     {
-        if (! in_array($info_key, $this->validLocaleInfoKeys())) {
+        if ( ! in_array($info_key, $this->validLocaleInfoKeys())) {
             throw new DomainException(
                 sprintf(
                     esc_html__(
@@ -299,7 +299,7 @@ 
     public function getLocaleInfo(string $key = '', $default = '')
     {
         $this->validateLocaleInfoKeys($key);
-        return array_key_exists($key, $this->locale_info) ? $this->locale_info[ $key ] : $default;
+        return array_key_exists($key, $this->locale_info) ? $this->locale_info[$key] : $default;
     }
 
 

core/services/locale/DefaultLocaleData.php

Indentation +47 added lines, -47 removed lines

@@ -14,57 +14,57 @@
  */
 class DefaultLocaleData
 {
-    /**
-     * @var EE_Currency_Config
-     */
-    private $currency_config;
+	/**
+	 * @var EE_Currency_Config
+	 */
+	private $currency_config;
 
 
-    /**
-     * DefaultLocaleData constructor.
-     *
-     * @param EE_Currency_Config $currency_config
-     */
-    public function __construct(EE_Currency_Config $currency_config)
-    {
-        $this->currency_config = $currency_config;
-    }
+	/**
+	 * DefaultLocaleData constructor.
+	 *
+	 * @param EE_Currency_Config $currency_config
+	 */
+	public function __construct(EE_Currency_Config $currency_config)
+	{
+		$this->currency_config = $currency_config;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function getDefaultLocale(): string
-    {
-        return $this->currency_config->locale();
-    }
+	/**
+	 * @return string
+	 */
+	public function getDefaultLocale(): string
+	{
+		return $this->currency_config->locale();
+	}
 
 
-    /**
-     * @return array
-     */
-    public function getDefaults(): array
-    {
-        // if locale info is missing, then fall back to legacy money formatting details
-        return [
-            Locale::CURRENCY_DECIMAL_POINT            => $this->currency_config->dec_plc,
-            Locale::CURRENCY_GROUPING                 => 3,
-            Locale::CURRENCY_ISO_CODE                 => $this->currency_config->code,
-            Locale::CURRENCY_SYMBOL                   => $this->currency_config->sign,
-            Locale::CURRENCY_SYMBOL_B4_NEGATIVE       => $this->currency_config->sign_b4,
-            Locale::CURRENCY_SYMBOL_B4_POSITIVE       => $this->currency_config->sign_b4,
-            Locale::CURRENCY_SYMBOL_SPACE_B4_NEGATIVE => true,
-            Locale::CURRENCY_SYMBOL_SPACE_B4_POSITIVE => true,
-            Locale::CURRENCY_THOUSANDS_SEP            => $this->currency_config->thsnds,
-            Locale::INTL_DECIMAL_PRECISION            => $this->currency_config->dec_plc,
-            Locale::LOCAL_DECIMAL_PRECISION           => $this->currency_config->dec_plc,
-            Locale::NUMBER_DECIMAL_POINT              => $this->currency_config->dec_mrk,
-            Locale::NUMBER_GROUPING                   => 3,
-            Locale::NUMBER_THOUSANDS_SEP              => $this->currency_config->thsnds,
-            Locale::NEGATIVE_SIGN                     => '-',
-            Locale::NEGATIVE_SIGN_POSITION            => 1,
-            Locale::POSITIVE_SIGN                     => '',
-            Locale::POSITIVE_SIGN_POSITION            => 1,
-        ];
-    }
+	/**
+	 * @return array
+	 */
+	public function getDefaults(): array
+	{
+		// if locale info is missing, then fall back to legacy money formatting details
+		return [
+			Locale::CURRENCY_DECIMAL_POINT            => $this->currency_config->dec_plc,
+			Locale::CURRENCY_GROUPING                 => 3,
+			Locale::CURRENCY_ISO_CODE                 => $this->currency_config->code,
+			Locale::CURRENCY_SYMBOL                   => $this->currency_config->sign,
+			Locale::CURRENCY_SYMBOL_B4_NEGATIVE       => $this->currency_config->sign_b4,
+			Locale::CURRENCY_SYMBOL_B4_POSITIVE       => $this->currency_config->sign_b4,
+			Locale::CURRENCY_SYMBOL_SPACE_B4_NEGATIVE => true,
+			Locale::CURRENCY_SYMBOL_SPACE_B4_POSITIVE => true,
+			Locale::CURRENCY_THOUSANDS_SEP            => $this->currency_config->thsnds,
+			Locale::INTL_DECIMAL_PRECISION            => $this->currency_config->dec_plc,
+			Locale::LOCAL_DECIMAL_PRECISION           => $this->currency_config->dec_plc,
+			Locale::NUMBER_DECIMAL_POINT              => $this->currency_config->dec_mrk,
+			Locale::NUMBER_GROUPING                   => 3,
+			Locale::NUMBER_THOUSANDS_SEP              => $this->currency_config->thsnds,
+			Locale::NEGATIVE_SIGN                     => '-',
+			Locale::NEGATIVE_SIGN_POSITION            => 1,
+			Locale::POSITIVE_SIGN                     => '',
+			Locale::POSITIVE_SIGN_POSITION            => 1,
+		];
+	}
 }