eventespresso / event-espresso-core

core/libraries/form_sections/inputs/EE_Form_Input_With_Options_Base.input.php

Indentation +322 added lines, -322 removed lines

@@ -11,328 +11,328 @@
  */
 class EE_Form_Input_With_Options_Base extends EE_Form_Input_Base
 {
-    /**
-     * array of available options to choose as an answer
-     *
-     * @var array
-     */
-    protected $_options = array();
-
-    /**
-     * whether to display the html_label_text above the checkbox/radio button options
-     *
-     * @var boolean
-     */
-    protected $_display_html_label_text = true;
-
-    /**
-     * whether to display an question option description as part of the input label
-     *
-     * @var boolean
-     */
-    protected $_use_desc_in_label = true;
-
-    /**
-     * strlen() result for the longest input value (what gets displayed in the label)
-     * this is used to apply a css class to the input label
-     *
-     * @var int
-     */
-    protected $_label_size = 0;
-
-    /**
-     * whether to enforce the label size value passed in the constructor
-     *
-     * @var boolean
-     */
-    protected $_enforce_label_size = false;
-
-    /**
-     * whether to allow multiple selections (ie, the value of this input should be an array)
-     * or not (ie, the value should be a simple int, string, etc)
-     *
-     * @var boolean
-     */
-    protected $_multiple_selections = false;
-
-
-
-    /**
-     * @param array     $answer_options
-     * @param array     $input_settings {
-     * @type int|string $label_size
-     * @type boolean    $display_html_label_text
-     *                                  }
-     *                                  And all the options accepted by EE_Form_Input_Base
-     */
-    public function __construct($answer_options = array(), $input_settings = array())
-    {
-        if (isset($input_settings['label_size'])) {
-            $this->_set_label_size($input_settings['label_size']);
-            if (isset($input_settings['enforce_label_size']) && $input_settings['enforce_label_size']) {
-                $this->_enforce_label_size = true;
-            }
-        }
-        if (isset($input_settings['display_html_label_text'])) {
-            $this->set_display_html_label_text($input_settings['display_html_label_text']);
-        }
-        $this->set_select_options($answer_options);
-        parent::__construct($input_settings);
-    }
-
-
-
-    /**
-     * Sets the allowed options for this input. Also has the side effect of
-     * updating the normalization strategy to match the keys provided in the array
-     *
-     * @param array $answer_options
-     * @return void  just has the side effect of setting the options for this input
-     */
-    public function set_select_options($answer_options = array())
-    {
-        $answer_options = is_array($answer_options) ? $answer_options : array($answer_options);
-        // get the first item in the select options and check its type
-        $this->_options = reset($answer_options) instanceof EE_Question_Option
-            ? $this->_process_question_options($answer_options)
-            : $answer_options;
-        // d( $this->_options );
-        $select_option_keys = array_keys($this->_options);
-        // attempt to determine data type for values in order to set normalization type
-        // purposefully only
-        if (
-            count($this->_options) === 2
-            && (
-                (in_array(true, $select_option_keys, true) && in_array(false, $select_option_keys, true))
-                || (in_array(1, $select_option_keys, true) && in_array(0, $select_option_keys, true))
-            )
-        ) {
-            // values appear to be boolean, like TRUE, FALSE, 1, 0
-            $normalization = new EE_Boolean_Normalization();
-        } else {
-            // are ALL the options integers (even if we're using a multidimensional array)? If so use int validation
-            $all_integers = true;
-            array_walk_recursive(
-                $this->_options,
-                function ($value, $key) use (&$all_integers) {
-                    // is this a top-level key? ignore it
-                    if (
-                        ! is_array($value)
-                        && ! is_int($key)
-                        && $key !== ''
-                        && $key !== null
-                    ) {
-                        $all_integers = false;
-                    }
-                }
-            );
-            $normalization = $all_integers ? new EE_Int_Normalization() : new EE_Text_Normalization();
-        }
-        // does input type have multiple options ?
-        if ($this->_multiple_selections) {
-            $this->_set_normalization_strategy(new EE_Many_Valued_Normalization($normalization));
-        } else {
-            $this->_set_normalization_strategy($normalization);
-        }
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function options()
-    {
-        return $this->_options;
-    }
-
-
-
-    /**
-     * Returns an array which is guaranteed to not be multidimensional
-     *
-     * @return array
-     */
-    public function flat_options()
-    {
-        return $this->_flatten_select_options($this->options());
-    }
-
-
-
-    /**
-     * Makes sure $arr is a flat array, not a multidimensional one
-     *
-     * @param array $arr
-     * @return array
-     */
-    protected function _flatten_select_options($arr)
-    {
-        $flat_array = array();
-        if (EEH_Array::is_multi_dimensional_array($arr)) {
-            foreach ($arr as $sub_array) {
-                foreach ((array) $sub_array as $key => $value) {
-                    $flat_array[ $key ] = $value;
-                    $this->_set_label_size($value);
-                }
-            }
-        } else {
-            foreach ($arr as $key => $value) {
-                $flat_array[ $key ] = $value;
-                $this->_set_label_size($value);
-            }
-        }
-        return $flat_array;
-    }
-
-
-
-    /**
-     * @param EE_Question_Option[] $question_options_array
-     * @return array
-     */
-    protected function _process_question_options($question_options_array = array())
-    {
-        $flat_array = array();
-        foreach ($question_options_array as $question_option) {
-            if ($question_option instanceof EE_Question_Option) {
-                $desc = '';
-                if ($this->_use_desc_in_label) {
-                    $desc = $question_option->desc();
-                    $desc = ! empty($desc) ? '<span class="ee-question-option-desc">' . $desc . '</span>' : '';
-                }
-                $value = $question_option->value();
-                // add value even if it's empty
-                $flat_array[ $value ] = $value;
-                // if both value and desc are not empty, then separate with a dash
-                if (! empty($value) && ! empty($desc)) {
-                    $flat_array[ $value ] .= ' - ' . $desc;
-                } else {
-                    // otherwise, just add desc, since either or both of the vars is empty, and no dash is necessary
-                    $flat_array[ $value ] .= $desc;
-                }
-            } elseif (is_array($question_option)) {
-                $flat_array += $this->_flatten_select_options($question_option);
-            }
-        }
-        return $flat_array;
-    }
-
-
-
-    /**
-     *    set_label_sizes
-     *
-     * @return void
-     */
-    public function set_label_sizes()
-    {
-        // did the input settings specifically say to NOT set the label size dynamically ?
-        if (! $this->_enforce_label_size) {
-            foreach ($this->_options as $option) {
-                // calculate the strlen of the label
-                $this->_set_label_size($option);
-            }
-        }
-    }
-
-
-
-    /**
-     *    _set_label_size_class
-     *
-     * @param int|string $value
-     * @return void
-     */
-    private function _set_label_size($value = '')
-    {
-        // don't change label size if it has already been set and is being enforced
-        if ($this->_enforce_label_size && $this->_label_size >  0) {
-            return;
-        }
-        // determine length of option value
-        $val_size = is_int($value) ? $value : strlen($value);
-        // use new value if bigger than existing
-        $this->_label_size = $val_size > $this->_label_size ? $val_size : $this->_label_size;
-    }
-
-
-
-    /**
-     *    get_label_size_class
-     *
-     * @return string
-     */
-    public function get_label_size_class()
-    {
-        $size = ' medium-lbl';
-        // use maximum option value length to determine label size
-        if ($this->_label_size < 3) {
-            $size = ' nano-lbl';
-        } elseif ($this->_label_size < 6) {
-            $size = ' micro-lbl';
-        } elseif ($this->_label_size < 12) {
-            $size = ' tiny-lbl';
-        } elseif ($this->_label_size < 25) {
-            $size = ' small-lbl';
-        } elseif ($this->_label_size < 50) {
-            $size = ' medium-lbl';
-        } elseif ($this->_label_size >= 100) {
-            $size = ' big-lbl';
-        }
-        return $size;
-    }
-
-
-
-    /**
-     * Returns the pretty value for the normalized value
-     *
-     * @return string
-     */
-    public function pretty_value()
-    {
-        $options = $this->flat_options();
-        $unnormalized_value_choices = $this->get_normalization_strategy()->unnormalize($this->_normalized_value);
-        if (! $this->_multiple_selections) {
-            $unnormalized_value_choices = array($unnormalized_value_choices);
-        }
-        $pretty_strings = array();
-        foreach ((array) $unnormalized_value_choices as $unnormalized_value_choice) {
-            if (isset($options[ $unnormalized_value_choice ])) {
-                $pretty_strings[] = $options[ $unnormalized_value_choice ];
-            } else {
-                $pretty_strings[] = $this->normalized_value();
-            }
-        }
-        return implode(', ', $pretty_strings);
-    }
-
-
-
-    /**
-     * @return boolean
-     */
-    public function display_html_label_text()
-    {
-        return $this->_display_html_label_text;
-    }
-
-
-
-    /**
-     * @param boolean $display_html_label_text
-     */
-    public function set_display_html_label_text($display_html_label_text)
-    {
-        $this->_display_html_label_text = filter_var($display_html_label_text, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    public function hasMultipleSelections(): bool
-    {
-        return $this->_multiple_selections;
-    }
+	/**
+	 * array of available options to choose as an answer
+	 *
+	 * @var array
+	 */
+	protected $_options = array();
+
+	/**
+	 * whether to display the html_label_text above the checkbox/radio button options
+	 *
+	 * @var boolean
+	 */
+	protected $_display_html_label_text = true;
+
+	/**
+	 * whether to display an question option description as part of the input label
+	 *
+	 * @var boolean
+	 */
+	protected $_use_desc_in_label = true;
+
+	/**
+	 * strlen() result for the longest input value (what gets displayed in the label)
+	 * this is used to apply a css class to the input label
+	 *
+	 * @var int
+	 */
+	protected $_label_size = 0;
+
+	/**
+	 * whether to enforce the label size value passed in the constructor
+	 *
+	 * @var boolean
+	 */
+	protected $_enforce_label_size = false;
+
+	/**
+	 * whether to allow multiple selections (ie, the value of this input should be an array)
+	 * or not (ie, the value should be a simple int, string, etc)
+	 *
+	 * @var boolean
+	 */
+	protected $_multiple_selections = false;
+
+
+
+	/**
+	 * @param array     $answer_options
+	 * @param array     $input_settings {
+	 * @type int|string $label_size
+	 * @type boolean    $display_html_label_text
+	 *                                  }
+	 *                                  And all the options accepted by EE_Form_Input_Base
+	 */
+	public function __construct($answer_options = array(), $input_settings = array())
+	{
+		if (isset($input_settings['label_size'])) {
+			$this->_set_label_size($input_settings['label_size']);
+			if (isset($input_settings['enforce_label_size']) && $input_settings['enforce_label_size']) {
+				$this->_enforce_label_size = true;
+			}
+		}
+		if (isset($input_settings['display_html_label_text'])) {
+			$this->set_display_html_label_text($input_settings['display_html_label_text']);
+		}
+		$this->set_select_options($answer_options);
+		parent::__construct($input_settings);
+	}
+
+
+
+	/**
+	 * Sets the allowed options for this input. Also has the side effect of
+	 * updating the normalization strategy to match the keys provided in the array
+	 *
+	 * @param array $answer_options
+	 * @return void  just has the side effect of setting the options for this input
+	 */
+	public function set_select_options($answer_options = array())
+	{
+		$answer_options = is_array($answer_options) ? $answer_options : array($answer_options);
+		// get the first item in the select options and check its type
+		$this->_options = reset($answer_options) instanceof EE_Question_Option
+			? $this->_process_question_options($answer_options)
+			: $answer_options;
+		// d( $this->_options );
+		$select_option_keys = array_keys($this->_options);
+		// attempt to determine data type for values in order to set normalization type
+		// purposefully only
+		if (
+			count($this->_options) === 2
+			&& (
+				(in_array(true, $select_option_keys, true) && in_array(false, $select_option_keys, true))
+				|| (in_array(1, $select_option_keys, true) && in_array(0, $select_option_keys, true))
+			)
+		) {
+			// values appear to be boolean, like TRUE, FALSE, 1, 0
+			$normalization = new EE_Boolean_Normalization();
+		} else {
+			// are ALL the options integers (even if we're using a multidimensional array)? If so use int validation
+			$all_integers = true;
+			array_walk_recursive(
+				$this->_options,
+				function ($value, $key) use (&$all_integers) {
+					// is this a top-level key? ignore it
+					if (
+						! is_array($value)
+						&& ! is_int($key)
+						&& $key !== ''
+						&& $key !== null
+					) {
+						$all_integers = false;
+					}
+				}
+			);
+			$normalization = $all_integers ? new EE_Int_Normalization() : new EE_Text_Normalization();
+		}
+		// does input type have multiple options ?
+		if ($this->_multiple_selections) {
+			$this->_set_normalization_strategy(new EE_Many_Valued_Normalization($normalization));
+		} else {
+			$this->_set_normalization_strategy($normalization);
+		}
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function options()
+	{
+		return $this->_options;
+	}
+
+
+
+	/**
+	 * Returns an array which is guaranteed to not be multidimensional
+	 *
+	 * @return array
+	 */
+	public function flat_options()
+	{
+		return $this->_flatten_select_options($this->options());
+	}
+
+
+
+	/**
+	 * Makes sure $arr is a flat array, not a multidimensional one
+	 *
+	 * @param array $arr
+	 * @return array
+	 */
+	protected function _flatten_select_options($arr)
+	{
+		$flat_array = array();
+		if (EEH_Array::is_multi_dimensional_array($arr)) {
+			foreach ($arr as $sub_array) {
+				foreach ((array) $sub_array as $key => $value) {
+					$flat_array[ $key ] = $value;
+					$this->_set_label_size($value);
+				}
+			}
+		} else {
+			foreach ($arr as $key => $value) {
+				$flat_array[ $key ] = $value;
+				$this->_set_label_size($value);
+			}
+		}
+		return $flat_array;
+	}
+
+
+
+	/**
+	 * @param EE_Question_Option[] $question_options_array
+	 * @return array
+	 */
+	protected function _process_question_options($question_options_array = array())
+	{
+		$flat_array = array();
+		foreach ($question_options_array as $question_option) {
+			if ($question_option instanceof EE_Question_Option) {
+				$desc = '';
+				if ($this->_use_desc_in_label) {
+					$desc = $question_option->desc();
+					$desc = ! empty($desc) ? '<span class="ee-question-option-desc">' . $desc . '</span>' : '';
+				}
+				$value = $question_option->value();
+				// add value even if it's empty
+				$flat_array[ $value ] = $value;
+				// if both value and desc are not empty, then separate with a dash
+				if (! empty($value) && ! empty($desc)) {
+					$flat_array[ $value ] .= ' - ' . $desc;
+				} else {
+					// otherwise, just add desc, since either or both of the vars is empty, and no dash is necessary
+					$flat_array[ $value ] .= $desc;
+				}
+			} elseif (is_array($question_option)) {
+				$flat_array += $this->_flatten_select_options($question_option);
+			}
+		}
+		return $flat_array;
+	}
+
+
+
+	/**
+	 *    set_label_sizes
+	 *
+	 * @return void
+	 */
+	public function set_label_sizes()
+	{
+		// did the input settings specifically say to NOT set the label size dynamically ?
+		if (! $this->_enforce_label_size) {
+			foreach ($this->_options as $option) {
+				// calculate the strlen of the label
+				$this->_set_label_size($option);
+			}
+		}
+	}
+
+
+
+	/**
+	 *    _set_label_size_class
+	 *
+	 * @param int|string $value
+	 * @return void
+	 */
+	private function _set_label_size($value = '')
+	{
+		// don't change label size if it has already been set and is being enforced
+		if ($this->_enforce_label_size && $this->_label_size >  0) {
+			return;
+		}
+		// determine length of option value
+		$val_size = is_int($value) ? $value : strlen($value);
+		// use new value if bigger than existing
+		$this->_label_size = $val_size > $this->_label_size ? $val_size : $this->_label_size;
+	}
+
+
+
+	/**
+	 *    get_label_size_class
+	 *
+	 * @return string
+	 */
+	public function get_label_size_class()
+	{
+		$size = ' medium-lbl';
+		// use maximum option value length to determine label size
+		if ($this->_label_size < 3) {
+			$size = ' nano-lbl';
+		} elseif ($this->_label_size < 6) {
+			$size = ' micro-lbl';
+		} elseif ($this->_label_size < 12) {
+			$size = ' tiny-lbl';
+		} elseif ($this->_label_size < 25) {
+			$size = ' small-lbl';
+		} elseif ($this->_label_size < 50) {
+			$size = ' medium-lbl';
+		} elseif ($this->_label_size >= 100) {
+			$size = ' big-lbl';
+		}
+		return $size;
+	}
+
+
+
+	/**
+	 * Returns the pretty value for the normalized value
+	 *
+	 * @return string
+	 */
+	public function pretty_value()
+	{
+		$options = $this->flat_options();
+		$unnormalized_value_choices = $this->get_normalization_strategy()->unnormalize($this->_normalized_value);
+		if (! $this->_multiple_selections) {
+			$unnormalized_value_choices = array($unnormalized_value_choices);
+		}
+		$pretty_strings = array();
+		foreach ((array) $unnormalized_value_choices as $unnormalized_value_choice) {
+			if (isset($options[ $unnormalized_value_choice ])) {
+				$pretty_strings[] = $options[ $unnormalized_value_choice ];
+			} else {
+				$pretty_strings[] = $this->normalized_value();
+			}
+		}
+		return implode(', ', $pretty_strings);
+	}
+
+
+
+	/**
+	 * @return boolean
+	 */
+	public function display_html_label_text()
+	{
+		return $this->_display_html_label_text;
+	}
+
+
+
+	/**
+	 * @param boolean $display_html_label_text
+	 */
+	public function set_display_html_label_text($display_html_label_text)
+	{
+		$this->_display_html_label_text = filter_var($display_html_label_text, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	public function hasMultipleSelections(): bool
+	{
+		return $this->_multiple_selections;
+	}
 
 
 }

Spacing +13 added lines, -13 removed lines

@@ -114,7 +114,7 @@ 
             $all_integers = true;
             array_walk_recursive(
                 $this->_options,
-                function ($value, $key) use (&$all_integers) {
+                function($value, $key) use (&$all_integers) {
                     // is this a top-level key? ignore it
                     if (
                         ! is_array($value)
@@ -172,13 +172,13 @@ 
         if (EEH_Array::is_multi_dimensional_array($arr)) {
             foreach ($arr as $sub_array) {
                 foreach ((array) $sub_array as $key => $value) {
-                    $flat_array[ $key ] = $value;
+                    $flat_array[$key] = $value;
                     $this->_set_label_size($value);
                 }
             }
         } else {
             foreach ($arr as $key => $value) {
-                $flat_array[ $key ] = $value;
+                $flat_array[$key] = $value;
                 $this->_set_label_size($value);
             }
         }
@@ -199,17 +199,17 @@ 
                 $desc = '';
                 if ($this->_use_desc_in_label) {
                     $desc = $question_option->desc();
-                    $desc = ! empty($desc) ? '<span class="ee-question-option-desc">' . $desc . '</span>' : '';
+                    $desc = ! empty($desc) ? '<span class="ee-question-option-desc">'.$desc.'</span>' : '';
                 }
                 $value = $question_option->value();
                 // add value even if it's empty
-                $flat_array[ $value ] = $value;
+                $flat_array[$value] = $value;
                 // if both value and desc are not empty, then separate with a dash
-                if (! empty($value) && ! empty($desc)) {
-                    $flat_array[ $value ] .= ' - ' . $desc;
+                if ( ! empty($value) && ! empty($desc)) {
+                    $flat_array[$value] .= ' - '.$desc;
                 } else {
                     // otherwise, just add desc, since either or both of the vars is empty, and no dash is necessary
-                    $flat_array[ $value ] .= $desc;
+                    $flat_array[$value] .= $desc;
                 }
             } elseif (is_array($question_option)) {
                 $flat_array += $this->_flatten_select_options($question_option);
@@ -228,7 +228,7 @@ 
     public function set_label_sizes()
     {
         // did the input settings specifically say to NOT set the label size dynamically ?
-        if (! $this->_enforce_label_size) {
+        if ( ! $this->_enforce_label_size) {
             foreach ($this->_options as $option) {
                 // calculate the strlen of the label
                 $this->_set_label_size($option);
@@ -247,7 +247,7 @@ 
     private function _set_label_size($value = '')
     {
         // don't change label size if it has already been set and is being enforced
-        if ($this->_enforce_label_size && $this->_label_size >  0) {
+        if ($this->_enforce_label_size && $this->_label_size > 0) {
             return;
         }
         // determine length of option value
@@ -294,13 +294,13 @@ 
     {
         $options = $this->flat_options();
         $unnormalized_value_choices = $this->get_normalization_strategy()->unnormalize($this->_normalized_value);
-        if (! $this->_multiple_selections) {
+        if ( ! $this->_multiple_selections) {
             $unnormalized_value_choices = array($unnormalized_value_choices);
         }
         $pretty_strings = array();
         foreach ((array) $unnormalized_value_choices as $unnormalized_value_choice) {
-            if (isset($options[ $unnormalized_value_choice ])) {
-                $pretty_strings[] = $options[ $unnormalized_value_choice ];
+            if (isset($options[$unnormalized_value_choice])) {
+                $pretty_strings[] = $options[$unnormalized_value_choice];
             } else {
                 $pretty_strings[] = $this->normalized_value();
             }

core/libraries/form_sections/inputs/EE_Datepicker_Input.php

Indentation +66 added lines, -66 removed lines

@@ -9,77 +9,77 @@
  */
 class EE_Datepicker_Input extends EE_Form_Input_Base
 {
-    private bool $use_jquery_ui;
+	private bool $use_jquery_ui;
 
 
-    /**
-     * @param array $input_settings
-     */
-    public function __construct($input_settings = [], $use_jquery_ui = false)
-    {
-        $this->use_jquery_ui = (bool) apply_filters('FHEE__EE_Datepicker_Input__use_jquery_ui', $use_jquery_ui);
-        $type                = $this->use_jquery_ui ? 'datepicker' : 'date';
-        $this->_set_display_strategy(new EE_Text_Input_Display_Strategy($type));
-        $this->_set_normalization_strategy(new EE_Text_Normalization());
-        // we could do better for validation, but at least verify its plaintext
-        $this->_add_validation_strategy(
-            new EE_Plaintext_Validation_Strategy($input_settings['validation_error_message'] ?? null)
-        );
-        parent::__construct($input_settings);
-        $this->set_html_class($this->html_class() . " $type");
+	/**
+	 * @param array $input_settings
+	 */
+	public function __construct($input_settings = [], $use_jquery_ui = false)
+	{
+		$this->use_jquery_ui = (bool) apply_filters('FHEE__EE_Datepicker_Input__use_jquery_ui', $use_jquery_ui);
+		$type                = $this->use_jquery_ui ? 'datepicker' : 'date';
+		$this->_set_display_strategy(new EE_Text_Input_Display_Strategy($type));
+		$this->_set_normalization_strategy(new EE_Text_Normalization());
+		// we could do better for validation, but at least verify its plaintext
+		$this->_add_validation_strategy(
+			new EE_Plaintext_Validation_Strategy($input_settings['validation_error_message'] ?? null)
+		);
+		parent::__construct($input_settings);
+		$this->set_html_class($this->html_class() . " $type");
 
-        if ($this->use_jquery_ui) {
-            // add some style and make it dance
-            add_action('wp_enqueue_scripts', ['EE_Datepicker_Input', 'enqueue_styles_and_scripts']);
-            add_action('admin_enqueue_scripts', ['EE_Datepicker_Input', 'enqueue_styles_and_scripts']);
-        }
-    }
+		if ($this->use_jquery_ui) {
+			// add some style and make it dance
+			add_action('wp_enqueue_scripts', ['EE_Datepicker_Input', 'enqueue_styles_and_scripts']);
+			add_action('admin_enqueue_scripts', ['EE_Datepicker_Input', 'enqueue_styles_and_scripts']);
+		}
+	}
 
 
-    /**
-     * @return void
-     * @deprecated 5.0.30.p
-     */
-    public static function enqueue_styles_and_scripts()
-    {
-        // load css
-        wp_register_style(
-            'espresso-ui-theme',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso-ui-theme');
-    }
+	/**
+	 * @return void
+	 * @deprecated 5.0.30.p
+	 */
+	public static function enqueue_styles_and_scripts()
+	{
+		// load css
+		wp_register_style(
+			'espresso-ui-theme',
+			EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso-ui-theme');
+	}
 
 
-    /**
-     * converts the raw value into a date strimg in the format Y-m-d
-     * unless we're using jquery ui, in which case we just return the raw value
-     *
-     * @return string
-     * @throws Exception
-     */
-    public function raw_value_in_form(): string
-    {
-        $raw_value = $this->raw_value();
-        if ($this->use_jquery_ui || ! $raw_value) {
-            return parent::raw_value_in_form();
-        }
-        // load the CURRENT WordPress date format and try that
-        $date = DateTime::createFromFormat(get_option('date_format', 'Y-m-d'), $raw_value);
-        if ($date instanceof DateTime) {
-            return $date->format('Y-m-d');
-        }
-        // nope? ok check if date format can just be parsed as is
-        $timestamp = strtotime($raw_value);
-        if ($timestamp) {
-            $date = date('Y-m-d', $timestamp);
-            if ($date) {
-                return $date;
-            }
-        }
-        // ... errr... ok... just return the raw value
-        return $raw_value;
-    }
+	/**
+	 * converts the raw value into a date strimg in the format Y-m-d
+	 * unless we're using jquery ui, in which case we just return the raw value
+	 *
+	 * @return string
+	 * @throws Exception
+	 */
+	public function raw_value_in_form(): string
+	{
+		$raw_value = $this->raw_value();
+		if ($this->use_jquery_ui || ! $raw_value) {
+			return parent::raw_value_in_form();
+		}
+		// load the CURRENT WordPress date format and try that
+		$date = DateTime::createFromFormat(get_option('date_format', 'Y-m-d'), $raw_value);
+		if ($date instanceof DateTime) {
+			return $date->format('Y-m-d');
+		}
+		// nope? ok check if date format can just be parsed as is
+		$timestamp = strtotime($raw_value);
+		if ($timestamp) {
+			$date = date('Y-m-d', $timestamp);
+			if ($date) {
+				return $date;
+			}
+		}
+		// ... errr... ok... just return the raw value
+		return $raw_value;
+	}
 }

core/libraries/form_sections/inputs/EE_Form_Input_Base.input.php

Indentation +1290 added lines, -1290 removed lines

@@ -14,1294 +14,1294 @@
  */
 abstract class EE_Form_Input_Base extends EE_Form_Section_Validatable
 {
-    /**
-     * the input's name attribute
-     *
-     * @var string|null
-     */
-    protected ?string $_html_name = null;
-
-    /**
-     * id for the html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_id;
-
-    /**
-     * class for teh html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_class;
-
-    /**
-     * style for teh html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_style;
-
-    /**
-     * text to be placed in the html label
-     *
-     * @var string
-     */
-    protected $_html_label_text;
-
-    /**
-     * the full html label. If used, all other html_label_* properties are invalid
-     *
-     * @var string
-     */
-    protected $_html_label;
-
-    /**
-     * HTML to use for help text (normally placed below form input), in a span which normally
-     * has a class of 'description'
-     *
-     * @var string
-     */
-    protected $_html_help_text;
-
-    /**
-     * CSS classes for displaying the help span
-     *
-     * @var string
-     */
-    protected $_html_help_class = 'description';
-
-    /**
-     * CSS to put in the style attribute on the help span
-     *
-     * @var string
-     */
-    protected $_html_help_style;
-
-    /**
-     * Stores whether or not this input's response is required.
-     * Because certain styling elements may also want to know that this
-     * input is required etc.
-     *
-     * @var boolean
-     */
-    protected $_required;
-
-    /**
-     * css class added to required inputs
-     *
-     * @var string
-     */
-    protected $_required_css_class = 'ee-required';
-
-    /**
-     * css styles applied to button type inputs
-     *
-     * @var string
-     */
-    protected $_button_css_attributes;
-
-    /**
-     * The raw post data submitted for this
-     * Generally unsafe for usage in client code
-     *
-     * @var mixed string or array
-     */
-    protected $_raw_value;
-
-    /**
-     * Value normalized according to the input's normalization strategy.
-     * The normalization strategy dictates whether this is a string, int, float,
-     * boolean, or array of any of those.
-     *
-     * @var mixed
-     */
-    protected $_normalized_value;
-
-
-    /**
-     * Normalized default value either initially set on the input, or provided by calling
-     * set_default().
-     *
-     * @var mixed
-     */
-    protected $_default;
-
-    /**
-     * Strategy used for displaying this field.
-     * Child classes must use _get_display_strategy to access it.
-     *
-     * @var EE_Display_Strategy_Base
-     */
-    private $_display_strategy;
-
-    /**
-     * Gets all the validation strategies used on this field
-     *
-     * @var EE_Validation_Strategy_Base[]
-     */
-    private $_validation_strategies = [];
-
-    /**
-     * The normalization strategy for this field
-     *
-     * @var EE_Normalization_Strategy_Base
-     */
-    private $_normalization_strategy;
-
-    /**
-     * Strategy for removing sensitive data after we're done with the form input
-     *
-     * @var EE_Sensitive_Data_Removal_Base
-     */
-    protected $_sensitive_data_removal_strategy;
-
-    /**
-     * Whether this input has been disabled or not.
-     * If it's disabled while rendering, an extra hidden input is added that indicates it has been knowingly disabled.
-     * (Client-side code that wants to dynamically disable it must also add this hidden input).
-     * When the form is submitted, if the input is disabled in the PHP form section, then input is ignored.
-     * If the input is missing from the request data but the hidden input indicating the input is disabled, then the
-     * input is again ignored.
-     *
-     * @var boolean
-     */
-    protected $disabled = false;
-
-    protected array $_data_attributes = [];
-
-    protected bool $_no_label = false; // if true, then no html label will be displayed for this input
-
-    /**
-     * adds a class to the input's container
-     *
-     * @var string
-     */
-    protected string $_layout_container_class = '';
-
-    /**
-     * additional HTML to inject into the input's container
-     *
-     * @var string
-     */
-    protected string $_extra_container_html = '';
-
-
-    /**
-     * @param array                         $input_args       {
-     * @type string                         $html_name        the html name for the input
-     * @type string                         $html_label_id    the id attribute to give to the html label tag
-     * @type string                         $html_label_class the class attribute to give to the html label tag
-     * @type string                         $html_label_style the style attribute to give ot teh label tag
-     * @type string                         $html_label_text  the text to put in the label tag
-     * @type string                         $html_label       the full html label. If used,
-     *                                                        all other html_label_* args are invalid
-     * @type string                         $html_help_text   text to put in help element
-     * @type string                         $html_help_style  style attribute to give to teh help element
-     * @type string                         $html_help_class  class attribute to give to the help element
-     * @type string                         $default          default value NORMALIZED (eg, if providing the default
-     *                                                        for a Yes_No_Input, you should provide TRUE or FALSE, not
-     *                                                        '1' or '0')
-     * @type EE_Display_Strategy_Base       $display          strategy
-     * @type EE_Normalization_Strategy_Base $normalization_strategy
-     * @type EE_Validation_Strategy_Base[]  $validation_strategies
-     * @type boolean                        $ignore_input     special argument which can be used to avoid adding any
-     *                                                        validation strategies, and sets the normalization
-     *                                                        strategy to the Null normalization. This is good when you
-     *                                                        want the input to be totally ignored server-side (like
-     *                                                        when using React.js form inputs)
-     *                                                        }
-     */
-    public function __construct($input_args = [])
-    {
-        $input_args = (array) apply_filters('FHEE__EE_Form_Input_Base___construct__input_args', $input_args, $this);
-        // the following properties must be cast as arrays
-        if (isset($input_args['validation_strategies'])) {
-            foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
-                if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
-                    $this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
-                }
-            }
-            unset($input_args['validation_strategies']);
-        }
-        if (isset($input_args['ignore_input'])) {
-            $this->_validation_strategies = [];
-        }
-        // loop thru incoming options
-        foreach ($input_args as $key => $value) {
-            if ($key === 'disabled') {
-                $this->disable($value);
-                continue;
-            }
-            $setter = 'set_' . $key;
-            if (method_exists($this, $setter)) {
-                $this->$setter($value);
-                unset($input_args[ $key ]);
-                continue;
-            }
-            // add underscore to $key to match property names
-            $_key = "_$key";
-            if (property_exists($this, $_key)) {
-                $this->{$_key} = $value;
-                unset($input_args[ $key ]);
-            }
-        }
-        // ensure that "required" is set correctly
-        $this->set_required(
-            $this->_required,
-            $input_args['required_validation_error_message'] ?? null
-        );
-        // $this->_html_name_specified = isset( $input_args['html_name'] ) ? TRUE : FALSE;
-        $this->_display_strategy->_construct_finalize($this);
-        foreach ($this->_validation_strategies as $validation_strategy) {
-            $validation_strategy->_construct_finalize($this);
-        }
-        if (isset($input_args['ignore_input'])) {
-            $this->_normalization_strategy = new EE_Null_Normalization();
-        }
-        if (! $this->_normalization_strategy) {
-            $this->_normalization_strategy = new EE_Text_Normalization();
-        }
-        $this->_normalization_strategy->_construct_finalize($this);
-        // at least we can use the normalization strategy to populate the default
-        if (isset($input_args['default'])) {
-            $this->set_default($input_args['default']);
-            unset($input_args['default']);
-        }
-        if (! $this->_sensitive_data_removal_strategy) {
-            $this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
-        }
-        $this->_sensitive_data_removal_strategy->_construct_finalize($this);
-        parent::__construct($input_args);
-    }
-
-
-    /**
-     * Sets the html_name to its default value, if none was specified in teh constructor.
-     * Calculation involves using the name and the parent's html_name
-     *
-     * @throws EE_Error
-     */
-    protected function _set_default_html_name_if_empty()
-    {
-        if (! $this->_html_name) {
-            $this->_html_name = $this->name();
-            if ($this->_parent_section instanceof EE_Form_Section_Proper) {
-                $this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
-            }
-        }
-    }
-
-
-    /**
-     * @param $parent_form_section
-     * @param $name
-     * @throws EE_Error
-     */
-    public function _construct_finalize($parent_form_section, $name)
-    {
-        parent::_construct_finalize($parent_form_section, $name);
-        if ($this->_html_label === null && $this->_html_label_text === null && ! $this->_no_label) {
-            $this->_html_label_text = ucwords(str_replace("_", " ", $name));
-        }
-        do_action('AHEE__EE_Form_Input_Base___construct_finalize__end', $this, $parent_form_section, $name);
-    }
-
-
-    /**
-     * Returns the strategy for displaying this form input. If none is set, throws an exception.
-     *
-     * @return EE_Display_Strategy_Base
-     * @throws EE_Error
-     */
-    protected function _get_display_strategy()
-    {
-        $this->ensure_construct_finalized_called();
-        if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Cannot get display strategy for form input with name %s and id %s, because it has not been set in the constructor",
-                        "event_espresso"
-                    ),
-                    $this->html_name(),
-                    $this->html_id()
-                )
-            );
-        } else {
-            return $this->_display_strategy;
-        }
-    }
-
-
-    /**
-     * Sets the display strategy.
-     *
-     * @param EE_Display_Strategy_Base $strategy
-     */
-    protected function _set_display_strategy(EE_Display_Strategy_Base $strategy)
-    {
-        $this->_display_strategy = $strategy;
-    }
-
-
-    /**
-     * Sets the sanitization strategy
-     *
-     * @param EE_Normalization_Strategy_Base $strategy
-     */
-    protected function _set_normalization_strategy(EE_Normalization_Strategy_Base $strategy)
-    {
-        $this->_normalization_strategy = $strategy;
-    }
-
-
-    /**
-     * Gets sensitive_data_removal_strategy
-     *
-     * @return EE_Sensitive_Data_Removal_Base
-     */
-    public function get_sensitive_data_removal_strategy()
-    {
-        return $this->_sensitive_data_removal_strategy;
-    }
-
-
-    /**
-     * Sets sensitive_data_removal_strategy
-     *
-     * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy
-     * @return void
-     */
-    public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy)
-    {
-        $this->_sensitive_data_removal_strategy = $sensitive_data_removal_strategy;
-    }
-
-
-    /**
-     * Gets the display strategy for this input
-     *
-     * @return EE_Display_Strategy_Base
-     */
-    public function get_display_strategy()
-    {
-        return $this->_display_strategy;
-    }
-
-
-    /**
-     * Overwrites the display strategy
-     *
-     * @param EE_Display_Strategy_Base $display_strategy
-     */
-    public function set_display_strategy($display_strategy)
-    {
-        $this->_display_strategy = $display_strategy;
-        $this->_display_strategy->_construct_finalize($this);
-    }
-
-
-    /**
-     * Gets the normalization strategy set on this input
-     *
-     * @return EE_Normalization_Strategy_Base
-     */
-    public function get_normalization_strategy()
-    {
-        return $this->_normalization_strategy;
-    }
-
-
-    /**
-     * Overwrites the normalization strategy
-     *
-     * @param EE_Normalization_Strategy_Base $normalization_strategy
-     */
-    public function set_normalization_strategy($normalization_strategy)
-    {
-        $this->_normalization_strategy = $normalization_strategy;
-        $this->_normalization_strategy->_construct_finalize($this);
-    }
-
-
-    /**
-     * Returns all teh validation strategies which apply to this field, numerically indexed
-     *
-     * @return EE_Validation_Strategy_Base[]
-     */
-    public function get_validation_strategies()
-    {
-        return $this->_validation_strategies;
-    }
-
-
-    /**
-     * Adds this strategy to the field so it will be used in both JS validation and server-side validation
-     *
-     * @param EE_Validation_Strategy_Base $validation_strategy
-     * @return void
-     */
-    protected function _add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
-    {
-        $validation_strategy->_construct_finalize($this);
-        $this->_validation_strategies[] = $validation_strategy;
-    }
-
-
-    /**
-     * Adds a new validation strategy onto the form input
-     *
-     * @param EE_Validation_Strategy_Base $validation_strategy
-     * @return void
-     */
-    public function add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
-    {
-        $this->_add_validation_strategy($validation_strategy);
-    }
-
-
-    /**
-     * The classname of the validation strategy to remove
-     *
-     * @param string $validation_strategy_classname
-     */
-    public function remove_validation_strategy($validation_strategy_classname)
-    {
-        foreach ($this->_validation_strategies as $key => $validation_strategy) {
-            if (
-                $validation_strategy instanceof $validation_strategy_classname
-                || is_subclass_of($validation_strategy, $validation_strategy_classname)
-            ) {
-                unset($this->_validation_strategies[ $key ]);
-            }
-        }
-    }
-
-
-    public function removeAllValidationStrategies()
-    {
-        $this->_validation_strategies = [];
-    }
-
-
-    /**
-     * returns true if input employs any of the validation strategy defined by the supplied array of classnames
-     *
-     * @param array $validation_strategy_classnames
-     * @return bool
-     */
-    public function has_validation_strategy($validation_strategy_classnames)
-    {
-        $validation_strategy_classnames = is_array($validation_strategy_classnames)
-            ? $validation_strategy_classnames
-            : [$validation_strategy_classnames];
-        foreach ($this->_validation_strategies as $key => $validation_strategy) {
-            if (in_array($key, $validation_strategy_classnames)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets the HTML
-     *
-     * @return string
-     */
-    public function get_html()
-    {
-        return $this->_parent_section->get_html_for_input($this);
-    }
-
-
-    /**
-     * Gets the HTML for the input itself (no label or errors) according to the
-     * input's display strategy
-     * Makes sure the JS and CSS are enqueued for it
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_html_for_input()
-    {
-        return $this->_form_html_filter
-            ? $this->_form_html_filter->filterHtml(
-                $this->_get_display_strategy()->display(),
-                $this
-            )
-            : $this->_get_display_strategy()->display();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_other_attributes()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use. You should replace it by %s',
-                    'event_espresso'
-                ),
-                'EE_Form_Section_Base::other_html_attributes()'
-            ),
-            '4.10.2.p'
-        );
-
-        return $this->other_html_attributes();
-    }
-
-
-    /**
-     * @param string $html_other_attributes
-     */
-    public function set_html_other_attributes($html_other_attributes)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use. You should replace it by %s',
-                    'event_espresso'
-                ),
-                'EE_Form_Section_Base::set_other_html_attributes()'
-            ),
-            '4.10.2.p'
-        );
-
-        $this->set_other_html_attributes($html_other_attributes);
-    }
-
-
-    /**
-     * Gets the HTML for displaying the label for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_html_for_label()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_label($this);
-    }
-
-
-    /**
-     * Gets the HTML for displaying the errors section for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_html_for_errors()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_errors($this);
-    }
-
-
-    /**
-     * Gets the HTML for displaying the help text for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_html_for_help()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_help_text($this);
-    }
-
-
-    /**
-     * Validates the input's sanitized value (assumes _sanitize() has already been called)
-     * and returns whether or not the form input's submitted value is value
-     *
-     * @return boolean
-     */
-    protected function _validate()
-    {
-        if ($this->isDisabled()) {
-            return true;
-        }
-        foreach ($this->_validation_strategies as $validation_strategy) {
-            if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
-                try {
-                    $validation_strategy->validate($this->normalized_value());
-                } catch (EE_Validation_Error $e) {
-                    $this->add_validation_error($e);
-                }
-            }
-        }
-        if ($this->get_validation_errors()) {
-            return false;
-        } else {
-            return true;
-        }
-    }
-
-
-    /**
-     * Performs basic sanitization on this value. But what sanitization can be performed anyways?
-     * This value MIGHT be allowed to have tags, so we can't really remove them.
-     *
-     * @param string $value
-     * @return null|string
-     */
-    protected function _sanitize($value)
-    {
-        return $value !== null
-            ? stripslashes(html_entity_decode(trim((string) $value)))
-            : null;
-    }
-
-
-    /**
-     * Picks out the form value that relates to this form input,
-     * and stores it as the sanitized value on the form input, and sets the normalized value.
-     * Returns whether or not any validation errors occurred
-     *
-     * @param array $req_data
-     * @return boolean whether or not there was an error
-     * @throws EE_Error
-     */
-    protected function _normalize($req_data)
-    {
-        // any existing validation errors don't apply so clear them
-        $this->_validation_errors = [];
-        // if the input is disabled, ignore whatever input was sent in
-        if ($this->isDisabled()) {
-            $this->_set_raw_value(null);
-            $this->_set_normalized_value($this->get_default());
-            return false;
-        }
-        try {
-            $raw_input = $this->find_form_data_for_this_section($req_data);
-            // super simple sanitization for now
-            if (is_array($raw_input)) {
-                $raw_value = [];
-                foreach ($raw_input as $key => $value) {
-                    $raw_value[ $key ] = $this->_sanitize($value);
-                }
-                $this->_set_raw_value($raw_value);
-            } else {
-                $this->_set_raw_value($this->_sanitize($raw_input));
-            }
-            // we want to mostly leave the input alone in case we need to re-display it to the user
-            $this->_set_normalized_value($this->_normalization_strategy->normalize($this->raw_value()));
-            return false;
-        } catch (EE_Validation_Error $e) {
-            $this->add_validation_error($e);
-            return true;
-        }
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_name()
-    {
-        $this->_set_default_html_name_if_empty();
-        return $this->_html_name ?? '';
-    }
-
-
-    /**
-     * @param string $html_label_id
-     */
-    public function set_html_label_id(string $html_label_id)
-    {
-        // if the html_label_id doesn't end in -lbl, then add it
-        if (strpos($html_label_id, '-lbl') !== (strlen($html_label_id) - 4)) {
-            $html_label_id .= '-lbl';
-        }
-        $this->_html_label_id = $html_label_id;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_label_id()
-    {
-        if (empty($this->_html_label_id)) {
-            $this->set_html_label_id($this->html_id());
-        }
-        return $this->_html_label_id;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_label_class()
-    {
-        return $this->_html_label_class ?? '';
-    }
-
-
-    /**
-     * @param string $html_class
-     */
-    public function add_html_label_class(string $html_class)
-    {
-        $this->_html_label_class .= ' ' . trim($html_class);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_label_style()
-    {
-        return $this->_html_label_style ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_label_text()
-    {
-        return $this->_html_label_text ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_help_text()
-    {
-        return $this->_html_help_text ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_help_class()
-    {
-        return $this->_html_help_class ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_help_style()
-    {
-        return $this->_html_style ?? '';
-    }
-
-
-    /**
-     * returns the raw, UNSAFE, input, almost exactly as the user submitted it.
-     * Please note that almost all client code should instead use the normalized_value;
-     * or possibly raw_value_in_form (which prepares the string for displaying in an HTML attribute on a tag,
-     * mostly by escaping quotes)
-     * Note, we do not store the exact original value sent in the user's request because
-     * it may have malicious content, and we MIGHT want to store the form input in a transient or something...
-     * in which case, we would have stored the malicious content to our database.
-     *
-     * @return mixed
-     */
-    public function raw_value()
-    {
-        return $this->_raw_value;
-    }
-
-
-    /**
-     * Returns a string safe to usage in form inputs when displaying, because
-     * it escapes all html entities
-     *
-     * @return string
-     */
-    public function raw_value_in_form(): string
-    {
-        return htmlentities((string) $this->raw_value(), ENT_QUOTES, 'UTF-8');
-    }
-
-
-    /**
-     * returns the value after it's been sanitized, and then converted into it's proper type
-     * in PHP. Eg, a string, an int, an array,
-     *
-     * @return mixed
-     */
-    public function normalized_value()
-    {
-        return $this->_normalized_value;
-    }
-
-
-    /**
-     * Returns the normalized value is a presentable way. By default this is just
-     * the normalized value by itself, but it can be overridden for when that's not
-     * the best thing to display
-     *
-     * @return mixed
-     */
-    public function pretty_value()
-    {
-        return $this->_normalized_value;
-    }
-
-
-    /**
-     * When generating the JS for the jquery validation rules like<br>
-     * <code>$( "#myform" ).validate({
-     * rules: {
-     * password: "required",
-     * password_again: {
-     * equalTo: "#password"
-     * }
-     * }
-     * });</code>
-     * if this field had the name 'password_again', it should return
-     * <br><code>password_again: {
-     * equalTo: "#password"
-     * }</code>
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_jquery_validation_rules(): array
-    {
-        $jquery_validation_js    = [];
-        $jquery_validation_rules = [];
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $jquery_validation_rules = array_replace_recursive(
-                $jquery_validation_rules,
-                $validation_strategy->get_jquery_validation_rule_array()
-            );
-        }
-        if (! empty($jquery_validation_rules)) {
-            foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
-                $jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
-            }
-        }
-        return $jquery_validation_js;
-    }
-
-
-    /**
-     * Sets the input's default value for use in displaying in the form. Note: value should be
-     * normalized (Eg, if providing a default of ra Yes_NO_Input you would provide TRUE or FALSE, not '1' or '0')
-     *
-     * @param mixed $value
-     * @return void
-     */
-    public function set_default($value)
-    {
-        $this->_default = $value;
-        $this->_set_normalized_value($value);
-        $this->_set_raw_value($value);
-    }
-
-
-    /**
-     * Sets the normalized value on this input
-     *
-     * @param mixed $value
-     */
-    protected function _set_normalized_value($value)
-    {
-        $this->_normalized_value = $value;
-    }
-
-
-    /**
-     * Sets the raw value on this input (ie, exactly as the user submitted it)
-     *
-     * @param mixed $value
-     */
-    protected function _set_raw_value($value)
-    {
-        $this->_raw_value = $this->_normalization_strategy->unnormalize($value);
-    }
-
-
-    /**
-     * Sets the HTML label text after it has already been defined
-     *
-     * @param string $label
-     * @return void
-     */
-    public function set_html_label_text($label)
-    {
-        $this->_html_label_text = $label;
-    }
-
-
-    /**
-     * Sets whether or not this field is required, and adjusts the validation strategy.
-     * If you want to use the EE_Conditionally_Required_Validation_Strategy,
-     * please add it as a validation strategy using add_validation_strategy as normal
-     *
-     * @param boolean $required boolean
-     * @param null    $required_text
-     */
-    public function set_required($required = true, $required_text = null)
-    {
-        $required = filter_var($required, FILTER_VALIDATE_BOOLEAN);
-        // whether $required is a string or a boolean, we want to add a required validation strategy
-        if ($required) {
-            $this->_add_validation_strategy(new EE_Required_Validation_Strategy($required_text));
-        } else {
-            $this->remove_validation_strategy('EE_Required_Validation_Strategy');
-        }
-        $this->_required = $required;
-    }
-
-
-    /**
-     * Returns whether or not this field is required
-     *
-     * @return boolean
-     */
-    public function required()
-    {
-        return $this->_required;
-    }
-
-
-    /**
-     * @param string $required_css_class
-     */
-    public function set_required_css_class($required_css_class)
-    {
-        $this->_required_css_class = $required_css_class;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function required_css_class()
-    {
-        return $this->_required_css_class;
-    }
-
-
-    /**
-     * @param bool $add_required
-     * @return string
-     */
-    public function html_class($add_required = false)
-    {
-        return $add_required && $this->required()
-            ? $this->required_css_class() . ' ' . $this->_html_class
-            : $this->_html_class;
-    }
-
-
-    /**
-     * Sets the help text, in case
-     *
-     * @param string $text
-     */
-    public function set_html_help_text($text)
-    {
-        $this->_html_help_text = $text;
-    }
-
-
-    /**
-     * Uses the sensitive data removal strategy to remove the sensitive data from this
-     * input. If there is any kind of sensitive data removal on this input, we clear
-     * out the raw value completely
-     *
-     * @return void
-     */
-    public function clean_sensitive_data()
-    {
-        // if we do ANY kind of sensitive data removal on this, then just clear out the raw value
-        // if we need more logic than this we'll make a strategy for it
-        if (
-            $this->_sensitive_data_removal_strategy
-            && ! $this->_sensitive_data_removal_strategy instanceof EE_No_Sensitive_Data_Removal
-        ) {
-            $this->_set_raw_value(null);
-        }
-        // and clean the normalized value according to the appropriate strategy
-        $this->_set_normalized_value(
-            $this->get_sensitive_data_removal_strategy()->remove_sensitive_data(
-                $this->_normalized_value
-            )
-        );
-    }
-
-
-    /**
-     * @param bool   $primary
-     * @param string $button_size
-     * @param string $other_attributes
-     */
-    public function set_button_css_attributes($primary = true, $button_size = '', $other_attributes = '')
-    {
-        $button_css_attributes = 'button';
-        $button_css_attributes .= $primary === true
-            ? ' button--primary'
-            : ' button--secondary';
-        switch ($button_size) {
-            case 'xs':
-            case 'extra-small':
-                $button_css_attributes .= ' button-xs';
-                break;
-            case 'sm':
-            case 'small':
-                $button_css_attributes .= ' button-sm';
-                break;
-            case 'lg':
-            case 'large':
-                $button_css_attributes .= ' button-lg';
-                break;
-            case 'block':
-                $button_css_attributes .= ' button-block';
-                break;
-            case 'md':
-            case 'medium':
-            default:
-                $button_css_attributes .= '';
-        }
-        $this->_button_css_attributes .= ! empty($other_attributes)
-            ? $button_css_attributes . ' ' . $other_attributes
-            : $button_css_attributes;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function button_css_attributes()
-    {
-        if (empty($this->_button_css_attributes)) {
-            $this->set_button_css_attributes();
-        }
-        return $this->_button_css_attributes;
-    }
-
-
-    /**
-     * find_form_data_for_this_section
-     * using this section's name and its parents, finds the value of the form data that corresponds to it.
-     * For example, if this form section's HTML name is my_form[subform][form_input_1],
-     * then it's value should be in request at request['my_form']['subform']['form_input_1'].
-     * (If that doesn't exist, we also check for this subsection's name
-     * at the TOP LEVEL of the request data. Eg request['form_input_1'].)
-     * This function finds its value in the form.
-     *
-     * @param array $req_data
-     * @return mixed whatever the raw value of this form section is in the request data
-     * @throws EE_Error
-     */
-    public function find_form_data_for_this_section($req_data)
-    {
-        $name_parts = $this->getInputNameParts();
-        // now get the value for the input
-        $value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
-        // check if this thing's name is at the TOP level of the request data
-        if ($value === null && isset($req_data[ $this->name() ])) {
-            $value = $req_data[ $this->name() ];
-        }
-        return $value;
-    }
-
-
-    /**
-     * If this input's name is something like "foo[bar][baz]"
-     * returns an array like `array('foo','bar',baz')`
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    protected function getInputNameParts()
-    {
-        // break up the html name by "[]"
-        if (strpos($this->html_name(), '[') !== false) {
-            $before_any_brackets = substr($this->html_name(), 0, strpos($this->html_name(), '['));
-        } else {
-            $before_any_brackets = $this->html_name();
-        }
-        // grab all of the segments
-        preg_match_all('~\[([^]]*)\]~', $this->html_name(), $matches);
-        if (isset($matches[1]) && is_array($matches[1])) {
-            $name_parts = $matches[1];
-            array_unshift($name_parts, $before_any_brackets);
-        } else {
-            $name_parts = [$before_any_brackets];
-        }
-        return $name_parts;
-    }
-
-
-    /**
-     * @param array $html_name_parts
-     * @param array $req_data
-     * @return array | NULL
-     */
-    public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
-    {
-        $first_part_to_consider = array_shift($html_name_parts);
-        if (isset($req_data[ $first_part_to_consider ])) {
-            if (empty($html_name_parts)) {
-                return $req_data[ $first_part_to_consider ];
-            } else {
-                return $this->findRequestForSectionUsingNameParts(
-                    $html_name_parts,
-                    $req_data[ $first_part_to_consider ]
-                );
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Checks if this form input's data is in the request data
-     *
-     * @param array $req_data
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function form_data_present_in($req_data = null)
-    {
-        if ($req_data === null) {
-            /** @var RequestInterface $request */
-            $request  = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $req_data = $request->postParams();
-        }
-
-        return $this->find_form_data_for_this_section($req_data) !== null;
-    }
-
-
-    /**
-     * Overrides parent to add js data from validation and display strategies
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data($form_other_js_data = [])
-    {
-        return $this->get_other_js_data_from_strategies($form_other_js_data);
-    }
-
-
-    /**
-     * Gets other JS data for localization from this input's strategies, like
-     * the validation strategies and the display strategy
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data_from_strategies($form_other_js_data = [])
-    {
-        $form_other_js_data = $this->get_display_strategy()->get_other_js_data($form_other_js_data);
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $form_other_js_data = $validation_strategy->get_other_js_data($form_other_js_data);
-        }
-        return $form_other_js_data;
-    }
-
-
-    /**
-     * Override parent because we want to give our strategies an opportunity to enqueue some js and css
-     *
-     * @return void
-     */
-    public function enqueue_js()
-    {
-        // ask our display strategy and validation strategies if they have js to enqueue
-        $this->enqueue_js_from_strategies();
-    }
-
-
-    /**
-     * Tells strategies when its ok to enqueue their js and css
-     *
-     * @return void
-     */
-    public function enqueue_js_from_strategies()
-    {
-        $this->get_display_strategy()->enqueue_js();
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $validation_strategy->enqueue_js();
-        }
-    }
-
-
-    /**
-     * Gets the default value set on the input (not the current value, which may have been
-     * changed because of a form submission). If no default was set, this us null.
-     *
-     * @return mixed
-     */
-    public function get_default()
-    {
-        return $this->_default;
-    }
-
-
-    /**
-     * Makes this input disabled. That means it will have the HTML attribute 'disabled="disabled"',
-     * and server-side if any input was received it will be ignored
-     */
-    public function disable($disable = true)
-    {
-        $disabled_attribute = ' disabled="disabled"';
-        $this->disabled     = filter_var($disable, FILTER_VALIDATE_BOOLEAN);
-        if ($this->disabled) {
-            if (strpos($this->_other_html_attributes, $disabled_attribute) === false) {
-                $this->_other_html_attributes .= $disabled_attribute;
-            }
-            $this->_set_normalized_value($this->get_default());
-        } else {
-            $this->_other_html_attributes = str_replace($disabled_attribute, '', $this->_other_html_attributes);
-        }
-    }
-
-
-    /**
-     * Returns whether this input is currently disabled.
-     *
-     * @return bool
-     */
-    public function isDisabled(): bool
-    {
-        return $this->disabled;
-    }
-
-
-    public function dataAttributes(): array
-    {
-        return $this->_data_attributes;
-    }
-
-
-    public function layoutContainerClass(): string
-    {
-        return $this->_layout_container_class;
-    }
-
-
-    public function extraContainerHtml(): string
-    {
-        return $this->_extra_container_html;
-    }
-
-
-    public function hasLabel(): bool
-    {
-        return ! $this->_no_label
-            && $this->html_label_text()
-            && ! $this->get_display_strategy() instanceof EE_Hidden_Display_Strategy;
-    }
+	/**
+	 * the input's name attribute
+	 *
+	 * @var string|null
+	 */
+	protected ?string $_html_name = null;
+
+	/**
+	 * id for the html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_id;
+
+	/**
+	 * class for teh html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_class;
+
+	/**
+	 * style for teh html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_style;
+
+	/**
+	 * text to be placed in the html label
+	 *
+	 * @var string
+	 */
+	protected $_html_label_text;
+
+	/**
+	 * the full html label. If used, all other html_label_* properties are invalid
+	 *
+	 * @var string
+	 */
+	protected $_html_label;
+
+	/**
+	 * HTML to use for help text (normally placed below form input), in a span which normally
+	 * has a class of 'description'
+	 *
+	 * @var string
+	 */
+	protected $_html_help_text;
+
+	/**
+	 * CSS classes for displaying the help span
+	 *
+	 * @var string
+	 */
+	protected $_html_help_class = 'description';
+
+	/**
+	 * CSS to put in the style attribute on the help span
+	 *
+	 * @var string
+	 */
+	protected $_html_help_style;
+
+	/**
+	 * Stores whether or not this input's response is required.
+	 * Because certain styling elements may also want to know that this
+	 * input is required etc.
+	 *
+	 * @var boolean
+	 */
+	protected $_required;
+
+	/**
+	 * css class added to required inputs
+	 *
+	 * @var string
+	 */
+	protected $_required_css_class = 'ee-required';
+
+	/**
+	 * css styles applied to button type inputs
+	 *
+	 * @var string
+	 */
+	protected $_button_css_attributes;
+
+	/**
+	 * The raw post data submitted for this
+	 * Generally unsafe for usage in client code
+	 *
+	 * @var mixed string or array
+	 */
+	protected $_raw_value;
+
+	/**
+	 * Value normalized according to the input's normalization strategy.
+	 * The normalization strategy dictates whether this is a string, int, float,
+	 * boolean, or array of any of those.
+	 *
+	 * @var mixed
+	 */
+	protected $_normalized_value;
+
+
+	/**
+	 * Normalized default value either initially set on the input, or provided by calling
+	 * set_default().
+	 *
+	 * @var mixed
+	 */
+	protected $_default;
+
+	/**
+	 * Strategy used for displaying this field.
+	 * Child classes must use _get_display_strategy to access it.
+	 *
+	 * @var EE_Display_Strategy_Base
+	 */
+	private $_display_strategy;
+
+	/**
+	 * Gets all the validation strategies used on this field
+	 *
+	 * @var EE_Validation_Strategy_Base[]
+	 */
+	private $_validation_strategies = [];
+
+	/**
+	 * The normalization strategy for this field
+	 *
+	 * @var EE_Normalization_Strategy_Base
+	 */
+	private $_normalization_strategy;
+
+	/**
+	 * Strategy for removing sensitive data after we're done with the form input
+	 *
+	 * @var EE_Sensitive_Data_Removal_Base
+	 */
+	protected $_sensitive_data_removal_strategy;
+
+	/**
+	 * Whether this input has been disabled or not.
+	 * If it's disabled while rendering, an extra hidden input is added that indicates it has been knowingly disabled.
+	 * (Client-side code that wants to dynamically disable it must also add this hidden input).
+	 * When the form is submitted, if the input is disabled in the PHP form section, then input is ignored.
+	 * If the input is missing from the request data but the hidden input indicating the input is disabled, then the
+	 * input is again ignored.
+	 *
+	 * @var boolean
+	 */
+	protected $disabled = false;
+
+	protected array $_data_attributes = [];
+
+	protected bool $_no_label = false; // if true, then no html label will be displayed for this input
+
+	/**
+	 * adds a class to the input's container
+	 *
+	 * @var string
+	 */
+	protected string $_layout_container_class = '';
+
+	/**
+	 * additional HTML to inject into the input's container
+	 *
+	 * @var string
+	 */
+	protected string $_extra_container_html = '';
+
+
+	/**
+	 * @param array                         $input_args       {
+	 * @type string                         $html_name        the html name for the input
+	 * @type string                         $html_label_id    the id attribute to give to the html label tag
+	 * @type string                         $html_label_class the class attribute to give to the html label tag
+	 * @type string                         $html_label_style the style attribute to give ot teh label tag
+	 * @type string                         $html_label_text  the text to put in the label tag
+	 * @type string                         $html_label       the full html label. If used,
+	 *                                                        all other html_label_* args are invalid
+	 * @type string                         $html_help_text   text to put in help element
+	 * @type string                         $html_help_style  style attribute to give to teh help element
+	 * @type string                         $html_help_class  class attribute to give to the help element
+	 * @type string                         $default          default value NORMALIZED (eg, if providing the default
+	 *                                                        for a Yes_No_Input, you should provide TRUE or FALSE, not
+	 *                                                        '1' or '0')
+	 * @type EE_Display_Strategy_Base       $display          strategy
+	 * @type EE_Normalization_Strategy_Base $normalization_strategy
+	 * @type EE_Validation_Strategy_Base[]  $validation_strategies
+	 * @type boolean                        $ignore_input     special argument which can be used to avoid adding any
+	 *                                                        validation strategies, and sets the normalization
+	 *                                                        strategy to the Null normalization. This is good when you
+	 *                                                        want the input to be totally ignored server-side (like
+	 *                                                        when using React.js form inputs)
+	 *                                                        }
+	 */
+	public function __construct($input_args = [])
+	{
+		$input_args = (array) apply_filters('FHEE__EE_Form_Input_Base___construct__input_args', $input_args, $this);
+		// the following properties must be cast as arrays
+		if (isset($input_args['validation_strategies'])) {
+			foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
+				if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
+					$this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
+				}
+			}
+			unset($input_args['validation_strategies']);
+		}
+		if (isset($input_args['ignore_input'])) {
+			$this->_validation_strategies = [];
+		}
+		// loop thru incoming options
+		foreach ($input_args as $key => $value) {
+			if ($key === 'disabled') {
+				$this->disable($value);
+				continue;
+			}
+			$setter = 'set_' . $key;
+			if (method_exists($this, $setter)) {
+				$this->$setter($value);
+				unset($input_args[ $key ]);
+				continue;
+			}
+			// add underscore to $key to match property names
+			$_key = "_$key";
+			if (property_exists($this, $_key)) {
+				$this->{$_key} = $value;
+				unset($input_args[ $key ]);
+			}
+		}
+		// ensure that "required" is set correctly
+		$this->set_required(
+			$this->_required,
+			$input_args['required_validation_error_message'] ?? null
+		);
+		// $this->_html_name_specified = isset( $input_args['html_name'] ) ? TRUE : FALSE;
+		$this->_display_strategy->_construct_finalize($this);
+		foreach ($this->_validation_strategies as $validation_strategy) {
+			$validation_strategy->_construct_finalize($this);
+		}
+		if (isset($input_args['ignore_input'])) {
+			$this->_normalization_strategy = new EE_Null_Normalization();
+		}
+		if (! $this->_normalization_strategy) {
+			$this->_normalization_strategy = new EE_Text_Normalization();
+		}
+		$this->_normalization_strategy->_construct_finalize($this);
+		// at least we can use the normalization strategy to populate the default
+		if (isset($input_args['default'])) {
+			$this->set_default($input_args['default']);
+			unset($input_args['default']);
+		}
+		if (! $this->_sensitive_data_removal_strategy) {
+			$this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
+		}
+		$this->_sensitive_data_removal_strategy->_construct_finalize($this);
+		parent::__construct($input_args);
+	}
+
+
+	/**
+	 * Sets the html_name to its default value, if none was specified in teh constructor.
+	 * Calculation involves using the name and the parent's html_name
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _set_default_html_name_if_empty()
+	{
+		if (! $this->_html_name) {
+			$this->_html_name = $this->name();
+			if ($this->_parent_section instanceof EE_Form_Section_Proper) {
+				$this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
+			}
+		}
+	}
+
+
+	/**
+	 * @param $parent_form_section
+	 * @param $name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize($parent_form_section, $name)
+	{
+		parent::_construct_finalize($parent_form_section, $name);
+		if ($this->_html_label === null && $this->_html_label_text === null && ! $this->_no_label) {
+			$this->_html_label_text = ucwords(str_replace("_", " ", $name));
+		}
+		do_action('AHEE__EE_Form_Input_Base___construct_finalize__end', $this, $parent_form_section, $name);
+	}
+
+
+	/**
+	 * Returns the strategy for displaying this form input. If none is set, throws an exception.
+	 *
+	 * @return EE_Display_Strategy_Base
+	 * @throws EE_Error
+	 */
+	protected function _get_display_strategy()
+	{
+		$this->ensure_construct_finalized_called();
+		if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Cannot get display strategy for form input with name %s and id %s, because it has not been set in the constructor",
+						"event_espresso"
+					),
+					$this->html_name(),
+					$this->html_id()
+				)
+			);
+		} else {
+			return $this->_display_strategy;
+		}
+	}
+
+
+	/**
+	 * Sets the display strategy.
+	 *
+	 * @param EE_Display_Strategy_Base $strategy
+	 */
+	protected function _set_display_strategy(EE_Display_Strategy_Base $strategy)
+	{
+		$this->_display_strategy = $strategy;
+	}
+
+
+	/**
+	 * Sets the sanitization strategy
+	 *
+	 * @param EE_Normalization_Strategy_Base $strategy
+	 */
+	protected function _set_normalization_strategy(EE_Normalization_Strategy_Base $strategy)
+	{
+		$this->_normalization_strategy = $strategy;
+	}
+
+
+	/**
+	 * Gets sensitive_data_removal_strategy
+	 *
+	 * @return EE_Sensitive_Data_Removal_Base
+	 */
+	public function get_sensitive_data_removal_strategy()
+	{
+		return $this->_sensitive_data_removal_strategy;
+	}
+
+
+	/**
+	 * Sets sensitive_data_removal_strategy
+	 *
+	 * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy
+	 * @return void
+	 */
+	public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy)
+	{
+		$this->_sensitive_data_removal_strategy = $sensitive_data_removal_strategy;
+	}
+
+
+	/**
+	 * Gets the display strategy for this input
+	 *
+	 * @return EE_Display_Strategy_Base
+	 */
+	public function get_display_strategy()
+	{
+		return $this->_display_strategy;
+	}
+
+
+	/**
+	 * Overwrites the display strategy
+	 *
+	 * @param EE_Display_Strategy_Base $display_strategy
+	 */
+	public function set_display_strategy($display_strategy)
+	{
+		$this->_display_strategy = $display_strategy;
+		$this->_display_strategy->_construct_finalize($this);
+	}
+
+
+	/**
+	 * Gets the normalization strategy set on this input
+	 *
+	 * @return EE_Normalization_Strategy_Base
+	 */
+	public function get_normalization_strategy()
+	{
+		return $this->_normalization_strategy;
+	}
+
+
+	/**
+	 * Overwrites the normalization strategy
+	 *
+	 * @param EE_Normalization_Strategy_Base $normalization_strategy
+	 */
+	public function set_normalization_strategy($normalization_strategy)
+	{
+		$this->_normalization_strategy = $normalization_strategy;
+		$this->_normalization_strategy->_construct_finalize($this);
+	}
+
+
+	/**
+	 * Returns all teh validation strategies which apply to this field, numerically indexed
+	 *
+	 * @return EE_Validation_Strategy_Base[]
+	 */
+	public function get_validation_strategies()
+	{
+		return $this->_validation_strategies;
+	}
+
+
+	/**
+	 * Adds this strategy to the field so it will be used in both JS validation and server-side validation
+	 *
+	 * @param EE_Validation_Strategy_Base $validation_strategy
+	 * @return void
+	 */
+	protected function _add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
+	{
+		$validation_strategy->_construct_finalize($this);
+		$this->_validation_strategies[] = $validation_strategy;
+	}
+
+
+	/**
+	 * Adds a new validation strategy onto the form input
+	 *
+	 * @param EE_Validation_Strategy_Base $validation_strategy
+	 * @return void
+	 */
+	public function add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
+	{
+		$this->_add_validation_strategy($validation_strategy);
+	}
+
+
+	/**
+	 * The classname of the validation strategy to remove
+	 *
+	 * @param string $validation_strategy_classname
+	 */
+	public function remove_validation_strategy($validation_strategy_classname)
+	{
+		foreach ($this->_validation_strategies as $key => $validation_strategy) {
+			if (
+				$validation_strategy instanceof $validation_strategy_classname
+				|| is_subclass_of($validation_strategy, $validation_strategy_classname)
+			) {
+				unset($this->_validation_strategies[ $key ]);
+			}
+		}
+	}
+
+
+	public function removeAllValidationStrategies()
+	{
+		$this->_validation_strategies = [];
+	}
+
+
+	/**
+	 * returns true if input employs any of the validation strategy defined by the supplied array of classnames
+	 *
+	 * @param array $validation_strategy_classnames
+	 * @return bool
+	 */
+	public function has_validation_strategy($validation_strategy_classnames)
+	{
+		$validation_strategy_classnames = is_array($validation_strategy_classnames)
+			? $validation_strategy_classnames
+			: [$validation_strategy_classnames];
+		foreach ($this->_validation_strategies as $key => $validation_strategy) {
+			if (in_array($key, $validation_strategy_classnames)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets the HTML
+	 *
+	 * @return string
+	 */
+	public function get_html()
+	{
+		return $this->_parent_section->get_html_for_input($this);
+	}
+
+
+	/**
+	 * Gets the HTML for the input itself (no label or errors) according to the
+	 * input's display strategy
+	 * Makes sure the JS and CSS are enqueued for it
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_html_for_input()
+	{
+		return $this->_form_html_filter
+			? $this->_form_html_filter->filterHtml(
+				$this->_get_display_strategy()->display(),
+				$this
+			)
+			: $this->_get_display_strategy()->display();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_other_attributes()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use. You should replace it by %s',
+					'event_espresso'
+				),
+				'EE_Form_Section_Base::other_html_attributes()'
+			),
+			'4.10.2.p'
+		);
+
+		return $this->other_html_attributes();
+	}
+
+
+	/**
+	 * @param string $html_other_attributes
+	 */
+	public function set_html_other_attributes($html_other_attributes)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use. You should replace it by %s',
+					'event_espresso'
+				),
+				'EE_Form_Section_Base::set_other_html_attributes()'
+			),
+			'4.10.2.p'
+		);
+
+		$this->set_other_html_attributes($html_other_attributes);
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the label for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_html_for_label()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_label($this);
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the errors section for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_html_for_errors()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_errors($this);
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the help text for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_html_for_help()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_help_text($this);
+	}
+
+
+	/**
+	 * Validates the input's sanitized value (assumes _sanitize() has already been called)
+	 * and returns whether or not the form input's submitted value is value
+	 *
+	 * @return boolean
+	 */
+	protected function _validate()
+	{
+		if ($this->isDisabled()) {
+			return true;
+		}
+		foreach ($this->_validation_strategies as $validation_strategy) {
+			if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
+				try {
+					$validation_strategy->validate($this->normalized_value());
+				} catch (EE_Validation_Error $e) {
+					$this->add_validation_error($e);
+				}
+			}
+		}
+		if ($this->get_validation_errors()) {
+			return false;
+		} else {
+			return true;
+		}
+	}
+
+
+	/**
+	 * Performs basic sanitization on this value. But what sanitization can be performed anyways?
+	 * This value MIGHT be allowed to have tags, so we can't really remove them.
+	 *
+	 * @param string $value
+	 * @return null|string
+	 */
+	protected function _sanitize($value)
+	{
+		return $value !== null
+			? stripslashes(html_entity_decode(trim((string) $value)))
+			: null;
+	}
+
+
+	/**
+	 * Picks out the form value that relates to this form input,
+	 * and stores it as the sanitized value on the form input, and sets the normalized value.
+	 * Returns whether or not any validation errors occurred
+	 *
+	 * @param array $req_data
+	 * @return boolean whether or not there was an error
+	 * @throws EE_Error
+	 */
+	protected function _normalize($req_data)
+	{
+		// any existing validation errors don't apply so clear them
+		$this->_validation_errors = [];
+		// if the input is disabled, ignore whatever input was sent in
+		if ($this->isDisabled()) {
+			$this->_set_raw_value(null);
+			$this->_set_normalized_value($this->get_default());
+			return false;
+		}
+		try {
+			$raw_input = $this->find_form_data_for_this_section($req_data);
+			// super simple sanitization for now
+			if (is_array($raw_input)) {
+				$raw_value = [];
+				foreach ($raw_input as $key => $value) {
+					$raw_value[ $key ] = $this->_sanitize($value);
+				}
+				$this->_set_raw_value($raw_value);
+			} else {
+				$this->_set_raw_value($this->_sanitize($raw_input));
+			}
+			// we want to mostly leave the input alone in case we need to re-display it to the user
+			$this->_set_normalized_value($this->_normalization_strategy->normalize($this->raw_value()));
+			return false;
+		} catch (EE_Validation_Error $e) {
+			$this->add_validation_error($e);
+			return true;
+		}
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_name()
+	{
+		$this->_set_default_html_name_if_empty();
+		return $this->_html_name ?? '';
+	}
+
+
+	/**
+	 * @param string $html_label_id
+	 */
+	public function set_html_label_id(string $html_label_id)
+	{
+		// if the html_label_id doesn't end in -lbl, then add it
+		if (strpos($html_label_id, '-lbl') !== (strlen($html_label_id) - 4)) {
+			$html_label_id .= '-lbl';
+		}
+		$this->_html_label_id = $html_label_id;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_label_id()
+	{
+		if (empty($this->_html_label_id)) {
+			$this->set_html_label_id($this->html_id());
+		}
+		return $this->_html_label_id;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_class()
+	{
+		return $this->_html_label_class ?? '';
+	}
+
+
+	/**
+	 * @param string $html_class
+	 */
+	public function add_html_label_class(string $html_class)
+	{
+		$this->_html_label_class .= ' ' . trim($html_class);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_style()
+	{
+		return $this->_html_label_style ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_text()
+	{
+		return $this->_html_label_text ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_text()
+	{
+		return $this->_html_help_text ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_class()
+	{
+		return $this->_html_help_class ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_style()
+	{
+		return $this->_html_style ?? '';
+	}
+
+
+	/**
+	 * returns the raw, UNSAFE, input, almost exactly as the user submitted it.
+	 * Please note that almost all client code should instead use the normalized_value;
+	 * or possibly raw_value_in_form (which prepares the string for displaying in an HTML attribute on a tag,
+	 * mostly by escaping quotes)
+	 * Note, we do not store the exact original value sent in the user's request because
+	 * it may have malicious content, and we MIGHT want to store the form input in a transient or something...
+	 * in which case, we would have stored the malicious content to our database.
+	 *
+	 * @return mixed
+	 */
+	public function raw_value()
+	{
+		return $this->_raw_value;
+	}
+
+
+	/**
+	 * Returns a string safe to usage in form inputs when displaying, because
+	 * it escapes all html entities
+	 *
+	 * @return string
+	 */
+	public function raw_value_in_form(): string
+	{
+		return htmlentities((string) $this->raw_value(), ENT_QUOTES, 'UTF-8');
+	}
+
+
+	/**
+	 * returns the value after it's been sanitized, and then converted into it's proper type
+	 * in PHP. Eg, a string, an int, an array,
+	 *
+	 * @return mixed
+	 */
+	public function normalized_value()
+	{
+		return $this->_normalized_value;
+	}
+
+
+	/**
+	 * Returns the normalized value is a presentable way. By default this is just
+	 * the normalized value by itself, but it can be overridden for when that's not
+	 * the best thing to display
+	 *
+	 * @return mixed
+	 */
+	public function pretty_value()
+	{
+		return $this->_normalized_value;
+	}
+
+
+	/**
+	 * When generating the JS for the jquery validation rules like<br>
+	 * <code>$( "#myform" ).validate({
+	 * rules: {
+	 * password: "required",
+	 * password_again: {
+	 * equalTo: "#password"
+	 * }
+	 * }
+	 * });</code>
+	 * if this field had the name 'password_again', it should return
+	 * <br><code>password_again: {
+	 * equalTo: "#password"
+	 * }</code>
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_jquery_validation_rules(): array
+	{
+		$jquery_validation_js    = [];
+		$jquery_validation_rules = [];
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$jquery_validation_rules = array_replace_recursive(
+				$jquery_validation_rules,
+				$validation_strategy->get_jquery_validation_rule_array()
+			);
+		}
+		if (! empty($jquery_validation_rules)) {
+			foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
+				$jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
+			}
+		}
+		return $jquery_validation_js;
+	}
+
+
+	/**
+	 * Sets the input's default value for use in displaying in the form. Note: value should be
+	 * normalized (Eg, if providing a default of ra Yes_NO_Input you would provide TRUE or FALSE, not '1' or '0')
+	 *
+	 * @param mixed $value
+	 * @return void
+	 */
+	public function set_default($value)
+	{
+		$this->_default = $value;
+		$this->_set_normalized_value($value);
+		$this->_set_raw_value($value);
+	}
+
+
+	/**
+	 * Sets the normalized value on this input
+	 *
+	 * @param mixed $value
+	 */
+	protected function _set_normalized_value($value)
+	{
+		$this->_normalized_value = $value;
+	}
+
+
+	/**
+	 * Sets the raw value on this input (ie, exactly as the user submitted it)
+	 *
+	 * @param mixed $value
+	 */
+	protected function _set_raw_value($value)
+	{
+		$this->_raw_value = $this->_normalization_strategy->unnormalize($value);
+	}
+
+
+	/**
+	 * Sets the HTML label text after it has already been defined
+	 *
+	 * @param string $label
+	 * @return void
+	 */
+	public function set_html_label_text($label)
+	{
+		$this->_html_label_text = $label;
+	}
+
+
+	/**
+	 * Sets whether or not this field is required, and adjusts the validation strategy.
+	 * If you want to use the EE_Conditionally_Required_Validation_Strategy,
+	 * please add it as a validation strategy using add_validation_strategy as normal
+	 *
+	 * @param boolean $required boolean
+	 * @param null    $required_text
+	 */
+	public function set_required($required = true, $required_text = null)
+	{
+		$required = filter_var($required, FILTER_VALIDATE_BOOLEAN);
+		// whether $required is a string or a boolean, we want to add a required validation strategy
+		if ($required) {
+			$this->_add_validation_strategy(new EE_Required_Validation_Strategy($required_text));
+		} else {
+			$this->remove_validation_strategy('EE_Required_Validation_Strategy');
+		}
+		$this->_required = $required;
+	}
+
+
+	/**
+	 * Returns whether or not this field is required
+	 *
+	 * @return boolean
+	 */
+	public function required()
+	{
+		return $this->_required;
+	}
+
+
+	/**
+	 * @param string $required_css_class
+	 */
+	public function set_required_css_class($required_css_class)
+	{
+		$this->_required_css_class = $required_css_class;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function required_css_class()
+	{
+		return $this->_required_css_class;
+	}
+
+
+	/**
+	 * @param bool $add_required
+	 * @return string
+	 */
+	public function html_class($add_required = false)
+	{
+		return $add_required && $this->required()
+			? $this->required_css_class() . ' ' . $this->_html_class
+			: $this->_html_class;
+	}
+
+
+	/**
+	 * Sets the help text, in case
+	 *
+	 * @param string $text
+	 */
+	public function set_html_help_text($text)
+	{
+		$this->_html_help_text = $text;
+	}
+
+
+	/**
+	 * Uses the sensitive data removal strategy to remove the sensitive data from this
+	 * input. If there is any kind of sensitive data removal on this input, we clear
+	 * out the raw value completely
+	 *
+	 * @return void
+	 */
+	public function clean_sensitive_data()
+	{
+		// if we do ANY kind of sensitive data removal on this, then just clear out the raw value
+		// if we need more logic than this we'll make a strategy for it
+		if (
+			$this->_sensitive_data_removal_strategy
+			&& ! $this->_sensitive_data_removal_strategy instanceof EE_No_Sensitive_Data_Removal
+		) {
+			$this->_set_raw_value(null);
+		}
+		// and clean the normalized value according to the appropriate strategy
+		$this->_set_normalized_value(
+			$this->get_sensitive_data_removal_strategy()->remove_sensitive_data(
+				$this->_normalized_value
+			)
+		);
+	}
+
+
+	/**
+	 * @param bool   $primary
+	 * @param string $button_size
+	 * @param string $other_attributes
+	 */
+	public function set_button_css_attributes($primary = true, $button_size = '', $other_attributes = '')
+	{
+		$button_css_attributes = 'button';
+		$button_css_attributes .= $primary === true
+			? ' button--primary'
+			: ' button--secondary';
+		switch ($button_size) {
+			case 'xs':
+			case 'extra-small':
+				$button_css_attributes .= ' button-xs';
+				break;
+			case 'sm':
+			case 'small':
+				$button_css_attributes .= ' button-sm';
+				break;
+			case 'lg':
+			case 'large':
+				$button_css_attributes .= ' button-lg';
+				break;
+			case 'block':
+				$button_css_attributes .= ' button-block';
+				break;
+			case 'md':
+			case 'medium':
+			default:
+				$button_css_attributes .= '';
+		}
+		$this->_button_css_attributes .= ! empty($other_attributes)
+			? $button_css_attributes . ' ' . $other_attributes
+			: $button_css_attributes;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function button_css_attributes()
+	{
+		if (empty($this->_button_css_attributes)) {
+			$this->set_button_css_attributes();
+		}
+		return $this->_button_css_attributes;
+	}
+
+
+	/**
+	 * find_form_data_for_this_section
+	 * using this section's name and its parents, finds the value of the form data that corresponds to it.
+	 * For example, if this form section's HTML name is my_form[subform][form_input_1],
+	 * then it's value should be in request at request['my_form']['subform']['form_input_1'].
+	 * (If that doesn't exist, we also check for this subsection's name
+	 * at the TOP LEVEL of the request data. Eg request['form_input_1'].)
+	 * This function finds its value in the form.
+	 *
+	 * @param array $req_data
+	 * @return mixed whatever the raw value of this form section is in the request data
+	 * @throws EE_Error
+	 */
+	public function find_form_data_for_this_section($req_data)
+	{
+		$name_parts = $this->getInputNameParts();
+		// now get the value for the input
+		$value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
+		// check if this thing's name is at the TOP level of the request data
+		if ($value === null && isset($req_data[ $this->name() ])) {
+			$value = $req_data[ $this->name() ];
+		}
+		return $value;
+	}
+
+
+	/**
+	 * If this input's name is something like "foo[bar][baz]"
+	 * returns an array like `array('foo','bar',baz')`
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function getInputNameParts()
+	{
+		// break up the html name by "[]"
+		if (strpos($this->html_name(), '[') !== false) {
+			$before_any_brackets = substr($this->html_name(), 0, strpos($this->html_name(), '['));
+		} else {
+			$before_any_brackets = $this->html_name();
+		}
+		// grab all of the segments
+		preg_match_all('~\[([^]]*)\]~', $this->html_name(), $matches);
+		if (isset($matches[1]) && is_array($matches[1])) {
+			$name_parts = $matches[1];
+			array_unshift($name_parts, $before_any_brackets);
+		} else {
+			$name_parts = [$before_any_brackets];
+		}
+		return $name_parts;
+	}
+
+
+	/**
+	 * @param array $html_name_parts
+	 * @param array $req_data
+	 * @return array | NULL
+	 */
+	public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
+	{
+		$first_part_to_consider = array_shift($html_name_parts);
+		if (isset($req_data[ $first_part_to_consider ])) {
+			if (empty($html_name_parts)) {
+				return $req_data[ $first_part_to_consider ];
+			} else {
+				return $this->findRequestForSectionUsingNameParts(
+					$html_name_parts,
+					$req_data[ $first_part_to_consider ]
+				);
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Checks if this form input's data is in the request data
+	 *
+	 * @param array $req_data
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function form_data_present_in($req_data = null)
+	{
+		if ($req_data === null) {
+			/** @var RequestInterface $request */
+			$request  = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$req_data = $request->postParams();
+		}
+
+		return $this->find_form_data_for_this_section($req_data) !== null;
+	}
+
+
+	/**
+	 * Overrides parent to add js data from validation and display strategies
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data($form_other_js_data = [])
+	{
+		return $this->get_other_js_data_from_strategies($form_other_js_data);
+	}
+
+
+	/**
+	 * Gets other JS data for localization from this input's strategies, like
+	 * the validation strategies and the display strategy
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data_from_strategies($form_other_js_data = [])
+	{
+		$form_other_js_data = $this->get_display_strategy()->get_other_js_data($form_other_js_data);
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$form_other_js_data = $validation_strategy->get_other_js_data($form_other_js_data);
+		}
+		return $form_other_js_data;
+	}
+
+
+	/**
+	 * Override parent because we want to give our strategies an opportunity to enqueue some js and css
+	 *
+	 * @return void
+	 */
+	public function enqueue_js()
+	{
+		// ask our display strategy and validation strategies if they have js to enqueue
+		$this->enqueue_js_from_strategies();
+	}
+
+
+	/**
+	 * Tells strategies when its ok to enqueue their js and css
+	 *
+	 * @return void
+	 */
+	public function enqueue_js_from_strategies()
+	{
+		$this->get_display_strategy()->enqueue_js();
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$validation_strategy->enqueue_js();
+		}
+	}
+
+
+	/**
+	 * Gets the default value set on the input (not the current value, which may have been
+	 * changed because of a form submission). If no default was set, this us null.
+	 *
+	 * @return mixed
+	 */
+	public function get_default()
+	{
+		return $this->_default;
+	}
+
+
+	/**
+	 * Makes this input disabled. That means it will have the HTML attribute 'disabled="disabled"',
+	 * and server-side if any input was received it will be ignored
+	 */
+	public function disable($disable = true)
+	{
+		$disabled_attribute = ' disabled="disabled"';
+		$this->disabled     = filter_var($disable, FILTER_VALIDATE_BOOLEAN);
+		if ($this->disabled) {
+			if (strpos($this->_other_html_attributes, $disabled_attribute) === false) {
+				$this->_other_html_attributes .= $disabled_attribute;
+			}
+			$this->_set_normalized_value($this->get_default());
+		} else {
+			$this->_other_html_attributes = str_replace($disabled_attribute, '', $this->_other_html_attributes);
+		}
+	}
+
+
+	/**
+	 * Returns whether this input is currently disabled.
+	 *
+	 * @return bool
+	 */
+	public function isDisabled(): bool
+	{
+		return $this->disabled;
+	}
+
+
+	public function dataAttributes(): array
+	{
+		return $this->_data_attributes;
+	}
+
+
+	public function layoutContainerClass(): string
+	{
+		return $this->_layout_container_class;
+	}
+
+
+	public function extraContainerHtml(): string
+	{
+		return $this->_extra_container_html;
+	}
+
+
+	public function hasLabel(): bool
+	{
+		return ! $this->_no_label
+			&& $this->html_label_text()
+			&& ! $this->get_display_strategy() instanceof EE_Hidden_Display_Strategy;
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -219,7 +219,7 @@ 
         if (isset($input_args['validation_strategies'])) {
             foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
                 if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
-                    $this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
+                    $this->_validation_strategies[get_class($validation_strategy)] = $validation_strategy;
                 }
             }
             unset($input_args['validation_strategies']);
@@ -233,17 +233,17 @@ 
                 $this->disable($value);
                 continue;
             }
-            $setter = 'set_' . $key;
+            $setter = 'set_'.$key;
             if (method_exists($this, $setter)) {
                 $this->$setter($value);
-                unset($input_args[ $key ]);
+                unset($input_args[$key]);
                 continue;
             }
             // add underscore to $key to match property names
             $_key = "_$key";
             if (property_exists($this, $_key)) {
                 $this->{$_key} = $value;
-                unset($input_args[ $key ]);
+                unset($input_args[$key]);
             }
         }
         // ensure that "required" is set correctly
@@ -259,7 +259,7 @@ 
         if (isset($input_args['ignore_input'])) {
             $this->_normalization_strategy = new EE_Null_Normalization();
         }
-        if (! $this->_normalization_strategy) {
+        if ( ! $this->_normalization_strategy) {
             $this->_normalization_strategy = new EE_Text_Normalization();
         }
         $this->_normalization_strategy->_construct_finalize($this);
@@ -268,7 +268,7 @@ 
             $this->set_default($input_args['default']);
             unset($input_args['default']);
         }
-        if (! $this->_sensitive_data_removal_strategy) {
+        if ( ! $this->_sensitive_data_removal_strategy) {
             $this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
         }
         $this->_sensitive_data_removal_strategy->_construct_finalize($this);
@@ -284,10 +284,10 @@ 
      */
     protected function _set_default_html_name_if_empty()
     {
-        if (! $this->_html_name) {
+        if ( ! $this->_html_name) {
             $this->_html_name = $this->name();
             if ($this->_parent_section instanceof EE_Form_Section_Proper) {
-                $this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
+                $this->_html_name = $this->_parent_section->html_name_prefix()."[{$this->name()}]";
             }
         }
     }
@@ -317,7 +317,7 @@ 
     protected function _get_display_strategy()
     {
         $this->ensure_construct_finalized_called();
-        if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
+        if ( ! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -473,7 +473,7 @@ 
                 $validation_strategy instanceof $validation_strategy_classname
                 || is_subclass_of($validation_strategy, $validation_strategy_classname)
             ) {
-                unset($this->_validation_strategies[ $key ]);
+                unset($this->_validation_strategies[$key]);
             }
         }
     }
@@ -684,7 +684,7 @@ 
             if (is_array($raw_input)) {
                 $raw_value = [];
                 foreach ($raw_input as $key => $value) {
-                    $raw_value[ $key ] = $this->_sanitize($value);
+                    $raw_value[$key] = $this->_sanitize($value);
                 }
                 $this->_set_raw_value($raw_value);
             } else {
@@ -751,7 +751,7 @@ 
      */
     public function add_html_label_class(string $html_class)
     {
-        $this->_html_label_class .= ' ' . trim($html_class);
+        $this->_html_label_class .= ' '.trim($html_class);
     }
 
 
@@ -882,9 +882,9 @@ 
                 $validation_strategy->get_jquery_validation_rule_array()
             );
         }
-        if (! empty($jquery_validation_rules)) {
+        if ( ! empty($jquery_validation_rules)) {
             foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
-                $jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
+                $jquery_validation_js[$html_id_with_pound_sign] = $jquery_validation_rules;
             }
         }
         return $jquery_validation_js;
@@ -997,7 +997,7 @@ 
     public function html_class($add_required = false)
     {
         return $add_required && $this->required()
-            ? $this->required_css_class() . ' ' . $this->_html_class
+            ? $this->required_css_class().' '.$this->_html_class
             : $this->_html_class;
     }
 
@@ -1072,7 +1072,7 @@ 
                 $button_css_attributes .= '';
         }
         $this->_button_css_attributes .= ! empty($other_attributes)
-            ? $button_css_attributes . ' ' . $other_attributes
+            ? $button_css_attributes.' '.$other_attributes
             : $button_css_attributes;
     }
 
@@ -1108,8 +1108,8 @@ 
         // now get the value for the input
         $value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
         // check if this thing's name is at the TOP level of the request data
-        if ($value === null && isset($req_data[ $this->name() ])) {
-            $value = $req_data[ $this->name() ];
+        if ($value === null && isset($req_data[$this->name()])) {
+            $value = $req_data[$this->name()];
         }
         return $value;
     }
@@ -1150,13 +1150,13 @@ 
     public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
     {
         $first_part_to_consider = array_shift($html_name_parts);
-        if (isset($req_data[ $first_part_to_consider ])) {
+        if (isset($req_data[$first_part_to_consider])) {
             if (empty($html_name_parts)) {
-                return $req_data[ $first_part_to_consider ];
+                return $req_data[$first_part_to_consider];
             } else {
                 return $this->findRequestForSectionUsingNameParts(
                     $html_name_parts,
-                    $req_data[ $first_part_to_consider ]
+                    $req_data[$first_part_to_consider]
                 );
             }
         }

core/helpers/EEH_Template.helper.php

Indentation +957 added lines, -957 removed lines

@@ -9,36 +9,36 @@ 
 use EventEspresso\core\services\request\sanitizers\AllowedTags;
 
 if (! function_exists('espresso_get_template_part')) {
-    /**
-     * espresso_get_template_part
-     * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
-     * so not a very useful function at all except that it adds familiarity PLUS filtering based off of the entire template part name
-     *
-     * @param string $slug The slug name for the generic template.
-     * @param string $name The name of the specialised template.
-     */
-    function espresso_get_template_part($slug = '', $name = '')
-    {
-        EEH_Template::get_template_part($slug, $name);
-    }
+	/**
+	 * espresso_get_template_part
+	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
+	 * so not a very useful function at all except that it adds familiarity PLUS filtering based off of the entire template part name
+	 *
+	 * @param string $slug The slug name for the generic template.
+	 * @param string $name The name of the specialised template.
+	 */
+	function espresso_get_template_part($slug = '', $name = '')
+	{
+		EEH_Template::get_template_part($slug, $name);
+	}
 }
 
 
 if (! function_exists('espresso_get_object_css_class')) {
-    /**
-     * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
-     *
-     * @param EE_Base_Class $object the EE object the css class is being generated for
-     * @param string        $prefix added to the beginning of the generated class
-     * @param string        $suffix added to the end of the generated class
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    function espresso_get_object_css_class($object = null, $prefix = '', $suffix = '')
-    {
-        return EEH_Template::get_object_css_class($object, $prefix, $suffix);
-    }
+	/**
+	 * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
+	 *
+	 * @param EE_Base_Class $object the EE object the css class is being generated for
+	 * @param string        $prefix added to the beginning of the generated class
+	 * @param string        $suffix added to the end of the generated class
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	function espresso_get_object_css_class($object = null, $prefix = '', $suffix = '')
+	{
+		return EEH_Template::get_object_css_class($object, $prefix, $suffix);
+	}
 }
 
 
@@ -52,665 +52,665 @@ 
  */
 class EEH_Template
 {
-    private static array $_espresso_themes = [];
-
-
-    /**
-     *    is_espresso_theme - returns TRUE or FALSE on whether the currently active WP theme is an espresso theme
-     *
-     * @return boolean
-     */
-    public static function is_espresso_theme()
-    {
-        return wp_get_theme()->get('TextDomain') === 'event_espresso';
-    }
-
-
-    /**
-     *    load_espresso_theme_functions - if current theme is an espresso theme, or uses ee theme template parts, then
-     *    load its functions.php file ( if not already loaded )
-     *
-     * @return void
-     */
-    public static function load_espresso_theme_functions()
-    {
-        if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
-            if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php')) {
-                require_once(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php');
-            }
-        }
-    }
-
-
-    /**
-     *    get_espresso_themes - returns an array of Espresso Child themes located in the /templates/ directory
-     *
-     * @return array
-     */
-    public static function get_espresso_themes(): array
-    {
-        if (empty(EEH_Template::$_espresso_themes)) {
-            $espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
-            if (empty($espresso_themes)) {
-                return [];
-            }
-            if (($key = array_search('global_assets', $espresso_themes)) !== false) {
-                unset($espresso_themes[ $key ]);
-            }
-            EEH_Template::$_espresso_themes = [];
-            foreach ($espresso_themes as $espresso_theme) {
-                EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
-            }
-        }
-        return EEH_Template::$_espresso_themes;
-    }
-
-
-    /**
-     * EEH_Template::get_template_part
-     * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead,
-     * and doesn't add base versions of files so not a very useful function at all except that it adds familiarity PLUS
-     * filtering based off of the entire template part name
-     *
-     * @param string $slug The slug name for the generic template.
-     * @param string $name The name of the specialised template.
-     * @param array  $template_args
-     * @param bool   $return_string
-     * @return string        the html output for the formatted money value
-     */
-    public static function get_template_part(
-        $slug = '',
-        $name = '',
-        $template_args = [],
-        $return_string = false
-    ) {
-        do_action("get_template_part_$slug-$name", $slug, $name);
-        $template = $slug;
-        $name      = (string) $name;
-        if ($name != '') {
-            $template .= "-$name";
-        }
-        $template .= ".php";
-        // allow template parts to be turned off via something like:
-        // add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
-        if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_$name", true)) {
-            return EEH_Template::locate_template($template, $template_args, true, $return_string);
-        }
-        return '';
-    }
-
-
-    /**
-     *    locate_template
-     *    locate a template file by looking in the following places, in the following order:
-     *        <server path up to>/wp-content/themes/<current active WordPress theme>/
-     *        <assumed full absolute server path>
-     *        <server path up to>/wp-content/uploads/espresso/templates/<current EE theme>/
-     *        <server path up to>/wp-content/uploads/espresso/templates/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/public/<current EE theme>/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/core/templates/<current EE theme>/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/
-     *    as soon as the template is found in one of these locations, it will be returned or loaded
-     *        Example:
-     *          You are using the WordPress Twenty Sixteen theme,
-     *        and you want to customize the "some-event.template.php" template,
-     *          which is located in the "/relative/path/to/" folder relative to the main EE plugin folder.
-     *          Assuming WP is installed on your server in the "/home/public_html/" folder,
-     *        EEH_Template::locate_template() will look at the following paths in order until the template is found:
-     *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
-     *        /relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/uploads/espresso/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/uploads/espresso/templates/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/public/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/core/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/relative/path/to/some-event.template.php
-     *          Had you passed an absolute path to your template that was in some other location,
-     *        ie: "/absolute/path/to/some-event.template.php"
-     *          then the search would have been :
-     *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
-     *        /absolute/path/to/some-event.template.php
-     *          and stopped there upon finding it in the second location
-     *
-     * @param array|string $templates       array of template file names including extension (or just a single string)
-     * @param array        $template_args   an array of arguments to be extracted for use in the template
-     * @param boolean      $load            whether to pass the located template path on to the
-     *                                      EEH_Template::display_template() method or simply return it
-     * @param boolean      $return_string   whether to send output immediately to screen, or capture and return as a
-     *                                      string
-     * @param boolean      $check_if_custom If TRUE, this flags this method to return boolean for whether this will
-     *                                      generate a custom template or not. Used in places where you don't actually
-     *                                      load the template, you just want to know if there's a custom version of it.
-     * @return string|true
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function locate_template(
-        $templates = [],
-        array $template_args = [],
-        bool $load = true,
-        bool $return_string = true,
-        bool $check_if_custom = false
-    ) {
-        $cache_id      = TemplateCache::generateCacheID(__FUNCTION__, func_get_args());
-        $template_path = TemplateCache::get($cache_id);
-        $template_path = $template_path ?: self::resolveTemplatePath($cache_id, (array) $templates, $check_if_custom);
-
-        if ($check_if_custom && ! empty($template_path)) {
-            return true;
-        }
-
-        // if we got it and you want to see it...
-        if ($template_path && $load && ! $check_if_custom) {
-            if ($return_string) {
-                return EEH_Template::display_template($template_path, $template_args, true);
-            }
-            EEH_Template::display_template($template_path, $template_args);
-        }
-        return $check_if_custom && ! empty($template_path) ? true : $template_path;
-    }
-
-
-    /**
-     * Resolves the path of a template by checking various possible locations.
-     *
-     * This method checks for the existence of a template in several locations,
-     * including the current theme folder, the uploads directory, and the plugin's own template directory.
-     * It uses the provided cache ID to store and retrieve the resolved path from a cache for performance.
-     * If the template is not found in any of the checked locations, an empty string is returned.
-     *
-     * @param string $cache_id        The ID used for caching the resolved path.
-     * @param array  $templates       An array of template file names to search for.
-     * @param bool $check_if_custom   If true, the method will only check if a custom template exists
-     *                                and won't include core plugin folders.
-     * @return string The resolved template path, or an empty string if the template was not found.
-     * @since 5.0.21.p
-     */
-    private static function resolveTemplatePath(string $cache_id, array $templates, bool $check_if_custom): string
-    {
-        // first use WP locate_template to check for template in the current theme folder
-        $template_path = $templates ? locate_template($templates) : '';
-        // not in the theme
-        if (empty($template_path)) {
-            // not even a template to look for ?
-            if (empty($templates)) {
-                $loader = LoaderFactory::getLoader();
-                /** @var RequestInterface $request */
-                $request = $loader->getShared(RequestInterface::class);
-                // get post_type
-                $post_type = $request->getRequestParam('post_type');
-                /** @var CustomPostTypeDefinitions $custom_post_types */
-                $custom_post_types = $loader->getShared(CustomPostTypeDefinitions::class);
-                // get array of EE Custom Post Types
-                $EE_CPTs = $custom_post_types->getDefinitions();
-                // build template name based on request
-                if (isset($EE_CPTs[ $post_type ])) {
-                    $archive_or_single = is_archive() ? 'archive' : '';
-                    $archive_or_single = is_single() ? 'single' : $archive_or_single;
-                    $templates[]       = $archive_or_single . '-' . $post_type . '.php';
-                }
-            }
-            // currently active EE template theme
-            $current_theme = EE_Config::get_current_theme();
-            // array of paths to folders that may contain templates
-            $template_folder_paths = [];
-
-            // add core plugin folders for checking only if we're not $check_if_custom
-            if (! $check_if_custom) {
-                $core_paths            = [
-                    // in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-                    EE_PUBLIC . $current_theme,
-                    // in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-                    EE_TEMPLATES . $current_theme,
-                    // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
-                    EE_PLUGIN_DIR_PATH,
-                ];
-                $template_folder_paths = array_merge($template_folder_paths, $core_paths);
-            }
-
-            // now filter that array
-            $template_folder_paths = (array) apply_filters(
-                'FHEE__EEH_Template__locate_template__template_folder_paths',
-                $template_folder_paths
-            );
-
-            // array to hold all possible template paths
-            $full_template_paths = [];
-            $file_name           = '';
-
-            // loop through $templates
-            foreach ($templates as $template) {
-                // normalize directory separators
-                $template                      = EEH_File::standardise_directory_separators($template);
-                $file_name                     = basename($template);
-                $template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
-                // while looping through all template folder paths
-                foreach ($template_folder_paths as $template_folder_path) {
-                    // normalize directory separators
-                    $template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
-                    // determine if any common base path exists between the two paths
-                    $common_base_path = EEH_Template::_find_common_base_path(
-                        [$template_folder_path, $template_path_minus_file_name]
-                    );
-                    if ($common_base_path !== '') {
-                        // both paths have a common base, so just tack the filename onto our search path
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
-                    } else {
-                        // no common base path, so let's just concatenate
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
-                    }
-                    // build up our template locations array by adding our resolved paths
-                    $full_template_paths[] = $resolved_path;
-                }
-                // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
-                array_unshift($full_template_paths, $template);
-                // path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-                array_unshift($full_template_paths, get_stylesheet_directory() . '/' . $file_name);
-            }
-            // filter final array of full template paths
-            $full_template_paths = apply_filters(
-                'FHEE__EEH_Template__locate_template__full_template_paths',
-                $full_template_paths,
-                $file_name
-            );
-            // now loop through our final array of template location paths and check each location
-            foreach ((array) $full_template_paths as $full_template_path) {
-                if (is_readable($full_template_path)) {
-                    $template_path = str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $full_template_path);
-                    TemplateCache::set($cache_id, $template_path);
-                    break;
-                }
-            }
-        }
-
-        // Display a deprecated notice if the template file is located in the WordPress uploads directory
-        if (strpos($template_path, 'wp-content/uploads/espresso') !== false) {
-            EE_Error::doing_it_wrong(
-                __CLASS__,
-                esc_html__(
-                    'The use of the WordPress uploads directory as a location to override template files has been deprecated.',
-                    'event_espresso'
-                ),
-                '5.0.0'
-            );
-        }
-
-        // hook that can be used to display the full template path that will be used
-        do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
-
-        return $template_path;
-    }
-
-
-    /**
-     * _find_common_base_path
-     * given two paths, this determines if there is a common base path between the two
-     *
-     * @param array $paths
-     * @return string
-     */
-    protected static function _find_common_base_path($paths)
-    {
-        $last_offset      = 0;
-        $common_base_path = '';
-        while (($index = strpos($paths[0], '/', $last_offset)) !== false) {
-            $dir_length = $index - $last_offset + 1;
-            $directory  = substr($paths[0], $last_offset, $dir_length);
-            foreach ($paths as $path) {
-                if (substr($path, $last_offset, $dir_length) != $directory) {
-                    return $common_base_path;
-                }
-            }
-            $common_base_path .= $directory;
-            $last_offset      = $index + 1;
-        }
-        return substr($common_base_path, 0, -1);
-    }
-
-
-    /**
-     * load and display a template
-     *
-     * @param bool|string $template_path    server path to the file to be loaded, including file name and extension
-     * @param array       $template_args    an array of arguments to be extracted for use in the template
-     * @param boolean     $return_string    whether to send output immediately to screen, or capture and return as a
-     *                                      string
-     * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
-     *                                      not found or is not readable
-     * @return string
-     * @throws DomainException
-     */
-    public static function display_template(
-        $template_path = '',
-        $template_args = [],
-        $return_string = false,
-        $throw_exceptions = false
-    ) {
-        /**
-         * These two filters are intended for last minute changes to templates being loaded and/or template arg
-         * modifications.  NOTE... modifying these things can cause breakage as most templates running through
-         * the display_template method are templates we DON'T want modified (usually because of js
-         * dependencies etc).  So unless you know what you are doing, do NOT filter templates or template args
-         * using this.
-         *
-         * @since 4.6.0
-         */
-        $template_path = (string) apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
-        $template_args = (array) apply_filters(
-            'FHEE__EEH_Template__display_template__template_args',
-            $template_args,
-            $template_path
-        );
-
-        // you gimme nuttin - YOU GET NUTTIN !!
-        if (! $template_path || ! is_readable($template_path)) {
-            // ignore whether template is accessible ?
-            if ($throw_exceptions) {
-                throw new DomainException(
-                    esc_html__('Invalid, unreadable, or missing file.', 'event_espresso')
-                );
-            }
-            return '';
-        }
-
-        extract($template_args, EXTR_SKIP);
-        // because we might want to return a string, we are going to capture the output
-        ob_start();
-        include($template_path);
-        $template = ob_get_clean();
-
-        if ($return_string) {
-            return $template;
-        }
-        echo wp_kses($template, AllowedTags::getWithFullTags());
-        return '';
-    }
-
-
-    /**
-     * get_object_css_class - attempts to generate a css class based on the type of EE object passed
-     *
-     * @param EE_Base_Class $object the EE object the css class is being generated for
-     * @param string        $prefix added to the beginning of the generated class
-     * @param string        $suffix added to the end of the generated class
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
-    {
-        // in the beginning...
-        $prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
-        // da muddle
-        $class = '';
-        // the end
-        $suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
-        // is the passed object an EE object ?
-        if ($object instanceof EE_Base_Class) {
-            // grab the exact type of object
-            $obj_class = get_class($object);
-            // depending on the type of object...
-            // no specifics just yet...
-            $class = strtolower(str_replace('_', '-', $obj_class));
-            $class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
-        }
-        return $prefix . $class . $suffix;
-    }
-
-
-    /**
-     * EEH_Template::format_currency
-     * This helper takes a raw float value and formats it according to the default config country currency settings, or
-     * the country currency settings from the supplied country ISO code
-     *
-     * @param float   $amount       raw money value
-     * @param boolean $return_raw   whether to return the formatted float value only with no currency sign or code
-     * @param boolean $display_code whether to display the country code (USD). Default = TRUE
-     * @param string  $CNT_ISO      2-letter ISO code for a country
-     * @param string  $cur_code_span_class
-     * @return string        the html output for the formatted money value
-     */
-    public static function format_currency(
-        $amount = null,
-        $return_raw = false,
-        $display_code = true,
-        $CNT_ISO = '',
-        $cur_code_span_class = 'currency-code'
-    ) {
-        // ensure amount was received
-        if ($amount === null) {
-            $msg = esc_html__('In order to format currency, an amount needs to be passed.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return '';
-        }
-        // ensure amount is float
-        $amount  = (float) apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float) $amount);
-        $CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
-        // filter raw amount (allows 0.00 to be changed to "free" for example)
-        $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
-        // still a number, or was amount converted to a string like "free" ?
-        if (! is_float($amount_formatted)) {
-            return esc_html($amount_formatted);
-        }
-        try {
-            // was a country ISO code passed ? if so generate currency config object for that country
-            $mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
-        } catch (Exception $e) {
-            // eat exception
-            $mny = null;
-        }
-        // verify results
-        if (! $mny instanceof EE_Currency_Config) {
-            // set default config country currency settings
-            $mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
-                ? EE_Registry::instance()->CFG->currency
-                : new EE_Currency_Config();
-        }
-        // format float
-        $amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
-        // add formatting ?
-        if (! $return_raw) {
-            // add currency sign
-            if ($mny->sign_b4) {
-                if ($amount >= 0) {
-                    $amount_formatted = $mny->sign . $amount_formatted;
-                } else {
-                    $amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
-                }
-            } else {
-                $amount_formatted = $amount_formatted . $mny->sign;
-            }
-
-            // filter to allow global setting of display_code
-            $display_code = (bool) apply_filters(
-                'FHEE__EEH_Template__format_currency__display_code',
-                $display_code
-            );
-
-            // add currency code ?
-            $amount_formatted = $display_code
-                ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">' . $mny->code . '</span>'
-                : $amount_formatted;
-        }
-        // filter results
-        $amount_formatted = apply_filters(
-            'FHEE__EEH_Template__format_currency__amount_formatted',
-            $amount_formatted,
-            $mny,
-            $return_raw
-        );
-        // clean up vars
-        unset($mny);
-        // return formatted currency amount
-        return $amount_formatted;
-    }
-
-
-    /**
-     * This function is used for outputting the localized label for a given status id in the schema requested (and
-     * possibly plural).  The intended use of this function is only for cases where wanting a label outside of a
-     * related status model or model object (i.e. in documentation etc.)
-     *
-     * @param string  $status_id  Status ID matching a registered status in the esp_status table.  If there is no
-     *                            match, then 'Unknown' will be returned.
-     * @param boolean $plural     Whether to return plural or not
-     * @param string  $schema     'UPPER', 'lower', or 'Sentence'
-     * @return string             The localized label for the status id.
-     * @throws EE_Error
-     */
-    public static function pretty_status($status_id, $plural = false, $schema = 'upper')
-    {
-        $status = EEM_Status::instance()->localized_status(
-            [$status_id => esc_html__('unknown', 'event_espresso')],
-            $plural,
-            $schema
-        );
-        return $status[ $status_id ];
-    }
-
-
-    /**
-     * This helper just returns a button or link for the given parameters
-     *
-     * @param string $url   the url for the link, note that `esc_url` will be called on it
-     * @param string $label What is the label you want displayed for the button
-     * @param string $class what class is used for the button (defaults to 'button--primary')
-     * @param string $icon
-     * @param string $title
-     * @return string the html output for the button
-     */
-    public static function get_button_or_link($url, $label, $class = 'button button--primary', $icon = '', $title = '')
-    {
-        $icon_html = '';
-        if (! empty($icon)) {
-            $dashicons = preg_split("(ee-icon |dashicons )", $icon);
-            $dashicons = array_filter($dashicons);
-            $count     = count($dashicons);
-            $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
-            foreach ($dashicons as $dashicon) {
-                $type      = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
-                $icon_html .= '<span class="' . $type . $dashicon . '"></span>';
-            }
-            $icon_html .= $count > 1 ? '</span>' : '';
-        }
-        // sanitize & escape
-        $id    = sanitize_title_with_dashes($label);
-        $url   = esc_url_raw($url);
-        $class = esc_attr($class);
-        $title = esc_attr($title);
-        $class .= $title ? ' ee-aria-tooltip' : '';
-        $title = $title ? " aria-label='{$title}'" : '';
-        $label = esc_html($label);
-        return "<a id='{$id}' href='{$url}' class='{$class}'{$title}>{$icon_html}{$label}</a>";
-    }
-
-
-    /**
-     * This returns a generated link that will load the related help tab on admin pages.
-     *
-     * @param string      $help_tab_id the id for the connected help tab
-     * @param bool|string $page        The page identifier for the page the help tab is on
-     * @param bool|string $action      The action (route) for the admin page the help tab is on.
-     * @param bool|string $icon_style  (optional) include css class for the style you want to use for the help icon.
-     * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
-     * @return string              generated link
-     */
-    public static function get_help_tab_link(
-        $help_tab_id,
-        $page = false,
-        $action = false,
-        $icon_style = false,
-        $help_text = false
-    ) {
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $page    = $page ?: $request->getRequestParam('page', '', 'key');
-        $action  = $action ?: $request->getRequestParam('action', 'default', 'key');
-
-
-        $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
-        $icon         = ! $icon_style ? 'dashicons-editor-help' : $icon_style;
-        $help_text    = ! $help_text ? '' : $help_text;
-        return '
+	private static array $_espresso_themes = [];
+
+
+	/**
+	 *    is_espresso_theme - returns TRUE or FALSE on whether the currently active WP theme is an espresso theme
+	 *
+	 * @return boolean
+	 */
+	public static function is_espresso_theme()
+	{
+		return wp_get_theme()->get('TextDomain') === 'event_espresso';
+	}
+
+
+	/**
+	 *    load_espresso_theme_functions - if current theme is an espresso theme, or uses ee theme template parts, then
+	 *    load its functions.php file ( if not already loaded )
+	 *
+	 * @return void
+	 */
+	public static function load_espresso_theme_functions()
+	{
+		if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
+			if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php')) {
+				require_once(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php');
+			}
+		}
+	}
+
+
+	/**
+	 *    get_espresso_themes - returns an array of Espresso Child themes located in the /templates/ directory
+	 *
+	 * @return array
+	 */
+	public static function get_espresso_themes(): array
+	{
+		if (empty(EEH_Template::$_espresso_themes)) {
+			$espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
+			if (empty($espresso_themes)) {
+				return [];
+			}
+			if (($key = array_search('global_assets', $espresso_themes)) !== false) {
+				unset($espresso_themes[ $key ]);
+			}
+			EEH_Template::$_espresso_themes = [];
+			foreach ($espresso_themes as $espresso_theme) {
+				EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
+			}
+		}
+		return EEH_Template::$_espresso_themes;
+	}
+
+
+	/**
+	 * EEH_Template::get_template_part
+	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead,
+	 * and doesn't add base versions of files so not a very useful function at all except that it adds familiarity PLUS
+	 * filtering based off of the entire template part name
+	 *
+	 * @param string $slug The slug name for the generic template.
+	 * @param string $name The name of the specialised template.
+	 * @param array  $template_args
+	 * @param bool   $return_string
+	 * @return string        the html output for the formatted money value
+	 */
+	public static function get_template_part(
+		$slug = '',
+		$name = '',
+		$template_args = [],
+		$return_string = false
+	) {
+		do_action("get_template_part_$slug-$name", $slug, $name);
+		$template = $slug;
+		$name      = (string) $name;
+		if ($name != '') {
+			$template .= "-$name";
+		}
+		$template .= ".php";
+		// allow template parts to be turned off via something like:
+		// add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
+		if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_$name", true)) {
+			return EEH_Template::locate_template($template, $template_args, true, $return_string);
+		}
+		return '';
+	}
+
+
+	/**
+	 *    locate_template
+	 *    locate a template file by looking in the following places, in the following order:
+	 *        <server path up to>/wp-content/themes/<current active WordPress theme>/
+	 *        <assumed full absolute server path>
+	 *        <server path up to>/wp-content/uploads/espresso/templates/<current EE theme>/
+	 *        <server path up to>/wp-content/uploads/espresso/templates/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/public/<current EE theme>/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/core/templates/<current EE theme>/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/
+	 *    as soon as the template is found in one of these locations, it will be returned or loaded
+	 *        Example:
+	 *          You are using the WordPress Twenty Sixteen theme,
+	 *        and you want to customize the "some-event.template.php" template,
+	 *          which is located in the "/relative/path/to/" folder relative to the main EE plugin folder.
+	 *          Assuming WP is installed on your server in the "/home/public_html/" folder,
+	 *        EEH_Template::locate_template() will look at the following paths in order until the template is found:
+	 *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
+	 *        /relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/uploads/espresso/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/uploads/espresso/templates/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/public/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/core/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/relative/path/to/some-event.template.php
+	 *          Had you passed an absolute path to your template that was in some other location,
+	 *        ie: "/absolute/path/to/some-event.template.php"
+	 *          then the search would have been :
+	 *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
+	 *        /absolute/path/to/some-event.template.php
+	 *          and stopped there upon finding it in the second location
+	 *
+	 * @param array|string $templates       array of template file names including extension (or just a single string)
+	 * @param array        $template_args   an array of arguments to be extracted for use in the template
+	 * @param boolean      $load            whether to pass the located template path on to the
+	 *                                      EEH_Template::display_template() method or simply return it
+	 * @param boolean      $return_string   whether to send output immediately to screen, or capture and return as a
+	 *                                      string
+	 * @param boolean      $check_if_custom If TRUE, this flags this method to return boolean for whether this will
+	 *                                      generate a custom template or not. Used in places where you don't actually
+	 *                                      load the template, you just want to know if there's a custom version of it.
+	 * @return string|true
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function locate_template(
+		$templates = [],
+		array $template_args = [],
+		bool $load = true,
+		bool $return_string = true,
+		bool $check_if_custom = false
+	) {
+		$cache_id      = TemplateCache::generateCacheID(__FUNCTION__, func_get_args());
+		$template_path = TemplateCache::get($cache_id);
+		$template_path = $template_path ?: self::resolveTemplatePath($cache_id, (array) $templates, $check_if_custom);
+
+		if ($check_if_custom && ! empty($template_path)) {
+			return true;
+		}
+
+		// if we got it and you want to see it...
+		if ($template_path && $load && ! $check_if_custom) {
+			if ($return_string) {
+				return EEH_Template::display_template($template_path, $template_args, true);
+			}
+			EEH_Template::display_template($template_path, $template_args);
+		}
+		return $check_if_custom && ! empty($template_path) ? true : $template_path;
+	}
+
+
+	/**
+	 * Resolves the path of a template by checking various possible locations.
+	 *
+	 * This method checks for the existence of a template in several locations,
+	 * including the current theme folder, the uploads directory, and the plugin's own template directory.
+	 * It uses the provided cache ID to store and retrieve the resolved path from a cache for performance.
+	 * If the template is not found in any of the checked locations, an empty string is returned.
+	 *
+	 * @param string $cache_id        The ID used for caching the resolved path.
+	 * @param array  $templates       An array of template file names to search for.
+	 * @param bool $check_if_custom   If true, the method will only check if a custom template exists
+	 *                                and won't include core plugin folders.
+	 * @return string The resolved template path, or an empty string if the template was not found.
+	 * @since 5.0.21.p
+	 */
+	private static function resolveTemplatePath(string $cache_id, array $templates, bool $check_if_custom): string
+	{
+		// first use WP locate_template to check for template in the current theme folder
+		$template_path = $templates ? locate_template($templates) : '';
+		// not in the theme
+		if (empty($template_path)) {
+			// not even a template to look for ?
+			if (empty($templates)) {
+				$loader = LoaderFactory::getLoader();
+				/** @var RequestInterface $request */
+				$request = $loader->getShared(RequestInterface::class);
+				// get post_type
+				$post_type = $request->getRequestParam('post_type');
+				/** @var CustomPostTypeDefinitions $custom_post_types */
+				$custom_post_types = $loader->getShared(CustomPostTypeDefinitions::class);
+				// get array of EE Custom Post Types
+				$EE_CPTs = $custom_post_types->getDefinitions();
+				// build template name based on request
+				if (isset($EE_CPTs[ $post_type ])) {
+					$archive_or_single = is_archive() ? 'archive' : '';
+					$archive_or_single = is_single() ? 'single' : $archive_or_single;
+					$templates[]       = $archive_or_single . '-' . $post_type . '.php';
+				}
+			}
+			// currently active EE template theme
+			$current_theme = EE_Config::get_current_theme();
+			// array of paths to folders that may contain templates
+			$template_folder_paths = [];
+
+			// add core plugin folders for checking only if we're not $check_if_custom
+			if (! $check_if_custom) {
+				$core_paths            = [
+					// in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
+					EE_PUBLIC . $current_theme,
+					// in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
+					EE_TEMPLATES . $current_theme,
+					// or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
+					EE_PLUGIN_DIR_PATH,
+				];
+				$template_folder_paths = array_merge($template_folder_paths, $core_paths);
+			}
+
+			// now filter that array
+			$template_folder_paths = (array) apply_filters(
+				'FHEE__EEH_Template__locate_template__template_folder_paths',
+				$template_folder_paths
+			);
+
+			// array to hold all possible template paths
+			$full_template_paths = [];
+			$file_name           = '';
+
+			// loop through $templates
+			foreach ($templates as $template) {
+				// normalize directory separators
+				$template                      = EEH_File::standardise_directory_separators($template);
+				$file_name                     = basename($template);
+				$template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
+				// while looping through all template folder paths
+				foreach ($template_folder_paths as $template_folder_path) {
+					// normalize directory separators
+					$template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
+					// determine if any common base path exists between the two paths
+					$common_base_path = EEH_Template::_find_common_base_path(
+						[$template_folder_path, $template_path_minus_file_name]
+					);
+					if ($common_base_path !== '') {
+						// both paths have a common base, so just tack the filename onto our search path
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
+					} else {
+						// no common base path, so let's just concatenate
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
+					}
+					// build up our template locations array by adding our resolved paths
+					$full_template_paths[] = $resolved_path;
+				}
+				// if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
+				array_unshift($full_template_paths, $template);
+				// path to the directory of the current theme: /wp-content/themes/(current WP theme)/
+				array_unshift($full_template_paths, get_stylesheet_directory() . '/' . $file_name);
+			}
+			// filter final array of full template paths
+			$full_template_paths = apply_filters(
+				'FHEE__EEH_Template__locate_template__full_template_paths',
+				$full_template_paths,
+				$file_name
+			);
+			// now loop through our final array of template location paths and check each location
+			foreach ((array) $full_template_paths as $full_template_path) {
+				if (is_readable($full_template_path)) {
+					$template_path = str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $full_template_path);
+					TemplateCache::set($cache_id, $template_path);
+					break;
+				}
+			}
+		}
+
+		// Display a deprecated notice if the template file is located in the WordPress uploads directory
+		if (strpos($template_path, 'wp-content/uploads/espresso') !== false) {
+			EE_Error::doing_it_wrong(
+				__CLASS__,
+				esc_html__(
+					'The use of the WordPress uploads directory as a location to override template files has been deprecated.',
+					'event_espresso'
+				),
+				'5.0.0'
+			);
+		}
+
+		// hook that can be used to display the full template path that will be used
+		do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
+
+		return $template_path;
+	}
+
+
+	/**
+	 * _find_common_base_path
+	 * given two paths, this determines if there is a common base path between the two
+	 *
+	 * @param array $paths
+	 * @return string
+	 */
+	protected static function _find_common_base_path($paths)
+	{
+		$last_offset      = 0;
+		$common_base_path = '';
+		while (($index = strpos($paths[0], '/', $last_offset)) !== false) {
+			$dir_length = $index - $last_offset + 1;
+			$directory  = substr($paths[0], $last_offset, $dir_length);
+			foreach ($paths as $path) {
+				if (substr($path, $last_offset, $dir_length) != $directory) {
+					return $common_base_path;
+				}
+			}
+			$common_base_path .= $directory;
+			$last_offset      = $index + 1;
+		}
+		return substr($common_base_path, 0, -1);
+	}
+
+
+	/**
+	 * load and display a template
+	 *
+	 * @param bool|string $template_path    server path to the file to be loaded, including file name and extension
+	 * @param array       $template_args    an array of arguments to be extracted for use in the template
+	 * @param boolean     $return_string    whether to send output immediately to screen, or capture and return as a
+	 *                                      string
+	 * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
+	 *                                      not found or is not readable
+	 * @return string
+	 * @throws DomainException
+	 */
+	public static function display_template(
+		$template_path = '',
+		$template_args = [],
+		$return_string = false,
+		$throw_exceptions = false
+	) {
+		/**
+		 * These two filters are intended for last minute changes to templates being loaded and/or template arg
+		 * modifications.  NOTE... modifying these things can cause breakage as most templates running through
+		 * the display_template method are templates we DON'T want modified (usually because of js
+		 * dependencies etc).  So unless you know what you are doing, do NOT filter templates or template args
+		 * using this.
+		 *
+		 * @since 4.6.0
+		 */
+		$template_path = (string) apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
+		$template_args = (array) apply_filters(
+			'FHEE__EEH_Template__display_template__template_args',
+			$template_args,
+			$template_path
+		);
+
+		// you gimme nuttin - YOU GET NUTTIN !!
+		if (! $template_path || ! is_readable($template_path)) {
+			// ignore whether template is accessible ?
+			if ($throw_exceptions) {
+				throw new DomainException(
+					esc_html__('Invalid, unreadable, or missing file.', 'event_espresso')
+				);
+			}
+			return '';
+		}
+
+		extract($template_args, EXTR_SKIP);
+		// because we might want to return a string, we are going to capture the output
+		ob_start();
+		include($template_path);
+		$template = ob_get_clean();
+
+		if ($return_string) {
+			return $template;
+		}
+		echo wp_kses($template, AllowedTags::getWithFullTags());
+		return '';
+	}
+
+
+	/**
+	 * get_object_css_class - attempts to generate a css class based on the type of EE object passed
+	 *
+	 * @param EE_Base_Class $object the EE object the css class is being generated for
+	 * @param string        $prefix added to the beginning of the generated class
+	 * @param string        $suffix added to the end of the generated class
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
+	{
+		// in the beginning...
+		$prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
+		// da muddle
+		$class = '';
+		// the end
+		$suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
+		// is the passed object an EE object ?
+		if ($object instanceof EE_Base_Class) {
+			// grab the exact type of object
+			$obj_class = get_class($object);
+			// depending on the type of object...
+			// no specifics just yet...
+			$class = strtolower(str_replace('_', '-', $obj_class));
+			$class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
+		}
+		return $prefix . $class . $suffix;
+	}
+
+
+	/**
+	 * EEH_Template::format_currency
+	 * This helper takes a raw float value and formats it according to the default config country currency settings, or
+	 * the country currency settings from the supplied country ISO code
+	 *
+	 * @param float   $amount       raw money value
+	 * @param boolean $return_raw   whether to return the formatted float value only with no currency sign or code
+	 * @param boolean $display_code whether to display the country code (USD). Default = TRUE
+	 * @param string  $CNT_ISO      2-letter ISO code for a country
+	 * @param string  $cur_code_span_class
+	 * @return string        the html output for the formatted money value
+	 */
+	public static function format_currency(
+		$amount = null,
+		$return_raw = false,
+		$display_code = true,
+		$CNT_ISO = '',
+		$cur_code_span_class = 'currency-code'
+	) {
+		// ensure amount was received
+		if ($amount === null) {
+			$msg = esc_html__('In order to format currency, an amount needs to be passed.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return '';
+		}
+		// ensure amount is float
+		$amount  = (float) apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float) $amount);
+		$CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
+		// filter raw amount (allows 0.00 to be changed to "free" for example)
+		$amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
+		// still a number, or was amount converted to a string like "free" ?
+		if (! is_float($amount_formatted)) {
+			return esc_html($amount_formatted);
+		}
+		try {
+			// was a country ISO code passed ? if so generate currency config object for that country
+			$mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
+		} catch (Exception $e) {
+			// eat exception
+			$mny = null;
+		}
+		// verify results
+		if (! $mny instanceof EE_Currency_Config) {
+			// set default config country currency settings
+			$mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
+				? EE_Registry::instance()->CFG->currency
+				: new EE_Currency_Config();
+		}
+		// format float
+		$amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
+		// add formatting ?
+		if (! $return_raw) {
+			// add currency sign
+			if ($mny->sign_b4) {
+				if ($amount >= 0) {
+					$amount_formatted = $mny->sign . $amount_formatted;
+				} else {
+					$amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
+				}
+			} else {
+				$amount_formatted = $amount_formatted . $mny->sign;
+			}
+
+			// filter to allow global setting of display_code
+			$display_code = (bool) apply_filters(
+				'FHEE__EEH_Template__format_currency__display_code',
+				$display_code
+			);
+
+			// add currency code ?
+			$amount_formatted = $display_code
+				? $amount_formatted . ' <span class="' . $cur_code_span_class . '">' . $mny->code . '</span>'
+				: $amount_formatted;
+		}
+		// filter results
+		$amount_formatted = apply_filters(
+			'FHEE__EEH_Template__format_currency__amount_formatted',
+			$amount_formatted,
+			$mny,
+			$return_raw
+		);
+		// clean up vars
+		unset($mny);
+		// return formatted currency amount
+		return $amount_formatted;
+	}
+
+
+	/**
+	 * This function is used for outputting the localized label for a given status id in the schema requested (and
+	 * possibly plural).  The intended use of this function is only for cases where wanting a label outside of a
+	 * related status model or model object (i.e. in documentation etc.)
+	 *
+	 * @param string  $status_id  Status ID matching a registered status in the esp_status table.  If there is no
+	 *                            match, then 'Unknown' will be returned.
+	 * @param boolean $plural     Whether to return plural or not
+	 * @param string  $schema     'UPPER', 'lower', or 'Sentence'
+	 * @return string             The localized label for the status id.
+	 * @throws EE_Error
+	 */
+	public static function pretty_status($status_id, $plural = false, $schema = 'upper')
+	{
+		$status = EEM_Status::instance()->localized_status(
+			[$status_id => esc_html__('unknown', 'event_espresso')],
+			$plural,
+			$schema
+		);
+		return $status[ $status_id ];
+	}
+
+
+	/**
+	 * This helper just returns a button or link for the given parameters
+	 *
+	 * @param string $url   the url for the link, note that `esc_url` will be called on it
+	 * @param string $label What is the label you want displayed for the button
+	 * @param string $class what class is used for the button (defaults to 'button--primary')
+	 * @param string $icon
+	 * @param string $title
+	 * @return string the html output for the button
+	 */
+	public static function get_button_or_link($url, $label, $class = 'button button--primary', $icon = '', $title = '')
+	{
+		$icon_html = '';
+		if (! empty($icon)) {
+			$dashicons = preg_split("(ee-icon |dashicons )", $icon);
+			$dashicons = array_filter($dashicons);
+			$count     = count($dashicons);
+			$icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
+			foreach ($dashicons as $dashicon) {
+				$type      = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
+				$icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+			}
+			$icon_html .= $count > 1 ? '</span>' : '';
+		}
+		// sanitize & escape
+		$id    = sanitize_title_with_dashes($label);
+		$url   = esc_url_raw($url);
+		$class = esc_attr($class);
+		$title = esc_attr($title);
+		$class .= $title ? ' ee-aria-tooltip' : '';
+		$title = $title ? " aria-label='{$title}'" : '';
+		$label = esc_html($label);
+		return "<a id='{$id}' href='{$url}' class='{$class}'{$title}>{$icon_html}{$label}</a>";
+	}
+
+
+	/**
+	 * This returns a generated link that will load the related help tab on admin pages.
+	 *
+	 * @param string      $help_tab_id the id for the connected help tab
+	 * @param bool|string $page        The page identifier for the page the help tab is on
+	 * @param bool|string $action      The action (route) for the admin page the help tab is on.
+	 * @param bool|string $icon_style  (optional) include css class for the style you want to use for the help icon.
+	 * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
+	 * @return string              generated link
+	 */
+	public static function get_help_tab_link(
+		$help_tab_id,
+		$page = false,
+		$action = false,
+		$icon_style = false,
+		$help_text = false
+	) {
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$page    = $page ?: $request->getRequestParam('page', '', 'key');
+		$action  = $action ?: $request->getRequestParam('action', 'default', 'key');
+
+
+		$help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
+		$icon         = ! $icon_style ? 'dashicons-editor-help' : $icon_style;
+		$help_text    = ! $help_text ? '' : $help_text;
+		return '
             <a id="' . esc_attr($help_tab_lnk) . '"
                class="espresso-help-tab-lnk ee-help-btn ee-aria-tooltip dashicons ' . esc_attr($icon) . '"
                aria-label="' . esc_attr__(
-                   'Click to open the \'Help\' tab for more information about this feature.',
-                   'event_espresso'
-               ) . '"
+				   'Click to open the \'Help\' tab for more information about this feature.',
+				   'event_espresso'
+			   ) . '"
             >
                 ' . wp_kses($help_text, AllowedTags::getAllowedTags()) . '
             </a>';
-    }
-
-
-    /**
-     * This is a helper method to generate a status legend for a given status array.
-     * Note this will only work if the incoming statuses have a key in the EEM_Status->localized_status() methods
-     * status_array.
-     *
-     * @param array  $status_array   array of statuses that will make up the legend. In format:
-     *                               array(
-     *                               'status_item' => 'status_name'
-     *                               )
-     * @param string $active_status  This is used to indicate what the active status is IF that is to be highlighted in
-     *                               the legend.
-     * @return string               html structure for status.
-     * @throws EE_Error
-     */
-    public static function status_legend($status_array, $active_status = '')
-    {
-        if (! is_array($status_array)) {
-            throw new EE_Error(
-                esc_html__(
-                    'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
-                    'event_espresso'
-                )
-            );
-        }
-
-        $content = '
+	}
+
+
+	/**
+	 * This is a helper method to generate a status legend for a given status array.
+	 * Note this will only work if the incoming statuses have a key in the EEM_Status->localized_status() methods
+	 * status_array.
+	 *
+	 * @param array  $status_array   array of statuses that will make up the legend. In format:
+	 *                               array(
+	 *                               'status_item' => 'status_name'
+	 *                               )
+	 * @param string $active_status  This is used to indicate what the active status is IF that is to be highlighted in
+	 *                               the legend.
+	 * @return string               html structure for status.
+	 * @throws EE_Error
+	 */
+	public static function status_legend($status_array, $active_status = '')
+	{
+		if (! is_array($status_array)) {
+			throw new EE_Error(
+				esc_html__(
+					'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
+					'event_espresso'
+				)
+			);
+		}
+
+		$content = '
             <div class="ee-list-table-legend-container">
                 <h4 class="status-legend-title">
                     ' . esc_html__('Status Legend', 'event_espresso') . '
                 </h4>
                 <dl class="ee-list-table-legend">';
 
-        foreach ($status_array as $item => $status) {
-            $active_class = $active_status == $status ? 'class="ee-is-active-status"' : '';
-            $content      .= '
+		foreach ($status_array as $item => $status) {
+			$active_class = $active_status == $status ? 'class="ee-is-active-status"' : '';
+			$content      .= '
                     <dt id="' . esc_attr('ee-legend-item-tooltip-' . $item) . '" ' . $active_class . '>
                         <span class="' . esc_attr('ee-status-legend ee-status-bg--' . $status) . '"></span>
                         <span class="ee-legend-description">
                             ' . EEH_Template::pretty_status($status, false, 'sentence') . '
                         </span>
                     </dt>';
-        }
+		}
 
-        $content .= '
+		$content .= '
                 </dl>
             </div>
 ';
-        return $content;
-    }
-
-
-    /**
-     * Gets HTML for laying out a deeply-nested array (and objects) in a format
-     * that's nice for presenting in the wp admin
-     *
-     * @param mixed $data
-     * @return string
-     */
-    public static function layout_array_as_table($data)
-    {
-        if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
-            $data = (array) $data;
-        }
-        ob_start();
-        if (is_array($data)) {
-            if (EEH_Array::is_associative_array($data)) { ?>
+		return $content;
+	}
+
+
+	/**
+	 * Gets HTML for laying out a deeply-nested array (and objects) in a format
+	 * that's nice for presenting in the wp admin
+	 *
+	 * @param mixed $data
+	 * @return string
+	 */
+	public static function layout_array_as_table($data)
+	{
+		if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
+			$data = (array) $data;
+		}
+		ob_start();
+		if (is_array($data)) {
+			if (EEH_Array::is_associative_array($data)) { ?>
                 <table class="widefat">
                     <tbody>
                         <?php foreach ($data as $data_key => $data_values) { ?>
@@ -728,304 +728,304 @@ 
             <?php } else { ?>
                 <ul>
                     <?php
-                    foreach ($data as $datum) {
-                        echo "<li>";
-                        echo self::layout_array_as_table($datum);
-                        echo "</li>";
-                    } ?>
+					foreach ($data as $datum) {
+						echo "<li>";
+						echo self::layout_array_as_table($datum);
+						echo "</li>";
+					} ?>
                 </ul>
             <?php }
-        } else {
-            // simple value
-            echo esc_html($data);
-        }
-        return ob_get_clean();
-    }
-
-
-    /**
-     * wrapper for self::get_paging_html() that simply echos the generated paging html
-     *
-     * @param        $total_items
-     * @param        $current
-     * @param        $per_page
-     * @param        $url
-     * @param bool   $show_num_field
-     * @param string $paged_arg_name
-     * @param array  $items_label
-     * @see   self:get_paging_html() for argument docs.
-     * @since 4.4.0
-     */
-    public static function paging_html(
-        $total_items,
-        $current,
-        $per_page,
-        $url,
-        $show_num_field = true,
-        $paged_arg_name = 'paged',
-        $items_label = []
-    ) {
-        echo self::get_paging_html(
-            $total_items,
-            $current,
-            $per_page,
-            $url,
-            $show_num_field,
-            $paged_arg_name,
-            $items_label
-        );
-    }
-
-
-    /**
-     * A method for generating paging similar to WP_List_Table
-     *
-     * @param int    $total_items       How many total items there are to page.
-     * @param int    $current           What the current page is.
-     * @param int    $per_page          How many items per page.
-     * @param string $url               What the base url for page links is.
-     * @param bool   $show_num_field    Whether to show the input for changing page number.
-     * @param string $paged_arg_name    The name of the key for the paged query argument.
-     * @param array  $items_label       An array of singular/plural values for the items label:
-     *                                  array(
-     *                                  'single' => 'item',
-     *                                  'plural' => 'items'
-     *                                  )
-     * @return  string
-     * @since    4.4.0
-     * @see      wp-admin/includes/class-wp-list-table.php WP_List_Table::pagination()
-     */
-    public static function get_paging_html(
-        int $total_items,
-        int $current,
-        int $per_page,
-        string $url,
-        bool $show_num_field = true,
-        string $paged_arg_name = 'paged',
-        array $items_label = [],
-        string $button_size = 'small'
-    ): string {
-        $page_links     = [];
-        $paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
-
-        // filter items_label
-        $items_label = apply_filters(
-            'FHEE__EEH_Template__get_paging_html__items_label',
-            $items_label
-        );
-
-        if (
-            empty($items_label)
-            || ! is_array($items_label)
-            || ! isset($items_label['single'])
-            || ! isset($items_label['plural'])
-        ) {
-            $items_label = [
-                'single' => esc_html__('1 item', 'event_espresso'),
-                'plural' => esc_html__('%s items', 'event_espresso'),
-            ];
-        } else {
-            $items_label = [
-                'single' => '1 ' . esc_html($items_label['single']),
-                'plural' => '%s ' . esc_html($items_label['plural']),
-            ];
-        }
-
-        $total_pages = (int) ceil($total_items / $per_page);
-
-        if ($total_pages <= 1) {
-            return '';
-        }
-
-        $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
-
-        $output = '<span class="displaying-num">' . $item_label . '</span>';
-
-        $disable_first = $current === 1 ? 'disabled' : '';
-        $disable_last  = $current === $total_pages ? 'disabled' : '';
-
-        $button_size    = in_array($button_size, ['tiny', 'small', 'default', 'big']) ? $button_size : 'small';
-        $button_classes = "button button--secondary button--icon-only button--$button_size";
-
-        $page_links[] = sprintf(
-            '<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
-            esc_attr("first-page $button_classes $disable_first"),
-            esc_attr__('Go to the first page', 'event_espresso'),
-            esc_url_raw(remove_query_arg($paged_arg_name, $url)),
-            '&laquo;'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
-            esc_attr("prev-page $button_classes $disable_first"),
-            esc_attr__('Go to the previous page', 'event_espresso'),
-            esc_url_raw(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
-            '&lsaquo;'
-        );
-
-        $html_current_page = $show_num_field
-            ? sprintf(
-                "<input class='current-page ee-input-size--small' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
-                esc_attr__('Current page', 'event_espresso'),
-                esc_attr($current),
-                strlen($total_pages)
-            )
-            : $current;
-
-        $html_total_pages = sprintf(
-            '<span class="total-pages">%s</span>',
-            number_format_i18n($total_pages)
-        );
-        $page_links[]     = sprintf(
-            _x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
-            "{$html_current_page}<span class='paging-input-of'>",
-            "</span>{$html_total_pages}",
-            '<span class="paging-input">',
-            '</span>'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
-            esc_attr("next-page $button_classes $disable_last"),
-            esc_attr__('Go to the next page', 'event_espresso'),
-            esc_url_raw(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
-            '&rsaquo;'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
-            esc_attr("last-page $button_classes $disable_last"),
-            esc_attr__('Go to the last page', 'event_espresso'),
-            esc_url_raw(add_query_arg($paged_arg_name, $total_pages, $url)),
-            '&raquo;'
-        );
-
-        $output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
-
-        $page_class = ' no-pages';
-        if ($total_pages) {
-            $page_class = $total_pages < 2 ? ' one-page' : '';
-        }
-
-        return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
-    }
-
-
-    /**
-     * @param string|null $wrap_class
-     * @param string|null $wrap_id
-     * @param array       $query_args
-     * @return string
-     */
-    public static function powered_by_event_espresso(
-        ?string $wrap_class = '',
-        ?string $wrap_id = '',
-        array $query_args = []
-    ): string {
-        $request = LoaderFactory::getShared(RequestInterface::class);
-        if (
-            $request->isActivation()
-            || strpos($request->requestUri(true), 'wp-admin/update.php') !== false
-        ) {
-            return '';
-        }
-        $cache_id = TemplateCache::generateCacheID(__FUNCTION__, func_get_args());
-        $cache    = TemplateCache::get($cache_id);
-        if ($cache) {
-            return $cache;
-        }
-
-        $admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
-        if (
-            ! $admin
-            && ! apply_filters(
-                'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
-                EE_Registry::instance()->CFG->admin->show_reg_footer
-            )
-        ) {
-            return '';
-        }
-        $tag        = $admin ? 'span' : 'div';
-        $attributes = ! empty($wrap_id) ? " id='$wrap_id'" : '';
-        $wrap_class = $admin ? "$wrap_class ee-layout-row ee-layout-row--inline" : $wrap_class;
-        $attributes .= ! empty($wrap_class)
-            ? " class='$wrap_class powered-by-event-espresso-credit'"
-            : ' class="powered-by-event-espresso-credit"';
-        $query_args = array_merge(
-            [
-                'ap_id'        => EE_Registry::instance()->CFG->admin->affiliate_id(),
-                'utm_source'   => 'powered_by_event_espresso',
-                'utm_medium'   => 'link',
-                'utm_campaign' => 'powered_by',
-            ],
-            $query_args
-        );
-        $powered_by = apply_filters(
-            'FHEE__EEH_Template__powered_by_event_espresso_text',
-            $admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
-        );
-        $url        = add_query_arg($query_args, 'https://eventespresso.com/');
-        $url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
-        $template   = (string) apply_filters(
-            'FHEE__EEH_Template__powered_by_event_espresso__html',
-            sprintf(
-                esc_html_x(
-                    '%3$s%1$sOnline event registration and ticketing powered by %2$s%3$s',
-                    'Online event registration and ticketing powered by [link to eventespresso.com]',
-                    'event_espresso'
-                ),
-                "<$tag$attributes style='margin-inline:.5rem;'>",
-                " <a href='$url' target='_blank' rel='nofollow' style='margin-inline: .25rem;'>$powered_by</a></$tag> ",
-                $admin ? '' : '<br />'
-            ),
-            $wrap_class,
-            $wrap_id
-        );
-        TemplateCache::set($cache_id, $template);
-        return $template;
-    }
-
-
-    /**
-     * @param string $image_name
-     * @return string|null
-     * @since   4.10.14.p
-     */
-    public static function getScreenshotUrl($image_name)
-    {
-        return esc_url_raw(EE_GLOBAL_ASSETS_URL . 'images/screenshots/' . $image_name . '.jpg');
-    }
+		} else {
+			// simple value
+			echo esc_html($data);
+		}
+		return ob_get_clean();
+	}
+
+
+	/**
+	 * wrapper for self::get_paging_html() that simply echos the generated paging html
+	 *
+	 * @param        $total_items
+	 * @param        $current
+	 * @param        $per_page
+	 * @param        $url
+	 * @param bool   $show_num_field
+	 * @param string $paged_arg_name
+	 * @param array  $items_label
+	 * @see   self:get_paging_html() for argument docs.
+	 * @since 4.4.0
+	 */
+	public static function paging_html(
+		$total_items,
+		$current,
+		$per_page,
+		$url,
+		$show_num_field = true,
+		$paged_arg_name = 'paged',
+		$items_label = []
+	) {
+		echo self::get_paging_html(
+			$total_items,
+			$current,
+			$per_page,
+			$url,
+			$show_num_field,
+			$paged_arg_name,
+			$items_label
+		);
+	}
+
+
+	/**
+	 * A method for generating paging similar to WP_List_Table
+	 *
+	 * @param int    $total_items       How many total items there are to page.
+	 * @param int    $current           What the current page is.
+	 * @param int    $per_page          How many items per page.
+	 * @param string $url               What the base url for page links is.
+	 * @param bool   $show_num_field    Whether to show the input for changing page number.
+	 * @param string $paged_arg_name    The name of the key for the paged query argument.
+	 * @param array  $items_label       An array of singular/plural values for the items label:
+	 *                                  array(
+	 *                                  'single' => 'item',
+	 *                                  'plural' => 'items'
+	 *                                  )
+	 * @return  string
+	 * @since    4.4.0
+	 * @see      wp-admin/includes/class-wp-list-table.php WP_List_Table::pagination()
+	 */
+	public static function get_paging_html(
+		int $total_items,
+		int $current,
+		int $per_page,
+		string $url,
+		bool $show_num_field = true,
+		string $paged_arg_name = 'paged',
+		array $items_label = [],
+		string $button_size = 'small'
+	): string {
+		$page_links     = [];
+		$paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
+
+		// filter items_label
+		$items_label = apply_filters(
+			'FHEE__EEH_Template__get_paging_html__items_label',
+			$items_label
+		);
+
+		if (
+			empty($items_label)
+			|| ! is_array($items_label)
+			|| ! isset($items_label['single'])
+			|| ! isset($items_label['plural'])
+		) {
+			$items_label = [
+				'single' => esc_html__('1 item', 'event_espresso'),
+				'plural' => esc_html__('%s items', 'event_espresso'),
+			];
+		} else {
+			$items_label = [
+				'single' => '1 ' . esc_html($items_label['single']),
+				'plural' => '%s ' . esc_html($items_label['plural']),
+			];
+		}
+
+		$total_pages = (int) ceil($total_items / $per_page);
+
+		if ($total_pages <= 1) {
+			return '';
+		}
+
+		$item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
+
+		$output = '<span class="displaying-num">' . $item_label . '</span>';
+
+		$disable_first = $current === 1 ? 'disabled' : '';
+		$disable_last  = $current === $total_pages ? 'disabled' : '';
+
+		$button_size    = in_array($button_size, ['tiny', 'small', 'default', 'big']) ? $button_size : 'small';
+		$button_classes = "button button--secondary button--icon-only button--$button_size";
+
+		$page_links[] = sprintf(
+			'<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
+			esc_attr("first-page $button_classes $disable_first"),
+			esc_attr__('Go to the first page', 'event_espresso'),
+			esc_url_raw(remove_query_arg($paged_arg_name, $url)),
+			'&laquo;'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
+			esc_attr("prev-page $button_classes $disable_first"),
+			esc_attr__('Go to the previous page', 'event_espresso'),
+			esc_url_raw(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
+			'&lsaquo;'
+		);
+
+		$html_current_page = $show_num_field
+			? sprintf(
+				"<input class='current-page ee-input-size--small' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
+				esc_attr__('Current page', 'event_espresso'),
+				esc_attr($current),
+				strlen($total_pages)
+			)
+			: $current;
+
+		$html_total_pages = sprintf(
+			'<span class="total-pages">%s</span>',
+			number_format_i18n($total_pages)
+		);
+		$page_links[]     = sprintf(
+			_x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
+			"{$html_current_page}<span class='paging-input-of'>",
+			"</span>{$html_total_pages}",
+			'<span class="paging-input">',
+			'</span>'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
+			esc_attr("next-page $button_classes $disable_last"),
+			esc_attr__('Go to the next page', 'event_espresso'),
+			esc_url_raw(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
+			'&rsaquo;'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
+			esc_attr("last-page $button_classes $disable_last"),
+			esc_attr__('Go to the last page', 'event_espresso'),
+			esc_url_raw(add_query_arg($paged_arg_name, $total_pages, $url)),
+			'&raquo;'
+		);
+
+		$output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
+
+		$page_class = ' no-pages';
+		if ($total_pages) {
+			$page_class = $total_pages < 2 ? ' one-page' : '';
+		}
+
+		return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+	}
+
+
+	/**
+	 * @param string|null $wrap_class
+	 * @param string|null $wrap_id
+	 * @param array       $query_args
+	 * @return string
+	 */
+	public static function powered_by_event_espresso(
+		?string $wrap_class = '',
+		?string $wrap_id = '',
+		array $query_args = []
+	): string {
+		$request = LoaderFactory::getShared(RequestInterface::class);
+		if (
+			$request->isActivation()
+			|| strpos($request->requestUri(true), 'wp-admin/update.php') !== false
+		) {
+			return '';
+		}
+		$cache_id = TemplateCache::generateCacheID(__FUNCTION__, func_get_args());
+		$cache    = TemplateCache::get($cache_id);
+		if ($cache) {
+			return $cache;
+		}
+
+		$admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
+		if (
+			! $admin
+			&& ! apply_filters(
+				'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
+				EE_Registry::instance()->CFG->admin->show_reg_footer
+			)
+		) {
+			return '';
+		}
+		$tag        = $admin ? 'span' : 'div';
+		$attributes = ! empty($wrap_id) ? " id='$wrap_id'" : '';
+		$wrap_class = $admin ? "$wrap_class ee-layout-row ee-layout-row--inline" : $wrap_class;
+		$attributes .= ! empty($wrap_class)
+			? " class='$wrap_class powered-by-event-espresso-credit'"
+			: ' class="powered-by-event-espresso-credit"';
+		$query_args = array_merge(
+			[
+				'ap_id'        => EE_Registry::instance()->CFG->admin->affiliate_id(),
+				'utm_source'   => 'powered_by_event_espresso',
+				'utm_medium'   => 'link',
+				'utm_campaign' => 'powered_by',
+			],
+			$query_args
+		);
+		$powered_by = apply_filters(
+			'FHEE__EEH_Template__powered_by_event_espresso_text',
+			$admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
+		);
+		$url        = add_query_arg($query_args, 'https://eventespresso.com/');
+		$url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
+		$template   = (string) apply_filters(
+			'FHEE__EEH_Template__powered_by_event_espresso__html',
+			sprintf(
+				esc_html_x(
+					'%3$s%1$sOnline event registration and ticketing powered by %2$s%3$s',
+					'Online event registration and ticketing powered by [link to eventespresso.com]',
+					'event_espresso'
+				),
+				"<$tag$attributes style='margin-inline:.5rem;'>",
+				" <a href='$url' target='_blank' rel='nofollow' style='margin-inline: .25rem;'>$powered_by</a></$tag> ",
+				$admin ? '' : '<br />'
+			),
+			$wrap_class,
+			$wrap_id
+		);
+		TemplateCache::set($cache_id, $template);
+		return $template;
+	}
+
+
+	/**
+	 * @param string $image_name
+	 * @return string|null
+	 * @since   4.10.14.p
+	 */
+	public static function getScreenshotUrl($image_name)
+	{
+		return esc_url_raw(EE_GLOBAL_ASSETS_URL . 'images/screenshots/' . $image_name . '.jpg');
+	}
 }
 
 
 if (! function_exists('espresso_pagination')) {
-    /**
-     *    espresso_pagination
-     *
-     * @access    public
-     * @return    void
-     */
-    function espresso_pagination()
-    {
-        global $wp_query;
-        $big        = 999999999; // need an unlikely integer
-        $pagination = paginate_links(
-            [
-                'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
-                'format'       => '?paged=%#%',
-                'current'      => max(1, get_query_var('paged')),
-                'total'        => $wp_query->max_num_pages,
-                'show_all'     => true,
-                'end_size'     => 10,
-                'mid_size'     => 6,
-                'prev_next'    => true,
-                'prev_text'    => esc_html__('&lsaquo; PREV', 'event_espresso'),
-                'next_text'    => esc_html__('NEXT &rsaquo;', 'event_espresso'),
-                'type'         => 'plain',
-                'add_args'     => false,
-                'add_fragment' => '',
-            ]
-        );
-        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
-    }
+	/**
+	 *    espresso_pagination
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	function espresso_pagination()
+	{
+		global $wp_query;
+		$big        = 999999999; // need an unlikely integer
+		$pagination = paginate_links(
+			[
+				'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
+				'format'       => '?paged=%#%',
+				'current'      => max(1, get_query_var('paged')),
+				'total'        => $wp_query->max_num_pages,
+				'show_all'     => true,
+				'end_size'     => 10,
+				'mid_size'     => 6,
+				'prev_next'    => true,
+				'prev_text'    => esc_html__('&lsaquo; PREV', 'event_espresso'),
+				'next_text'    => esc_html__('NEXT &rsaquo;', 'event_espresso'),
+				'type'         => 'plain',
+				'add_args'     => false,
+				'add_fragment' => '',
+			]
+		);
+		echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+	}
 }

Spacing +56 added lines, -56 removed lines

@@ -8,7 +8,7 @@ 
 use EventEspresso\core\services\request\RequestInterface;
 use EventEspresso\core\services\request\sanitizers\AllowedTags;
 
-if (! function_exists('espresso_get_template_part')) {
+if ( ! function_exists('espresso_get_template_part')) {
     /**
      * espresso_get_template_part
      * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
@@ -24,7 +24,7 @@ 
 }
 
 
-if (! function_exists('espresso_get_object_css_class')) {
+if ( ! function_exists('espresso_get_object_css_class')) {
     /**
      * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
      *
@@ -74,9 +74,9 @@ 
      */
     public static function load_espresso_theme_functions()
     {
-        if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
-            if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php')) {
-                require_once(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php');
+        if ( ! defined('EE_THEME_FUNCTIONS_LOADED')) {
+            if (is_readable(EE_PUBLIC.EE_Config::get_current_theme().'/functions.php')) {
+                require_once(EE_PUBLIC.EE_Config::get_current_theme().'/functions.php');
             }
         }
     }
@@ -90,16 +90,16 @@ 
     public static function get_espresso_themes(): array
     {
         if (empty(EEH_Template::$_espresso_themes)) {
-            $espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
+            $espresso_themes = glob(EE_PUBLIC.'*', GLOB_ONLYDIR);
             if (empty($espresso_themes)) {
                 return [];
             }
             if (($key = array_search('global_assets', $espresso_themes)) !== false) {
-                unset($espresso_themes[ $key ]);
+                unset($espresso_themes[$key]);
             }
             EEH_Template::$_espresso_themes = [];
             foreach ($espresso_themes as $espresso_theme) {
-                EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
+                EEH_Template::$_espresso_themes[basename($espresso_theme)] = $espresso_theme;
             }
         }
         return EEH_Template::$_espresso_themes;
@@ -126,7 +126,7 @@ 
     ) {
         do_action("get_template_part_$slug-$name", $slug, $name);
         $template = $slug;
-        $name      = (string) $name;
+        $name = (string) $name;
         if ($name != '') {
             $template .= "-$name";
         }
@@ -245,10 +245,10 @@ 
                 // get array of EE Custom Post Types
                 $EE_CPTs = $custom_post_types->getDefinitions();
                 // build template name based on request
-                if (isset($EE_CPTs[ $post_type ])) {
+                if (isset($EE_CPTs[$post_type])) {
                     $archive_or_single = is_archive() ? 'archive' : '';
                     $archive_or_single = is_single() ? 'single' : $archive_or_single;
-                    $templates[]       = $archive_or_single . '-' . $post_type . '.php';
+                    $templates[]       = $archive_or_single.'-'.$post_type.'.php';
                 }
             }
             // currently active EE template theme
@@ -257,12 +257,12 @@ 
             $template_folder_paths = [];
 
             // add core plugin folders for checking only if we're not $check_if_custom
-            if (! $check_if_custom) {
-                $core_paths            = [
+            if ( ! $check_if_custom) {
+                $core_paths = [
                     // in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-                    EE_PUBLIC . $current_theme,
+                    EE_PUBLIC.$current_theme,
                     // in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-                    EE_TEMPLATES . $current_theme,
+                    EE_TEMPLATES.$current_theme,
                     // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
                     EE_PLUGIN_DIR_PATH,
                 ];
@@ -295,10 +295,10 @@ 
                     );
                     if ($common_base_path !== '') {
                         // both paths have a common base, so just tack the filename onto our search path
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
+                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$file_name;
                     } else {
                         // no common base path, so let's just concatenate
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
+                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$template;
                     }
                     // build up our template locations array by adding our resolved paths
                     $full_template_paths[] = $resolved_path;
@@ -306,7 +306,7 @@ 
                 // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
                 array_unshift($full_template_paths, $template);
                 // path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-                array_unshift($full_template_paths, get_stylesheet_directory() . '/' . $file_name);
+                array_unshift($full_template_paths, get_stylesheet_directory().'/'.$file_name);
             }
             // filter final array of full template paths
             $full_template_paths = apply_filters(
@@ -363,7 +363,7 @@ 
                 }
             }
             $common_base_path .= $directory;
-            $last_offset      = $index + 1;
+            $last_offset = $index + 1;
         }
         return substr($common_base_path, 0, -1);
     }
@@ -404,7 +404,7 @@ 
         );
 
         // you gimme nuttin - YOU GET NUTTIN !!
-        if (! $template_path || ! is_readable($template_path)) {
+        if ( ! $template_path || ! is_readable($template_path)) {
             // ignore whether template is accessible ?
             if ($throw_exceptions) {
                 throw new DomainException(
@@ -441,11 +441,11 @@ 
     public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
     {
         // in the beginning...
-        $prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
+        $prefix = ! empty($prefix) ? rtrim($prefix, '-').'-' : '';
         // da muddle
         $class = '';
         // the end
-        $suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
+        $suffix = ! empty($suffix) ? '-'.ltrim($suffix, '-') : '';
         // is the passed object an EE object ?
         if ($object instanceof EE_Base_Class) {
             // grab the exact type of object
@@ -453,9 +453,9 @@ 
             // depending on the type of object...
             // no specifics just yet...
             $class = strtolower(str_replace('_', '-', $obj_class));
-            $class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
+            $class .= method_exists($obj_class, 'name') ? '-'.sanitize_title($object->name()) : '';
         }
-        return $prefix . $class . $suffix;
+        return $prefix.$class.$suffix;
     }
 
 
@@ -490,7 +490,7 @@ 
         // filter raw amount (allows 0.00 to be changed to "free" for example)
         $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
         // still a number, or was amount converted to a string like "free" ?
-        if (! is_float($amount_formatted)) {
+        if ( ! is_float($amount_formatted)) {
             return esc_html($amount_formatted);
         }
         try {
@@ -501,7 +501,7 @@ 
             $mny = null;
         }
         // verify results
-        if (! $mny instanceof EE_Currency_Config) {
+        if ( ! $mny instanceof EE_Currency_Config) {
             // set default config country currency settings
             $mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
                 ? EE_Registry::instance()->CFG->currency
@@ -510,16 +510,16 @@ 
         // format float
         $amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
         // add formatting ?
-        if (! $return_raw) {
+        if ( ! $return_raw) {
             // add currency sign
             if ($mny->sign_b4) {
                 if ($amount >= 0) {
-                    $amount_formatted = $mny->sign . $amount_formatted;
+                    $amount_formatted = $mny->sign.$amount_formatted;
                 } else {
-                    $amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
+                    $amount_formatted = '-'.$mny->sign.str_replace('-', '', $amount_formatted);
                 }
             } else {
-                $amount_formatted = $amount_formatted . $mny->sign;
+                $amount_formatted = $amount_formatted.$mny->sign;
             }
 
             // filter to allow global setting of display_code
@@ -530,7 +530,7 @@ 
 
             // add currency code ?
             $amount_formatted = $display_code
-                ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">' . $mny->code . '</span>'
+                ? $amount_formatted.' <span class="'.$cur_code_span_class.'">'.$mny->code.'</span>'
                 : $amount_formatted;
         }
         // filter results
@@ -566,7 +566,7 @@ 
             $plural,
             $schema
         );
-        return $status[ $status_id ];
+        return $status[$status_id];
     }
 
 
@@ -583,14 +583,14 @@ 
     public static function get_button_or_link($url, $label, $class = 'button button--primary', $icon = '', $title = '')
     {
         $icon_html = '';
-        if (! empty($icon)) {
+        if ( ! empty($icon)) {
             $dashicons = preg_split("(ee-icon |dashicons )", $icon);
             $dashicons = array_filter($dashicons);
             $count     = count($dashicons);
             $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
             foreach ($dashicons as $dashicon) {
-                $type      = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
-                $icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+                $type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
+                $icon_html .= '<span class="'.$type.$dashicon.'"></span>';
             }
             $icon_html .= $count > 1 ? '</span>' : '';
         }
@@ -629,18 +629,18 @@ 
         $action  = $action ?: $request->getRequestParam('action', 'default', 'key');
 
 
-        $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
+        $help_tab_lnk = $page.'-'.$action.'-'.$help_tab_id;
         $icon         = ! $icon_style ? 'dashicons-editor-help' : $icon_style;
         $help_text    = ! $help_text ? '' : $help_text;
         return '
-            <a id="' . esc_attr($help_tab_lnk) . '"
-               class="espresso-help-tab-lnk ee-help-btn ee-aria-tooltip dashicons ' . esc_attr($icon) . '"
+            <a id="' . esc_attr($help_tab_lnk).'"
+               class="espresso-help-tab-lnk ee-help-btn ee-aria-tooltip dashicons ' . esc_attr($icon).'"
                aria-label="' . esc_attr__(
                    'Click to open the \'Help\' tab for more information about this feature.',
                    'event_espresso'
-               ) . '"
+               ).'"
             >
-                ' . wp_kses($help_text, AllowedTags::getAllowedTags()) . '
+                ' . wp_kses($help_text, AllowedTags::getAllowedTags()).'
             </a>';
     }
 
@@ -661,7 +661,7 @@ 
      */
     public static function status_legend($status_array, $active_status = '')
     {
-        if (! is_array($status_array)) {
+        if ( ! is_array($status_array)) {
             throw new EE_Error(
                 esc_html__(
                     'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
@@ -673,17 +673,17 @@ 
         $content = '
             <div class="ee-list-table-legend-container">
                 <h4 class="status-legend-title">
-                    ' . esc_html__('Status Legend', 'event_espresso') . '
+                    ' . esc_html__('Status Legend', 'event_espresso').'
                 </h4>
                 <dl class="ee-list-table-legend">';
 
         foreach ($status_array as $item => $status) {
             $active_class = $active_status == $status ? 'class="ee-is-active-status"' : '';
-            $content      .= '
-                    <dt id="' . esc_attr('ee-legend-item-tooltip-' . $item) . '" ' . $active_class . '>
-                        <span class="' . esc_attr('ee-status-legend ee-status-bg--' . $status) . '"></span>
+            $content .= '
+                    <dt id="' . esc_attr('ee-legend-item-tooltip-'.$item).'" '.$active_class.'>
+                        <span class="' . esc_attr('ee-status-legend ee-status-bg--'.$status).'"></span>
                         <span class="ee-legend-description">
-                            ' . EEH_Template::pretty_status($status, false, 'sentence') . '
+                            ' . EEH_Template::pretty_status($status, false, 'sentence').'
                         </span>
                     </dt>';
         }
@@ -826,8 +826,8 @@ 
             ];
         } else {
             $items_label = [
-                'single' => '1 ' . esc_html($items_label['single']),
-                'plural' => '%s ' . esc_html($items_label['plural']),
+                'single' => '1 '.esc_html($items_label['single']),
+                'plural' => '%s '.esc_html($items_label['plural']),
             ];
         }
 
@@ -839,7 +839,7 @@ 
 
         $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
 
-        $output = '<span class="displaying-num">' . $item_label . '</span>';
+        $output = '<span class="displaying-num">'.$item_label.'</span>';
 
         $disable_first = $current === 1 ? 'disabled' : '';
         $disable_last  = $current === $total_pages ? 'disabled' : '';
@@ -876,7 +876,7 @@ 
             '<span class="total-pages">%s</span>',
             number_format_i18n($total_pages)
         );
-        $page_links[]     = sprintf(
+        $page_links[] = sprintf(
             _x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
             "{$html_current_page}<span class='paging-input-of'>",
             "</span>{$html_total_pages}",
@@ -900,14 +900,14 @@ 
             '&raquo;'
         );
 
-        $output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
+        $output .= "\n".'<span class="pagination-links">'.join("\n", $page_links).'</span>';
 
         $page_class = ' no-pages';
         if ($total_pages) {
             $page_class = $total_pages < 2 ? ' one-page' : '';
         }
 
-        return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+        return '<div class="tablenav"><div class="tablenav-pages'.$page_class.'">'.$output.'</div></div>';
     }
 
 
@@ -962,7 +962,7 @@ 
         );
         $powered_by = apply_filters(
             'FHEE__EEH_Template__powered_by_event_espresso_text',
-            $admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
+            $admin ? 'Event Espresso - '.EVENT_ESPRESSO_VERSION : 'Event Espresso'
         );
         $url        = add_query_arg($query_args, 'https://eventespresso.com/');
         $url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
@@ -993,12 +993,12 @@ 
      */
     public static function getScreenshotUrl($image_name)
     {
-        return esc_url_raw(EE_GLOBAL_ASSETS_URL . 'images/screenshots/' . $image_name . '.jpg');
+        return esc_url_raw(EE_GLOBAL_ASSETS_URL.'images/screenshots/'.$image_name.'.jpg');
     }
 }
 
 
-if (! function_exists('espresso_pagination')) {
+if ( ! function_exists('espresso_pagination')) {
     /**
      *    espresso_pagination
      *
@@ -1026,6 +1026,6 @@ 
                 'add_fragment' => '',
             ]
         );
-        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">'.$pagination.'</div>' : '';
     }
 }

core/helpers/EEH_Array.helper.php

Indentation +315 added lines, -315 removed lines

@@ -11,345 +11,345 @@
  */
 class EEH_Array extends EEH_Base
 {
-    /**
-     * This method basically works the same as the PHP core function array_diff except it allows you to compare arrays
-     * of EE_Base_Class objects NOTE: This will ONLY work on an array of EE_Base_Class objects
-     *
-     * @param array $array1 an array of objects
-     * @param array $array2 an array of objects
-     * @return array         an array of objects found in array 1 that aren't found in array 2.
-     * @uses self::_compare_objects as the custom method for array_udiff
-     * @uses array_udiff core php function for setting up our own array comparison
-     */
-    public static function object_array_diff(array $array1, array $array2): array
-    {
-        return array_udiff($array1, $array2, ['self', '_compare_objects']);
-    }
+	/**
+	 * This method basically works the same as the PHP core function array_diff except it allows you to compare arrays
+	 * of EE_Base_Class objects NOTE: This will ONLY work on an array of EE_Base_Class objects
+	 *
+	 * @param array $array1 an array of objects
+	 * @param array $array2 an array of objects
+	 * @return array         an array of objects found in array 1 that aren't found in array 2.
+	 * @uses self::_compare_objects as the custom method for array_udiff
+	 * @uses array_udiff core php function for setting up our own array comparison
+	 */
+	public static function object_array_diff(array $array1, array $array2): array
+	{
+		return array_udiff($array1, $array2, ['self', '_compare_objects']);
+	}
 
 
-    /**
-     * Given that $array is an array, determines if it's associative or numerically AND sequentially indexed
-     *
-     * @param array $array
-     * @return boolean
-     */
-    public static function is_associative_array(array $array): bool
-    {
-        return ! empty($array) && array_keys($array) !== range(0, count($array) - 1);
-    }
+	/**
+	 * Given that $array is an array, determines if it's associative or numerically AND sequentially indexed
+	 *
+	 * @param array $array
+	 * @return boolean
+	 */
+	public static function is_associative_array(array $array): bool
+	{
+		return ! empty($array) && array_keys($array) !== range(0, count($array) - 1);
+	}
 
 
-    /**
-     * Gets an item from the array and leave the array intact. Use in place of end()
-     * when you don't want to change the array
-     *
-     * @param array $array
-     * @return mixed what ever is in the array
-     */
-    public static function get_one_item_from_array(array $array)
-    {
-        $item = end($array);
-        reset($array);
-        return $item;
-    }
+	/**
+	 * Gets an item from the array and leave the array intact. Use in place of end()
+	 * when you don't want to change the array
+	 *
+	 * @param array $array
+	 * @return mixed what ever is in the array
+	 */
+	public static function get_one_item_from_array(array $array)
+	{
+		$item = end($array);
+		reset($array);
+		return $item;
+	}
 
 
-    /**
-     * Detects if this is a multidimensional array
-     * meaning that at least one top-level value is an array. Eg [ [], ...]
-     *
-     * @param mixed $array
-     * @return boolean
-     */
-    public static function is_multi_dimensional_array($array): bool
-    {
-        if (is_array($array)) {
-            foreach ($array as $item) {
-                if (is_array($item)) {
-                    return true; // yep, there's at least 2 levels to this array
-                }
-            }
-        }
-        return false; // there's only 1 level, or it's not an array at all!
-    }
+	/**
+	 * Detects if this is a multidimensional array
+	 * meaning that at least one top-level value is an array. Eg [ [], ...]
+	 *
+	 * @param mixed $array
+	 * @return boolean
+	 */
+	public static function is_multi_dimensional_array($array): bool
+	{
+		if (is_array($array)) {
+			foreach ($array as $item) {
+				if (is_array($item)) {
+					return true; // yep, there's at least 2 levels to this array
+				}
+			}
+		}
+		return false; // there's only 1 level, or it's not an array at all!
+	}
 
 
-    /**
-     * Shorthand for isset( $array[ $index ] ) ? $array[ $index ] : $default
-     *
-     * @param array $array
-     * @param mixed $index
-     * @param mixed $default
-     * @return mixed
-     */
-    public static function is_set(array $array, $index, $default)
-    {
-        return $array[ $index ] ?? $default;
-    }
+	/**
+	 * Shorthand for isset( $array[ $index ] ) ? $array[ $index ] : $default
+	 *
+	 * @param array $array
+	 * @param mixed $index
+	 * @param mixed $default
+	 * @return mixed
+	 */
+	public static function is_set(array $array, $index, $default)
+	{
+		return $array[ $index ] ?? $default;
+	}
 
 
-    /**
-     * Exactly like `maybe_unserialize`, but also accounts for a WP bug: http://core.trac.wordpress.org/ticket/26118
-     *
-     * @param mixed $value usually a string, but could be an array or object
-     * @return mixed the UN-serialized data
-     */
-    public static function maybe_unserialize($value)
-    {
-        $data = maybe_unserialize($value);
-        // it's possible that this still has serialized data if it's the session.
-        //  WP has a bug, http://core.trac.wordpress.org/ticket/26118 that doesn't unserialize this automatically.
-        $token = 'C';
-        $data  = is_string($data) ? trim($data) : $data;
-        if (is_string($data) && strlen($data) > 1 && $data[0] == $token && preg_match("/^$token:[0-9]+:/s", $data)) {
-            return unserialize($data);
-        }
-        return $data;
-    }
+	/**
+	 * Exactly like `maybe_unserialize`, but also accounts for a WP bug: http://core.trac.wordpress.org/ticket/26118
+	 *
+	 * @param mixed $value usually a string, but could be an array or object
+	 * @return mixed the UN-serialized data
+	 */
+	public static function maybe_unserialize($value)
+	{
+		$data = maybe_unserialize($value);
+		// it's possible that this still has serialized data if it's the session.
+		//  WP has a bug, http://core.trac.wordpress.org/ticket/26118 that doesn't unserialize this automatically.
+		$token = 'C';
+		$data  = is_string($data) ? trim($data) : $data;
+		if (is_string($data) && strlen($data) > 1 && $data[0] == $token && preg_match("/^$token:[0-9]+:/s", $data)) {
+			return unserialize($data);
+		}
+		return $data;
+	}
 
 
-    /**
-     * insert_into_array
-     *
-     * @param array           $target_array    the array to insert new data into
-     * @param array           $array_to_insert the new data to be inserted
-     * @param int|string|null $offset          a known key within $target_array where new data will be inserted
-     * @param bool            $add_before      whether to add new data before or after the offset key
-     * @param bool            $preserve_keys   whether to reset numerically indexed arrays
-     * @return array
-     */
-    public static function insert_into_array(
-        array $target_array = [],
-        array $array_to_insert = [],
-        $offset = null,
-        bool $add_before = true,
-        bool $preserve_keys = true
-    ): array {
-        $target_array_keys = array_keys($target_array);
-        // if no offset key was supplied
-        if (empty($offset)) {
-            // use start or end of $target_array based on whether we are adding before or not
-            $offset = $add_before ? 0 : count($target_array);
-        }
-        // if offset key is a string, then find the corresponding numeric location for that element
-        $offset = is_int($offset) ? $offset : array_search($offset, $target_array_keys, true);
-        // add one to the offset if adding after
-        $offset = $add_before ? $offset : $offset + 1;
-        // but ensure offset does not exceed the length of the array
-        $offset = $offset > count($target_array) ? count($target_array) : $offset;
-        // reindex array ???
-        if ($preserve_keys) {
-            // take a slice of the target array from the beginning till the offset,
-            // then add the new data
-            // then add another slice that starts at the offset and goes till the end
-            return array_slice($target_array, 0, $offset, true)
-                + $array_to_insert
-                + array_slice($target_array, $offset, null, true);
-        }
-        // since we don't want to preserve keys, we can use array_splice
-        array_splice($target_array, $offset, 0, $array_to_insert);
-        return $target_array;
-    }
+	/**
+	 * insert_into_array
+	 *
+	 * @param array           $target_array    the array to insert new data into
+	 * @param array           $array_to_insert the new data to be inserted
+	 * @param int|string|null $offset          a known key within $target_array where new data will be inserted
+	 * @param bool            $add_before      whether to add new data before or after the offset key
+	 * @param bool            $preserve_keys   whether to reset numerically indexed arrays
+	 * @return array
+	 */
+	public static function insert_into_array(
+		array $target_array = [],
+		array $array_to_insert = [],
+		$offset = null,
+		bool $add_before = true,
+		bool $preserve_keys = true
+	): array {
+		$target_array_keys = array_keys($target_array);
+		// if no offset key was supplied
+		if (empty($offset)) {
+			// use start or end of $target_array based on whether we are adding before or not
+			$offset = $add_before ? 0 : count($target_array);
+		}
+		// if offset key is a string, then find the corresponding numeric location for that element
+		$offset = is_int($offset) ? $offset : array_search($offset, $target_array_keys, true);
+		// add one to the offset if adding after
+		$offset = $add_before ? $offset : $offset + 1;
+		// but ensure offset does not exceed the length of the array
+		$offset = $offset > count($target_array) ? count($target_array) : $offset;
+		// reindex array ???
+		if ($preserve_keys) {
+			// take a slice of the target array from the beginning till the offset,
+			// then add the new data
+			// then add another slice that starts at the offset and goes till the end
+			return array_slice($target_array, 0, $offset, true)
+				+ $array_to_insert
+				+ array_slice($target_array, $offset, null, true);
+		}
+		// since we don't want to preserve keys, we can use array_splice
+		array_splice($target_array, $offset, 0, $array_to_insert);
+		return $target_array;
+	}
 
 
-    /**
-     * array_merge() is slow and should never be used while looping over data
-     * if you don't need to preserve keys from all arrays, then using a foreach loop is much faster
-     * so really this acts more like array_replace( $array1, $array2 )
-     * or a union with the arrays flipped ( $array2 + $array1 )
-     * this saves a few lines of code and improves readability
-     *
-     * @param array $array1
-     * @param array $array2
-     * @return array
-     */
-    public static function merge_arrays_and_overwrite_keys(array $array1, array $array2): array
-    {
-        foreach ($array2 as $key => $value) {
-            $array1[ $key ] = $value;
-        }
-        return $array1;
-    }
+	/**
+	 * array_merge() is slow and should never be used while looping over data
+	 * if you don't need to preserve keys from all arrays, then using a foreach loop is much faster
+	 * so really this acts more like array_replace( $array1, $array2 )
+	 * or a union with the arrays flipped ( $array2 + $array1 )
+	 * this saves a few lines of code and improves readability
+	 *
+	 * @param array $array1
+	 * @param array $array2
+	 * @return array
+	 */
+	public static function merge_arrays_and_overwrite_keys(array $array1, array $array2): array
+	{
+		foreach ($array2 as $key => $value) {
+			$array1[ $key ] = $value;
+		}
+		return $array1;
+	}
 
 
-    /**
-     * given a flat array like $array = array('A', 'B', 'C')
-     * will convert into a multidimensional array like $array[A][B][C]
-     * if $final_value is provided and is anything other than null,
-     * then that will be set as the value for the innermost array key
-     * like so: $array[A][B][C] = $final_value
-     *
-     * @param array $flat_array
-     * @param mixed $final_value
-     * @return array
-     */
-    public static function convert_array_values_to_keys(array $flat_array, $final_value = null): array
-    {
-        $multidimensional = [];
-        $reference        = &$multidimensional;
-        foreach ($flat_array as $key) {
-            $reference[ $key ] = [];
-            $reference         = &$reference[ $key ];
-        }
-        if ($final_value !== null) {
-            $reference = $final_value;
-        }
-        return $multidimensional;
-    }
+	/**
+	 * given a flat array like $array = array('A', 'B', 'C')
+	 * will convert into a multidimensional array like $array[A][B][C]
+	 * if $final_value is provided and is anything other than null,
+	 * then that will be set as the value for the innermost array key
+	 * like so: $array[A][B][C] = $final_value
+	 *
+	 * @param array $flat_array
+	 * @param mixed $final_value
+	 * @return array
+	 */
+	public static function convert_array_values_to_keys(array $flat_array, $final_value = null): array
+	{
+		$multidimensional = [];
+		$reference        = &$multidimensional;
+		foreach ($flat_array as $key) {
+			$reference[ $key ] = [];
+			$reference         = &$reference[ $key ];
+		}
+		if ($final_value !== null) {
+			$reference = $final_value;
+		}
+		return $multidimensional;
+	}
 
 
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    public static function is_array_numerically_and_sequentially_indexed(array $array): bool
-    {
-        return empty($array) || array_keys($array) === range(0, count($array) - 1);
-    }
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	public static function is_array_numerically_and_sequentially_indexed(array $array): bool
+	{
+		return empty($array) || array_keys($array) === range(0, count($array) - 1);
+	}
 
 
-    /**
-     * recursively walks through an array and adds slashes to all no array elements
-     *
-     * @param mixed $element
-     * @return array|string
-     * @since   4.10.29.p
-     */
-    public static function addSlashesRecursively($element)
-    {
-        if (is_array($element)) {
-            foreach ($element as $key => $value) {
-                $element[ $key ] = EEH_Array::addSlashesRecursively($value);
-            }
-            return $element;
-        }
-        return is_string($element) ? addslashes($element) : $element;
-    }
+	/**
+	 * recursively walks through an array and adds slashes to all no array elements
+	 *
+	 * @param mixed $element
+	 * @return array|string
+	 * @since   4.10.29.p
+	 */
+	public static function addSlashesRecursively($element)
+	{
+		if (is_array($element)) {
+			foreach ($element as $key => $value) {
+				$element[ $key ] = EEH_Array::addSlashesRecursively($value);
+			}
+			return $element;
+		}
+		return is_string($element) ? addslashes($element) : $element;
+	}
 
 
-    /**
-     * link https://stackoverflow.com/a/3877494
-     *
-     * @param array $array_1
-     * @param array $array_2
-     * @return array
-     * @since   5.0.0.p
-     */
-    public static function array_diff_recursive(array $array_1, array $array_2): array
-    {
-        $diff = [];
-        foreach ($array_1 as $key => $value) {
-            if (array_key_exists($key, $array_2)) {
-                if (is_array($value)) {
-                    $inner_diff = EEH_Array::array_diff_recursive($value, $array_2[ $key ]);
-                    if (count($inner_diff)) {
-                        $diff[ $key ] = $inner_diff;
-                    }
-                } else {
-                    if ($value != $array_2[ $key ]) {
-                        $diff[ $key ] = $value;
-                    }
-                }
-            } else {
-                $diff[ $key ] = $value;
-            }
-        }
-        return $diff;
-    }
+	/**
+	 * link https://stackoverflow.com/a/3877494
+	 *
+	 * @param array $array_1
+	 * @param array $array_2
+	 * @return array
+	 * @since   5.0.0.p
+	 */
+	public static function array_diff_recursive(array $array_1, array $array_2): array
+	{
+		$diff = [];
+		foreach ($array_1 as $key => $value) {
+			if (array_key_exists($key, $array_2)) {
+				if (is_array($value)) {
+					$inner_diff = EEH_Array::array_diff_recursive($value, $array_2[ $key ]);
+					if (count($inner_diff)) {
+						$diff[ $key ] = $inner_diff;
+					}
+				} else {
+					if ($value != $array_2[ $key ]) {
+						$diff[ $key ] = $value;
+					}
+				}
+			} else {
+				$diff[ $key ] = $value;
+			}
+		}
+		return $diff;
+	}
 
 
-    /**
-     * converts multidimensional arrays into a single depth associative array
-     * or converts arrays of any depth into a readable string representation
-     *
-     *  $example = [
-     *      'a' => 'A',
-     *      'b' => 'B',
-     *      'c' => [
-     *          'd' => 'D',
-     *          'e' => 'E',
-     *          'f' => [ 'G', 'H', 'I' ],
-     *      ],
-     *      [ 'J', 'K' ],
-     *      'L',
-     *      'M',
-     *      'n' => [
-     *          'o' => 'P'
-     *      ],
-     *  ];
-     *
-     *  print_r( EEH_Array::flattenArray($example) );
-     *
-     *  Array (
-     *      [a] => A
-     *      [b] => B
-     *      [c] => [ d:D, e:E, f:[ G, H, I ] ]
-     *      [0] => [ J, K ]
-     *      [1] => L
-     *      [2] => M
-     *      [n] => [ o:P ]
-     *  )
-     *
-     *  print_r( EEH_Array::flattenArray($example, true) );
-     *
-     *  "a:A, b:B, c:[ d:D, e:E, f:[ G, H, I ] ], [ J, K ], L, M, n:[ o:P ]"
-     *
-     * @param array $array      the array to be flattened
-     * @param bool  $to_string  [true] will flatten the entire array down into a string
-     *                          [false] will only flatten sub-arrays down into strings and return an array
-     * @param bool  $top_level  used for formatting purposes only, best to leave this alone as it's set internally
-     * @return array|false|string
-     * @since 5.0.0.p
-     */
-    public static function flattenArray(array $array, bool $to_string = false, bool $top_level = true)
-    {
-        $flat_array = [];
-        foreach ($array as $key => $value) {
-            $flat_array[ $key ] = is_array($value)
-                ? EEH_Array::flattenArray($value, true, false)
-                : $value;
-        }
-        if (! $to_string) {
-            return $flat_array;
-        }
-        $flat = '';
-        foreach ($flat_array as $key => $value) {
-            $flat .= is_int($key) ? "$value, " : "$key:$value, ";
-        }
-        $flat = substr($flat, 0, -2);
-        return $top_level ? $flat : "[ $flat ]";
-    }
+	/**
+	 * converts multidimensional arrays into a single depth associative array
+	 * or converts arrays of any depth into a readable string representation
+	 *
+	 *  $example = [
+	 *      'a' => 'A',
+	 *      'b' => 'B',
+	 *      'c' => [
+	 *          'd' => 'D',
+	 *          'e' => 'E',
+	 *          'f' => [ 'G', 'H', 'I' ],
+	 *      ],
+	 *      [ 'J', 'K' ],
+	 *      'L',
+	 *      'M',
+	 *      'n' => [
+	 *          'o' => 'P'
+	 *      ],
+	 *  ];
+	 *
+	 *  print_r( EEH_Array::flattenArray($example) );
+	 *
+	 *  Array (
+	 *      [a] => A
+	 *      [b] => B
+	 *      [c] => [ d:D, e:E, f:[ G, H, I ] ]
+	 *      [0] => [ J, K ]
+	 *      [1] => L
+	 *      [2] => M
+	 *      [n] => [ o:P ]
+	 *  )
+	 *
+	 *  print_r( EEH_Array::flattenArray($example, true) );
+	 *
+	 *  "a:A, b:B, c:[ d:D, e:E, f:[ G, H, I ] ], [ J, K ], L, M, n:[ o:P ]"
+	 *
+	 * @param array $array      the array to be flattened
+	 * @param bool  $to_string  [true] will flatten the entire array down into a string
+	 *                          [false] will only flatten sub-arrays down into strings and return an array
+	 * @param bool  $top_level  used for formatting purposes only, best to leave this alone as it's set internally
+	 * @return array|false|string
+	 * @since 5.0.0.p
+	 */
+	public static function flattenArray(array $array, bool $to_string = false, bool $top_level = true)
+	{
+		$flat_array = [];
+		foreach ($array as $key => $value) {
+			$flat_array[ $key ] = is_array($value)
+				? EEH_Array::flattenArray($value, true, false)
+				: $value;
+		}
+		if (! $to_string) {
+			return $flat_array;
+		}
+		$flat = '';
+		foreach ($flat_array as $key => $value) {
+			$flat .= is_int($key) ? "$value, " : "$key:$value, ";
+		}
+		$flat = substr($flat, 0, -2);
+		return $top_level ? $flat : "[ $flat ]";
+	}
 
 
-    /**
-     * Filters elements of an array using a callback function recursively.
-     *
-     * This method applies a user-supplied function to each element of the input array recursively.
-     * It preserves keys by default. The array is traversed in a depth-first manner.
-     * It also provides an option to remove empty elements.
-     *
-     * @param array    $array        The input array to filter.
-     * @param callable $filter       The callback function to use. If the function returns true,
-     *                               the current value from array is returned into the result array.
-     * @param bool     $remove_empty Optional parameter to remove empty elements. Default is false.
-     * @return array The filtered array.
-     */
-    public static function arrayFilterRecursive(array $array, callable $filter, bool $remove_empty = false): array
-    {
-        $filtered = [];
-        foreach ($array as $key => $value) {
-            if (is_array($value)) {
-                $value = EEH_Array::arrayFilterRecursive($value, $filter);
-                if (! ($remove_empty && empty($value))) {
-                    $filtered[ $key ] = $value;
-                }
-            } else {
-                if (! ($remove_empty && empty($value)) && $filter($value, $key)) {
-                    $filtered[ $key ] = $value;
-                }
-            }
-        }
-        return $filtered;
-    }
+	/**
+	 * Filters elements of an array using a callback function recursively.
+	 *
+	 * This method applies a user-supplied function to each element of the input array recursively.
+	 * It preserves keys by default. The array is traversed in a depth-first manner.
+	 * It also provides an option to remove empty elements.
+	 *
+	 * @param array    $array        The input array to filter.
+	 * @param callable $filter       The callback function to use. If the function returns true,
+	 *                               the current value from array is returned into the result array.
+	 * @param bool     $remove_empty Optional parameter to remove empty elements. Default is false.
+	 * @return array The filtered array.
+	 */
+	public static function arrayFilterRecursive(array $array, callable $filter, bool $remove_empty = false): array
+	{
+		$filtered = [];
+		foreach ($array as $key => $value) {
+			if (is_array($value)) {
+				$value = EEH_Array::arrayFilterRecursive($value, $filter);
+				if (! ($remove_empty && empty($value))) {
+					$filtered[ $key ] = $value;
+				}
+			} else {
+				if (! ($remove_empty && empty($value)) && $filter($value, $key)) {
+					$filtered[ $key ] = $value;
+				}
+			}
+		}
+		return $filtered;
+	}
 }

core/helpers/EEH_Line_Item.helper.php

Indentation +2233 added lines, -2233 removed lines

@@ -21,2237 +21,2237 @@
  */
 class EEH_Line_Item
 {
-    /**
-     * @var EE_Line_Item[]|null
-     */
-    private static ?array $global_taxes = null;
-
-
-    /**
-     * Adds a simple item (unrelated to any other model object) to the provided PARENT line item.
-     * Does NOT automatically re-calculate the line item totals or update the related transaction.
-     * You should call recalculate_total_including_taxes() on the grant total line item after this
-     * to update the subtotals, and EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
-     * to keep the registration final prices in-sync with the transaction's total.
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @param string       $name
-     * @param float        $unit_price
-     * @param string       $description
-     * @param int          $quantity
-     * @param boolean      $taxable
-     * @param string|null  $code if set to a value, ensures there is only one line item with that code
-     * @param bool         $return_item
-     * @param bool         $recalculate_totals
-     * @return boolean|EE_Line_Item success
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function add_unrelated_item(
-        EE_Line_Item $parent_line_item,
-        string $name,
-        float $unit_price,
-        string $description = '',
-        int $quantity = 1,
-        bool $taxable = false,
-        ?string $code = null,
-        bool $return_item = false,
-        bool $recalculate_totals = true
-    ) {
-        $items_subtotal = self::get_pre_tax_subtotal($parent_line_item);
-        $line_item      = EE_Line_Item::new_instance(
-            [
-                'LIN_name'       => $name,
-                'LIN_desc'       => $description,
-                'LIN_unit_price' => $unit_price,
-                'LIN_quantity'   => $quantity,
-                'LIN_percent'    => null,
-                'LIN_is_taxable' => $taxable,
-                'LIN_order'      => count($items_subtotal->children()),
-                'LIN_total'      => $unit_price * $quantity,
-                'LIN_type'       => EEM_Line_Item::type_line_item,
-                'LIN_code'       => $code,
-            ]
-        );
-        $line_item      = apply_filters(
-            'FHEE__EEH_Line_Item__add_unrelated_item__line_item',
-            $line_item,
-            $parent_line_item
-        );
-        $added          = self::add_item($parent_line_item, $line_item, $recalculate_totals);
-        return $return_item ? $line_item : $added;
-    }
-
-
-    /**
-     * Adds a simple item ( unrelated to any other model object) to the total line item,
-     * in the correct spot in the line item tree. Does not automatically
-     * re-calculate the line item totals, nor update the related transaction, nor upgrade the transaction's
-     * registrations' final prices (which should probably change because of this).
-     * You should call recalculate_total_including_taxes() on the grand total line item, then
-     * update the transaction's total, and EE_Registration_Processor::update_registration_final_prices()
-     * after using this, to keep the registration final prices in-sync with the transaction's total.
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @param string       $name
-     * @param float        $percentage_amount
-     * @param string       $description
-     * @param boolean      $taxable
-     * @param string|null  $code
-     * @param bool         $return_item
-     * @return boolean|EE_Line_Item success
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function add_percentage_based_item(
-        EE_Line_Item $parent_line_item,
-        string $name,
-        float $percentage_amount,
-        string $description = '',
-        bool $taxable = false,
-        ?string $code = null,
-        bool $return_item = false
-    ) {
-        $total     = $percentage_amount * $parent_line_item->total() / 100;
-        $line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_name'       => $name,
-                'LIN_desc'       => $description,
-                'LIN_unit_price' => 0,
-                'LIN_percent'    => $percentage_amount,
-                'LIN_is_taxable' => $taxable,
-                'LIN_total'      => $total,
-                'LIN_type'       => EEM_Line_Item::type_line_item,
-                'LIN_parent'     => $parent_line_item->ID(),
-                'LIN_code'       => $code,
-                'TXN_ID'         => $parent_line_item->TXN_ID(),
-            ]
-        );
-        $line_item = apply_filters(
-            'FHEE__EEH_Line_Item__add_percentage_based_item__line_item',
-            $line_item
-        );
-        $added     = $parent_line_item->add_child_line_item($line_item, false);
-        return $return_item ? $line_item : $added;
-    }
-
-
-    /**
-     * Returns the new line item created by adding a purchase of the ticket
-     * ensures that ticket line item is saved, and that cart total has been recalculated.
-     * If this ticket has already been purchased, just increments its count.
-     * Automatically re-calculates the line item totals and updates the related transaction. But
-     * DOES NOT automatically upgrade the transaction's registrations' final prices (which
-     * should probably change because of this).
-     * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
-     * after using this, to keep the registration final prices in-sync with the transaction's total.
-     *
-     * @param EE_Line_Item|null $total_line_item grand total line item of type EEM_Line_Item::type_total
-     * @param EE_Ticket         $ticket
-     * @param int               $qty
-     * @param bool              $recalculate_totals
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function add_ticket_purchase(
-        ?EE_Line_Item $total_line_item,
-        EE_Ticket $ticket,
-        int $qty = 1,
-        bool $recalculate_totals = true
-    ): ?EE_Line_Item {
-        if (! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'A valid line item total is required in order to add tickets. A line item of type "%s" was passed.',
-                        'event_espresso'
-                    ),
-                    $ticket->ID(),
-                    $total_line_item->ID()
-                )
-            );
-        }
-        // either increment the qty for an existing ticket
-        $line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty);
-        // or add a new one
-        if (! $line_item instanceof EE_Line_Item) {
-            $line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty);
-        }
-        if ($recalculate_totals) {
-            $total_line_item->recalculate_total_including_taxes();
-        }
-        return $line_item;
-    }
-
-
-    /**
-     * Returns the new line item created by adding a purchase of the ticket
-     *
-     * @param EE_Line_Item|null $total_line_item
-     * @param EE_Ticket         $ticket
-     * @param int               $qty
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function increment_ticket_qty_if_already_in_cart(
-        ?EE_Line_Item $total_line_item,
-        EE_Ticket $ticket,
-        int $qty = 1
-    ): ?EE_Line_Item {
-        $line_item = null;
-        if ($total_line_item instanceof EE_Line_Item && $total_line_item->is_total()) {
-            $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
-            foreach ($ticket_line_items as $ticket_line_item) {
-                if (
-                    $ticket_line_item instanceof EE_Line_Item
-                    && $ticket_line_item->OBJ_ID() === $ticket->ID()
-                ) {
-                    $line_item = $ticket_line_item;
-                    break;
-                }
-            }
-        }
-        if ($line_item instanceof EE_Line_Item) {
-            EEH_Line_Item::increment_quantity($line_item, $qty);
-            return $line_item;
-        }
-        return null;
-    }
-
-
-    /**
-     * Increments the line item and all its children's quantity by $qty (but percent line items are unaffected).
-     * Does NOT save or recalculate other line items totals
-     *
-     * @param EE_Line_Item $line_item
-     * @param int          $qty
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function increment_quantity(EE_Line_Item $line_item, int $qty = 1)
-    {
-        if (! $line_item->is_percent()) {
-            $qty += $line_item->quantity();
-            $line_item->set_quantity($qty);
-            $line_item->set_total($line_item->unit_price() * $qty);
-            $line_item->save();
-        }
-        foreach ($line_item->children() as $child) {
-            if ($child->is_sub_line_item()) {
-                EEH_Line_Item::update_quantity($child, $qty);
-            }
-        }
-    }
-
-
-    /**
-     * Decrements the line item and all its children's quantity by $qty (but percent line items are unaffected).
-     * Does NOT save or recalculate other line items totals
-     *
-     * @param EE_Line_Item $line_item
-     * @param int          $qty
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function decrement_quantity(EE_Line_Item $line_item, int $qty = 1)
-    {
-        if (! $line_item->is_percent()) {
-            $qty = $line_item->quantity() - $qty;
-            $qty = max($qty, 0);
-            $line_item->set_quantity($qty);
-            $line_item->set_total($line_item->unit_price() * $qty);
-            $line_item->save();
-        }
-        foreach ($line_item->children() as $child) {
-            if ($child->is_sub_line_item()) {
-                EEH_Line_Item::update_quantity($child, $qty);
-            }
-        }
-    }
-
-
-    /**
-     * Updates the line item and its children's quantities to the specified number.
-     * Does NOT save them or recalculate totals.
-     *
-     * @param EE_Line_Item $line_item
-     * @param int          $new_quantity
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function update_quantity(EE_Line_Item $line_item, int $new_quantity)
-    {
-        if (! $line_item->is_percent()) {
-            $line_item->set_quantity($new_quantity);
-            $line_item->set_total($line_item->unit_price() * $new_quantity);
-            $line_item->save();
-        }
-        foreach ($line_item->children() as $child) {
-            if ($child->is_sub_line_item()) {
-                EEH_Line_Item::update_quantity($child, $new_quantity);
-            }
-        }
-    }
-
-
-    /**
-     * Returns the new line item created by adding a purchase of the ticket
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @param EE_Ticket    $ticket
-     * @param int          $qty
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function create_ticket_line_item(
-        EE_Line_Item $total_line_item,
-        EE_Ticket $ticket,
-        int $qty = 1
-    ): EE_Line_Item {
-        $datetimes           = $ticket->datetimes();
-        $first_datetime      = reset($datetimes);
-        $first_datetime_name = esc_html__('Event', 'event_espresso');
-        if ($first_datetime instanceof EE_Datetime && $first_datetime->event() instanceof EE_Event) {
-            $first_datetime_name = $first_datetime->event()->name();
-        }
-        $event = sprintf(_x('(For %1$s)', '(For Event Name)', 'event_espresso'), $first_datetime_name);
-        // get event subtotal line
-        $events_sub_total = self::get_event_line_item_for_ticket($total_line_item, $ticket);
-        $taxes            = $ticket->tax_price_modifiers();
-        // add $ticket to cart
-        $line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_name'       => $ticket->name(),
-                'LIN_desc'       => $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event,
-                'LIN_unit_price' => $ticket->price(),
-                'LIN_quantity'   => $qty,
-                'LIN_is_taxable' => empty($taxes) && $ticket->taxable(),
-                'LIN_order'      => count($events_sub_total->children()),
-                'LIN_total'      => $ticket->price() * $qty,
-                'LIN_type'       => EEM_Line_Item::type_line_item,
-                'OBJ_ID'         => $ticket->ID(),
-                'OBJ_type'       => EEM_Line_Item::OBJ_TYPE_TICKET,
-            ]
-        );
-        $line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_ticket_line_item__line_item',
-            $line_item
-        );
-        if (! $line_item instanceof EE_Line_Item) {
-            throw new DomainException(
-                esc_html__('Invalid EE_Line_Item received.', 'event_espresso')
-            );
-        }
-        $events_sub_total->add_child_line_item($line_item);
-        // now add the sub-line items
-        $running_pre_tax_total = 0;
-        $prices                = $ticket->prices();
-        if (empty($prices)) {
-            // WUT?!?! NO PRICES??? Well, just create a default price then.
-            $default_price = EEM_Price::instance()->get_new_price();
-            if ($default_price->amount() !== $ticket->price()) {
-                $default_price->set_amount($ticket->price());
-            }
-            $default_price->save();
-            $ticket->_add_relation_to($default_price, 'Price');
-            $ticket->save();
-            $prices = [$default_price];
-        }
-        foreach ($prices as $price) {
-            $sign = $price->is_discount() ? -1 : 1;
-            $price_amount = $price->amount();
-            if ($price->is_percent()) {
-                $price_total = $running_pre_tax_total * $price_amount / 100;
-                $percent    = $sign * $price_amount;
-                $unit_price = 0;
-            } else {
-                $price_total = $price_amount * $qty;
-                $percent    = 0;
-                $unit_price = $sign * $price_amount;
-            }
-
-            $price_desc = $price->desc();
-            $price_type = $price->type_obj();
-            $price_desc = $price_desc === '' && $price_type instanceof EE_Price_Type
-                ? $price_type->name()
-                : $price_desc;
-
-            $sub_line_item         = EE_Line_Item::new_instance(
-                [
-                    'LIN_name'       => $price->name(),
-                    'LIN_desc'       => $price_desc,
-                    'LIN_is_taxable' => false,
-                    'LIN_order'      => $price->order(),
-                    'LIN_total'      => $price_total,
-                    'LIN_pretax'     => 0,
-                    'LIN_unit_price' => $unit_price,
-                    'LIN_percent'    => $percent,
-                    'LIN_type'       => $price->is_tax()
-                        ? EEM_Line_Item::type_sub_tax
-                        : EEM_Line_Item::type_sub_line_item,
-                    'OBJ_ID'         => $price->ID(),
-                    'OBJ_type'       => EEM_Line_Item::OBJ_TYPE_PRICE,
-                ]
-            );
-            $sub_line_item         = apply_filters(
-                'FHEE__EEH_Line_Item__create_ticket_line_item__sub_line_item',
-                $sub_line_item
-            );
-            $running_pre_tax_total += ! $price->is_tax() ? $sign * $price_total : 0;
-            $line_item->add_child_line_item($sub_line_item);
-        }
-        $line_item->setPretaxTotal($running_pre_tax_total);
-        return $line_item;
-    }
-
-
-    /**
-     * Adds the specified item under the pre-tax-sub-total line item. Automatically
-     * re-calculates the line item totals and updates the related transaction. But
-     * DOES NOT automatically upgrade the transaction's registrations' final prices (which
-     * should probably change because of this).
-     * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
-     * after using this, to keep the registration final prices in-sync with the transaction's total.
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param EE_Line_Item $item to be added
-     * @param bool         $recalculate_totals
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function add_item(
-        EE_Line_Item $total_line_item,
-        EE_Line_Item $item,
-        bool $recalculate_totals = true
-    ): bool {
-        $pre_tax_subtotal = self::get_pre_tax_subtotal($total_line_item);
-        $success          = $pre_tax_subtotal->add_child_line_item($item);
-        if ($recalculate_totals) {
-            $total_line_item->recalculate_total_including_taxes();
-        }
-        return $success;
-    }
-
-
-    /**
-     * cancels an existing ticket line item,
-     * by decrementing its quantity by 1 and adding a new "type_cancellation" sub-line-item.
-     * ALL totals and subtotals will NEED TO BE UPDATED after performing this action
-     *
-     * @param EE_Line_Item $ticket_line_item
-     * @param int          $qty
-     * @return bool success
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function cancel_ticket_line_item(EE_Line_Item $ticket_line_item, int $qty = 1): bool
-    {
-        // validate incoming line_item
-        if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The supplied line item must have an Object Type of "Ticket", not %1$s.',
-                        'event_espresso'
-                    ),
-                    $ticket_line_item->type()
-                )
-            );
-        }
-        if ($ticket_line_item->quantity() < $qty) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Can not cancel %1$d ticket(s) because the supplied line item has a quantity of %2$d.',
-                        'event_espresso'
-                    ),
-                    $qty,
-                    $ticket_line_item->quantity()
-                )
-            );
-        }
-        // decrement ticket quantity; don't rely on auto-fixing when recalculating totals to do this
-        $ticket_line_item->set_quantity($ticket_line_item->quantity() - $qty);
-        foreach ($ticket_line_item->children() as $child_line_item) {
-            if (
-                $child_line_item->is_sub_line_item()
-                && ! $child_line_item->is_percent()
-                && ! $child_line_item->is_cancellation()
-            ) {
-                $child_line_item->set_quantity($child_line_item->quantity() - $qty);
-            }
-        }
-        // get cancellation sub line item
-        $cancellation_line_item = EEH_Line_Item::get_descendants_of_type(
-            $ticket_line_item,
-            EEM_Line_Item::type_cancellation
-        );
-        $cancellation_line_item = reset($cancellation_line_item);
-        // verify that this ticket was indeed previously cancelled
-        if ($cancellation_line_item instanceof EE_Line_Item) {
-            // increment cancelled quantity
-            $cancellation_line_item->set_quantity($cancellation_line_item->quantity() + $qty);
-        } else {
-            // create cancellation sub line item
-            $cancellation_line_item = EE_Line_Item::new_instance(
-                [
-                    'LIN_name'       => esc_html__('Cancellation', 'event_espresso'),
-                    'LIN_desc'       => sprintf(
-                        esc_html_x(
-                            'Cancelled %1$s : %2$s',
-                            'Cancelled Ticket Name : 2015-01-01 11:11',
-                            'event_espresso'
-                        ),
-                        $ticket_line_item->name(),
-                        current_time(get_option('date_format') . ' ' . get_option('time_format'))
-                    ),
-                    'LIN_total'      => 0,
-                    'LIN_unit_price' => 0,
-                    'LIN_quantity'   => $qty,
-                    'LIN_is_taxable' => $ticket_line_item->is_taxable(),
-                    'LIN_order'      => count($ticket_line_item->children()),
-                    'LIN_type'       => EEM_Line_Item::type_cancellation,
-                ]
-            );
-            $ticket_line_item->add_child_line_item($cancellation_line_item);
-        }
-        if ($ticket_line_item->save_this_and_descendants() > 0) {
-            // decrement parent line item quantity
-            $event_line_item = $ticket_line_item->parent();
-            if (
-                $event_line_item instanceof EE_Line_Item
-                && $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT
-            ) {
-                $event_line_item->set_quantity($event_line_item->quantity() - $qty);
-                $event_line_item->save();
-            }
-            EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * reinstates (un-cancels?) a previously canceled ticket line item,
-     * by incrementing its quantity by 1, and decrementing its "type_cancellation" sub-line-item.
-     * ALL totals and subtotals will NEED TO BE UPDATED after performing this action
-     *
-     * @param EE_Line_Item $ticket_line_item
-     * @param int          $qty
-     * @return bool success
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function reinstate_canceled_ticket_line_item(EE_Line_Item $ticket_line_item, int $qty = 1): bool
-    {
-        // validate incoming line_item
-        if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The supplied line item must have an Object Type of "Ticket", not %1$s.',
-                        'event_espresso'
-                    ),
-                    $ticket_line_item->type()
-                )
-            );
-        }
-        // get cancellation sub line item
-        $cancellation_line_item = EEH_Line_Item::get_descendants_of_type(
-            $ticket_line_item,
-            EEM_Line_Item::type_cancellation
-        );
-        $cancellation_line_item = reset($cancellation_line_item);
-        // verify that this ticket was indeed previously cancelled
-        if (! $cancellation_line_item instanceof EE_Line_Item) {
-            return false;
-        }
-        if ($cancellation_line_item->quantity() > $qty) {
-            // decrement cancelled quantity
-            $cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
-        } elseif ($cancellation_line_item->quantity() === $qty) {
-            // decrement cancelled quantity in case anyone still has the object kicking around
-            $cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
-            // delete because quantity will end up as 0
-            $cancellation_line_item->delete();
-            // and attempt to destroy the object,
-            // even though PHP won't actually destroy it until it needs the memory
-            unset($cancellation_line_item);
-        } else {
-            // what ?!?! negative quantity ?!?!
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Can not reinstate %1$d cancelled ticket(s) because the cancelled ticket quantity is only %2$d.',
-                        'event_espresso'
-                    ),
-                    $qty,
-                    $cancellation_line_item->quantity()
-                )
-            );
-        }
-        // increment ticket quantity
-        $ticket_line_item->set_quantity($ticket_line_item->quantity() + $qty);
-        if ($ticket_line_item->save_this_and_descendants() > 0) {
-            // increment parent line item quantity
-            $event_line_item = $ticket_line_item->parent();
-            if (
-                $event_line_item instanceof EE_Line_Item
-                && $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT
-            ) {
-                $event_line_item->set_quantity($event_line_item->quantity() + $qty);
-            }
-            EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * calls EEH_Line_Item::find_transaction_grand_total_for_line_item()
-     * then EE_Line_Item::recalculate_total_including_taxes() on the result
-     *
-     * @param EE_Line_Item $line_item
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function get_grand_total_and_recalculate_everything(EE_Line_Item $line_item): float
-    {
-        $grand_total_line_item = EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item);
-        return $grand_total_line_item->recalculate_total_including_taxes();
-    }
-
-
-    /**
-     * Gets the line item which contains the subtotal of all the items
-     *
-     * @param EE_Line_Item        $total_line_item of type EEM_Line_Item::type_total
-     * @param EE_Transaction|null $transaction
-     * @param bool                $create_event_subtotal
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_pre_tax_subtotal(
-        EE_Line_Item $total_line_item,
-        ?EE_Transaction $transaction = null,
-        bool $create_event_subtotal = true
-    ): EE_Line_Item {
-        $pre_tax_subtotal = $total_line_item->get_child_line_item('pre-tax-subtotal');
-        return $pre_tax_subtotal instanceof EE_Line_Item
-            ? $pre_tax_subtotal
-            : self::create_pre_tax_subtotal($total_line_item, $transaction, $create_event_subtotal);
-    }
-
-
-    /**
-     * Gets the line item for the taxes subtotal
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function get_taxes_subtotal(EE_Line_Item $total_line_item): EE_Line_Item
-    {
-        $taxes = $total_line_item->get_child_line_item('taxes');
-        return $taxes ?: self::create_taxes_subtotal($total_line_item);
-    }
-
-
-    /**
-     * sets the TXN ID on an EE_Line_Item if passed a valid EE_Transaction object
-     *
-     * @param EE_Line_Item        $line_item
-     * @param EE_Transaction|null $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function set_TXN_ID(EE_Line_Item $line_item, ?EE_Transaction $transaction = null)
-    {
-        if ($transaction) {
-            /** @type EEM_Transaction $EEM_Transaction */
-            $EEM_Transaction = EE_Registry::instance()->load_model('Transaction');
-            $TXN_ID          = $EEM_Transaction->ensure_is_ID($transaction);
-            $line_item->set_TXN_ID($TXN_ID);
-        }
-    }
-
-
-    /**
-     * Creates a new default total line item for the transaction,
-     * and its tickets subtotal and taxes subtotal line items (and adds the
-     * existing taxes as children of the taxes subtotal line item)
-     *
-     * @param EE_Transaction|null $transaction
-     * @return EE_Line_Item of type total
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function create_total_line_item(?EE_Transaction $transaction = null): EE_Line_Item
-    {
-        $total_line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_code' => 'total',
-                'LIN_name' => esc_html__('Grand Total', 'event_espresso'),
-                'LIN_type' => EEM_Line_Item::type_total,
-                'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TRANSACTION,
-            ]
-        );
-        $total_line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_total_line_item__total_line_item',
-            $total_line_item
-        );
-        self::set_TXN_ID($total_line_item, $transaction);
-        self::create_pre_tax_subtotal($total_line_item, $transaction);
-        self::create_taxes_subtotal($total_line_item, $transaction);
-        return $total_line_item;
-    }
-
-
-    /**
-     * Creates a default items subtotal line item
-     *
-     * @param EE_Line_Item        $total_line_item
-     * @param EE_Transaction|null $transaction
-     * @param bool                $create_event_subtotal
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function create_pre_tax_subtotal(
-        EE_Line_Item $total_line_item,
-        ?EE_Transaction $transaction = null,
-        bool $create_event_subtotal = true
-    ): EE_Line_Item {
-        $pre_tax_line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_code' => 'pre-tax-subtotal',
-                'LIN_name' => esc_html__('Pre-Tax Subtotal', 'event_espresso'),
-                'LIN_type' => EEM_Line_Item::type_sub_total,
-            ]
-        );
-        $pre_tax_line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_pre_tax_subtotal__pre_tax_line_item',
-            $pre_tax_line_item
-        );
-        self::set_TXN_ID($pre_tax_line_item, $transaction);
-        $total_line_item->add_child_line_item($pre_tax_line_item);
-        if ($create_event_subtotal) {
-            self::create_event_subtotal($pre_tax_line_item, $transaction);
-        }
-        return $pre_tax_line_item;
-    }
-
-
-    /**
-     * Creates a line item for the taxes subtotal and finds all the tax prices
-     * and applies taxes to it
-     *
-     * @param EE_Line_Item        $total_line_item of type EEM_Line_Item::type_total
-     * @param EE_Transaction|null $transaction
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected static function create_taxes_subtotal(
-        EE_Line_Item $total_line_item,
-        ?EE_Transaction $transaction = null
-    ): EE_Line_Item {
-        $tax_line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_code'  => 'taxes',
-                'LIN_name'  => esc_html__('Taxes', 'event_espresso'),
-                'LIN_type'  => EEM_Line_Item::type_tax_sub_total,
-                'LIN_order' => 1000,// this should always come last
-            ]
-        );
-        $tax_line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_taxes_subtotal__tax_line_item',
-            $tax_line_item
-        );
-        self::set_TXN_ID($tax_line_item, $transaction);
-        $total_line_item->add_child_line_item($tax_line_item);
-        // and lastly, add the actual taxes
-        self::apply_taxes($total_line_item);
-        return $tax_line_item;
-    }
-
-
-    /**
-     * Creates a default items subtotal line item
-     *
-     * @param EE_Line_Item        $pre_tax_line_item
-     * @param EE_Transaction|null $transaction
-     * @param EE_Event|null       $event
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function create_event_subtotal(
-        EE_Line_Item $pre_tax_line_item,
-        ?EE_Transaction $transaction = null,
-        ?EE_Event $event = null
-    ): EE_Line_Item {
-        // first check if this line item already exists
-        $event_line_item = EEM_Line_Item::instance()->get_one(
-            [
-                [
-                    'LIN_type' => EEM_Line_Item::type_sub_total,
-                    'OBJ_type' => EEM_Line_Item::OBJ_TYPE_EVENT,
-                    'OBJ_ID'   => $event instanceof EE_Event ? $event->ID() : 0,
-                    'TXN_ID'   => $transaction instanceof EE_Transaction ? $transaction->ID() : 0,
-                ],
-            ]
-        );
-        if ($event_line_item instanceof EE_Line_Item) {
-            return $event_line_item;
-        }
-
-        $event_line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_code' => self::get_event_code($event),
-                'LIN_name' => self::get_event_name($event),
-                'LIN_desc' => self::get_event_desc($event),
-                'LIN_type' => EEM_Line_Item::type_sub_total,
-                'OBJ_type' => EEM_Line_Item::OBJ_TYPE_EVENT,
-                'OBJ_ID'   => $event instanceof EE_Event ? $event->ID() : 0,
-            ]
-        );
-        $event_line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_event_subtotal__event_line_item',
-            $event_line_item
-        );
-        self::set_TXN_ID($event_line_item, $transaction);
-        $pre_tax_line_item->add_child_line_item($event_line_item);
-        return $event_line_item;
-    }
-
-
-    /**
-     * Gets what the event ticket's code SHOULD be
-     *
-     * @param EE_Event|null $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_event_code(?EE_Event $event = null): string
-    {
-        return 'event-' . ($event instanceof EE_Event ? $event->ID() : '0');
-    }
-
-
-    /**
-     * Gets the event name
-     *
-     * @param EE_Event|null $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_event_name(?EE_Event $event = null): string
-    {
-        return $event instanceof EE_Event
-            ? mb_substr($event->name(), 0, 245)
-            : esc_html__('Event', 'event_espresso');
-    }
-
-
-    /**
-     * Gets the event excerpt
-     *
-     * @param EE_Event|null $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_event_desc(?EE_Event $event = null): string
-    {
-        return $event instanceof EE_Event ? $event->short_description() : '';
-    }
-
-
-    /**
-     * Given the grand total line item and a ticket, finds the event sub-total
-     * line item the ticket's purchase should be added onto
-     *
-     * @access public
-     * @param EE_Line_Item $grand_total the grand total line item
-     * @param EE_Ticket    $ticket
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket): EE_Line_Item
-    {
-        $first_datetime = $ticket->first_datetime();
-        if (! $first_datetime instanceof EE_Datetime) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('The supplied ticket (ID %d) has no datetimes', 'event_espresso'),
-                    $ticket->ID()
-                )
-            );
-        }
-        $event = $first_datetime->event();
-        if (! $event instanceof EE_Event) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The supplied ticket (ID %d) has no event data associated with it.',
-                        'event_espresso'
-                    ),
-                    $ticket->ID()
-                )
-            );
-        }
-        $events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event);
-        if (! $events_sub_total instanceof EE_Line_Item) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'There is no events sub-total for ticket %s on total line item %d',
-                        'event_espresso'
-                    ),
-                    $ticket->ID(),
-                    $grand_total->ID()
-                )
-            );
-        }
-        return $events_sub_total;
-    }
-
-
-    /**
-     * Gets the event line item
-     *
-     * @param EE_Line_Item  $total_line_item
-     * @param EE_Event|null $event
-     * @return EE_Line_Item for the event subtotal which is a child of $grand_total
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_event_line_item(EE_Line_Item $total_line_item, ?EE_Event $event = null): ?EE_Line_Item
-    {
-        /** @type EE_Event $event */
-        $event           = EEM_Event::instance()->ensure_is_obj($event, true);
-        $event_line_items = EEH_Line_Item::get_event_subtotals($total_line_item);
-        $existing_event_line_item = null;
-        foreach ($event_line_items as $event_line_item) {
-            // default event subtotal, we should only ever find this the first time this method is called
-            $OBJ_ID = $event_line_item->OBJ_ID();
-            if ($OBJ_ID === $event->ID()) {
-                // found existing line item for this event in the cart, so break out of loop and use this one
-                $existing_event_line_item = $event_line_item;
-                break;
-            }
-            if (! $OBJ_ID) {
-                // OK?!?! We have an event subtotal that is not actually associated with any event???
-                // let's just use this line item since it's already there, but first... set the event details
-                $existing_event_line_item = $event_line_item;
-                EEH_Line_Item::set_event_subtotal_details($existing_event_line_item, $event);
-                break;
-            }
-        }
-        unset($event_line_item);
-        if ($existing_event_line_item instanceof EE_Line_Item) {
-            return $existing_event_line_item;
-        }
-        // there is no event sub-total yet for this event, so create a new "event" subtotal
-        $transaction = $total_line_item->transaction();
-        $pre_tax_subtotal = self::get_pre_tax_subtotal($total_line_item, $transaction, false);
-        $new_event_line_item = EEH_Line_Item::create_event_subtotal($pre_tax_subtotal, $transaction, $event);
-        // and set the event details
-        EEH_Line_Item::set_event_subtotal_details($new_event_line_item, $event, $transaction);
-        return $new_event_line_item;
-    }
-
-
-    /**
-     * Creates a default items subtotal line item
-     *
-     * @param EE_Line_Item        $event_line_item
-     * @param EE_Event|null       $event
-     * @param EE_Transaction|null $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function set_event_subtotal_details(
-        EE_Line_Item $event_line_item,
-        EE_Event $event = null,
-        ?EE_Transaction $transaction = null
-    ) {
-        if ($event instanceof EE_Event) {
-            $event_line_item->set_code(self::get_event_code($event));
-            $event_line_item->set_name(self::get_event_name($event));
-            $event_line_item->set_desc(self::get_event_desc($event));
-            $event_line_item->set_OBJ_ID($event->ID());
-        }
-        self::set_TXN_ID($event_line_item, $transaction);
-    }
-
-
-    /**
-     * Finds what taxes should apply, adds them as tax line items under the taxes sub-total,
-     * and recalculates the taxes sub-total and the grand total. Resets the taxes, so
-     * any old taxes are removed
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @param bool         $update_txn_status
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public static function apply_taxes(EE_Line_Item $total_line_item, bool $update_txn_status = false): bool
-    {
-        $total_line_item       = EEH_Line_Item::find_transaction_grand_total_for_line_item($total_line_item);
-        $taxes_line_item       = self::get_taxes_subtotal($total_line_item);
-        $existing_global_taxes = $taxes_line_item->tax_descendants();
-        $updates               = false;
-        // loop thru taxes
-        $global_taxes = EEH_Line_Item::getGlobalTaxes();
-        foreach ($global_taxes as $order => $taxes) {
-            foreach ($taxes as $tax) {
-                if ($tax instanceof EE_Price) {
-                    $found = false;
-                    // check if this is already an existing tax
-                    foreach ($existing_global_taxes as $existing_global_tax) {
-                        if ($tax->ID() === $existing_global_tax->OBJ_ID()) {
-                            // maybe update the tax rate in case it has changed
-                            if ($existing_global_tax->percent() !== $tax->amount()) {
-                                $existing_global_tax->set_percent($tax->amount());
-                                $existing_global_tax->save();
-                                $updates = true;
-                            }
-                            $found = true;
-                            break;
-                        }
-                    }
-                    if (! $found) {
-                        // add a new line item for this global tax
-                        $tax_line_item = apply_filters(
-                            'FHEE__EEH_Line_Item__apply_taxes__tax_line_item',
-                            EE_Line_Item::new_instance(
-                                [
-                                    'LIN_name'       => $tax->name(),
-                                    'LIN_desc'       => $tax->desc(),
-                                    'LIN_percent'    => $tax->amount(),
-                                    'LIN_is_taxable' => false,
-                                    'LIN_order'      => $order,
-                                    'LIN_total'      => 0,
-                                    'LIN_type'       => EEM_Line_Item::type_tax,
-                                    'OBJ_type'       => EEM_Line_Item::OBJ_TYPE_PRICE,
-                                    'OBJ_ID'         => $tax->ID(),
-                                ]
-                            )
-                        );
-                        $updates       = $taxes_line_item->add_child_line_item($tax_line_item) ? true : $updates;
-                    }
-                }
-            }
-        }
-        // only recalculate totals if something changed
-        if ($updates || $update_txn_status) {
-            $total_line_item->recalculate_total_including_taxes($update_txn_status);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Ensures that taxes have been applied to the order, if not applies them.
-     * Returns the total amount of tax
-     *
-     * @param EE_Line_Item|null $total_line_item of type EEM_Line_Item::type_total
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function ensure_taxes_applied(?EE_Line_Item $total_line_item): float
-    {
-        $taxes_subtotal = self::get_taxes_subtotal($total_line_item);
-        if (! $taxes_subtotal->children()) {
-            self::apply_taxes($total_line_item);
-        }
-        return $taxes_subtotal->total();
-    }
-
-
-    /**
-     * Deletes ALL children of the passed line item
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function delete_all_child_items(EE_Line_Item $parent_line_item)
-    {
-        $deleted = 0;
-        foreach ($parent_line_item->children() as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                $deleted += EEH_Line_Item::delete_all_child_items($child_line_item);
-                if ($child_line_item->ID()) {
-                    $child_line_item->delete();
-                    unset($child_line_item);
-                } else {
-                    $parent_line_item->delete_child_line_item($child_line_item->code());
-                }
-                $deleted++;
-            }
-        }
-        return $deleted;
-    }
-
-
-    /**
-     * Deletes the line items as indicated by the line item code(s) provided,
-     * regardless of where they're found in the line item tree. Automatically
-     * re-calculates the line item totals and updates the related transaction. But
-     * DOES NOT automatically upgrade the transaction's registrations' final prices (which
-     * should probably change because of this).
-     * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
-     * after using this, to keep the registration final prices in-sync with the transaction's total.
-     *
-     * @param EE_Line_Item      $total_line_item of type EEM_Line_Item::type_total
-     * @param array|bool|string $line_item_codes
-     * @return int number of items successfully removed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function delete_items(EE_Line_Item $total_line_item, $line_item_codes = false)
-    {
-        if ($total_line_item->type() !== EEM_Line_Item::type_total) {
-            EE_Error::doing_it_wrong(
-                'EEH_Line_Item::delete_items',
-                esc_html__(
-                    'This static method should only be called with a TOTAL line item, otherwise we won\'t recalculate the totals correctly',
-                    'event_espresso'
-                ),
-                '4.6.18'
-            );
-        }
-
-        // check if only a single line_item_id was passed
-        if (! empty($line_item_codes) && ! is_array($line_item_codes)) {
-            // place single line_item_id in an array to appear as multiple line_item_ids
-            $line_item_codes = [$line_item_codes];
-        }
-        $removals = 0;
-        // cycle thru line_item_ids
-        foreach ($line_item_codes as $line_item_id) {
-            $removals += $total_line_item->delete_child_line_item($line_item_id);
-        }
-
-        if ($removals > 0) {
-            $total_line_item->recalculate_taxes_and_tax_total();
-            return $removals;
-        }
-        return false;
-    }
-
-
-    /**
-     * Overwrites the previous tax by clearing out the old taxes, and creates a new
-     * tax and updates the total line item accordingly
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param float        $amount
-     * @param string       $name
-     * @param string       $description
-     * @param string       $code
-     * @param boolean      $add_to_existing_line_item
-     *                          if true, and a duplicate line item with the same code is found,
-     *                          $amount will be added onto it; otherwise will simply set the taxes to match $amount
-     * @return EE_Line_Item the new tax line item created
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function set_total_tax_to(
-        EE_Line_Item $total_line_item,
-        float $amount,
-        string $name = '',
-        string $description = '',
-        string $code = '',
-        bool $add_to_existing_line_item = false
-    ): EE_Line_Item {
-        $tax_subtotal  = self::get_taxes_subtotal($total_line_item);
-        $taxable_total = $total_line_item->taxable_total();
-
-        if ($add_to_existing_line_item) {
-            $new_tax = $tax_subtotal->get_child_line_item($code);
-            EEM_Line_Item::instance()->delete(
-                [['LIN_code' => ['!=', $code], 'LIN_parent' => $tax_subtotal->ID()]]
-            );
-        } else {
-            $new_tax = null;
-            $tax_subtotal->delete_children_line_items();
-        }
-        if ($new_tax) {
-            $new_tax->set_total($new_tax->total() + $amount);
-            $new_tax->set_percent($taxable_total ? $new_tax->total() / $taxable_total * 100 : 0);
-        } else {
-            // no existing tax item. Create it
-            $new_tax = EE_Line_Item::new_instance(
-                [
-                    'TXN_ID'      => $total_line_item->TXN_ID(),
-                    'LIN_name'    => $name ?: esc_html__('Tax', 'event_espresso'),
-                    'LIN_desc'    => $description ?: '',
-                    'LIN_percent' => $taxable_total ? ($amount / $taxable_total * 100) : 0,
-                    'LIN_total'   => $amount,
-                    'LIN_parent'  => $tax_subtotal->ID(),
-                    'LIN_type'    => EEM_Line_Item::type_tax,
-                    'LIN_code'    => $code,
-                ]
-            );
-        }
-
-        $new_tax = apply_filters(
-            'FHEE__EEH_Line_Item__set_total_tax_to__new_tax_subtotal',
-            $new_tax,
-            $total_line_item
-        );
-        $new_tax->save();
-        $tax_subtotal->set_total($new_tax->total());
-        $tax_subtotal->save();
-        $total_line_item->recalculate_total_including_taxes();
-        return $new_tax;
-    }
-
-
-    /**
-     * Makes all the line items which are children of $line_item taxable (or not).
-     * Does NOT save the line items
-     *
-     * @param EE_Line_Item $line_item
-     * @param boolean      $taxable
-     * @param string|null  $code_substring_for_whitelist if this string is part of the line item's code
-     *                                                   it will be whitelisted (ie, except from becoming taxable)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function set_line_items_taxable(
-        EE_Line_Item $line_item,
-        bool $taxable = true,
-        ?string $code_substring_for_whitelist = null
-    ) {
-        $whitelisted = false;
-        if ($code_substring_for_whitelist !== null) {
-            $whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false;
-        }
-        if (! $whitelisted && $line_item->is_line_item()) {
-            $line_item->set_is_taxable($taxable);
-        }
-        foreach ($line_item->children() as $child_line_item) {
-            EEH_Line_Item::set_line_items_taxable(
-                $child_line_item,
-                $taxable,
-                $code_substring_for_whitelist
-            );
-        }
-    }
-
-
-    /**
-     * Gets all descendants that are event subtotals
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @uses  EEH_Line_Item::get_subtotals_of_object_type()
-     */
-    public static function get_event_subtotals(EE_Line_Item $parent_line_item): array
-    {
-        return self::get_subtotals_of_object_type($parent_line_item, EEM_Line_Item::OBJ_TYPE_EVENT);
-    }
-
-
-    /**
-     * Gets all descendants subtotals that match the supplied object type
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $obj_type
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
-     */
-    public static function get_subtotals_of_object_type(EE_Line_Item $parent_line_item, string $obj_type = ''): array
-    {
-        return self::_get_descendants_by_type_and_object_type(
-            $parent_line_item,
-            EEM_Line_Item::type_sub_total,
-            $obj_type
-        );
-    }
-
-
-    /**
-     * Gets all descendants that are tickets
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @uses  EEH_Line_Item::get_line_items_of_object_type()
-     */
-    public static function get_ticket_line_items(EE_Line_Item $parent_line_item): array
-    {
-        return self::get_line_items_of_object_type(
-            $parent_line_item,
-            EEM_Line_Item::OBJ_TYPE_TICKET
-        );
-    }
-
-
-    /**
-     * Gets all descendants subtotals that match the supplied object type
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $obj_type
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
-     */
-    public static function get_line_items_of_object_type(EE_Line_Item $parent_line_item, string $obj_type = ''): array
-    {
-        return self::_get_descendants_by_type_and_object_type(
-            $parent_line_item,
-            EEM_Line_Item::type_line_item,
-            $obj_type
-        );
-    }
-
-
-    /**
-     * Gets all the descendants (ie, children or children of children etc) that are of the type 'tax'
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @uses  EEH_Line_Item::get_descendants_of_type()
-     */
-    public static function get_tax_descendants(EE_Line_Item $parent_line_item): array
-    {
-        return EEH_Line_Item::get_descendants_of_type(
-            $parent_line_item,
-            EEM_Line_Item::type_tax
-        );
-    }
-
-
-    /**
-     * Gets all the real items purchased which are children of this item
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @uses  EEH_Line_Item::get_descendants_of_type()
-     */
-    public static function get_line_item_descendants(EE_Line_Item $parent_line_item): array
-    {
-        return EEH_Line_Item::get_descendants_of_type(
-            $parent_line_item,
-            EEM_Line_Item::type_line_item
-        );
-    }
-
-
-    /**
-     * Gets all descendants of supplied line item that match the supplied line item type
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $line_item_type   one of the EEM_Line_Item constants
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
-     */
-    public static function get_descendants_of_type(EE_Line_Item $parent_line_item, string $line_item_type): array
-    {
-        return self::_get_descendants_by_type_and_object_type(
-            $parent_line_item,
-            $line_item_type
-        );
-    }
-
-
-    /**
-     * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type
-     * as well
-     *
-     * @param EE_Line_Item $parent_line_item  - the line item to find descendants of
-     * @param string       $line_item_type    one of the EEM_Line_Item constants
-     * @param string|null  $obj_type          object model class name (minus prefix) or NULL to ignore object type when
-     *                                        searching
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function _get_descendants_by_type_and_object_type(
-        EE_Line_Item $parent_line_item,
-        string $line_item_type,
-        ?string $obj_type = null
-    ): array {
-        $objects = [];
-        foreach ($parent_line_item->children() as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                if (
-                    $child_line_item->type() === $line_item_type
-                    && (
-                        $child_line_item->OBJ_type() === $obj_type || $obj_type === null
-                    )
-                ) {
-                    $objects[] = $child_line_item;
-                } else {
-                    // go-through-all-its children looking for more matches
-                    $objects = array_merge(
-                        $objects,
-                        self::_get_descendants_by_type_and_object_type(
-                            $child_line_item,
-                            $line_item_type,
-                            $obj_type
-                        )
-                    );
-                }
-            }
-        }
-        return $objects;
-    }
-
-
-    /**
-     * Gets all descendants subtotals that match the supplied object type
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $OBJ_type         object type (like Event)
-     * @param array        $OBJ_IDs          array of OBJ_IDs
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
-     */
-    public static function get_line_items_by_object_type_and_IDs(
-        EE_Line_Item $parent_line_item,
-        string $OBJ_type = '',
-        array $OBJ_IDs = []
-    ): array {
-        return self::_get_descendants_by_object_type_and_object_ID(
-            $parent_line_item,
-            $OBJ_type,
-            $OBJ_IDs
-        );
-    }
-
-
-    /**
-     * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type
-     * as well
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $OBJ_type         object type (like Event)
-     * @param array        $OBJ_IDs          array of OBJ_IDs
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function _get_descendants_by_object_type_and_object_ID(
-        EE_Line_Item $parent_line_item,
-        string $OBJ_type,
-        array $OBJ_IDs
-    ): array {
-        $objects = [];
-        foreach ($parent_line_item->children() as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                if (
-                    $child_line_item->OBJ_type() === $OBJ_type
-                    && in_array($child_line_item->OBJ_ID(), $OBJ_IDs)
-                ) {
-                    $objects[] = $child_line_item;
-                } else {
-                    // go-through-all-its children looking for more matches
-                    $objects = array_merge(
-                        $objects,
-                        self::_get_descendants_by_object_type_and_object_ID(
-                            $child_line_item,
-                            $OBJ_type,
-                            $OBJ_IDs
-                        )
-                    );
-                }
-            }
-        }
-        return $objects;
-    }
-
-
-    /**
-     * Uses a breadth-first-search in order to find the nearest descendant of
-     * the specified type and returns it, else NULL
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $type             like one of the EEM_Line_Item::type_*
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @uses  EEH_Line_Item::_get_nearest_descendant()
-     */
-    public static function get_nearest_descendant_of_type(EE_Line_Item $parent_line_item, string $type): ?EE_Line_Item
-    {
-        return self::_get_nearest_descendant($parent_line_item, 'LIN_type', $type);
-    }
-
-
-    /**
-     * Uses a breadth-first-search in order to find the nearest descendant
-     * having the specified LIN_code and returns it, else NULL
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $code             any value used for LIN_code
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @uses  EEH_Line_Item::_get_nearest_descendant()
-     */
-    public static function get_nearest_descendant_having_code(
-        EE_Line_Item $parent_line_item,
-        string $code
-    ): ?EE_Line_Item {
-        return self::_get_nearest_descendant($parent_line_item, 'LIN_code', $code);
-    }
-
-
-    /**
-     * Uses a breadth-first-search in order to find the nearest descendant
-     * having the specified LIN_code and returns it, else NULL
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $search_field     name of EE_Line_Item property
-     * @param mixed        $value            any value stored in $search_field
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected static function _get_nearest_descendant(
-        EE_Line_Item $parent_line_item,
-        string $search_field,
-        $value
-    ): ?EE_Line_Item {
-        foreach ($parent_line_item->children() as $child) {
-            if ($child->get($search_field) == $value) {
-                return $child;
-            }
-        }
-        foreach ($parent_line_item->children() as $child) {
-            $descendant_found = self::_get_nearest_descendant(
-                $child,
-                $search_field,
-                $value
-            );
-            if ($descendant_found) {
-                return $descendant_found;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * if passed line item has a TXN ID, uses that to jump directly to the grand total line item for the transaction,
-     * else recursively walks up the line item tree until a parent of type total is found,
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function find_transaction_grand_total_for_line_item(EE_Line_Item $line_item): EE_Line_Item
-    {
-        if ($line_item->is_total()) {
-            return $line_item;
-        }
-        if ($line_item->TXN_ID()) {
-            $total_line_item = $line_item->transaction()->total_line_item(false);
-            if ($total_line_item instanceof EE_Line_Item) {
-                return $total_line_item;
-            }
-        } else {
-            $line_item_parent = $line_item->parent();
-            if ($line_item_parent instanceof EE_Line_Item) {
-                if ($line_item_parent->is_total()) {
-                    return $line_item_parent;
-                }
-                return EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item_parent);
-            }
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'A valid grand total for line item %1$d was not found.',
-                    'event_espresso'
-                ),
-                $line_item->ID()
-            )
-        );
-    }
-
-
-    /**
-     * Prints out a representation of the line item tree
-     *
-     * @param EE_Line_Item $line_item
-     * @param int          $indentation
-     * @param bool         $top_level
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function visualize(EE_Line_Item $line_item, int $indentation = 0, bool $top_level = true)
-    {
-        if (! defined('WP_DEBUG') || ! WP_DEBUG) {
-            return;
-        }
-        $no_formatting  = defined('EE_TESTS_DIR') || (defined('DOING_AJAX') && DOING_AJAX);
-        $new_line = $no_formatting ? "\n" : '<br />';
-        if ($top_level && ! $no_formatting) {
-            echo '<div style="position: relative; z-index: 9999; margin: 2rem;">';
-            echo '<pre style="padding: 2rem 3rem; color: #00CCFF; background: #363636;">';
-        }
-        if ($top_level || $indentation) {
-            // echo $top_level ? "$new_line$new_line" : $new_line;
-            echo $new_line;
-        }
-        echo str_repeat('. ', $indentation);
-        $breakdown = '';
-        if ($line_item->is_line_item() || $line_item->is_sub_line_item() || $line_item->isTax()) {
-            if ($line_item->is_percent()) {
-                $breakdown = "{$line_item->percent()}%";
-            } else {
-                $breakdown = "\${$line_item->unit_price()} x {$line_item->quantity()}";
-            }
-        }
-        echo wp_kses($line_item->name(), AllowedTags::getAllowedTags());
-        echo " [ ID:{$line_item->ID()} · qty:{$line_item->quantity()} ] {$line_item->type()}";
-        echo " · \${$line_item->total()} · \${$line_item->pretaxTotal()}";
-        if ($breakdown) {
-            echo " ( $breakdown )";
-        }
-        if ($line_item->is_taxable()) {
-            echo '  * taxable';
-        }
-        $children = $line_item->children();
-        if ($children) {
-            foreach ($children as $child) {
-                self::visualize($child, $indentation + 1, false);
-            }
-        }
-        if ($top_level) {
-            echo $no_formatting ? $new_line : "$new_line</pre></div>$new_line";
-        }
-    }
-
-
-    /**
-     * Calculates the registration's final price, taking into account that they
-     * need to not only help pay for their OWN ticket, but also any transaction-wide surcharges and taxes,
-     * and receive a portion of any transaction-wide discounts.
-     * eg1, if I buy a $1 ticket and brent buys a $9 ticket, and we receive a $5 discount
-     * then I'll get 1/10 of that $5 discount, which is $0.50, and brent will get
-     * 9/10ths of that $5 discount, which is $4.50. So my final price should be $0.50
-     * and brent's final price should be $5.50.
-     * In order to do this, we basically need to traverse the line item tree calculating
-     * the running totals (just as if we were recalculating the total), but when we identify
-     * regular line items, we need to keep track of their share of the grand total.
-     * Also, we need to keep track of the TAXABLE total for each ticket purchase, so
-     * we can know how to apply taxes to it. (Note: "taxable total" does not equal the "pretax total"
-     * when there are non-taxable items; otherwise they would be the same)
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $billable_ticket_quantities          array of EE_Ticket IDs and their corresponding quantity
-     *                                                          that can be included in price calculations at this
-     *                                                          moment
-     * @return array        keys are line items for tickets IDs and values are their share of the running total,
-     *                                                          plus the key 'total', and 'taxable' which also has keys
-     *                                                          of all the ticket IDs. Eg array(
-     *                                                          12 => 4.3
-     *                                                          23 => 8.0
-     *                                                          'total' => 16.6,
-     *                                                          'taxable' => array(
-     *                                                          12 => 10,
-     *                                                          23 => 4
-     *                                                          ).
-     *                                                          So to find which registrations have which final price,
-     *                                                          we need to find which line item is theirs, which can be
-     *                                                          done with
-     *                                                          `EEM_Line_Item::instance()->get_line_item_for_registration(
-     *                                                          $registration );`
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function calculate_reg_final_prices_per_line_item(
-        EE_Line_Item $line_item,
-        array $billable_ticket_quantities = []
-    ): array {
-        $running_totals = [
-            'total'   => 0,
-            'taxable' => ['total' => 0],
-        ];
-        foreach ($line_item->children() as $child_line_item) {
-            switch ($child_line_item->type()) {
-                case EEM_Line_Item::type_sub_total:
-                    $running_totals_from_subtotal = EEH_Line_Item::calculate_reg_final_prices_per_line_item(
-                        $child_line_item,
-                        $billable_ticket_quantities
-                    );
-                    // combine arrays but preserve numeric keys
-                    $running_totals                     = array_replace_recursive(
-                        $running_totals_from_subtotal,
-                        $running_totals
-                    );
-                    $running_totals['total']            += $running_totals_from_subtotal['total'];
-                    $running_totals['taxable']['total'] += $running_totals_from_subtotal['taxable']['total'];
-                    break;
-
-                case EEM_Line_Item::type_tax_sub_total:
-                    // find how much the taxes percentage is
-                    if ($child_line_item->percent() !== 0.0) {
-                        $tax_percent_decimal = $child_line_item->percent() / 100;
-                    } else {
-                        $tax_percent_decimal = EE_Taxes::get_total_taxes_percentage() / 100;
-                    }
-                    // and apply to all the taxable totals, and add to the pretax totals
-                    foreach ($running_totals as $line_item_id => $this_running_total) {
-                        // "total" and "taxable" array key is an exception
-                        if ($line_item_id === 'taxable') {
-                            continue;
-                        }
-                        $taxable_total                   = $running_totals['taxable'][ $line_item_id ];
-                        $running_totals[ $line_item_id ] += ($taxable_total * $tax_percent_decimal);
-                    }
-                    break;
-
-                case EEM_Line_Item::type_line_item:
-                    // ticket line items or ????
-                    if ($child_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) {
-                        // kk it's a ticket
-                        if (isset($running_totals[ $child_line_item->ID() ])) {
-                            // huh? that shouldn't happen.
-                            $running_totals['total'] += $child_line_item->total();
-                        } else {
-                            // it's not in our running totals yet. great.
-                            if ($child_line_item->is_taxable()) {
-                                $taxable_amount = $child_line_item->unit_price();
-                            } else {
-                                $taxable_amount = 0;
-                            }
-                            // are we only calculating totals for some tickets?
-                            if (isset($billable_ticket_quantities[ $child_line_item->OBJ_ID() ])) {
-                                $quantity = $billable_ticket_quantities[ $child_line_item->OBJ_ID() ];
-
-                                $running_totals[ $child_line_item->ID() ]            = $quantity
-                                    ? $child_line_item->unit_price()
-                                    : 0;
-                                $running_totals['taxable'][ $child_line_item->ID() ] = $quantity
-                                    ? $taxable_amount
-                                    : 0;
-                            } else {
-                                $quantity                                            = $child_line_item->quantity();
-                                $running_totals[ $child_line_item->ID() ]            = $child_line_item->unit_price();
-                                $running_totals['taxable'][ $child_line_item->ID() ] = $taxable_amount;
-                            }
-                            $running_totals['taxable']['total'] += $taxable_amount * $quantity;
-                            $running_totals['total']            += $child_line_item->unit_price() * $quantity;
-                        }
-                    } else {
-                        // it's some other type of item added to the cart
-                        // it should affect the running totals
-                        // basically we want to convert it into a PERCENT modifier. Because
-                        // more clearly affect all registration's final price equally
-                        $line_items_percent_of_running_total = $running_totals['total'] > 0
-                            ? ($child_line_item->total() / $running_totals['total']) + 1
-                            : 1;
-                        foreach ($running_totals as $line_item_id => $this_running_total) {
-                            // the "taxable" array key is an exception
-                            if ($line_item_id === 'taxable') {
-                                continue;
-                            }
-                            // update the running totals
-                            // yes this actually even works for the running grand total!
-                            $running_totals[ $line_item_id ] =
-                                $line_items_percent_of_running_total * $this_running_total;
-
-                            if ($child_line_item->is_taxable()) {
-                                $running_totals['taxable'][ $line_item_id ] =
-                                    $line_items_percent_of_running_total * $running_totals['taxable'][ $line_item_id ];
-                            }
-                        }
-                    }
-                    break;
-            }
-        }
-        return $running_totals;
-    }
-
-
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @param EE_Line_Item $ticket_line_item
-     * @return float | null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws OutOfRangeException
-     * @throws ReflectionException
-     */
-    public static function calculate_final_price_for_ticket_line_item(
-        EE_Line_Item $total_line_item,
-        EE_Line_Item $ticket_line_item
-    ): ?float {
-        static $final_prices_per_ticket_line_item = [];
-        if (
-            empty($final_prices_per_ticket_line_item)
-            || empty($final_prices_per_ticket_line_item[ $total_line_item->ID() ])
-        ) {
-            $final_prices_per_ticket_line_item[ $total_line_item->ID() ] =
-                EEH_Line_Item::calculate_reg_final_prices_per_line_item(
-                    $total_line_item
-                );
-        }
-        // ok now find this new registration's final price
-        if (isset($final_prices_per_ticket_line_item[ $total_line_item->ID() ][ $ticket_line_item->ID() ])) {
-            return $final_prices_per_ticket_line_item[ $total_line_item->ID() ][ $ticket_line_item->ID() ];
-        }
-        $message = sprintf(
-            esc_html__(
-                'The final price for the ticket line item (ID:%1$d) on the total line item (ID:%2$d) could not be calculated.',
-                'event_espresso'
-            ),
-            $ticket_line_item->ID(),
-            $total_line_item->ID()
-        );
-        if (WP_DEBUG) {
-            $message .= '<br>' . print_r($final_prices_per_ticket_line_item, true);
-            throw new OutOfRangeException($message);
-        }
-        EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message);
-        return null;
-    }
-
-
-    /**
-     * Creates a duplicate of the line item tree, except only includes billable items
-     * and the portion of line items attributed to billable things
-     *
-     * @param EE_Line_Item      $line_item
-     * @param EE_Registration[] $registrations
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function billable_line_item_tree(EE_Line_Item $line_item, array $registrations): EE_Line_Item
-    {
-        $copy_li = EEH_Line_Item::billable_line_item($line_item, $registrations);
-        foreach ($line_item->children() as $child_li) {
-            $copy_li->add_child_line_item(
-                EEH_Line_Item::billable_line_item_tree($child_li, $registrations)
-            );
-        }
-        // if this is the grand total line item, make sure the totals all add up
-        // (we could have duplicated this logic AS we copied the line items, but
-        // it seems DRYer this way)
-        if ($copy_li->type() === EEM_Line_Item::type_total) {
-            $copy_li->recalculate_total_including_taxes();
-        }
-        return $copy_li;
-    }
-
-
-    /**
-     * Creates a new, unsaved line item from $line_item that factors in the
-     * number of billable registrations on $registrations.
-     *
-     * @param EE_Line_Item      $line_item
-     * @param EE_Registration[] $registrations
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function billable_line_item(EE_Line_Item $line_item, array $registrations): EE_Line_Item
-    {
-        $new_li_fields = $line_item->model_field_array();
-        if (
-            $line_item->type() === EEM_Line_Item::type_line_item &&
-            $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
-        ) {
-            $count = 0;
-            foreach ($registrations as $registration) {
-                if (
-                    $line_item->OBJ_ID() === $registration->ticket_ID() &&
-                    in_array(
-                        $registration->status_ID(),
-                        EEM_Registration::reg_statuses_that_allow_payment(),
-                        true
-                    )
-                ) {
-                    $count++;
-                }
-            }
-            $new_li_fields['LIN_quantity'] = $count;
-        }
-        // don't set the total. We'll leave that up to the code that calculates it
-        unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent'], $new_li_fields['LIN_total']);
-        return EE_Line_Item::new_instance($new_li_fields);
-    }
-
-
-    /**
-     * Returns a modified line item tree where all the subtotals which have a total of 0
-     * are removed, and line items with a quantity of 0
-     *
-     * @param EE_Line_Item $line_item |null
-     * @return EE_Line_Item|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function non_empty_line_items(EE_Line_Item $line_item): ?EE_Line_Item
-    {
-        $copied_li = EEH_Line_Item::non_empty_line_item($line_item);
-        if ($copied_li === null) {
-            return null;
-        }
-        // if this is an event subtotal, we want to only include it if it
-        // has a non-zero total and at least one ticket line item child
-        $ticket_children = 0;
-        foreach ($line_item->children() as $child_li) {
-            $child_li_copy = EEH_Line_Item::non_empty_line_items($child_li);
-            if ($child_li_copy !== null) {
-                $copied_li->add_child_line_item($child_li_copy);
-                if (
-                    $child_li_copy->type() === EEM_Line_Item::type_line_item &&
-                    $child_li_copy->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
-                ) {
-                    $ticket_children++;
-                }
-            }
-        }
-        // if this is an event subtotal with NO ticket children
-        // we basically want to ignore it
-        if (
-            $ticket_children === 0
-            && $line_item->type() === EEM_Line_Item::type_sub_total
-            && $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT
-            && $line_item->total() === 0.0
-        ) {
-            return null;
-        }
-        return $copied_li;
-    }
-
-
-    /**
-     * Creates a new, unsaved line item, but if it's a ticket line item
-     * with a total of 0, or a subtotal of 0, returns null instead
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function non_empty_line_item(EE_Line_Item $line_item): ?EE_Line_Item
-    {
-        if (
-            $line_item->type() === EEM_Line_Item::type_line_item
-            && $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
-            && $line_item->quantity() === 0
-        ) {
-            return null;
-        }
-        $new_li_fields = $line_item->model_field_array();
-        // don't set the total. We'll leave that up to the code that calculates it
-        unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent']);
-        return EE_Line_Item::new_instance($new_li_fields);
-    }
-
-
-    /**
-     * Cycles through all the ticket line items for the supplied total line item
-     * and ensures that the line item's "is_taxable" field matches that of its corresponding ticket
-     *
-     * @param EE_Line_Item $total_line_item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.9.79.p
-     */
-    public static function resetIsTaxableForTickets(EE_Line_Item $total_line_item)
-    {
-        $ticket_line_items = self::get_ticket_line_items($total_line_item);
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (
-                $ticket_line_item instanceof EE_Line_Item
-                && $ticket_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
-            ) {
-                $ticket = $ticket_line_item->ticket();
-                if ($ticket instanceof EE_Ticket && $ticket->taxable() !== $ticket_line_item->is_taxable()) {
-                    $ticket_line_item->set_is_taxable($ticket->taxable());
-                    $ticket_line_item->save();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    private static function getGlobalTaxes(): array
-    {
-        if (EEH_Line_Item::$global_taxes === null) {
-            /** @type EEM_Price $EEM_Price */
-            $EEM_Price = EE_Registry::instance()->load_model('Price');
-            // get array of taxes via Price Model
-            EEH_Line_Item::$global_taxes = $EEM_Price->get_all_prices_that_are_taxes();
-            ksort(EEH_Line_Item::$global_taxes);
-        }
-        return EEH_Line_Item::$global_taxes;
-    }
-
-
-
-    /**************************************** @DEPRECATED METHODS *************************************** */
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function get_items_subtotal(EE_Line_Item $total_line_item): EE_Line_Item
-    {
-        EE_Error::doing_it_wrong(
-            'EEH_Line_Item::get_items_subtotal()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::get_pre_tax_subtotal()'
-            ),
-            '4.6.0'
-        );
-        return self::get_pre_tax_subtotal($total_line_item);
-    }
-
-
-    /**
-     * @param EE_Transaction|null $transaction
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function create_default_total_line_item(?EE_Transaction $transaction = null): EE_Line_Item
-    {
-        EE_Error::doing_it_wrong(
-            'EEH_Line_Item::create_default_total_line_item()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::create_total_line_item()'
-            ),
-            '4.6.0'
-        );
-        return self::create_total_line_item($transaction);
-    }
-
-
-    /**
-     * @param EE_Line_Item        $total_line_item
-     * @param EE_Transaction|null $transaction
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function create_default_tickets_subtotal(
-        EE_Line_Item $total_line_item,
-        ?EE_Transaction $transaction = null
-    ): EE_Line_Item {
-        EE_Error::doing_it_wrong(
-            'EEH_Line_Item::create_default_tickets_subtotal()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::create_pre_tax_subtotal()'
-            ),
-            '4.6.0'
-        );
-        return self::create_pre_tax_subtotal($total_line_item, $transaction);
-    }
-
-
-    /**
-     * @param EE_Line_Item        $total_line_item
-     * @param EE_Transaction|null $transaction
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function create_default_taxes_subtotal(
-        EE_Line_Item $total_line_item,
-        ?EE_Transaction $transaction = null
-    ): EE_Line_Item {
-        EE_Error::doing_it_wrong(
-            'EEH_Line_Item::create_default_taxes_subtotal()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::create_taxes_subtotal()'
-            ),
-            '4.6.0'
-        );
-        return self::create_taxes_subtotal($total_line_item, $transaction);
-    }
-
-
-    /**
-     * @param EE_Line_Item        $total_line_item
-     * @param EE_Transaction|null $transaction
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function create_default_event_subtotal(
-        EE_Line_Item $total_line_item,
-        ?EE_Transaction $transaction = null
-    ): EE_Line_Item {
-        EE_Error::doing_it_wrong(
-            'EEH_Line_Item::create_default_event_subtotal()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::create_event_subtotal()'
-            ),
-            '4.6.0'
-        );
-        return self::create_event_subtotal($total_line_item, $transaction);
-    }
+	/**
+	 * @var EE_Line_Item[]|null
+	 */
+	private static ?array $global_taxes = null;
+
+
+	/**
+	 * Adds a simple item (unrelated to any other model object) to the provided PARENT line item.
+	 * Does NOT automatically re-calculate the line item totals or update the related transaction.
+	 * You should call recalculate_total_including_taxes() on the grant total line item after this
+	 * to update the subtotals, and EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
+	 * to keep the registration final prices in-sync with the transaction's total.
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @param string       $name
+	 * @param float        $unit_price
+	 * @param string       $description
+	 * @param int          $quantity
+	 * @param boolean      $taxable
+	 * @param string|null  $code if set to a value, ensures there is only one line item with that code
+	 * @param bool         $return_item
+	 * @param bool         $recalculate_totals
+	 * @return boolean|EE_Line_Item success
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function add_unrelated_item(
+		EE_Line_Item $parent_line_item,
+		string $name,
+		float $unit_price,
+		string $description = '',
+		int $quantity = 1,
+		bool $taxable = false,
+		?string $code = null,
+		bool $return_item = false,
+		bool $recalculate_totals = true
+	) {
+		$items_subtotal = self::get_pre_tax_subtotal($parent_line_item);
+		$line_item      = EE_Line_Item::new_instance(
+			[
+				'LIN_name'       => $name,
+				'LIN_desc'       => $description,
+				'LIN_unit_price' => $unit_price,
+				'LIN_quantity'   => $quantity,
+				'LIN_percent'    => null,
+				'LIN_is_taxable' => $taxable,
+				'LIN_order'      => count($items_subtotal->children()),
+				'LIN_total'      => $unit_price * $quantity,
+				'LIN_type'       => EEM_Line_Item::type_line_item,
+				'LIN_code'       => $code,
+			]
+		);
+		$line_item      = apply_filters(
+			'FHEE__EEH_Line_Item__add_unrelated_item__line_item',
+			$line_item,
+			$parent_line_item
+		);
+		$added          = self::add_item($parent_line_item, $line_item, $recalculate_totals);
+		return $return_item ? $line_item : $added;
+	}
+
+
+	/**
+	 * Adds a simple item ( unrelated to any other model object) to the total line item,
+	 * in the correct spot in the line item tree. Does not automatically
+	 * re-calculate the line item totals, nor update the related transaction, nor upgrade the transaction's
+	 * registrations' final prices (which should probably change because of this).
+	 * You should call recalculate_total_including_taxes() on the grand total line item, then
+	 * update the transaction's total, and EE_Registration_Processor::update_registration_final_prices()
+	 * after using this, to keep the registration final prices in-sync with the transaction's total.
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @param string       $name
+	 * @param float        $percentage_amount
+	 * @param string       $description
+	 * @param boolean      $taxable
+	 * @param string|null  $code
+	 * @param bool         $return_item
+	 * @return boolean|EE_Line_Item success
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function add_percentage_based_item(
+		EE_Line_Item $parent_line_item,
+		string $name,
+		float $percentage_amount,
+		string $description = '',
+		bool $taxable = false,
+		?string $code = null,
+		bool $return_item = false
+	) {
+		$total     = $percentage_amount * $parent_line_item->total() / 100;
+		$line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_name'       => $name,
+				'LIN_desc'       => $description,
+				'LIN_unit_price' => 0,
+				'LIN_percent'    => $percentage_amount,
+				'LIN_is_taxable' => $taxable,
+				'LIN_total'      => $total,
+				'LIN_type'       => EEM_Line_Item::type_line_item,
+				'LIN_parent'     => $parent_line_item->ID(),
+				'LIN_code'       => $code,
+				'TXN_ID'         => $parent_line_item->TXN_ID(),
+			]
+		);
+		$line_item = apply_filters(
+			'FHEE__EEH_Line_Item__add_percentage_based_item__line_item',
+			$line_item
+		);
+		$added     = $parent_line_item->add_child_line_item($line_item, false);
+		return $return_item ? $line_item : $added;
+	}
+
+
+	/**
+	 * Returns the new line item created by adding a purchase of the ticket
+	 * ensures that ticket line item is saved, and that cart total has been recalculated.
+	 * If this ticket has already been purchased, just increments its count.
+	 * Automatically re-calculates the line item totals and updates the related transaction. But
+	 * DOES NOT automatically upgrade the transaction's registrations' final prices (which
+	 * should probably change because of this).
+	 * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
+	 * after using this, to keep the registration final prices in-sync with the transaction's total.
+	 *
+	 * @param EE_Line_Item|null $total_line_item grand total line item of type EEM_Line_Item::type_total
+	 * @param EE_Ticket         $ticket
+	 * @param int               $qty
+	 * @param bool              $recalculate_totals
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function add_ticket_purchase(
+		?EE_Line_Item $total_line_item,
+		EE_Ticket $ticket,
+		int $qty = 1,
+		bool $recalculate_totals = true
+	): ?EE_Line_Item {
+		if (! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'A valid line item total is required in order to add tickets. A line item of type "%s" was passed.',
+						'event_espresso'
+					),
+					$ticket->ID(),
+					$total_line_item->ID()
+				)
+			);
+		}
+		// either increment the qty for an existing ticket
+		$line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty);
+		// or add a new one
+		if (! $line_item instanceof EE_Line_Item) {
+			$line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty);
+		}
+		if ($recalculate_totals) {
+			$total_line_item->recalculate_total_including_taxes();
+		}
+		return $line_item;
+	}
+
+
+	/**
+	 * Returns the new line item created by adding a purchase of the ticket
+	 *
+	 * @param EE_Line_Item|null $total_line_item
+	 * @param EE_Ticket         $ticket
+	 * @param int               $qty
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function increment_ticket_qty_if_already_in_cart(
+		?EE_Line_Item $total_line_item,
+		EE_Ticket $ticket,
+		int $qty = 1
+	): ?EE_Line_Item {
+		$line_item = null;
+		if ($total_line_item instanceof EE_Line_Item && $total_line_item->is_total()) {
+			$ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
+			foreach ($ticket_line_items as $ticket_line_item) {
+				if (
+					$ticket_line_item instanceof EE_Line_Item
+					&& $ticket_line_item->OBJ_ID() === $ticket->ID()
+				) {
+					$line_item = $ticket_line_item;
+					break;
+				}
+			}
+		}
+		if ($line_item instanceof EE_Line_Item) {
+			EEH_Line_Item::increment_quantity($line_item, $qty);
+			return $line_item;
+		}
+		return null;
+	}
+
+
+	/**
+	 * Increments the line item and all its children's quantity by $qty (but percent line items are unaffected).
+	 * Does NOT save or recalculate other line items totals
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int          $qty
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function increment_quantity(EE_Line_Item $line_item, int $qty = 1)
+	{
+		if (! $line_item->is_percent()) {
+			$qty += $line_item->quantity();
+			$line_item->set_quantity($qty);
+			$line_item->set_total($line_item->unit_price() * $qty);
+			$line_item->save();
+		}
+		foreach ($line_item->children() as $child) {
+			if ($child->is_sub_line_item()) {
+				EEH_Line_Item::update_quantity($child, $qty);
+			}
+		}
+	}
+
+
+	/**
+	 * Decrements the line item and all its children's quantity by $qty (but percent line items are unaffected).
+	 * Does NOT save or recalculate other line items totals
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int          $qty
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function decrement_quantity(EE_Line_Item $line_item, int $qty = 1)
+	{
+		if (! $line_item->is_percent()) {
+			$qty = $line_item->quantity() - $qty;
+			$qty = max($qty, 0);
+			$line_item->set_quantity($qty);
+			$line_item->set_total($line_item->unit_price() * $qty);
+			$line_item->save();
+		}
+		foreach ($line_item->children() as $child) {
+			if ($child->is_sub_line_item()) {
+				EEH_Line_Item::update_quantity($child, $qty);
+			}
+		}
+	}
+
+
+	/**
+	 * Updates the line item and its children's quantities to the specified number.
+	 * Does NOT save them or recalculate totals.
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int          $new_quantity
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function update_quantity(EE_Line_Item $line_item, int $new_quantity)
+	{
+		if (! $line_item->is_percent()) {
+			$line_item->set_quantity($new_quantity);
+			$line_item->set_total($line_item->unit_price() * $new_quantity);
+			$line_item->save();
+		}
+		foreach ($line_item->children() as $child) {
+			if ($child->is_sub_line_item()) {
+				EEH_Line_Item::update_quantity($child, $new_quantity);
+			}
+		}
+	}
+
+
+	/**
+	 * Returns the new line item created by adding a purchase of the ticket
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @param EE_Ticket    $ticket
+	 * @param int          $qty
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function create_ticket_line_item(
+		EE_Line_Item $total_line_item,
+		EE_Ticket $ticket,
+		int $qty = 1
+	): EE_Line_Item {
+		$datetimes           = $ticket->datetimes();
+		$first_datetime      = reset($datetimes);
+		$first_datetime_name = esc_html__('Event', 'event_espresso');
+		if ($first_datetime instanceof EE_Datetime && $first_datetime->event() instanceof EE_Event) {
+			$first_datetime_name = $first_datetime->event()->name();
+		}
+		$event = sprintf(_x('(For %1$s)', '(For Event Name)', 'event_espresso'), $first_datetime_name);
+		// get event subtotal line
+		$events_sub_total = self::get_event_line_item_for_ticket($total_line_item, $ticket);
+		$taxes            = $ticket->tax_price_modifiers();
+		// add $ticket to cart
+		$line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_name'       => $ticket->name(),
+				'LIN_desc'       => $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event,
+				'LIN_unit_price' => $ticket->price(),
+				'LIN_quantity'   => $qty,
+				'LIN_is_taxable' => empty($taxes) && $ticket->taxable(),
+				'LIN_order'      => count($events_sub_total->children()),
+				'LIN_total'      => $ticket->price() * $qty,
+				'LIN_type'       => EEM_Line_Item::type_line_item,
+				'OBJ_ID'         => $ticket->ID(),
+				'OBJ_type'       => EEM_Line_Item::OBJ_TYPE_TICKET,
+			]
+		);
+		$line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_ticket_line_item__line_item',
+			$line_item
+		);
+		if (! $line_item instanceof EE_Line_Item) {
+			throw new DomainException(
+				esc_html__('Invalid EE_Line_Item received.', 'event_espresso')
+			);
+		}
+		$events_sub_total->add_child_line_item($line_item);
+		// now add the sub-line items
+		$running_pre_tax_total = 0;
+		$prices                = $ticket->prices();
+		if (empty($prices)) {
+			// WUT?!?! NO PRICES??? Well, just create a default price then.
+			$default_price = EEM_Price::instance()->get_new_price();
+			if ($default_price->amount() !== $ticket->price()) {
+				$default_price->set_amount($ticket->price());
+			}
+			$default_price->save();
+			$ticket->_add_relation_to($default_price, 'Price');
+			$ticket->save();
+			$prices = [$default_price];
+		}
+		foreach ($prices as $price) {
+			$sign = $price->is_discount() ? -1 : 1;
+			$price_amount = $price->amount();
+			if ($price->is_percent()) {
+				$price_total = $running_pre_tax_total * $price_amount / 100;
+				$percent    = $sign * $price_amount;
+				$unit_price = 0;
+			} else {
+				$price_total = $price_amount * $qty;
+				$percent    = 0;
+				$unit_price = $sign * $price_amount;
+			}
+
+			$price_desc = $price->desc();
+			$price_type = $price->type_obj();
+			$price_desc = $price_desc === '' && $price_type instanceof EE_Price_Type
+				? $price_type->name()
+				: $price_desc;
+
+			$sub_line_item         = EE_Line_Item::new_instance(
+				[
+					'LIN_name'       => $price->name(),
+					'LIN_desc'       => $price_desc,
+					'LIN_is_taxable' => false,
+					'LIN_order'      => $price->order(),
+					'LIN_total'      => $price_total,
+					'LIN_pretax'     => 0,
+					'LIN_unit_price' => $unit_price,
+					'LIN_percent'    => $percent,
+					'LIN_type'       => $price->is_tax()
+						? EEM_Line_Item::type_sub_tax
+						: EEM_Line_Item::type_sub_line_item,
+					'OBJ_ID'         => $price->ID(),
+					'OBJ_type'       => EEM_Line_Item::OBJ_TYPE_PRICE,
+				]
+			);
+			$sub_line_item         = apply_filters(
+				'FHEE__EEH_Line_Item__create_ticket_line_item__sub_line_item',
+				$sub_line_item
+			);
+			$running_pre_tax_total += ! $price->is_tax() ? $sign * $price_total : 0;
+			$line_item->add_child_line_item($sub_line_item);
+		}
+		$line_item->setPretaxTotal($running_pre_tax_total);
+		return $line_item;
+	}
+
+
+	/**
+	 * Adds the specified item under the pre-tax-sub-total line item. Automatically
+	 * re-calculates the line item totals and updates the related transaction. But
+	 * DOES NOT automatically upgrade the transaction's registrations' final prices (which
+	 * should probably change because of this).
+	 * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
+	 * after using this, to keep the registration final prices in-sync with the transaction's total.
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param EE_Line_Item $item to be added
+	 * @param bool         $recalculate_totals
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function add_item(
+		EE_Line_Item $total_line_item,
+		EE_Line_Item $item,
+		bool $recalculate_totals = true
+	): bool {
+		$pre_tax_subtotal = self::get_pre_tax_subtotal($total_line_item);
+		$success          = $pre_tax_subtotal->add_child_line_item($item);
+		if ($recalculate_totals) {
+			$total_line_item->recalculate_total_including_taxes();
+		}
+		return $success;
+	}
+
+
+	/**
+	 * cancels an existing ticket line item,
+	 * by decrementing its quantity by 1 and adding a new "type_cancellation" sub-line-item.
+	 * ALL totals and subtotals will NEED TO BE UPDATED after performing this action
+	 *
+	 * @param EE_Line_Item $ticket_line_item
+	 * @param int          $qty
+	 * @return bool success
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function cancel_ticket_line_item(EE_Line_Item $ticket_line_item, int $qty = 1): bool
+	{
+		// validate incoming line_item
+		if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The supplied line item must have an Object Type of "Ticket", not %1$s.',
+						'event_espresso'
+					),
+					$ticket_line_item->type()
+				)
+			);
+		}
+		if ($ticket_line_item->quantity() < $qty) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Can not cancel %1$d ticket(s) because the supplied line item has a quantity of %2$d.',
+						'event_espresso'
+					),
+					$qty,
+					$ticket_line_item->quantity()
+				)
+			);
+		}
+		// decrement ticket quantity; don't rely on auto-fixing when recalculating totals to do this
+		$ticket_line_item->set_quantity($ticket_line_item->quantity() - $qty);
+		foreach ($ticket_line_item->children() as $child_line_item) {
+			if (
+				$child_line_item->is_sub_line_item()
+				&& ! $child_line_item->is_percent()
+				&& ! $child_line_item->is_cancellation()
+			) {
+				$child_line_item->set_quantity($child_line_item->quantity() - $qty);
+			}
+		}
+		// get cancellation sub line item
+		$cancellation_line_item = EEH_Line_Item::get_descendants_of_type(
+			$ticket_line_item,
+			EEM_Line_Item::type_cancellation
+		);
+		$cancellation_line_item = reset($cancellation_line_item);
+		// verify that this ticket was indeed previously cancelled
+		if ($cancellation_line_item instanceof EE_Line_Item) {
+			// increment cancelled quantity
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() + $qty);
+		} else {
+			// create cancellation sub line item
+			$cancellation_line_item = EE_Line_Item::new_instance(
+				[
+					'LIN_name'       => esc_html__('Cancellation', 'event_espresso'),
+					'LIN_desc'       => sprintf(
+						esc_html_x(
+							'Cancelled %1$s : %2$s',
+							'Cancelled Ticket Name : 2015-01-01 11:11',
+							'event_espresso'
+						),
+						$ticket_line_item->name(),
+						current_time(get_option('date_format') . ' ' . get_option('time_format'))
+					),
+					'LIN_total'      => 0,
+					'LIN_unit_price' => 0,
+					'LIN_quantity'   => $qty,
+					'LIN_is_taxable' => $ticket_line_item->is_taxable(),
+					'LIN_order'      => count($ticket_line_item->children()),
+					'LIN_type'       => EEM_Line_Item::type_cancellation,
+				]
+			);
+			$ticket_line_item->add_child_line_item($cancellation_line_item);
+		}
+		if ($ticket_line_item->save_this_and_descendants() > 0) {
+			// decrement parent line item quantity
+			$event_line_item = $ticket_line_item->parent();
+			if (
+				$event_line_item instanceof EE_Line_Item
+				&& $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT
+			) {
+				$event_line_item->set_quantity($event_line_item->quantity() - $qty);
+				$event_line_item->save();
+			}
+			EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * reinstates (un-cancels?) a previously canceled ticket line item,
+	 * by incrementing its quantity by 1, and decrementing its "type_cancellation" sub-line-item.
+	 * ALL totals and subtotals will NEED TO BE UPDATED after performing this action
+	 *
+	 * @param EE_Line_Item $ticket_line_item
+	 * @param int          $qty
+	 * @return bool success
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function reinstate_canceled_ticket_line_item(EE_Line_Item $ticket_line_item, int $qty = 1): bool
+	{
+		// validate incoming line_item
+		if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The supplied line item must have an Object Type of "Ticket", not %1$s.',
+						'event_espresso'
+					),
+					$ticket_line_item->type()
+				)
+			);
+		}
+		// get cancellation sub line item
+		$cancellation_line_item = EEH_Line_Item::get_descendants_of_type(
+			$ticket_line_item,
+			EEM_Line_Item::type_cancellation
+		);
+		$cancellation_line_item = reset($cancellation_line_item);
+		// verify that this ticket was indeed previously cancelled
+		if (! $cancellation_line_item instanceof EE_Line_Item) {
+			return false;
+		}
+		if ($cancellation_line_item->quantity() > $qty) {
+			// decrement cancelled quantity
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
+		} elseif ($cancellation_line_item->quantity() === $qty) {
+			// decrement cancelled quantity in case anyone still has the object kicking around
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
+			// delete because quantity will end up as 0
+			$cancellation_line_item->delete();
+			// and attempt to destroy the object,
+			// even though PHP won't actually destroy it until it needs the memory
+			unset($cancellation_line_item);
+		} else {
+			// what ?!?! negative quantity ?!?!
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Can not reinstate %1$d cancelled ticket(s) because the cancelled ticket quantity is only %2$d.',
+						'event_espresso'
+					),
+					$qty,
+					$cancellation_line_item->quantity()
+				)
+			);
+		}
+		// increment ticket quantity
+		$ticket_line_item->set_quantity($ticket_line_item->quantity() + $qty);
+		if ($ticket_line_item->save_this_and_descendants() > 0) {
+			// increment parent line item quantity
+			$event_line_item = $ticket_line_item->parent();
+			if (
+				$event_line_item instanceof EE_Line_Item
+				&& $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT
+			) {
+				$event_line_item->set_quantity($event_line_item->quantity() + $qty);
+			}
+			EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * calls EEH_Line_Item::find_transaction_grand_total_for_line_item()
+	 * then EE_Line_Item::recalculate_total_including_taxes() on the result
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function get_grand_total_and_recalculate_everything(EE_Line_Item $line_item): float
+	{
+		$grand_total_line_item = EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item);
+		return $grand_total_line_item->recalculate_total_including_taxes();
+	}
+
+
+	/**
+	 * Gets the line item which contains the subtotal of all the items
+	 *
+	 * @param EE_Line_Item        $total_line_item of type EEM_Line_Item::type_total
+	 * @param EE_Transaction|null $transaction
+	 * @param bool                $create_event_subtotal
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_pre_tax_subtotal(
+		EE_Line_Item $total_line_item,
+		?EE_Transaction $transaction = null,
+		bool $create_event_subtotal = true
+	): EE_Line_Item {
+		$pre_tax_subtotal = $total_line_item->get_child_line_item('pre-tax-subtotal');
+		return $pre_tax_subtotal instanceof EE_Line_Item
+			? $pre_tax_subtotal
+			: self::create_pre_tax_subtotal($total_line_item, $transaction, $create_event_subtotal);
+	}
+
+
+	/**
+	 * Gets the line item for the taxes subtotal
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function get_taxes_subtotal(EE_Line_Item $total_line_item): EE_Line_Item
+	{
+		$taxes = $total_line_item->get_child_line_item('taxes');
+		return $taxes ?: self::create_taxes_subtotal($total_line_item);
+	}
+
+
+	/**
+	 * sets the TXN ID on an EE_Line_Item if passed a valid EE_Transaction object
+	 *
+	 * @param EE_Line_Item        $line_item
+	 * @param EE_Transaction|null $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function set_TXN_ID(EE_Line_Item $line_item, ?EE_Transaction $transaction = null)
+	{
+		if ($transaction) {
+			/** @type EEM_Transaction $EEM_Transaction */
+			$EEM_Transaction = EE_Registry::instance()->load_model('Transaction');
+			$TXN_ID          = $EEM_Transaction->ensure_is_ID($transaction);
+			$line_item->set_TXN_ID($TXN_ID);
+		}
+	}
+
+
+	/**
+	 * Creates a new default total line item for the transaction,
+	 * and its tickets subtotal and taxes subtotal line items (and adds the
+	 * existing taxes as children of the taxes subtotal line item)
+	 *
+	 * @param EE_Transaction|null $transaction
+	 * @return EE_Line_Item of type total
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function create_total_line_item(?EE_Transaction $transaction = null): EE_Line_Item
+	{
+		$total_line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_code' => 'total',
+				'LIN_name' => esc_html__('Grand Total', 'event_espresso'),
+				'LIN_type' => EEM_Line_Item::type_total,
+				'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TRANSACTION,
+			]
+		);
+		$total_line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_total_line_item__total_line_item',
+			$total_line_item
+		);
+		self::set_TXN_ID($total_line_item, $transaction);
+		self::create_pre_tax_subtotal($total_line_item, $transaction);
+		self::create_taxes_subtotal($total_line_item, $transaction);
+		return $total_line_item;
+	}
+
+
+	/**
+	 * Creates a default items subtotal line item
+	 *
+	 * @param EE_Line_Item        $total_line_item
+	 * @param EE_Transaction|null $transaction
+	 * @param bool                $create_event_subtotal
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function create_pre_tax_subtotal(
+		EE_Line_Item $total_line_item,
+		?EE_Transaction $transaction = null,
+		bool $create_event_subtotal = true
+	): EE_Line_Item {
+		$pre_tax_line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_code' => 'pre-tax-subtotal',
+				'LIN_name' => esc_html__('Pre-Tax Subtotal', 'event_espresso'),
+				'LIN_type' => EEM_Line_Item::type_sub_total,
+			]
+		);
+		$pre_tax_line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_pre_tax_subtotal__pre_tax_line_item',
+			$pre_tax_line_item
+		);
+		self::set_TXN_ID($pre_tax_line_item, $transaction);
+		$total_line_item->add_child_line_item($pre_tax_line_item);
+		if ($create_event_subtotal) {
+			self::create_event_subtotal($pre_tax_line_item, $transaction);
+		}
+		return $pre_tax_line_item;
+	}
+
+
+	/**
+	 * Creates a line item for the taxes subtotal and finds all the tax prices
+	 * and applies taxes to it
+	 *
+	 * @param EE_Line_Item        $total_line_item of type EEM_Line_Item::type_total
+	 * @param EE_Transaction|null $transaction
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected static function create_taxes_subtotal(
+		EE_Line_Item $total_line_item,
+		?EE_Transaction $transaction = null
+	): EE_Line_Item {
+		$tax_line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_code'  => 'taxes',
+				'LIN_name'  => esc_html__('Taxes', 'event_espresso'),
+				'LIN_type'  => EEM_Line_Item::type_tax_sub_total,
+				'LIN_order' => 1000,// this should always come last
+			]
+		);
+		$tax_line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_taxes_subtotal__tax_line_item',
+			$tax_line_item
+		);
+		self::set_TXN_ID($tax_line_item, $transaction);
+		$total_line_item->add_child_line_item($tax_line_item);
+		// and lastly, add the actual taxes
+		self::apply_taxes($total_line_item);
+		return $tax_line_item;
+	}
+
+
+	/**
+	 * Creates a default items subtotal line item
+	 *
+	 * @param EE_Line_Item        $pre_tax_line_item
+	 * @param EE_Transaction|null $transaction
+	 * @param EE_Event|null       $event
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function create_event_subtotal(
+		EE_Line_Item $pre_tax_line_item,
+		?EE_Transaction $transaction = null,
+		?EE_Event $event = null
+	): EE_Line_Item {
+		// first check if this line item already exists
+		$event_line_item = EEM_Line_Item::instance()->get_one(
+			[
+				[
+					'LIN_type' => EEM_Line_Item::type_sub_total,
+					'OBJ_type' => EEM_Line_Item::OBJ_TYPE_EVENT,
+					'OBJ_ID'   => $event instanceof EE_Event ? $event->ID() : 0,
+					'TXN_ID'   => $transaction instanceof EE_Transaction ? $transaction->ID() : 0,
+				],
+			]
+		);
+		if ($event_line_item instanceof EE_Line_Item) {
+			return $event_line_item;
+		}
+
+		$event_line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_code' => self::get_event_code($event),
+				'LIN_name' => self::get_event_name($event),
+				'LIN_desc' => self::get_event_desc($event),
+				'LIN_type' => EEM_Line_Item::type_sub_total,
+				'OBJ_type' => EEM_Line_Item::OBJ_TYPE_EVENT,
+				'OBJ_ID'   => $event instanceof EE_Event ? $event->ID() : 0,
+			]
+		);
+		$event_line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_event_subtotal__event_line_item',
+			$event_line_item
+		);
+		self::set_TXN_ID($event_line_item, $transaction);
+		$pre_tax_line_item->add_child_line_item($event_line_item);
+		return $event_line_item;
+	}
+
+
+	/**
+	 * Gets what the event ticket's code SHOULD be
+	 *
+	 * @param EE_Event|null $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_event_code(?EE_Event $event = null): string
+	{
+		return 'event-' . ($event instanceof EE_Event ? $event->ID() : '0');
+	}
+
+
+	/**
+	 * Gets the event name
+	 *
+	 * @param EE_Event|null $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_event_name(?EE_Event $event = null): string
+	{
+		return $event instanceof EE_Event
+			? mb_substr($event->name(), 0, 245)
+			: esc_html__('Event', 'event_espresso');
+	}
+
+
+	/**
+	 * Gets the event excerpt
+	 *
+	 * @param EE_Event|null $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_event_desc(?EE_Event $event = null): string
+	{
+		return $event instanceof EE_Event ? $event->short_description() : '';
+	}
+
+
+	/**
+	 * Given the grand total line item and a ticket, finds the event sub-total
+	 * line item the ticket's purchase should be added onto
+	 *
+	 * @access public
+	 * @param EE_Line_Item $grand_total the grand total line item
+	 * @param EE_Ticket    $ticket
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket): EE_Line_Item
+	{
+		$first_datetime = $ticket->first_datetime();
+		if (! $first_datetime instanceof EE_Datetime) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('The supplied ticket (ID %d) has no datetimes', 'event_espresso'),
+					$ticket->ID()
+				)
+			);
+		}
+		$event = $first_datetime->event();
+		if (! $event instanceof EE_Event) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The supplied ticket (ID %d) has no event data associated with it.',
+						'event_espresso'
+					),
+					$ticket->ID()
+				)
+			);
+		}
+		$events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event);
+		if (! $events_sub_total instanceof EE_Line_Item) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'There is no events sub-total for ticket %s on total line item %d',
+						'event_espresso'
+					),
+					$ticket->ID(),
+					$grand_total->ID()
+				)
+			);
+		}
+		return $events_sub_total;
+	}
+
+
+	/**
+	 * Gets the event line item
+	 *
+	 * @param EE_Line_Item  $total_line_item
+	 * @param EE_Event|null $event
+	 * @return EE_Line_Item for the event subtotal which is a child of $grand_total
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_event_line_item(EE_Line_Item $total_line_item, ?EE_Event $event = null): ?EE_Line_Item
+	{
+		/** @type EE_Event $event */
+		$event           = EEM_Event::instance()->ensure_is_obj($event, true);
+		$event_line_items = EEH_Line_Item::get_event_subtotals($total_line_item);
+		$existing_event_line_item = null;
+		foreach ($event_line_items as $event_line_item) {
+			// default event subtotal, we should only ever find this the first time this method is called
+			$OBJ_ID = $event_line_item->OBJ_ID();
+			if ($OBJ_ID === $event->ID()) {
+				// found existing line item for this event in the cart, so break out of loop and use this one
+				$existing_event_line_item = $event_line_item;
+				break;
+			}
+			if (! $OBJ_ID) {
+				// OK?!?! We have an event subtotal that is not actually associated with any event???
+				// let's just use this line item since it's already there, but first... set the event details
+				$existing_event_line_item = $event_line_item;
+				EEH_Line_Item::set_event_subtotal_details($existing_event_line_item, $event);
+				break;
+			}
+		}
+		unset($event_line_item);
+		if ($existing_event_line_item instanceof EE_Line_Item) {
+			return $existing_event_line_item;
+		}
+		// there is no event sub-total yet for this event, so create a new "event" subtotal
+		$transaction = $total_line_item->transaction();
+		$pre_tax_subtotal = self::get_pre_tax_subtotal($total_line_item, $transaction, false);
+		$new_event_line_item = EEH_Line_Item::create_event_subtotal($pre_tax_subtotal, $transaction, $event);
+		// and set the event details
+		EEH_Line_Item::set_event_subtotal_details($new_event_line_item, $event, $transaction);
+		return $new_event_line_item;
+	}
+
+
+	/**
+	 * Creates a default items subtotal line item
+	 *
+	 * @param EE_Line_Item        $event_line_item
+	 * @param EE_Event|null       $event
+	 * @param EE_Transaction|null $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function set_event_subtotal_details(
+		EE_Line_Item $event_line_item,
+		EE_Event $event = null,
+		?EE_Transaction $transaction = null
+	) {
+		if ($event instanceof EE_Event) {
+			$event_line_item->set_code(self::get_event_code($event));
+			$event_line_item->set_name(self::get_event_name($event));
+			$event_line_item->set_desc(self::get_event_desc($event));
+			$event_line_item->set_OBJ_ID($event->ID());
+		}
+		self::set_TXN_ID($event_line_item, $transaction);
+	}
+
+
+	/**
+	 * Finds what taxes should apply, adds them as tax line items under the taxes sub-total,
+	 * and recalculates the taxes sub-total and the grand total. Resets the taxes, so
+	 * any old taxes are removed
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @param bool         $update_txn_status
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public static function apply_taxes(EE_Line_Item $total_line_item, bool $update_txn_status = false): bool
+	{
+		$total_line_item       = EEH_Line_Item::find_transaction_grand_total_for_line_item($total_line_item);
+		$taxes_line_item       = self::get_taxes_subtotal($total_line_item);
+		$existing_global_taxes = $taxes_line_item->tax_descendants();
+		$updates               = false;
+		// loop thru taxes
+		$global_taxes = EEH_Line_Item::getGlobalTaxes();
+		foreach ($global_taxes as $order => $taxes) {
+			foreach ($taxes as $tax) {
+				if ($tax instanceof EE_Price) {
+					$found = false;
+					// check if this is already an existing tax
+					foreach ($existing_global_taxes as $existing_global_tax) {
+						if ($tax->ID() === $existing_global_tax->OBJ_ID()) {
+							// maybe update the tax rate in case it has changed
+							if ($existing_global_tax->percent() !== $tax->amount()) {
+								$existing_global_tax->set_percent($tax->amount());
+								$existing_global_tax->save();
+								$updates = true;
+							}
+							$found = true;
+							break;
+						}
+					}
+					if (! $found) {
+						// add a new line item for this global tax
+						$tax_line_item = apply_filters(
+							'FHEE__EEH_Line_Item__apply_taxes__tax_line_item',
+							EE_Line_Item::new_instance(
+								[
+									'LIN_name'       => $tax->name(),
+									'LIN_desc'       => $tax->desc(),
+									'LIN_percent'    => $tax->amount(),
+									'LIN_is_taxable' => false,
+									'LIN_order'      => $order,
+									'LIN_total'      => 0,
+									'LIN_type'       => EEM_Line_Item::type_tax,
+									'OBJ_type'       => EEM_Line_Item::OBJ_TYPE_PRICE,
+									'OBJ_ID'         => $tax->ID(),
+								]
+							)
+						);
+						$updates       = $taxes_line_item->add_child_line_item($tax_line_item) ? true : $updates;
+					}
+				}
+			}
+		}
+		// only recalculate totals if something changed
+		if ($updates || $update_txn_status) {
+			$total_line_item->recalculate_total_including_taxes($update_txn_status);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Ensures that taxes have been applied to the order, if not applies them.
+	 * Returns the total amount of tax
+	 *
+	 * @param EE_Line_Item|null $total_line_item of type EEM_Line_Item::type_total
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function ensure_taxes_applied(?EE_Line_Item $total_line_item): float
+	{
+		$taxes_subtotal = self::get_taxes_subtotal($total_line_item);
+		if (! $taxes_subtotal->children()) {
+			self::apply_taxes($total_line_item);
+		}
+		return $taxes_subtotal->total();
+	}
+
+
+	/**
+	 * Deletes ALL children of the passed line item
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function delete_all_child_items(EE_Line_Item $parent_line_item)
+	{
+		$deleted = 0;
+		foreach ($parent_line_item->children() as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$deleted += EEH_Line_Item::delete_all_child_items($child_line_item);
+				if ($child_line_item->ID()) {
+					$child_line_item->delete();
+					unset($child_line_item);
+				} else {
+					$parent_line_item->delete_child_line_item($child_line_item->code());
+				}
+				$deleted++;
+			}
+		}
+		return $deleted;
+	}
+
+
+	/**
+	 * Deletes the line items as indicated by the line item code(s) provided,
+	 * regardless of where they're found in the line item tree. Automatically
+	 * re-calculates the line item totals and updates the related transaction. But
+	 * DOES NOT automatically upgrade the transaction's registrations' final prices (which
+	 * should probably change because of this).
+	 * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
+	 * after using this, to keep the registration final prices in-sync with the transaction's total.
+	 *
+	 * @param EE_Line_Item      $total_line_item of type EEM_Line_Item::type_total
+	 * @param array|bool|string $line_item_codes
+	 * @return int number of items successfully removed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function delete_items(EE_Line_Item $total_line_item, $line_item_codes = false)
+	{
+		if ($total_line_item->type() !== EEM_Line_Item::type_total) {
+			EE_Error::doing_it_wrong(
+				'EEH_Line_Item::delete_items',
+				esc_html__(
+					'This static method should only be called with a TOTAL line item, otherwise we won\'t recalculate the totals correctly',
+					'event_espresso'
+				),
+				'4.6.18'
+			);
+		}
+
+		// check if only a single line_item_id was passed
+		if (! empty($line_item_codes) && ! is_array($line_item_codes)) {
+			// place single line_item_id in an array to appear as multiple line_item_ids
+			$line_item_codes = [$line_item_codes];
+		}
+		$removals = 0;
+		// cycle thru line_item_ids
+		foreach ($line_item_codes as $line_item_id) {
+			$removals += $total_line_item->delete_child_line_item($line_item_id);
+		}
+
+		if ($removals > 0) {
+			$total_line_item->recalculate_taxes_and_tax_total();
+			return $removals;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Overwrites the previous tax by clearing out the old taxes, and creates a new
+	 * tax and updates the total line item accordingly
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param float        $amount
+	 * @param string       $name
+	 * @param string       $description
+	 * @param string       $code
+	 * @param boolean      $add_to_existing_line_item
+	 *                          if true, and a duplicate line item with the same code is found,
+	 *                          $amount will be added onto it; otherwise will simply set the taxes to match $amount
+	 * @return EE_Line_Item the new tax line item created
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function set_total_tax_to(
+		EE_Line_Item $total_line_item,
+		float $amount,
+		string $name = '',
+		string $description = '',
+		string $code = '',
+		bool $add_to_existing_line_item = false
+	): EE_Line_Item {
+		$tax_subtotal  = self::get_taxes_subtotal($total_line_item);
+		$taxable_total = $total_line_item->taxable_total();
+
+		if ($add_to_existing_line_item) {
+			$new_tax = $tax_subtotal->get_child_line_item($code);
+			EEM_Line_Item::instance()->delete(
+				[['LIN_code' => ['!=', $code], 'LIN_parent' => $tax_subtotal->ID()]]
+			);
+		} else {
+			$new_tax = null;
+			$tax_subtotal->delete_children_line_items();
+		}
+		if ($new_tax) {
+			$new_tax->set_total($new_tax->total() + $amount);
+			$new_tax->set_percent($taxable_total ? $new_tax->total() / $taxable_total * 100 : 0);
+		} else {
+			// no existing tax item. Create it
+			$new_tax = EE_Line_Item::new_instance(
+				[
+					'TXN_ID'      => $total_line_item->TXN_ID(),
+					'LIN_name'    => $name ?: esc_html__('Tax', 'event_espresso'),
+					'LIN_desc'    => $description ?: '',
+					'LIN_percent' => $taxable_total ? ($amount / $taxable_total * 100) : 0,
+					'LIN_total'   => $amount,
+					'LIN_parent'  => $tax_subtotal->ID(),
+					'LIN_type'    => EEM_Line_Item::type_tax,
+					'LIN_code'    => $code,
+				]
+			);
+		}
+
+		$new_tax = apply_filters(
+			'FHEE__EEH_Line_Item__set_total_tax_to__new_tax_subtotal',
+			$new_tax,
+			$total_line_item
+		);
+		$new_tax->save();
+		$tax_subtotal->set_total($new_tax->total());
+		$tax_subtotal->save();
+		$total_line_item->recalculate_total_including_taxes();
+		return $new_tax;
+	}
+
+
+	/**
+	 * Makes all the line items which are children of $line_item taxable (or not).
+	 * Does NOT save the line items
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param boolean      $taxable
+	 * @param string|null  $code_substring_for_whitelist if this string is part of the line item's code
+	 *                                                   it will be whitelisted (ie, except from becoming taxable)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function set_line_items_taxable(
+		EE_Line_Item $line_item,
+		bool $taxable = true,
+		?string $code_substring_for_whitelist = null
+	) {
+		$whitelisted = false;
+		if ($code_substring_for_whitelist !== null) {
+			$whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false;
+		}
+		if (! $whitelisted && $line_item->is_line_item()) {
+			$line_item->set_is_taxable($taxable);
+		}
+		foreach ($line_item->children() as $child_line_item) {
+			EEH_Line_Item::set_line_items_taxable(
+				$child_line_item,
+				$taxable,
+				$code_substring_for_whitelist
+			);
+		}
+	}
+
+
+	/**
+	 * Gets all descendants that are event subtotals
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @uses  EEH_Line_Item::get_subtotals_of_object_type()
+	 */
+	public static function get_event_subtotals(EE_Line_Item $parent_line_item): array
+	{
+		return self::get_subtotals_of_object_type($parent_line_item, EEM_Line_Item::OBJ_TYPE_EVENT);
+	}
+
+
+	/**
+	 * Gets all descendants subtotals that match the supplied object type
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $obj_type
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
+	 */
+	public static function get_subtotals_of_object_type(EE_Line_Item $parent_line_item, string $obj_type = ''): array
+	{
+		return self::_get_descendants_by_type_and_object_type(
+			$parent_line_item,
+			EEM_Line_Item::type_sub_total,
+			$obj_type
+		);
+	}
+
+
+	/**
+	 * Gets all descendants that are tickets
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @uses  EEH_Line_Item::get_line_items_of_object_type()
+	 */
+	public static function get_ticket_line_items(EE_Line_Item $parent_line_item): array
+	{
+		return self::get_line_items_of_object_type(
+			$parent_line_item,
+			EEM_Line_Item::OBJ_TYPE_TICKET
+		);
+	}
+
+
+	/**
+	 * Gets all descendants subtotals that match the supplied object type
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $obj_type
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
+	 */
+	public static function get_line_items_of_object_type(EE_Line_Item $parent_line_item, string $obj_type = ''): array
+	{
+		return self::_get_descendants_by_type_and_object_type(
+			$parent_line_item,
+			EEM_Line_Item::type_line_item,
+			$obj_type
+		);
+	}
+
+
+	/**
+	 * Gets all the descendants (ie, children or children of children etc) that are of the type 'tax'
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @uses  EEH_Line_Item::get_descendants_of_type()
+	 */
+	public static function get_tax_descendants(EE_Line_Item $parent_line_item): array
+	{
+		return EEH_Line_Item::get_descendants_of_type(
+			$parent_line_item,
+			EEM_Line_Item::type_tax
+		);
+	}
+
+
+	/**
+	 * Gets all the real items purchased which are children of this item
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @uses  EEH_Line_Item::get_descendants_of_type()
+	 */
+	public static function get_line_item_descendants(EE_Line_Item $parent_line_item): array
+	{
+		return EEH_Line_Item::get_descendants_of_type(
+			$parent_line_item,
+			EEM_Line_Item::type_line_item
+		);
+	}
+
+
+	/**
+	 * Gets all descendants of supplied line item that match the supplied line item type
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $line_item_type   one of the EEM_Line_Item constants
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
+	 */
+	public static function get_descendants_of_type(EE_Line_Item $parent_line_item, string $line_item_type): array
+	{
+		return self::_get_descendants_by_type_and_object_type(
+			$parent_line_item,
+			$line_item_type
+		);
+	}
+
+
+	/**
+	 * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type
+	 * as well
+	 *
+	 * @param EE_Line_Item $parent_line_item  - the line item to find descendants of
+	 * @param string       $line_item_type    one of the EEM_Line_Item constants
+	 * @param string|null  $obj_type          object model class name (minus prefix) or NULL to ignore object type when
+	 *                                        searching
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function _get_descendants_by_type_and_object_type(
+		EE_Line_Item $parent_line_item,
+		string $line_item_type,
+		?string $obj_type = null
+	): array {
+		$objects = [];
+		foreach ($parent_line_item->children() as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				if (
+					$child_line_item->type() === $line_item_type
+					&& (
+						$child_line_item->OBJ_type() === $obj_type || $obj_type === null
+					)
+				) {
+					$objects[] = $child_line_item;
+				} else {
+					// go-through-all-its children looking for more matches
+					$objects = array_merge(
+						$objects,
+						self::_get_descendants_by_type_and_object_type(
+							$child_line_item,
+							$line_item_type,
+							$obj_type
+						)
+					);
+				}
+			}
+		}
+		return $objects;
+	}
+
+
+	/**
+	 * Gets all descendants subtotals that match the supplied object type
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $OBJ_type         object type (like Event)
+	 * @param array        $OBJ_IDs          array of OBJ_IDs
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
+	 */
+	public static function get_line_items_by_object_type_and_IDs(
+		EE_Line_Item $parent_line_item,
+		string $OBJ_type = '',
+		array $OBJ_IDs = []
+	): array {
+		return self::_get_descendants_by_object_type_and_object_ID(
+			$parent_line_item,
+			$OBJ_type,
+			$OBJ_IDs
+		);
+	}
+
+
+	/**
+	 * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type
+	 * as well
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $OBJ_type         object type (like Event)
+	 * @param array        $OBJ_IDs          array of OBJ_IDs
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function _get_descendants_by_object_type_and_object_ID(
+		EE_Line_Item $parent_line_item,
+		string $OBJ_type,
+		array $OBJ_IDs
+	): array {
+		$objects = [];
+		foreach ($parent_line_item->children() as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				if (
+					$child_line_item->OBJ_type() === $OBJ_type
+					&& in_array($child_line_item->OBJ_ID(), $OBJ_IDs)
+				) {
+					$objects[] = $child_line_item;
+				} else {
+					// go-through-all-its children looking for more matches
+					$objects = array_merge(
+						$objects,
+						self::_get_descendants_by_object_type_and_object_ID(
+							$child_line_item,
+							$OBJ_type,
+							$OBJ_IDs
+						)
+					);
+				}
+			}
+		}
+		return $objects;
+	}
+
+
+	/**
+	 * Uses a breadth-first-search in order to find the nearest descendant of
+	 * the specified type and returns it, else NULL
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $type             like one of the EEM_Line_Item::type_*
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @uses  EEH_Line_Item::_get_nearest_descendant()
+	 */
+	public static function get_nearest_descendant_of_type(EE_Line_Item $parent_line_item, string $type): ?EE_Line_Item
+	{
+		return self::_get_nearest_descendant($parent_line_item, 'LIN_type', $type);
+	}
+
+
+	/**
+	 * Uses a breadth-first-search in order to find the nearest descendant
+	 * having the specified LIN_code and returns it, else NULL
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $code             any value used for LIN_code
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @uses  EEH_Line_Item::_get_nearest_descendant()
+	 */
+	public static function get_nearest_descendant_having_code(
+		EE_Line_Item $parent_line_item,
+		string $code
+	): ?EE_Line_Item {
+		return self::_get_nearest_descendant($parent_line_item, 'LIN_code', $code);
+	}
+
+
+	/**
+	 * Uses a breadth-first-search in order to find the nearest descendant
+	 * having the specified LIN_code and returns it, else NULL
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $search_field     name of EE_Line_Item property
+	 * @param mixed        $value            any value stored in $search_field
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected static function _get_nearest_descendant(
+		EE_Line_Item $parent_line_item,
+		string $search_field,
+		$value
+	): ?EE_Line_Item {
+		foreach ($parent_line_item->children() as $child) {
+			if ($child->get($search_field) == $value) {
+				return $child;
+			}
+		}
+		foreach ($parent_line_item->children() as $child) {
+			$descendant_found = self::_get_nearest_descendant(
+				$child,
+				$search_field,
+				$value
+			);
+			if ($descendant_found) {
+				return $descendant_found;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * if passed line item has a TXN ID, uses that to jump directly to the grand total line item for the transaction,
+	 * else recursively walks up the line item tree until a parent of type total is found,
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function find_transaction_grand_total_for_line_item(EE_Line_Item $line_item): EE_Line_Item
+	{
+		if ($line_item->is_total()) {
+			return $line_item;
+		}
+		if ($line_item->TXN_ID()) {
+			$total_line_item = $line_item->transaction()->total_line_item(false);
+			if ($total_line_item instanceof EE_Line_Item) {
+				return $total_line_item;
+			}
+		} else {
+			$line_item_parent = $line_item->parent();
+			if ($line_item_parent instanceof EE_Line_Item) {
+				if ($line_item_parent->is_total()) {
+					return $line_item_parent;
+				}
+				return EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item_parent);
+			}
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'A valid grand total for line item %1$d was not found.',
+					'event_espresso'
+				),
+				$line_item->ID()
+			)
+		);
+	}
+
+
+	/**
+	 * Prints out a representation of the line item tree
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int          $indentation
+	 * @param bool         $top_level
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function visualize(EE_Line_Item $line_item, int $indentation = 0, bool $top_level = true)
+	{
+		if (! defined('WP_DEBUG') || ! WP_DEBUG) {
+			return;
+		}
+		$no_formatting  = defined('EE_TESTS_DIR') || (defined('DOING_AJAX') && DOING_AJAX);
+		$new_line = $no_formatting ? "\n" : '<br />';
+		if ($top_level && ! $no_formatting) {
+			echo '<div style="position: relative; z-index: 9999; margin: 2rem;">';
+			echo '<pre style="padding: 2rem 3rem; color: #00CCFF; background: #363636;">';
+		}
+		if ($top_level || $indentation) {
+			// echo $top_level ? "$new_line$new_line" : $new_line;
+			echo $new_line;
+		}
+		echo str_repeat('. ', $indentation);
+		$breakdown = '';
+		if ($line_item->is_line_item() || $line_item->is_sub_line_item() || $line_item->isTax()) {
+			if ($line_item->is_percent()) {
+				$breakdown = "{$line_item->percent()}%";
+			} else {
+				$breakdown = "\${$line_item->unit_price()} x {$line_item->quantity()}";
+			}
+		}
+		echo wp_kses($line_item->name(), AllowedTags::getAllowedTags());
+		echo " [ ID:{$line_item->ID()} · qty:{$line_item->quantity()} ] {$line_item->type()}";
+		echo " · \${$line_item->total()} · \${$line_item->pretaxTotal()}";
+		if ($breakdown) {
+			echo " ( $breakdown )";
+		}
+		if ($line_item->is_taxable()) {
+			echo '  * taxable';
+		}
+		$children = $line_item->children();
+		if ($children) {
+			foreach ($children as $child) {
+				self::visualize($child, $indentation + 1, false);
+			}
+		}
+		if ($top_level) {
+			echo $no_formatting ? $new_line : "$new_line</pre></div>$new_line";
+		}
+	}
+
+
+	/**
+	 * Calculates the registration's final price, taking into account that they
+	 * need to not only help pay for their OWN ticket, but also any transaction-wide surcharges and taxes,
+	 * and receive a portion of any transaction-wide discounts.
+	 * eg1, if I buy a $1 ticket and brent buys a $9 ticket, and we receive a $5 discount
+	 * then I'll get 1/10 of that $5 discount, which is $0.50, and brent will get
+	 * 9/10ths of that $5 discount, which is $4.50. So my final price should be $0.50
+	 * and brent's final price should be $5.50.
+	 * In order to do this, we basically need to traverse the line item tree calculating
+	 * the running totals (just as if we were recalculating the total), but when we identify
+	 * regular line items, we need to keep track of their share of the grand total.
+	 * Also, we need to keep track of the TAXABLE total for each ticket purchase, so
+	 * we can know how to apply taxes to it. (Note: "taxable total" does not equal the "pretax total"
+	 * when there are non-taxable items; otherwise they would be the same)
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $billable_ticket_quantities          array of EE_Ticket IDs and their corresponding quantity
+	 *                                                          that can be included in price calculations at this
+	 *                                                          moment
+	 * @return array        keys are line items for tickets IDs and values are their share of the running total,
+	 *                                                          plus the key 'total', and 'taxable' which also has keys
+	 *                                                          of all the ticket IDs. Eg array(
+	 *                                                          12 => 4.3
+	 *                                                          23 => 8.0
+	 *                                                          'total' => 16.6,
+	 *                                                          'taxable' => array(
+	 *                                                          12 => 10,
+	 *                                                          23 => 4
+	 *                                                          ).
+	 *                                                          So to find which registrations have which final price,
+	 *                                                          we need to find which line item is theirs, which can be
+	 *                                                          done with
+	 *                                                          `EEM_Line_Item::instance()->get_line_item_for_registration(
+	 *                                                          $registration );`
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function calculate_reg_final_prices_per_line_item(
+		EE_Line_Item $line_item,
+		array $billable_ticket_quantities = []
+	): array {
+		$running_totals = [
+			'total'   => 0,
+			'taxable' => ['total' => 0],
+		];
+		foreach ($line_item->children() as $child_line_item) {
+			switch ($child_line_item->type()) {
+				case EEM_Line_Item::type_sub_total:
+					$running_totals_from_subtotal = EEH_Line_Item::calculate_reg_final_prices_per_line_item(
+						$child_line_item,
+						$billable_ticket_quantities
+					);
+					// combine arrays but preserve numeric keys
+					$running_totals                     = array_replace_recursive(
+						$running_totals_from_subtotal,
+						$running_totals
+					);
+					$running_totals['total']            += $running_totals_from_subtotal['total'];
+					$running_totals['taxable']['total'] += $running_totals_from_subtotal['taxable']['total'];
+					break;
+
+				case EEM_Line_Item::type_tax_sub_total:
+					// find how much the taxes percentage is
+					if ($child_line_item->percent() !== 0.0) {
+						$tax_percent_decimal = $child_line_item->percent() / 100;
+					} else {
+						$tax_percent_decimal = EE_Taxes::get_total_taxes_percentage() / 100;
+					}
+					// and apply to all the taxable totals, and add to the pretax totals
+					foreach ($running_totals as $line_item_id => $this_running_total) {
+						// "total" and "taxable" array key is an exception
+						if ($line_item_id === 'taxable') {
+							continue;
+						}
+						$taxable_total                   = $running_totals['taxable'][ $line_item_id ];
+						$running_totals[ $line_item_id ] += ($taxable_total * $tax_percent_decimal);
+					}
+					break;
+
+				case EEM_Line_Item::type_line_item:
+					// ticket line items or ????
+					if ($child_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) {
+						// kk it's a ticket
+						if (isset($running_totals[ $child_line_item->ID() ])) {
+							// huh? that shouldn't happen.
+							$running_totals['total'] += $child_line_item->total();
+						} else {
+							// it's not in our running totals yet. great.
+							if ($child_line_item->is_taxable()) {
+								$taxable_amount = $child_line_item->unit_price();
+							} else {
+								$taxable_amount = 0;
+							}
+							// are we only calculating totals for some tickets?
+							if (isset($billable_ticket_quantities[ $child_line_item->OBJ_ID() ])) {
+								$quantity = $billable_ticket_quantities[ $child_line_item->OBJ_ID() ];
+
+								$running_totals[ $child_line_item->ID() ]            = $quantity
+									? $child_line_item->unit_price()
+									: 0;
+								$running_totals['taxable'][ $child_line_item->ID() ] = $quantity
+									? $taxable_amount
+									: 0;
+							} else {
+								$quantity                                            = $child_line_item->quantity();
+								$running_totals[ $child_line_item->ID() ]            = $child_line_item->unit_price();
+								$running_totals['taxable'][ $child_line_item->ID() ] = $taxable_amount;
+							}
+							$running_totals['taxable']['total'] += $taxable_amount * $quantity;
+							$running_totals['total']            += $child_line_item->unit_price() * $quantity;
+						}
+					} else {
+						// it's some other type of item added to the cart
+						// it should affect the running totals
+						// basically we want to convert it into a PERCENT modifier. Because
+						// more clearly affect all registration's final price equally
+						$line_items_percent_of_running_total = $running_totals['total'] > 0
+							? ($child_line_item->total() / $running_totals['total']) + 1
+							: 1;
+						foreach ($running_totals as $line_item_id => $this_running_total) {
+							// the "taxable" array key is an exception
+							if ($line_item_id === 'taxable') {
+								continue;
+							}
+							// update the running totals
+							// yes this actually even works for the running grand total!
+							$running_totals[ $line_item_id ] =
+								$line_items_percent_of_running_total * $this_running_total;
+
+							if ($child_line_item->is_taxable()) {
+								$running_totals['taxable'][ $line_item_id ] =
+									$line_items_percent_of_running_total * $running_totals['taxable'][ $line_item_id ];
+							}
+						}
+					}
+					break;
+			}
+		}
+		return $running_totals;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @param EE_Line_Item $ticket_line_item
+	 * @return float | null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws OutOfRangeException
+	 * @throws ReflectionException
+	 */
+	public static function calculate_final_price_for_ticket_line_item(
+		EE_Line_Item $total_line_item,
+		EE_Line_Item $ticket_line_item
+	): ?float {
+		static $final_prices_per_ticket_line_item = [];
+		if (
+			empty($final_prices_per_ticket_line_item)
+			|| empty($final_prices_per_ticket_line_item[ $total_line_item->ID() ])
+		) {
+			$final_prices_per_ticket_line_item[ $total_line_item->ID() ] =
+				EEH_Line_Item::calculate_reg_final_prices_per_line_item(
+					$total_line_item
+				);
+		}
+		// ok now find this new registration's final price
+		if (isset($final_prices_per_ticket_line_item[ $total_line_item->ID() ][ $ticket_line_item->ID() ])) {
+			return $final_prices_per_ticket_line_item[ $total_line_item->ID() ][ $ticket_line_item->ID() ];
+		}
+		$message = sprintf(
+			esc_html__(
+				'The final price for the ticket line item (ID:%1$d) on the total line item (ID:%2$d) could not be calculated.',
+				'event_espresso'
+			),
+			$ticket_line_item->ID(),
+			$total_line_item->ID()
+		);
+		if (WP_DEBUG) {
+			$message .= '<br>' . print_r($final_prices_per_ticket_line_item, true);
+			throw new OutOfRangeException($message);
+		}
+		EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message);
+		return null;
+	}
+
+
+	/**
+	 * Creates a duplicate of the line item tree, except only includes billable items
+	 * and the portion of line items attributed to billable things
+	 *
+	 * @param EE_Line_Item      $line_item
+	 * @param EE_Registration[] $registrations
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function billable_line_item_tree(EE_Line_Item $line_item, array $registrations): EE_Line_Item
+	{
+		$copy_li = EEH_Line_Item::billable_line_item($line_item, $registrations);
+		foreach ($line_item->children() as $child_li) {
+			$copy_li->add_child_line_item(
+				EEH_Line_Item::billable_line_item_tree($child_li, $registrations)
+			);
+		}
+		// if this is the grand total line item, make sure the totals all add up
+		// (we could have duplicated this logic AS we copied the line items, but
+		// it seems DRYer this way)
+		if ($copy_li->type() === EEM_Line_Item::type_total) {
+			$copy_li->recalculate_total_including_taxes();
+		}
+		return $copy_li;
+	}
+
+
+	/**
+	 * Creates a new, unsaved line item from $line_item that factors in the
+	 * number of billable registrations on $registrations.
+	 *
+	 * @param EE_Line_Item      $line_item
+	 * @param EE_Registration[] $registrations
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function billable_line_item(EE_Line_Item $line_item, array $registrations): EE_Line_Item
+	{
+		$new_li_fields = $line_item->model_field_array();
+		if (
+			$line_item->type() === EEM_Line_Item::type_line_item &&
+			$line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
+		) {
+			$count = 0;
+			foreach ($registrations as $registration) {
+				if (
+					$line_item->OBJ_ID() === $registration->ticket_ID() &&
+					in_array(
+						$registration->status_ID(),
+						EEM_Registration::reg_statuses_that_allow_payment(),
+						true
+					)
+				) {
+					$count++;
+				}
+			}
+			$new_li_fields['LIN_quantity'] = $count;
+		}
+		// don't set the total. We'll leave that up to the code that calculates it
+		unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent'], $new_li_fields['LIN_total']);
+		return EE_Line_Item::new_instance($new_li_fields);
+	}
+
+
+	/**
+	 * Returns a modified line item tree where all the subtotals which have a total of 0
+	 * are removed, and line items with a quantity of 0
+	 *
+	 * @param EE_Line_Item $line_item |null
+	 * @return EE_Line_Item|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function non_empty_line_items(EE_Line_Item $line_item): ?EE_Line_Item
+	{
+		$copied_li = EEH_Line_Item::non_empty_line_item($line_item);
+		if ($copied_li === null) {
+			return null;
+		}
+		// if this is an event subtotal, we want to only include it if it
+		// has a non-zero total and at least one ticket line item child
+		$ticket_children = 0;
+		foreach ($line_item->children() as $child_li) {
+			$child_li_copy = EEH_Line_Item::non_empty_line_items($child_li);
+			if ($child_li_copy !== null) {
+				$copied_li->add_child_line_item($child_li_copy);
+				if (
+					$child_li_copy->type() === EEM_Line_Item::type_line_item &&
+					$child_li_copy->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
+				) {
+					$ticket_children++;
+				}
+			}
+		}
+		// if this is an event subtotal with NO ticket children
+		// we basically want to ignore it
+		if (
+			$ticket_children === 0
+			&& $line_item->type() === EEM_Line_Item::type_sub_total
+			&& $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT
+			&& $line_item->total() === 0.0
+		) {
+			return null;
+		}
+		return $copied_li;
+	}
+
+
+	/**
+	 * Creates a new, unsaved line item, but if it's a ticket line item
+	 * with a total of 0, or a subtotal of 0, returns null instead
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function non_empty_line_item(EE_Line_Item $line_item): ?EE_Line_Item
+	{
+		if (
+			$line_item->type() === EEM_Line_Item::type_line_item
+			&& $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
+			&& $line_item->quantity() === 0
+		) {
+			return null;
+		}
+		$new_li_fields = $line_item->model_field_array();
+		// don't set the total. We'll leave that up to the code that calculates it
+		unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent']);
+		return EE_Line_Item::new_instance($new_li_fields);
+	}
+
+
+	/**
+	 * Cycles through all the ticket line items for the supplied total line item
+	 * and ensures that the line item's "is_taxable" field matches that of its corresponding ticket
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.9.79.p
+	 */
+	public static function resetIsTaxableForTickets(EE_Line_Item $total_line_item)
+	{
+		$ticket_line_items = self::get_ticket_line_items($total_line_item);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (
+				$ticket_line_item instanceof EE_Line_Item
+				&& $ticket_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
+			) {
+				$ticket = $ticket_line_item->ticket();
+				if ($ticket instanceof EE_Ticket && $ticket->taxable() !== $ticket_line_item->is_taxable()) {
+					$ticket_line_item->set_is_taxable($ticket->taxable());
+					$ticket_line_item->save();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	private static function getGlobalTaxes(): array
+	{
+		if (EEH_Line_Item::$global_taxes === null) {
+			/** @type EEM_Price $EEM_Price */
+			$EEM_Price = EE_Registry::instance()->load_model('Price');
+			// get array of taxes via Price Model
+			EEH_Line_Item::$global_taxes = $EEM_Price->get_all_prices_that_are_taxes();
+			ksort(EEH_Line_Item::$global_taxes);
+		}
+		return EEH_Line_Item::$global_taxes;
+	}
+
+
+
+	/**************************************** @DEPRECATED METHODS *************************************** */
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function get_items_subtotal(EE_Line_Item $total_line_item): EE_Line_Item
+	{
+		EE_Error::doing_it_wrong(
+			'EEH_Line_Item::get_items_subtotal()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::get_pre_tax_subtotal()'
+			),
+			'4.6.0'
+		);
+		return self::get_pre_tax_subtotal($total_line_item);
+	}
+
+
+	/**
+	 * @param EE_Transaction|null $transaction
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function create_default_total_line_item(?EE_Transaction $transaction = null): EE_Line_Item
+	{
+		EE_Error::doing_it_wrong(
+			'EEH_Line_Item::create_default_total_line_item()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::create_total_line_item()'
+			),
+			'4.6.0'
+		);
+		return self::create_total_line_item($transaction);
+	}
+
+
+	/**
+	 * @param EE_Line_Item        $total_line_item
+	 * @param EE_Transaction|null $transaction
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function create_default_tickets_subtotal(
+		EE_Line_Item $total_line_item,
+		?EE_Transaction $transaction = null
+	): EE_Line_Item {
+		EE_Error::doing_it_wrong(
+			'EEH_Line_Item::create_default_tickets_subtotal()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::create_pre_tax_subtotal()'
+			),
+			'4.6.0'
+		);
+		return self::create_pre_tax_subtotal($total_line_item, $transaction);
+	}
+
+
+	/**
+	 * @param EE_Line_Item        $total_line_item
+	 * @param EE_Transaction|null $transaction
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function create_default_taxes_subtotal(
+		EE_Line_Item $total_line_item,
+		?EE_Transaction $transaction = null
+	): EE_Line_Item {
+		EE_Error::doing_it_wrong(
+			'EEH_Line_Item::create_default_taxes_subtotal()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::create_taxes_subtotal()'
+			),
+			'4.6.0'
+		);
+		return self::create_taxes_subtotal($total_line_item, $transaction);
+	}
+
+
+	/**
+	 * @param EE_Line_Item        $total_line_item
+	 * @param EE_Transaction|null $transaction
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function create_default_event_subtotal(
+		EE_Line_Item $total_line_item,
+		?EE_Transaction $transaction = null
+	): EE_Line_Item {
+		EE_Error::doing_it_wrong(
+			'EEH_Line_Item::create_default_event_subtotal()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::create_event_subtotal()'
+			),
+			'4.6.0'
+		);
+		return self::create_event_subtotal($total_line_item, $transaction);
+	}
 }

Spacing +47 added lines, -47 removed lines

@@ -24,7 +24,7 @@ 
     /**
      * @var EE_Line_Item[]|null
      */
-    private static ?array $global_taxes = null;
+    private static ? array $global_taxes = null;
 
 
     /**
@@ -73,12 +73,12 @@ 
                 'LIN_code'       => $code,
             ]
         );
-        $line_item      = apply_filters(
+        $line_item = apply_filters(
             'FHEE__EEH_Line_Item__add_unrelated_item__line_item',
             $line_item,
             $parent_line_item
         );
-        $added          = self::add_item($parent_line_item, $line_item, $recalculate_totals);
+        $added = self::add_item($parent_line_item, $line_item, $recalculate_totals);
         return $return_item ? $line_item : $added;
     }
 
@@ -131,7 +131,7 @@ 
             'FHEE__EEH_Line_Item__add_percentage_based_item__line_item',
             $line_item
         );
-        $added     = $parent_line_item->add_child_line_item($line_item, false);
+        $added = $parent_line_item->add_child_line_item($line_item, false);
         return $return_item ? $line_item : $added;
     }
 
@@ -160,7 +160,7 @@ 
         int $qty = 1,
         bool $recalculate_totals = true
     ): ?EE_Line_Item {
-        if (! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) {
+        if ( ! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -175,7 +175,7 @@ 
         // either increment the qty for an existing ticket
         $line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty);
         // or add a new one
-        if (! $line_item instanceof EE_Line_Item) {
+        if ( ! $line_item instanceof EE_Line_Item) {
             $line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty);
         }
         if ($recalculate_totals) {
@@ -239,7 +239,7 @@ 
      */
     public static function increment_quantity(EE_Line_Item $line_item, int $qty = 1)
     {
-        if (! $line_item->is_percent()) {
+        if ( ! $line_item->is_percent()) {
             $qty += $line_item->quantity();
             $line_item->set_quantity($qty);
             $line_item->set_total($line_item->unit_price() * $qty);
@@ -268,7 +268,7 @@ 
      */
     public static function decrement_quantity(EE_Line_Item $line_item, int $qty = 1)
     {
-        if (! $line_item->is_percent()) {
+        if ( ! $line_item->is_percent()) {
             $qty = $line_item->quantity() - $qty;
             $qty = max($qty, 0);
             $line_item->set_quantity($qty);
@@ -297,7 +297,7 @@ 
      */
     public static function update_quantity(EE_Line_Item $line_item, int $new_quantity)
     {
-        if (! $line_item->is_percent()) {
+        if ( ! $line_item->is_percent()) {
             $line_item->set_quantity($new_quantity);
             $line_item->set_total($line_item->unit_price() * $new_quantity);
             $line_item->save();
@@ -342,7 +342,7 @@ 
         $line_item = EE_Line_Item::new_instance(
             [
                 'LIN_name'       => $ticket->name(),
-                'LIN_desc'       => $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event,
+                'LIN_desc'       => $ticket->description() !== '' ? $ticket->description().' '.$event : $event,
                 'LIN_unit_price' => $ticket->price(),
                 'LIN_quantity'   => $qty,
                 'LIN_is_taxable' => empty($taxes) && $ticket->taxable(),
@@ -357,7 +357,7 @@ 
             'FHEE__EEH_Line_Item__create_ticket_line_item__line_item',
             $line_item
         );
-        if (! $line_item instanceof EE_Line_Item) {
+        if ( ! $line_item instanceof EE_Line_Item) {
             throw new DomainException(
                 esc_html__('Invalid EE_Line_Item received.', 'event_espresso')
             );
@@ -396,7 +396,7 @@ 
                 ? $price_type->name()
                 : $price_desc;
 
-            $sub_line_item         = EE_Line_Item::new_instance(
+            $sub_line_item = EE_Line_Item::new_instance(
                 [
                     'LIN_name'       => $price->name(),
                     'LIN_desc'       => $price_desc,
@@ -413,7 +413,7 @@ 
                     'OBJ_type'       => EEM_Line_Item::OBJ_TYPE_PRICE,
                 ]
             );
-            $sub_line_item         = apply_filters(
+            $sub_line_item = apply_filters(
                 'FHEE__EEH_Line_Item__create_ticket_line_item__sub_line_item',
                 $sub_line_item
             );
@@ -530,7 +530,7 @@ 
                             'event_espresso'
                         ),
                         $ticket_line_item->name(),
-                        current_time(get_option('date_format') . ' ' . get_option('time_format'))
+                        current_time(get_option('date_format').' '.get_option('time_format'))
                     ),
                     'LIN_total'      => 0,
                     'LIN_unit_price' => 0,
@@ -594,7 +594,7 @@ 
         );
         $cancellation_line_item = reset($cancellation_line_item);
         // verify that this ticket was indeed previously cancelled
-        if (! $cancellation_line_item instanceof EE_Line_Item) {
+        if ( ! $cancellation_line_item instanceof EE_Line_Item) {
             return false;
         }
         if ($cancellation_line_item->quantity() > $qty) {
@@ -812,7 +812,7 @@ 
                 'LIN_code'  => 'taxes',
                 'LIN_name'  => esc_html__('Taxes', 'event_espresso'),
                 'LIN_type'  => EEM_Line_Item::type_tax_sub_total,
-                'LIN_order' => 1000,// this should always come last
+                'LIN_order' => 1000, // this should always come last
             ]
         );
         $tax_line_item = apply_filters(
@@ -890,7 +890,7 @@ 
      */
     public static function get_event_code(?EE_Event $event = null): string
     {
-        return 'event-' . ($event instanceof EE_Event ? $event->ID() : '0');
+        return 'event-'.($event instanceof EE_Event ? $event->ID() : '0');
     }
 
 
@@ -941,7 +941,7 @@ 
     public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket): EE_Line_Item
     {
         $first_datetime = $ticket->first_datetime();
-        if (! $first_datetime instanceof EE_Datetime) {
+        if ( ! $first_datetime instanceof EE_Datetime) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('The supplied ticket (ID %d) has no datetimes', 'event_espresso'),
@@ -950,7 +950,7 @@ 
             );
         }
         $event = $first_datetime->event();
-        if (! $event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -962,7 +962,7 @@ 
             );
         }
         $events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event);
-        if (! $events_sub_total instanceof EE_Line_Item) {
+        if ( ! $events_sub_total instanceof EE_Line_Item) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -990,7 +990,7 @@ 
     public static function get_event_line_item(EE_Line_Item $total_line_item, ?EE_Event $event = null): ?EE_Line_Item
     {
         /** @type EE_Event $event */
-        $event           = EEM_Event::instance()->ensure_is_obj($event, true);
+        $event = EEM_Event::instance()->ensure_is_obj($event, true);
         $event_line_items = EEH_Line_Item::get_event_subtotals($total_line_item);
         $existing_event_line_item = null;
         foreach ($event_line_items as $event_line_item) {
@@ -1001,7 +1001,7 @@ 
                 $existing_event_line_item = $event_line_item;
                 break;
             }
-            if (! $OBJ_ID) {
+            if ( ! $OBJ_ID) {
                 // OK?!?! We have an event subtotal that is not actually associated with any event???
                 // let's just use this line item since it's already there, but first... set the event details
                 $existing_event_line_item = $event_line_item;
@@ -1091,7 +1091,7 @@ 
                             break;
                         }
                     }
-                    if (! $found) {
+                    if ( ! $found) {
                         // add a new line item for this global tax
                         $tax_line_item = apply_filters(
                             'FHEE__EEH_Line_Item__apply_taxes__tax_line_item',
@@ -1109,7 +1109,7 @@ 
                                 ]
                             )
                         );
-                        $updates       = $taxes_line_item->add_child_line_item($tax_line_item) ? true : $updates;
+                        $updates = $taxes_line_item->add_child_line_item($tax_line_item) ? true : $updates;
                     }
                 }
             }
@@ -1138,7 +1138,7 @@ 
     public static function ensure_taxes_applied(?EE_Line_Item $total_line_item): float
     {
         $taxes_subtotal = self::get_taxes_subtotal($total_line_item);
-        if (! $taxes_subtotal->children()) {
+        if ( ! $taxes_subtotal->children()) {
             self::apply_taxes($total_line_item);
         }
         return $taxes_subtotal->total();
@@ -1204,7 +1204,7 @@ 
         }
 
         // check if only a single line_item_id was passed
-        if (! empty($line_item_codes) && ! is_array($line_item_codes)) {
+        if ( ! empty($line_item_codes) && ! is_array($line_item_codes)) {
             // place single line_item_id in an array to appear as multiple line_item_ids
             $line_item_codes = [$line_item_codes];
         }
@@ -1313,7 +1313,7 @@ 
         if ($code_substring_for_whitelist !== null) {
             $whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false;
         }
-        if (! $whitelisted && $line_item->is_line_item()) {
+        if ( ! $whitelisted && $line_item->is_line_item()) {
             $line_item->set_is_taxable($taxable);
         }
         foreach ($line_item->children() as $child_line_item) {
@@ -1695,10 +1695,10 @@ 
      */
     public static function visualize(EE_Line_Item $line_item, int $indentation = 0, bool $top_level = true)
     {
-        if (! defined('WP_DEBUG') || ! WP_DEBUG) {
+        if ( ! defined('WP_DEBUG') || ! WP_DEBUG) {
             return;
         }
-        $no_formatting  = defined('EE_TESTS_DIR') || (defined('DOING_AJAX') && DOING_AJAX);
+        $no_formatting = defined('EE_TESTS_DIR') || (defined('DOING_AJAX') && DOING_AJAX);
         $new_line = $no_formatting ? "\n" : '<br />';
         if ($top_level && ! $no_formatting) {
             echo '<div style="position: relative; z-index: 9999; margin: 2rem;">';
@@ -1794,7 +1794,7 @@ 
                         $billable_ticket_quantities
                     );
                     // combine arrays but preserve numeric keys
-                    $running_totals                     = array_replace_recursive(
+                    $running_totals = array_replace_recursive(
                         $running_totals_from_subtotal,
                         $running_totals
                     );
@@ -1815,8 +1815,8 @@ 
                         if ($line_item_id === 'taxable') {
                             continue;
                         }
-                        $taxable_total                   = $running_totals['taxable'][ $line_item_id ];
-                        $running_totals[ $line_item_id ] += ($taxable_total * $tax_percent_decimal);
+                        $taxable_total = $running_totals['taxable'][$line_item_id];
+                        $running_totals[$line_item_id] += ($taxable_total * $tax_percent_decimal);
                     }
                     break;
 
@@ -1824,7 +1824,7 @@ 
                     // ticket line items or ????
                     if ($child_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) {
                         // kk it's a ticket
-                        if (isset($running_totals[ $child_line_item->ID() ])) {
+                        if (isset($running_totals[$child_line_item->ID()])) {
                             // huh? that shouldn't happen.
                             $running_totals['total'] += $child_line_item->total();
                         } else {
@@ -1835,19 +1835,19 @@ 
                                 $taxable_amount = 0;
                             }
                             // are we only calculating totals for some tickets?
-                            if (isset($billable_ticket_quantities[ $child_line_item->OBJ_ID() ])) {
-                                $quantity = $billable_ticket_quantities[ $child_line_item->OBJ_ID() ];
+                            if (isset($billable_ticket_quantities[$child_line_item->OBJ_ID()])) {
+                                $quantity = $billable_ticket_quantities[$child_line_item->OBJ_ID()];
 
-                                $running_totals[ $child_line_item->ID() ]            = $quantity
+                                $running_totals[$child_line_item->ID()]            = $quantity
                                     ? $child_line_item->unit_price()
                                     : 0;
-                                $running_totals['taxable'][ $child_line_item->ID() ] = $quantity
+                                $running_totals['taxable'][$child_line_item->ID()] = $quantity
                                     ? $taxable_amount
                                     : 0;
                             } else {
                                 $quantity                                            = $child_line_item->quantity();
-                                $running_totals[ $child_line_item->ID() ]            = $child_line_item->unit_price();
-                                $running_totals['taxable'][ $child_line_item->ID() ] = $taxable_amount;
+                                $running_totals[$child_line_item->ID()]            = $child_line_item->unit_price();
+                                $running_totals['taxable'][$child_line_item->ID()] = $taxable_amount;
                             }
                             $running_totals['taxable']['total'] += $taxable_amount * $quantity;
                             $running_totals['total']            += $child_line_item->unit_price() * $quantity;
@@ -1867,12 +1867,12 @@ 
                             }
                             // update the running totals
                             // yes this actually even works for the running grand total!
-                            $running_totals[ $line_item_id ] =
+                            $running_totals[$line_item_id] =
                                 $line_items_percent_of_running_total * $this_running_total;
 
                             if ($child_line_item->is_taxable()) {
-                                $running_totals['taxable'][ $line_item_id ] =
-                                    $line_items_percent_of_running_total * $running_totals['taxable'][ $line_item_id ];
+                                $running_totals['taxable'][$line_item_id] =
+                                    $line_items_percent_of_running_total * $running_totals['taxable'][$line_item_id];
                             }
                         }
                     }
@@ -1901,16 +1901,16 @@ 
         static $final_prices_per_ticket_line_item = [];
         if (
             empty($final_prices_per_ticket_line_item)
-            || empty($final_prices_per_ticket_line_item[ $total_line_item->ID() ])
+            || empty($final_prices_per_ticket_line_item[$total_line_item->ID()])
         ) {
-            $final_prices_per_ticket_line_item[ $total_line_item->ID() ] =
+            $final_prices_per_ticket_line_item[$total_line_item->ID()] =
                 EEH_Line_Item::calculate_reg_final_prices_per_line_item(
                     $total_line_item
                 );
         }
         // ok now find this new registration's final price
-        if (isset($final_prices_per_ticket_line_item[ $total_line_item->ID() ][ $ticket_line_item->ID() ])) {
-            return $final_prices_per_ticket_line_item[ $total_line_item->ID() ][ $ticket_line_item->ID() ];
+        if (isset($final_prices_per_ticket_line_item[$total_line_item->ID()][$ticket_line_item->ID()])) {
+            return $final_prices_per_ticket_line_item[$total_line_item->ID()][$ticket_line_item->ID()];
         }
         $message = sprintf(
             esc_html__(
@@ -1921,7 +1921,7 @@ 
             $total_line_item->ID()
         );
         if (WP_DEBUG) {
-            $message .= '<br>' . print_r($final_prices_per_ticket_line_item, true);
+            $message .= '<br>'.print_r($final_prices_per_ticket_line_item, true);
             throw new OutOfRangeException($message);
         }
         EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message);

core/helpers/EEH_HTML.helper.php

Indentation +940 added lines, -940 removed lines

@@ -15,944 +15,944 @@
  */
 class EEH_HTML
 {
-    private static ?EEH_HTML $_instance = null;
-
-    /**
-     * some initial formatting for table indentation
-     *
-     * @var int[]
-     */
-    private static array $_indent = [
-        'table' => 0,
-        'thead' => 1,
-        'tbody' => 1,
-        'tr'    => 2,
-        'th'    => 3,
-        'td'    => 3,
-        'div'   => 0,
-        'h1'    => 0,
-        'h2'    => 0,
-        'h3'    => 0,
-        'h4'    => 0,
-        'h5'    => 0,
-        'h6'    => 0,
-        'p'     => 0,
-        'ul'    => 0,
-        'li'    => 1,
-    ];
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EEH_HTML
-     */
-    public static function instance(): EEH_HTML
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_HTML) {
-            self::$_instance = new EEH_HTML();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Generates an opening HTML <XX> tag and adds any passed attributes
-     * if passed content, it will also add that, as well as the closing </XX> tag
-     *
-     * @param string $tag
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @param bool   $force_close
-     * @return string
-     */
-    protected static function _open_tag(
-        string $tag = 'div',
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = '',
-        bool $force_close = false
-    ): string {
-        $attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        $html       = EEH_HTML::nl(0, $tag) . '<' . $tag . $attributes . '>';
-        $html       .= trim($content) !== '' ? EEH_HTML::nl(1, $tag) . $content : '';
-        $indent     = ! empty($content) || $force_close;
-        $html       .= ! empty($content) || $force_close
-            ? EEH_HTML::_close_tag($tag, $id, $class, $indent, $content)
-            : '';
-        return $html;
-    }
-
-
-    /**
-     * Generates HTML closing </XX> tag - if passed the id or class attribute
-     * used for the opening tag, will append a comment
-     *
-     * @access protected
-     * @param string $tag
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @param bool   $indent
-     * @param string $content
-     * @return string
-     */
-    protected static function _close_tag(
-        string $tag = 'div',
-        string $id = '',
-        string $class = '',
-        bool $indent = true,
-        string $content = ''
-    ): string {
-        $alotta_content = strlen($content) > 500;
-        $comment         = '';
-        if ($id && $alotta_content) {
-            $comment = EEH_HTML::comment('close ' . $id) . EEH_HTML::nl(0, $tag);
-        } elseif ($class && $alotta_content) {
-            $comment = EEH_HTML::comment('close ' . $class) . EEH_HTML::nl(0, $tag);
-        }
-        $html = $indent ? EEH_HTML::nl(-1, $tag) : '';
-        $html .= '</' . $tag . '>' . $comment;
-        return $html;
-    }
-
-
-    /**
-     *  div - generates HTML opening <div> tag and adds any passed attributes
-     *  to add an id use:       echo EEH_HTML::div( 'this is some content', 'footer' );
-     *  to add a class use:     echo EEH_HTML::div( 'this is some content', '', 'float_left' );
-     *  to add a both an id and a class use:    echo EEH_HTML::div( 'this is some content', 'footer', 'float_left' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function div(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('div', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * Generates HTML closing </div> tag - if passed the id or class attribute used for the opening div tag, will
-     * append a comment usage: echo EEH_HTML::divx();
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function divx(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('div', $id, $class);
-    }
-
-
-    /**
-     * Generates HTML <h1></h1> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h1( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h1(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('h1', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-    /**
-     * Generates HTML <h2></h2> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h2( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h2(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('h2', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-    /**
-     * Generates HTML <h3></h3> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h3( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h3(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('h3', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-    /**
-     * Generates HTML <h4></h4> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h4( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h4(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('h4', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-    /**
-     * Generates HTML <h5></h5> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h5( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h5(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('h5', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-    /**
-     * Generates HTML <h6></h6> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::h6( 'This is a Heading' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function h6(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('h6', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-    /**
-     * Generates HTML <p></p> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::p( 'this is a paragraph' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function p(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('p', $content, $id, $class, $style, $other_attributes, true);
-    }
-
-
-    /**
-     *  ul - generates HTML opening <ul> tag and adds any passed attributes
-     *  usage:      echo EEH_HTML::ul( 'my-list-id', 'my-list-class' );
-     *
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function ul(
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('ul', '', $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * Generates HTML closing </ul> tag - if passed the id or class attribute used for the opening ul tag, will append
-     * a comment usage: echo EEH_HTML::ulx();
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function ulx(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('ul', $id, $class);
-    }
-
-
-    /**
-     * Generates HTML <li> tag, inserts content, and adds any passed attributes
-     * if passed content, it will also add that, as well as the closing </li> tag
-     * usage: echo EEH_HTML::li( 'this is a line item' );
-     *
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function li(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('li', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * Generates HTML closing </li> tag - if passed the id or class attribute used for the opening ul tag, will append
-     * a comment usage: echo EEH_HTML::lix();
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function lix(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('li', $id, $class);
-    }
-
-
-    /**
-     *    table - generates an HTML <table> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::table();
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function table(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('table', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * tablex - generates an HTML </table> tag - if passed the id or class attribute used for the opening ul tag, will
-     * append a comment
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function tablex(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('table', $id, $class);
-    }
-
-
-    /**
-     *    thead - generates an HTML <thead> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::thead();
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function thead(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('thead', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * theadx - generates an HTML </thead> tag - if passed the id or class attribute used for the opening ul tag, will
-     * append a comment
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function theadx(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('thead', $id, $class);
-    }
-
-
-    /**
-     *    tbody - generates an HTML <tbody> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::tbody();
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function tbody(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('tbody', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * tbodyx - generates an HTML </tbody> tag - if passed the id or class attribute used for the opening ul tag, will
-     * append a comment
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function tbodyx(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('tbody', $id, $class);
-    }
-
-
-    /**
-     *    tr - generates an HTML <tr> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::tr();
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function tr(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('tr', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * trx - generates an HTML </tr> tag - if passed the id or class attribute used for the opening ul tag, will append
-     * a comment
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function trx(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('tr', $id, $class);
-    }
-
-
-    /**
-     *    th - generates an HTML <th> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::th();
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function th(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = 'scope="col"'
-    ): string {
-        return EEH_HTML::_open_tag('th', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * thx - generates an HTML </th> tag - if passed the id or class attribute used for the opening ul tag, will append
-     * a comment
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function thx(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('th', $id, $class);
-    }
-
-
-    /**
-     *    td - generates an HTML <td> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::td();
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function td(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_open_tag('td', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * tdx - generates an HTML </td> tag - if passed the id or class attribute used for the opening ul tag, will append
-     * a comment
-     *
-     * @param string $id    - html id attribute
-     * @param string $class - html class attribute
-     * @return string
-     */
-    public static function tdx(string $id = '', string $class = ''): string
-    {
-        return EEH_HTML::_close_tag('td', $id, $class);
-    }
-
-
-    /**
-     * no_row - for generating a "hidden" table row, good for embedding tables within tables
-     * generates a new table row with one td cell that spans however many columns you set
-     * removes all styles from the tr and td
-     *
-     * @param string $content
-     * @param int    $colspan
-     * @return string
-     */
-    public static function no_row(string $content = '', int $colspan = 2): string
-    {
-        return EEH_HTML::tr(
-            EEH_HTML::td($content, '', '', '', 'colspan="' . $colspan . '"'),
-            '',
-            'ee-no-row'
-        );
-    }
-
-
-    /**
-     * Generates HTML <a href="url">text</a> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::link( 'domain.com', 'this is a link' );
-     *
-     * @param string $href             URL to link to
-     * @param string $link_text        - the text that will become "hyperlinked"
-     * @param string $title            - html title attribute
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function link(
-        string $href = '',
-        string $link_text = '',
-        string $title = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        $link_text  = ! empty($link_text) ? $link_text : $href;
-        $attributes = ! empty($href) ? ' href="' . $href . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($title) ? ' title="' . esc_attr($title) . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return "<a$attributes>$link_text</a>";
-    }
-
-
-    /**
-     * Generates HTML <button>text</button> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::button( 'this is a button' );
-     *
-     * @param string $btn_text         - the text that will become "hyperlinked"
-     * @param string $class            - html class attribute
-     * @param string $aria_label       - aria-label attribute
-     * @param string $id               - html id attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function button(
-        string $btn_text = '',
-        string $class = '',
-        string $aria_label = '',
-        string $id = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        $attributes = ! empty($aria_label) ? ' aria-label="' . $aria_label . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return "<button type='button' $attributes>$btn_text</button>";
-    }
-
-
-    /**
-     *    img - generates an HTML <img> tag and adds any passed attributes
-     *    usage: echo EEH_HTML::img();
-     *
-     * @param string $src              - html src attribute ie: the path or URL to the image
-     * @param string $alt              - html alt attribute
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function img(
-        string $src = '',
-        string $alt = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        $attributes = ! empty($src) ? ' src="' . esc_url_raw($src) . '"' : '';
-        $attributes .= ! empty($alt) ? ' alt="' . esc_attr($alt) . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return '<img' . $attributes . '/>';
-    }
-
-
-    /**
-     * Generates HTML <tag></tag> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::span( 'this is some inline text' );
-     *
-     * @param string $tag
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    protected static function _inline_tag(
-        string $tag = 'span',
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        $attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return '<' . $tag . ' ' . $attributes . '>' . $content . '</' . $tag . '>';
-    }
-
-
-    /**
-     * Generates HTML <label></label> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::span( 'this is some inline text' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function label(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_inline_tag('label', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * Generates HTML <span></span> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::span( 'this is some inline text' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function span(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_inline_tag('span', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * Generates HTML <span></span> tags, inserts content, and adds any passed attributes
-     * usage: echo EEH_HTML::span( 'this is some inline text' );
-     *
-     * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
-     * @param string $id               - html id attribute
-     * @param string $class            - html class attribute
-     * @param string $style            - html style attribute for applying inline styles
-     * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
-     * @return string
-     */
-    public static function strong(
-        string $content = '',
-        string $id = '',
-        string $class = '',
-        string $style = '',
-        string $other_attributes = ''
-    ): string {
-        return EEH_HTML::_inline_tag('strong', $content, $id, $class, $style, $other_attributes);
-    }
-
-
-    /**
-     * Generates an html <--  comment --> tag
-     *  usage: echo comment( 'this is a comment' );
-     *
-     * @param string $comment
-     * @return string
-     */
-    public static function comment(string $comment = ''): string
-    {
-        return ! empty($comment) ? EEH_HTML::nl() . '<!-- ' . $comment . ' -->' : '';
-    }
-
-
-    /**
-     * br - generates a line break
-     *
-     * @param int $number - the number of line breaks to return
-     * @return string
-     */
-    public static function br(int $number = 1): string
-    {
-        return str_repeat('<br />', $number);
-    }
-
-
-    /**
-     * nbsp - generates non-breaking space entities based on number supplied
-     *
-     * @param int $number - the number of non-breaking spaces to return
-     * @return string
-     */
-    public static function nbsp(int $number = 1): string
-    {
-        return str_repeat('&nbsp;', $number);
-    }
-
-
-    /**
-     * sanitize_id
-     * functionally does the same as the wp_core function sanitize_key except it does NOT use
-     * strtolower and allows capitals.
-     *
-     * @param string $id
-     * @return string
-     */
-    public static function sanitize_id(string $id = ''): string
-    {
-        $key = str_replace(' ', '-', trim($id));
-        return preg_replace('/[^a-zA-Z0-9_\-]/', '', $key);
-    }
-
-
-    /**
-     * return a newline and tabs ("nl" stands for "new line")
-     *
-     * @param int    $indent the number of tabs to ADD to the current indent (can be negative or zero)
-     * @param string $tag
-     * @return string - newline character plus # of indents passed (can be + or -)
-     */
-    public static function nl(int $indent = 0, string $tag = 'none'): string
-    {
-        $html = "\n";
-        EEH_HTML::indent($indent, $tag);
-        $html .= str_repeat("\t", EEH_HTML::$_indent[ $tag ]);
-        return $html;
-    }
-
-
-    /**
-     * Changes the indents used in EEH_HTML::nl. Often it's convenient to change
-     * the indentation level without actually creating a new line
-     *
-     * @param int    $indent can be negative to decrease the indentation level
-     * @param string $tag
-     */
-    public static function indent(int $indent, string $tag = 'none')
-    {
-        static $default_indentation = false;
-        if (! $default_indentation) {
-            EEH_HTML::_set_default_indentation();
-            $default_indentation = true;
-        }
-        if (! isset(EEH_HTML::$_indent[ $tag ])) {
-            EEH_HTML::$_indent[ $tag ] = 0;
-        }
-        EEH_HTML::$_indent[ $tag ] += $indent;
-        EEH_HTML::$_indent[ $tag ] = max(EEH_HTML::$_indent[ $tag ], 0);
-    }
-
-
-    /**
-     *  class _set_default_indentation
-     */
-    private static function _set_default_indentation()
-    {
-        // set some initial formatting for table indentation
-        EEH_HTML::$_indent = [
-            'none'     => 0,
-            'form'     => 0,
-            'radio'    => 0,
-            'checkbox' => 0,
-            'select'   => 0,
-            'option'   => 0,
-            'optgroup' => 0,
-            'table'    => 1,
-            'thead'    => 2,
-            'tbody'    => 2,
-            'tr'       => 3,
-            'th'       => 4,
-            'td'       => 4,
-            'div'      => 0,
-            'h1'       => 0,
-            'h2'       => 0,
-            'h3'       => 0,
-            'h4'       => 0,
-            'h5'       => 0,
-            'h6'       => 0,
-            'p'        => 0,
-            'ul'       => 0,
-            'li'       => 1,
-        ];
-    }
-
-
-    /**
-     * Retrieves the list of tags considered "simple", that are probably safe for
-     * use in inputs
-     *
-     * @return array
-     * @global array $allowedtags
-     */
-    public static function get_simple_tags(): array
-    {
-        global $allowedtags;
-        $tags_we_allow = array_merge_recursive(
-            $allowedtags,
-            [
-                'ol' => [],
-                'ul' => [],
-                'li' => [],
-                'br' => [],
-                'p'  => [],
-                'a'  => ['target'],
-            ]
-        );
-        return apply_filters('FHEE__EEH_HTML__get_simple_tags', $tags_we_allow);
-    }
+	private static ?EEH_HTML $_instance = null;
+
+	/**
+	 * some initial formatting for table indentation
+	 *
+	 * @var int[]
+	 */
+	private static array $_indent = [
+		'table' => 0,
+		'thead' => 1,
+		'tbody' => 1,
+		'tr'    => 2,
+		'th'    => 3,
+		'td'    => 3,
+		'div'   => 0,
+		'h1'    => 0,
+		'h2'    => 0,
+		'h3'    => 0,
+		'h4'    => 0,
+		'h5'    => 0,
+		'h6'    => 0,
+		'p'     => 0,
+		'ul'    => 0,
+		'li'    => 1,
+	];
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EEH_HTML
+	 */
+	public static function instance(): EEH_HTML
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EEH_HTML) {
+			self::$_instance = new EEH_HTML();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Generates an opening HTML <XX> tag and adds any passed attributes
+	 * if passed content, it will also add that, as well as the closing </XX> tag
+	 *
+	 * @param string $tag
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @param bool   $force_close
+	 * @return string
+	 */
+	protected static function _open_tag(
+		string $tag = 'div',
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = '',
+		bool $force_close = false
+	): string {
+		$attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
+		$attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
+		$attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
+		$attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+		$html       = EEH_HTML::nl(0, $tag) . '<' . $tag . $attributes . '>';
+		$html       .= trim($content) !== '' ? EEH_HTML::nl(1, $tag) . $content : '';
+		$indent     = ! empty($content) || $force_close;
+		$html       .= ! empty($content) || $force_close
+			? EEH_HTML::_close_tag($tag, $id, $class, $indent, $content)
+			: '';
+		return $html;
+	}
+
+
+	/**
+	 * Generates HTML closing </XX> tag - if passed the id or class attribute
+	 * used for the opening tag, will append a comment
+	 *
+	 * @access protected
+	 * @param string $tag
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @param bool   $indent
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function _close_tag(
+		string $tag = 'div',
+		string $id = '',
+		string $class = '',
+		bool $indent = true,
+		string $content = ''
+	): string {
+		$alotta_content = strlen($content) > 500;
+		$comment         = '';
+		if ($id && $alotta_content) {
+			$comment = EEH_HTML::comment('close ' . $id) . EEH_HTML::nl(0, $tag);
+		} elseif ($class && $alotta_content) {
+			$comment = EEH_HTML::comment('close ' . $class) . EEH_HTML::nl(0, $tag);
+		}
+		$html = $indent ? EEH_HTML::nl(-1, $tag) : '';
+		$html .= '</' . $tag . '>' . $comment;
+		return $html;
+	}
+
+
+	/**
+	 *  div - generates HTML opening <div> tag and adds any passed attributes
+	 *  to add an id use:       echo EEH_HTML::div( 'this is some content', 'footer' );
+	 *  to add a class use:     echo EEH_HTML::div( 'this is some content', '', 'float_left' );
+	 *  to add a both an id and a class use:    echo EEH_HTML::div( 'this is some content', 'footer', 'float_left' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function div(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('div', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * Generates HTML closing </div> tag - if passed the id or class attribute used for the opening div tag, will
+	 * append a comment usage: echo EEH_HTML::divx();
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function divx(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('div', $id, $class);
+	}
+
+
+	/**
+	 * Generates HTML <h1></h1> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h1( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h1(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('h1', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+	/**
+	 * Generates HTML <h2></h2> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h2( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h2(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('h2', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+	/**
+	 * Generates HTML <h3></h3> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h3( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h3(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('h3', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+	/**
+	 * Generates HTML <h4></h4> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h4( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h4(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('h4', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+	/**
+	 * Generates HTML <h5></h5> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h5( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h5(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('h5', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+	/**
+	 * Generates HTML <h6></h6> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::h6( 'This is a Heading' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function h6(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('h6', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+	/**
+	 * Generates HTML <p></p> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::p( 'this is a paragraph' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function p(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('p', $content, $id, $class, $style, $other_attributes, true);
+	}
+
+
+	/**
+	 *  ul - generates HTML opening <ul> tag and adds any passed attributes
+	 *  usage:      echo EEH_HTML::ul( 'my-list-id', 'my-list-class' );
+	 *
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function ul(
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('ul', '', $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * Generates HTML closing </ul> tag - if passed the id or class attribute used for the opening ul tag, will append
+	 * a comment usage: echo EEH_HTML::ulx();
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function ulx(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('ul', $id, $class);
+	}
+
+
+	/**
+	 * Generates HTML <li> tag, inserts content, and adds any passed attributes
+	 * if passed content, it will also add that, as well as the closing </li> tag
+	 * usage: echo EEH_HTML::li( 'this is a line item' );
+	 *
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function li(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('li', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * Generates HTML closing </li> tag - if passed the id or class attribute used for the opening ul tag, will append
+	 * a comment usage: echo EEH_HTML::lix();
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function lix(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('li', $id, $class);
+	}
+
+
+	/**
+	 *    table - generates an HTML <table> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::table();
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function table(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('table', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * tablex - generates an HTML </table> tag - if passed the id or class attribute used for the opening ul tag, will
+	 * append a comment
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function tablex(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('table', $id, $class);
+	}
+
+
+	/**
+	 *    thead - generates an HTML <thead> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::thead();
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function thead(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('thead', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * theadx - generates an HTML </thead> tag - if passed the id or class attribute used for the opening ul tag, will
+	 * append a comment
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function theadx(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('thead', $id, $class);
+	}
+
+
+	/**
+	 *    tbody - generates an HTML <tbody> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::tbody();
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function tbody(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('tbody', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * tbodyx - generates an HTML </tbody> tag - if passed the id or class attribute used for the opening ul tag, will
+	 * append a comment
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function tbodyx(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('tbody', $id, $class);
+	}
+
+
+	/**
+	 *    tr - generates an HTML <tr> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::tr();
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function tr(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('tr', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * trx - generates an HTML </tr> tag - if passed the id or class attribute used for the opening ul tag, will append
+	 * a comment
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function trx(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('tr', $id, $class);
+	}
+
+
+	/**
+	 *    th - generates an HTML <th> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::th();
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function th(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = 'scope="col"'
+	): string {
+		return EEH_HTML::_open_tag('th', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * thx - generates an HTML </th> tag - if passed the id or class attribute used for the opening ul tag, will append
+	 * a comment
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function thx(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('th', $id, $class);
+	}
+
+
+	/**
+	 *    td - generates an HTML <td> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::td();
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function td(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_open_tag('td', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * tdx - generates an HTML </td> tag - if passed the id or class attribute used for the opening ul tag, will append
+	 * a comment
+	 *
+	 * @param string $id    - html id attribute
+	 * @param string $class - html class attribute
+	 * @return string
+	 */
+	public static function tdx(string $id = '', string $class = ''): string
+	{
+		return EEH_HTML::_close_tag('td', $id, $class);
+	}
+
+
+	/**
+	 * no_row - for generating a "hidden" table row, good for embedding tables within tables
+	 * generates a new table row with one td cell that spans however many columns you set
+	 * removes all styles from the tr and td
+	 *
+	 * @param string $content
+	 * @param int    $colspan
+	 * @return string
+	 */
+	public static function no_row(string $content = '', int $colspan = 2): string
+	{
+		return EEH_HTML::tr(
+			EEH_HTML::td($content, '', '', '', 'colspan="' . $colspan . '"'),
+			'',
+			'ee-no-row'
+		);
+	}
+
+
+	/**
+	 * Generates HTML <a href="url">text</a> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::link( 'domain.com', 'this is a link' );
+	 *
+	 * @param string $href             URL to link to
+	 * @param string $link_text        - the text that will become "hyperlinked"
+	 * @param string $title            - html title attribute
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function link(
+		string $href = '',
+		string $link_text = '',
+		string $title = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		$link_text  = ! empty($link_text) ? $link_text : $href;
+		$attributes = ! empty($href) ? ' href="' . $href . '"' : '';
+		$attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
+		$attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
+		$attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
+		$attributes .= ! empty($title) ? ' title="' . esc_attr($title) . '"' : '';
+		$attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+		return "<a$attributes>$link_text</a>";
+	}
+
+
+	/**
+	 * Generates HTML <button>text</button> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::button( 'this is a button' );
+	 *
+	 * @param string $btn_text         - the text that will become "hyperlinked"
+	 * @param string $class            - html class attribute
+	 * @param string $aria_label       - aria-label attribute
+	 * @param string $id               - html id attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function button(
+		string $btn_text = '',
+		string $class = '',
+		string $aria_label = '',
+		string $id = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		$attributes = ! empty($aria_label) ? ' aria-label="' . $aria_label . '"' : '';
+		$attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
+		$attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
+		$attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
+		$attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+		return "<button type='button' $attributes>$btn_text</button>";
+	}
+
+
+	/**
+	 *    img - generates an HTML <img> tag and adds any passed attributes
+	 *    usage: echo EEH_HTML::img();
+	 *
+	 * @param string $src              - html src attribute ie: the path or URL to the image
+	 * @param string $alt              - html alt attribute
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function img(
+		string $src = '',
+		string $alt = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		$attributes = ! empty($src) ? ' src="' . esc_url_raw($src) . '"' : '';
+		$attributes .= ! empty($alt) ? ' alt="' . esc_attr($alt) . '"' : '';
+		$attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
+		$attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
+		$attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
+		$attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+		return '<img' . $attributes . '/>';
+	}
+
+
+	/**
+	 * Generates HTML <tag></tag> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::span( 'this is some inline text' );
+	 *
+	 * @param string $tag
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	protected static function _inline_tag(
+		string $tag = 'span',
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		$attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
+		$attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
+		$attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
+		$attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+		return '<' . $tag . ' ' . $attributes . '>' . $content . '</' . $tag . '>';
+	}
+
+
+	/**
+	 * Generates HTML <label></label> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::span( 'this is some inline text' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function label(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_inline_tag('label', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * Generates HTML <span></span> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::span( 'this is some inline text' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function span(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_inline_tag('span', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * Generates HTML <span></span> tags, inserts content, and adds any passed attributes
+	 * usage: echo EEH_HTML::span( 'this is some inline text' );
+	 *
+	 * @param string $content          - inserted after opening tag, and appends closing tag, otherwise tag is left open
+	 * @param string $id               - html id attribute
+	 * @param string $class            - html class attribute
+	 * @param string $style            - html style attribute for applying inline styles
+	 * @param string $other_attributes - additional attributes like "colspan", inline JS, "rel" tags, etc
+	 * @return string
+	 */
+	public static function strong(
+		string $content = '',
+		string $id = '',
+		string $class = '',
+		string $style = '',
+		string $other_attributes = ''
+	): string {
+		return EEH_HTML::_inline_tag('strong', $content, $id, $class, $style, $other_attributes);
+	}
+
+
+	/**
+	 * Generates an html <--  comment --> tag
+	 *  usage: echo comment( 'this is a comment' );
+	 *
+	 * @param string $comment
+	 * @return string
+	 */
+	public static function comment(string $comment = ''): string
+	{
+		return ! empty($comment) ? EEH_HTML::nl() . '<!-- ' . $comment . ' -->' : '';
+	}
+
+
+	/**
+	 * br - generates a line break
+	 *
+	 * @param int $number - the number of line breaks to return
+	 * @return string
+	 */
+	public static function br(int $number = 1): string
+	{
+		return str_repeat('<br />', $number);
+	}
+
+
+	/**
+	 * nbsp - generates non-breaking space entities based on number supplied
+	 *
+	 * @param int $number - the number of non-breaking spaces to return
+	 * @return string
+	 */
+	public static function nbsp(int $number = 1): string
+	{
+		return str_repeat('&nbsp;', $number);
+	}
+
+
+	/**
+	 * sanitize_id
+	 * functionally does the same as the wp_core function sanitize_key except it does NOT use
+	 * strtolower and allows capitals.
+	 *
+	 * @param string $id
+	 * @return string
+	 */
+	public static function sanitize_id(string $id = ''): string
+	{
+		$key = str_replace(' ', '-', trim($id));
+		return preg_replace('/[^a-zA-Z0-9_\-]/', '', $key);
+	}
+
+
+	/**
+	 * return a newline and tabs ("nl" stands for "new line")
+	 *
+	 * @param int    $indent the number of tabs to ADD to the current indent (can be negative or zero)
+	 * @param string $tag
+	 * @return string - newline character plus # of indents passed (can be + or -)
+	 */
+	public static function nl(int $indent = 0, string $tag = 'none'): string
+	{
+		$html = "\n";
+		EEH_HTML::indent($indent, $tag);
+		$html .= str_repeat("\t", EEH_HTML::$_indent[ $tag ]);
+		return $html;
+	}
+
+
+	/**
+	 * Changes the indents used in EEH_HTML::nl. Often it's convenient to change
+	 * the indentation level without actually creating a new line
+	 *
+	 * @param int    $indent can be negative to decrease the indentation level
+	 * @param string $tag
+	 */
+	public static function indent(int $indent, string $tag = 'none')
+	{
+		static $default_indentation = false;
+		if (! $default_indentation) {
+			EEH_HTML::_set_default_indentation();
+			$default_indentation = true;
+		}
+		if (! isset(EEH_HTML::$_indent[ $tag ])) {
+			EEH_HTML::$_indent[ $tag ] = 0;
+		}
+		EEH_HTML::$_indent[ $tag ] += $indent;
+		EEH_HTML::$_indent[ $tag ] = max(EEH_HTML::$_indent[ $tag ], 0);
+	}
+
+
+	/**
+	 *  class _set_default_indentation
+	 */
+	private static function _set_default_indentation()
+	{
+		// set some initial formatting for table indentation
+		EEH_HTML::$_indent = [
+			'none'     => 0,
+			'form'     => 0,
+			'radio'    => 0,
+			'checkbox' => 0,
+			'select'   => 0,
+			'option'   => 0,
+			'optgroup' => 0,
+			'table'    => 1,
+			'thead'    => 2,
+			'tbody'    => 2,
+			'tr'       => 3,
+			'th'       => 4,
+			'td'       => 4,
+			'div'      => 0,
+			'h1'       => 0,
+			'h2'       => 0,
+			'h3'       => 0,
+			'h4'       => 0,
+			'h5'       => 0,
+			'h6'       => 0,
+			'p'        => 0,
+			'ul'       => 0,
+			'li'       => 1,
+		];
+	}
+
+
+	/**
+	 * Retrieves the list of tags considered "simple", that are probably safe for
+	 * use in inputs
+	 *
+	 * @return array
+	 * @global array $allowedtags
+	 */
+	public static function get_simple_tags(): array
+	{
+		global $allowedtags;
+		$tags_we_allow = array_merge_recursive(
+			$allowedtags,
+			[
+				'ol' => [],
+				'ul' => [],
+				'li' => [],
+				'br' => [],
+				'p'  => [],
+				'a'  => ['target'],
+			]
+		);
+		return apply_filters('FHEE__EEH_HTML__get_simple_tags', $tags_we_allow);
+	}
 }

Spacing +42 added lines, -42 removed lines

@@ -49,7 +49,7 @@ 
     public static function instance(): EEH_HTML
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_HTML) {
+        if ( ! self::$_instance instanceof EEH_HTML) {
             self::$_instance = new EEH_HTML();
         }
         return self::$_instance;
@@ -78,12 +78,12 @@ 
         string $other_attributes = '',
         bool $force_close = false
     ): string {
-        $attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        $html       = EEH_HTML::nl(0, $tag) . '<' . $tag . $attributes . '>';
-        $html       .= trim($content) !== '' ? EEH_HTML::nl(1, $tag) . $content : '';
+        $attributes = ! empty($id) ? ' id="'.EEH_HTML::sanitize_id($id).'"' : '';
+        $attributes .= ! empty($class) ? ' class="'.$class.'"' : '';
+        $attributes .= ! empty($style) ? ' style="'.$style.'"' : '';
+        $attributes .= ! empty($other_attributes) ? ' '.$other_attributes : '';
+        $html       = EEH_HTML::nl(0, $tag).'<'.$tag.$attributes.'>';
+        $html       .= trim($content) !== '' ? EEH_HTML::nl(1, $tag).$content : '';
         $indent     = ! empty($content) || $force_close;
         $html       .= ! empty($content) || $force_close
             ? EEH_HTML::_close_tag($tag, $id, $class, $indent, $content)
@@ -112,14 +112,14 @@ 
         string $content = ''
     ): string {
         $alotta_content = strlen($content) > 500;
-        $comment         = '';
+        $comment = '';
         if ($id && $alotta_content) {
-            $comment = EEH_HTML::comment('close ' . $id) . EEH_HTML::nl(0, $tag);
+            $comment = EEH_HTML::comment('close '.$id).EEH_HTML::nl(0, $tag);
         } elseif ($class && $alotta_content) {
-            $comment = EEH_HTML::comment('close ' . $class) . EEH_HTML::nl(0, $tag);
+            $comment = EEH_HTML::comment('close '.$class).EEH_HTML::nl(0, $tag);
         }
         $html = $indent ? EEH_HTML::nl(-1, $tag) : '';
-        $html .= '</' . $tag . '>' . $comment;
+        $html .= '</'.$tag.'>'.$comment;
         return $html;
     }
 
@@ -615,7 +615,7 @@ 
     public static function no_row(string $content = '', int $colspan = 2): string
     {
         return EEH_HTML::tr(
-            EEH_HTML::td($content, '', '', '', 'colspan="' . $colspan . '"'),
+            EEH_HTML::td($content, '', '', '', 'colspan="'.$colspan.'"'),
             '',
             'ee-no-row'
         );
@@ -645,12 +645,12 @@ 
         string $other_attributes = ''
     ): string {
         $link_text  = ! empty($link_text) ? $link_text : $href;
-        $attributes = ! empty($href) ? ' href="' . $href . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($title) ? ' title="' . esc_attr($title) . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+        $attributes = ! empty($href) ? ' href="'.$href.'"' : '';
+        $attributes .= ! empty($id) ? ' id="'.EEH_HTML::sanitize_id($id).'"' : '';
+        $attributes .= ! empty($class) ? ' class="'.$class.'"' : '';
+        $attributes .= ! empty($style) ? ' style="'.$style.'"' : '';
+        $attributes .= ! empty($title) ? ' title="'.esc_attr($title).'"' : '';
+        $attributes .= ! empty($other_attributes) ? ' '.$other_attributes : '';
         return "<a$attributes>$link_text</a>";
     }
 
@@ -675,11 +675,11 @@ 
         string $style = '',
         string $other_attributes = ''
     ): string {
-        $attributes = ! empty($aria_label) ? ' aria-label="' . $aria_label . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
+        $attributes = ! empty($aria_label) ? ' aria-label="'.$aria_label.'"' : '';
+        $attributes .= ! empty($id) ? ' id="'.EEH_HTML::sanitize_id($id).'"' : '';
+        $attributes .= ! empty($class) ? ' class="'.$class.'"' : '';
+        $attributes .= ! empty($style) ? ' style="'.$style.'"' : '';
+        $attributes .= ! empty($other_attributes) ? ' '.$other_attributes : '';
         return "<button type='button' $attributes>$btn_text</button>";
     }
 
@@ -704,13 +704,13 @@ 
         string $style = '',
         string $other_attributes = ''
     ): string {
-        $attributes = ! empty($src) ? ' src="' . esc_url_raw($src) . '"' : '';
-        $attributes .= ! empty($alt) ? ' alt="' . esc_attr($alt) . '"' : '';
-        $attributes .= ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return '<img' . $attributes . '/>';
+        $attributes = ! empty($src) ? ' src="'.esc_url_raw($src).'"' : '';
+        $attributes .= ! empty($alt) ? ' alt="'.esc_attr($alt).'"' : '';
+        $attributes .= ! empty($id) ? ' id="'.EEH_HTML::sanitize_id($id).'"' : '';
+        $attributes .= ! empty($class) ? ' class="'.$class.'"' : '';
+        $attributes .= ! empty($style) ? ' style="'.$style.'"' : '';
+        $attributes .= ! empty($other_attributes) ? ' '.$other_attributes : '';
+        return '<img'.$attributes.'/>';
     }
 
 
@@ -734,11 +734,11 @@ 
         string $style = '',
         string $other_attributes = ''
     ): string {
-        $attributes = ! empty($id) ? ' id="' . EEH_HTML::sanitize_id($id) . '"' : '';
-        $attributes .= ! empty($class) ? ' class="' . $class . '"' : '';
-        $attributes .= ! empty($style) ? ' style="' . $style . '"' : '';
-        $attributes .= ! empty($other_attributes) ? ' ' . $other_attributes : '';
-        return '<' . $tag . ' ' . $attributes . '>' . $content . '</' . $tag . '>';
+        $attributes = ! empty($id) ? ' id="'.EEH_HTML::sanitize_id($id).'"' : '';
+        $attributes .= ! empty($class) ? ' class="'.$class.'"' : '';
+        $attributes .= ! empty($style) ? ' style="'.$style.'"' : '';
+        $attributes .= ! empty($other_attributes) ? ' '.$other_attributes : '';
+        return '<'.$tag.' '.$attributes.'>'.$content.'</'.$tag.'>';
     }
 
 
@@ -817,7 +817,7 @@ 
      */
     public static function comment(string $comment = ''): string
     {
-        return ! empty($comment) ? EEH_HTML::nl() . '<!-- ' . $comment . ' -->' : '';
+        return ! empty($comment) ? EEH_HTML::nl().'<!-- '.$comment.' -->' : '';
     }
 
 
@@ -871,7 +871,7 @@ 
     {
         $html = "\n";
         EEH_HTML::indent($indent, $tag);
-        $html .= str_repeat("\t", EEH_HTML::$_indent[ $tag ]);
+        $html .= str_repeat("\t", EEH_HTML::$_indent[$tag]);
         return $html;
     }
 
@@ -886,15 +886,15 @@ 
     public static function indent(int $indent, string $tag = 'none')
     {
         static $default_indentation = false;
-        if (! $default_indentation) {
+        if ( ! $default_indentation) {
             EEH_HTML::_set_default_indentation();
             $default_indentation = true;
         }
-        if (! isset(EEH_HTML::$_indent[ $tag ])) {
-            EEH_HTML::$_indent[ $tag ] = 0;
+        if ( ! isset(EEH_HTML::$_indent[$tag])) {
+            EEH_HTML::$_indent[$tag] = 0;
         }
-        EEH_HTML::$_indent[ $tag ] += $indent;
-        EEH_HTML::$_indent[ $tag ] = max(EEH_HTML::$_indent[ $tag ], 0);
+        EEH_HTML::$_indent[$tag] += $indent;
+        EEH_HTML::$_indent[$tag] = max(EEH_HTML::$_indent[$tag], 0);
     }
 
 

core/EE_Cart.core.php

Indentation +411 added lines, -411 removed lines

@@ -17,415 +17,415 @@
  */
 class EE_Cart implements ResettableInterface
 {
-    private static ?EE_Cart $_instance = null;
-
-    protected ?EE_Session $session = null;
-
-    /**
-     * The total Line item which comprises all the children line-item subtotals,
-     * which in turn each have their line items.
-     * Typically, the line item structure will look like:
-     * grand total
-     * -tickets-sub-total
-     * --ticket1
-     * --ticket2
-     * --...
-     * -taxes-sub-total
-     * --tax1
-     * --tax2
-     *
-     * If cart is serialized, this will be an ID of the line item
-     *
-     * @var EE_Line_Item|null
-     */
-    private ?EE_Line_Item $grand_total = null;
-
-    private int $grand_total_ID = 0;
-
-
-    /**
-     * singleton method used to instantiate class object
-     *
-     * @param EE_Line_Item|null $grand_total
-     * @param EE_Session|null   $session
-     * @return EE_Cart
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(?EE_Line_Item $grand_total = null, ?EE_Session $session = null): ?EE_Cart
-    {
-        if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
-            self::$_instance = new self($grand_total, $session);
-        }
-        // or maybe retrieve an existing one ?
-        if (! self::$_instance instanceof EE_Cart) {
-            // try getting the cart out of the session
-            $saved_cart      = $session instanceof EE_Session ? $session->cart() : null;
-            self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
-            unset($saved_cart);
-        }
-        // verify that cart is ok and grand total line item exists
-        if (! self::$_instance instanceof EE_Cart || ! self::$_instance->grand_total instanceof EE_Line_Item) {
-            self::$_instance = new self($grand_total, $session);
-        }
-        self::$_instance->get_grand_total();
-        // once everything is all said and done, save the cart to the EE_Session
-        add_action('shutdown', [self::$_instance, 'save_cart'], 90);
-        return self::$_instance;
-    }
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param EE_Line_Item|null $grand_total
-     * @param EE_Session|null   $session
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function __construct(?EE_Line_Item $grand_total = null, ?EE_Session $session = null)
-    {
-        $this->set_session($session);
-        if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
-            $this->set_grand_total_line_item($grand_total);
-        }
-    }
-
-
-    /**
-     * Resets the cart completely (whereas empty_cart
-     *
-     * @param EE_Line_Item|null $grand_total
-     * @param EE_Session|null   $session
-     * @return EE_Cart
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reset(?EE_Line_Item $grand_total = null, ?EE_Session $session = null): ?EE_Cart
-    {
-        remove_action('shutdown', [self::$_instance, 'save_cart'], 90);
-        if ($session instanceof EE_Session) {
-            $session->reset_cart();
-        }
-        self::$_instance = null;
-        return self::instance($grand_total, $session);
-    }
-
-
-    /**
-     * @return EE_Session
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function session(): EE_Session
-    {
-        if (! $this->session instanceof EE_Session) {
-            $this->set_session();
-        }
-        return $this->session;
-    }
-
-
-    /**
-     * @param EE_Session|null $session
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_session(?EE_Session $session = null)
-    {
-        $this->session = $session instanceof EE_Session ? $session : EE_Registry::instance()->load_core('Session');
-    }
-
-
-    /**
-     * Sets the cart to match the line item. Especially handy for loading an old cart where you
-     *  know the grand total line item on it
-     *
-     * @param EE_Line_Item $line_item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_grand_total_line_item(EE_Line_Item $line_item)
-    {
-        $this->grand_total    = $line_item;
-        $this->grand_total_ID = $line_item->ID();
-    }
-
-
-    /**
-     * get_cart_from_reg_url_link
-     *
-     * @param EE_Transaction  $transaction
-     * @param EE_Session|null $session
-     * @return EE_Cart
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_cart_from_txn(EE_Transaction $transaction, ?EE_Session $session = null): EE_Cart
-    {
-        $grand_total = $transaction->total_line_item();
-        $grand_total->get_items();
-        $grand_total->tax_descendants();
-        return EE_Cart::instance($grand_total, $session);
-    }
-
-
-    /**
-     * Creates the total line item, and ensures it has its 'tickets' and 'taxes' sub-items
-     *
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function create_grand_total(): EE_Line_Item
-    {
-        $this->grand_total = EEH_Line_Item::create_total_line_item();
-        return $this->grand_total;
-    }
-
-
-    /**
-     * Gets all the line items of object type Ticket
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_tickets(): array
-    {
-        if ($this->grand_total === null) {
-            return [];
-        }
-        return EEH_Line_Item::get_ticket_line_items($this->grand_total);
-    }
-
-
-    /**
-     * returns the total quantity of tickets in the cart
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function all_ticket_quantity_count(): int
-    {
-        $tickets = $this->get_tickets();
-        if (empty($tickets)) {
-            return 0;
-        }
-        $count = 0;
-        foreach ($tickets as $ticket) {
-            $count += $ticket->quantity();
-        }
-        return $count;
-    }
-
-
-    /**
-     * Gets all the tax line items
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_taxes(): array
-    {
-        return EEH_Line_Item::get_taxes_subtotal($this->grand_total)->children();
-    }
-
-
-    /**
-     * Gets the total line item (which is a parent of all other line items) on this cart
-     *
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_grand_total(): EE_Line_Item
-    {
-        if ($this->grand_total instanceof EE_Line_Item) {
-            return $this->grand_total;
-        }
-        // $this->grand_total_ID is set, use it to get the object from the db
-        if ($this->grand_total_ID !== 0) {
-            $this->grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->grand_total_ID);
-            return $this->grand_total;
-        }
-        return $this->create_grand_total();
-    }
-
-
-    /**
-     * process items for adding to cart
-     *
-     * @param EE_Ticket $ticket
-     * @param int       $qty
-     * @return bool TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_ticket_to_cart(EE_Ticket $ticket, int $qty = 1): bool
-    {
-        EEH_Line_Item::add_ticket_purchase($this->get_grand_total(), $ticket, $qty, false);
-        return $this->save_cart();
-    }
-
-
-    /**
-     * get_cart_total_before_tax
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_cart_total_before_tax(): float
-    {
-        return $this->get_grand_total()->recalculate_pre_tax_total();
-    }
-
-
-    /**
-     * gets the total amount of tax paid for items in this cart
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_applied_taxes(): float
-    {
-        return EEH_Line_Item::ensure_taxes_applied($this->grand_total);
-    }
-
-
-    /**
-     * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_cart_grand_total(): float
-    {
-        EEH_Line_Item::ensure_taxes_applied($this->grand_total);
-        return $this->get_grand_total()->total();
-    }
-
-
-    /**
-     * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function recalculate_all_cart_totals(): float
-    {
-        $pre_tax_total = $this->get_cart_total_before_tax();
-        $taxes_total   = EEH_Line_Item::ensure_taxes_applied($this->grand_total);
-        $this->grand_total->set_total($pre_tax_total + $taxes_total);
-        $this->grand_total->save_this_and_descendants_to_txn();
-        return $this->get_grand_total()->total();
-    }
-
-
-    /**
-     * deletes an item from the cart
-     *
-     * @param array|bool|string $line_item_codes
-     * @return int on success, FALSE on fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_items($line_item_codes = false): int
-    {
-        return (int) EEH_Line_Item::delete_items($this->get_grand_total(), $line_item_codes);
-    }
-
-
-    /**
-     * @remove ALL items from cart and zero ALL totals
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function empty_cart(): bool
-    {
-        $this->grand_total = $this->create_grand_total();
-        return $this->save_cart();
-    }
-
-
-    /**
-     * remove ALL items from cart and delete total as well
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_cart(): bool
-    {
-        if ($this->grand_total instanceof EE_Line_Item) {
-            $deleted = EEH_Line_Item::delete_all_child_items($this->grand_total);
-            if ($deleted) {
-                $this->grand_total->delete();
-                $this->grand_total = null;
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * save   cart to session
-     *
-     * @param bool $apply_taxes
-     * @return bool TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function save_cart(bool $apply_taxes = true): bool
-    {
-        if ($apply_taxes && $this->grand_total instanceof EE_Line_Item) {
-            EEH_Line_Item::ensure_taxes_applied($this->grand_total);
-            // make sure we don't cache the transaction because it can get stale
-            if (
-                $this->grand_total->get_one_from_cache('Transaction') instanceof EE_Transaction
-                && $this->grand_total->get_one_from_cache('Transaction')->ID()
-            ) {
-                $this->grand_total->clear_cache('Transaction', null, true);
-            }
-        }
-        if ($this->session() instanceof EE_Session) {
-            return $this->session()->set_cart($this);
-        }
-        return false;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __wakeup()
-    {
-        if (! $this->grand_total instanceof EE_Line_Item && $this->grand_total_ID !== 0) {
-            // $this->_grand_total is actually just an ID, so use it to get the object from the db
-            $this->grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->grand_total_ID);
-        }
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __sleep()
-    {
-        if ($this->grand_total instanceof EE_Line_Item && $this->grand_total->ID()) {
-            $this->grand_total_ID = $this->grand_total->ID();
-        }
-        return ['grand_total_ID'];
-    }
+	private static ?EE_Cart $_instance = null;
+
+	protected ?EE_Session $session = null;
+
+	/**
+	 * The total Line item which comprises all the children line-item subtotals,
+	 * which in turn each have their line items.
+	 * Typically, the line item structure will look like:
+	 * grand total
+	 * -tickets-sub-total
+	 * --ticket1
+	 * --ticket2
+	 * --...
+	 * -taxes-sub-total
+	 * --tax1
+	 * --tax2
+	 *
+	 * If cart is serialized, this will be an ID of the line item
+	 *
+	 * @var EE_Line_Item|null
+	 */
+	private ?EE_Line_Item $grand_total = null;
+
+	private int $grand_total_ID = 0;
+
+
+	/**
+	 * singleton method used to instantiate class object
+	 *
+	 * @param EE_Line_Item|null $grand_total
+	 * @param EE_Session|null   $session
+	 * @return EE_Cart
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(?EE_Line_Item $grand_total = null, ?EE_Session $session = null): ?EE_Cart
+	{
+		if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
+			self::$_instance = new self($grand_total, $session);
+		}
+		// or maybe retrieve an existing one ?
+		if (! self::$_instance instanceof EE_Cart) {
+			// try getting the cart out of the session
+			$saved_cart      = $session instanceof EE_Session ? $session->cart() : null;
+			self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
+			unset($saved_cart);
+		}
+		// verify that cart is ok and grand total line item exists
+		if (! self::$_instance instanceof EE_Cart || ! self::$_instance->grand_total instanceof EE_Line_Item) {
+			self::$_instance = new self($grand_total, $session);
+		}
+		self::$_instance->get_grand_total();
+		// once everything is all said and done, save the cart to the EE_Session
+		add_action('shutdown', [self::$_instance, 'save_cart'], 90);
+		return self::$_instance;
+	}
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param EE_Line_Item|null $grand_total
+	 * @param EE_Session|null   $session
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function __construct(?EE_Line_Item $grand_total = null, ?EE_Session $session = null)
+	{
+		$this->set_session($session);
+		if ($grand_total instanceof EE_Line_Item && $grand_total->is_total()) {
+			$this->set_grand_total_line_item($grand_total);
+		}
+	}
+
+
+	/**
+	 * Resets the cart completely (whereas empty_cart
+	 *
+	 * @param EE_Line_Item|null $grand_total
+	 * @param EE_Session|null   $session
+	 * @return EE_Cart
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reset(?EE_Line_Item $grand_total = null, ?EE_Session $session = null): ?EE_Cart
+	{
+		remove_action('shutdown', [self::$_instance, 'save_cart'], 90);
+		if ($session instanceof EE_Session) {
+			$session->reset_cart();
+		}
+		self::$_instance = null;
+		return self::instance($grand_total, $session);
+	}
+
+
+	/**
+	 * @return EE_Session
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function session(): EE_Session
+	{
+		if (! $this->session instanceof EE_Session) {
+			$this->set_session();
+		}
+		return $this->session;
+	}
+
+
+	/**
+	 * @param EE_Session|null $session
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_session(?EE_Session $session = null)
+	{
+		$this->session = $session instanceof EE_Session ? $session : EE_Registry::instance()->load_core('Session');
+	}
+
+
+	/**
+	 * Sets the cart to match the line item. Especially handy for loading an old cart where you
+	 *  know the grand total line item on it
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_grand_total_line_item(EE_Line_Item $line_item)
+	{
+		$this->grand_total    = $line_item;
+		$this->grand_total_ID = $line_item->ID();
+	}
+
+
+	/**
+	 * get_cart_from_reg_url_link
+	 *
+	 * @param EE_Transaction  $transaction
+	 * @param EE_Session|null $session
+	 * @return EE_Cart
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_cart_from_txn(EE_Transaction $transaction, ?EE_Session $session = null): EE_Cart
+	{
+		$grand_total = $transaction->total_line_item();
+		$grand_total->get_items();
+		$grand_total->tax_descendants();
+		return EE_Cart::instance($grand_total, $session);
+	}
+
+
+	/**
+	 * Creates the total line item, and ensures it has its 'tickets' and 'taxes' sub-items
+	 *
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function create_grand_total(): EE_Line_Item
+	{
+		$this->grand_total = EEH_Line_Item::create_total_line_item();
+		return $this->grand_total;
+	}
+
+
+	/**
+	 * Gets all the line items of object type Ticket
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_tickets(): array
+	{
+		if ($this->grand_total === null) {
+			return [];
+		}
+		return EEH_Line_Item::get_ticket_line_items($this->grand_total);
+	}
+
+
+	/**
+	 * returns the total quantity of tickets in the cart
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function all_ticket_quantity_count(): int
+	{
+		$tickets = $this->get_tickets();
+		if (empty($tickets)) {
+			return 0;
+		}
+		$count = 0;
+		foreach ($tickets as $ticket) {
+			$count += $ticket->quantity();
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Gets all the tax line items
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_taxes(): array
+	{
+		return EEH_Line_Item::get_taxes_subtotal($this->grand_total)->children();
+	}
+
+
+	/**
+	 * Gets the total line item (which is a parent of all other line items) on this cart
+	 *
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_grand_total(): EE_Line_Item
+	{
+		if ($this->grand_total instanceof EE_Line_Item) {
+			return $this->grand_total;
+		}
+		// $this->grand_total_ID is set, use it to get the object from the db
+		if ($this->grand_total_ID !== 0) {
+			$this->grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->grand_total_ID);
+			return $this->grand_total;
+		}
+		return $this->create_grand_total();
+	}
+
+
+	/**
+	 * process items for adding to cart
+	 *
+	 * @param EE_Ticket $ticket
+	 * @param int       $qty
+	 * @return bool TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_ticket_to_cart(EE_Ticket $ticket, int $qty = 1): bool
+	{
+		EEH_Line_Item::add_ticket_purchase($this->get_grand_total(), $ticket, $qty, false);
+		return $this->save_cart();
+	}
+
+
+	/**
+	 * get_cart_total_before_tax
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_cart_total_before_tax(): float
+	{
+		return $this->get_grand_total()->recalculate_pre_tax_total();
+	}
+
+
+	/**
+	 * gets the total amount of tax paid for items in this cart
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_applied_taxes(): float
+	{
+		return EEH_Line_Item::ensure_taxes_applied($this->grand_total);
+	}
+
+
+	/**
+	 * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_cart_grand_total(): float
+	{
+		EEH_Line_Item::ensure_taxes_applied($this->grand_total);
+		return $this->get_grand_total()->total();
+	}
+
+
+	/**
+	 * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function recalculate_all_cart_totals(): float
+	{
+		$pre_tax_total = $this->get_cart_total_before_tax();
+		$taxes_total   = EEH_Line_Item::ensure_taxes_applied($this->grand_total);
+		$this->grand_total->set_total($pre_tax_total + $taxes_total);
+		$this->grand_total->save_this_and_descendants_to_txn();
+		return $this->get_grand_total()->total();
+	}
+
+
+	/**
+	 * deletes an item from the cart
+	 *
+	 * @param array|bool|string $line_item_codes
+	 * @return int on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_items($line_item_codes = false): int
+	{
+		return (int) EEH_Line_Item::delete_items($this->get_grand_total(), $line_item_codes);
+	}
+
+
+	/**
+	 * @remove ALL items from cart and zero ALL totals
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function empty_cart(): bool
+	{
+		$this->grand_total = $this->create_grand_total();
+		return $this->save_cart();
+	}
+
+
+	/**
+	 * remove ALL items from cart and delete total as well
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_cart(): bool
+	{
+		if ($this->grand_total instanceof EE_Line_Item) {
+			$deleted = EEH_Line_Item::delete_all_child_items($this->grand_total);
+			if ($deleted) {
+				$this->grand_total->delete();
+				$this->grand_total = null;
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * save   cart to session
+	 *
+	 * @param bool $apply_taxes
+	 * @return bool TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function save_cart(bool $apply_taxes = true): bool
+	{
+		if ($apply_taxes && $this->grand_total instanceof EE_Line_Item) {
+			EEH_Line_Item::ensure_taxes_applied($this->grand_total);
+			// make sure we don't cache the transaction because it can get stale
+			if (
+				$this->grand_total->get_one_from_cache('Transaction') instanceof EE_Transaction
+				&& $this->grand_total->get_one_from_cache('Transaction')->ID()
+			) {
+				$this->grand_total->clear_cache('Transaction', null, true);
+			}
+		}
+		if ($this->session() instanceof EE_Session) {
+			return $this->session()->set_cart($this);
+		}
+		return false;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __wakeup()
+	{
+		if (! $this->grand_total instanceof EE_Line_Item && $this->grand_total_ID !== 0) {
+			// $this->_grand_total is actually just an ID, so use it to get the object from the db
+			$this->grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->grand_total_ID);
+		}
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __sleep()
+	{
+		if ($this->grand_total instanceof EE_Line_Item && $this->grand_total->ID()) {
+			$this->grand_total_ID = $this->grand_total->ID();
+		}
+		return ['grand_total_ID'];
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -58,14 +58,14 @@ 
             self::$_instance = new self($grand_total, $session);
         }
         // or maybe retrieve an existing one ?
-        if (! self::$_instance instanceof EE_Cart) {
+        if ( ! self::$_instance instanceof EE_Cart) {
             // try getting the cart out of the session
             $saved_cart      = $session instanceof EE_Session ? $session->cart() : null;
             self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
             unset($saved_cart);
         }
         // verify that cart is ok and grand total line item exists
-        if (! self::$_instance instanceof EE_Cart || ! self::$_instance->grand_total instanceof EE_Line_Item) {
+        if ( ! self::$_instance instanceof EE_Cart || ! self::$_instance->grand_total instanceof EE_Line_Item) {
             self::$_instance = new self($grand_total, $session);
         }
         self::$_instance->get_grand_total();
@@ -119,7 +119,7 @@ 
      */
     public function session(): EE_Session
     {
-        if (! $this->session instanceof EE_Session) {
+        if ( ! $this->session instanceof EE_Session) {
             $this->set_session();
         }
         return $this->session;
@@ -409,7 +409,7 @@ 
      */
     public function __wakeup()
     {
-        if (! $this->grand_total instanceof EE_Line_Item && $this->grand_total_ID !== 0) {
+        if ( ! $this->grand_total instanceof EE_Line_Item && $this->grand_total_ID !== 0) {
             // $this->_grand_total is actually just an ID, so use it to get the object from the db
             $this->grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->grand_total_ID);
         }

core/data_migration_scripts/EE_DMS_Core_5_0_0.dms.php

Indentation +426 added lines, -426 removed lines

@@ -11,9 +11,9 @@ 
 $stages            = glob(EE_CORE . 'data_migration_scripts/5_0_0_stages/*');
 $class_to_filepath = [];
 foreach ($stages as $filepath) {
-    $matches = [];
-    preg_match('~5_0_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[ $matches[1] ] = $filepath;
+	$matches = [];
+	preg_match('~5_0_0_stages/(.*).dmsstage.php~', $filepath, $matches);
+	$class_to_filepath[ $matches[1] ] = $filepath;
 }
 // give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_5_0_0__autoloaded_stages', $class_to_filepath);
@@ -29,65 +29,65 @@ 
  */
 class EE_DMS_Core_5_0_0 extends EE_Data_Migration_Script_Base
 {
-    /**
-     * @param EE_DMS_Core_4_10_0 $dms_4_10
-     * @param TableManager|null  $table_manager
-     * @param TableAnalysis|null $table_analysis
-     */
-    public function __construct(
-        EE_DMS_Core_4_10_0 $dms_4_10,
-        TableManager $table_manager = null,
-        TableAnalysis $table_analysis = null
-    ) {
-        $this->previous_dms      = $dms_4_10;
-        $this->_pretty_name      = esc_html__("Data Update to Event Espresso 5.0.0", "event_espresso");
-        $this->_priority         = 10;
-        $this->_migration_stages = [
-            new EE_DMS_5_0_0_Event_Venues(),
-        ];
-        parent::__construct($table_manager, $table_analysis);
-    }
-
-
-    /**
-     * Whether to migrate or not.
-     *
-     * @param array $version_array
-     * @return bool
-     */
-    public function can_migrate_from_version($version_array): bool
-    {
-        $version_string = $version_array['Core'];
-        return $version_string &&
-            version_compare($version_string, '5.0.0.decaf', '<') &&
-            version_compare($version_string, '4.10.0.decaf', '>=');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function schema_changes_before_migration(): bool
-    {
-        require_once EE_HELPERS . 'EEH_Activation.helper.php';
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_answer',
-            ' ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+	/**
+	 * @param EE_DMS_Core_4_10_0 $dms_4_10
+	 * @param TableManager|null  $table_manager
+	 * @param TableAnalysis|null $table_analysis
+	 */
+	public function __construct(
+		EE_DMS_Core_4_10_0 $dms_4_10,
+		TableManager $table_manager = null,
+		TableAnalysis $table_analysis = null
+	) {
+		$this->previous_dms      = $dms_4_10;
+		$this->_pretty_name      = esc_html__("Data Update to Event Espresso 5.0.0", "event_espresso");
+		$this->_priority         = 10;
+		$this->_migration_stages = [
+			new EE_DMS_5_0_0_Event_Venues(),
+		];
+		parent::__construct($table_manager, $table_analysis);
+	}
+
+
+	/**
+	 * Whether to migrate or not.
+	 *
+	 * @param array $version_array
+	 * @return bool
+	 */
+	public function can_migrate_from_version($version_array): bool
+	{
+		$version_string = $version_array['Core'];
+		return $version_string &&
+			version_compare($version_string, '5.0.0.decaf', '<') &&
+			version_compare($version_string, '4.10.0.decaf', '>=');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function schema_changes_before_migration(): bool
+	{
+		require_once EE_HELPERS . 'EEH_Activation.helper.php';
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_answer',
+			' ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
             REG_ID int(10) unsigned NOT NULL,
             QST_ID int(10) unsigned NOT NULL,
             ANS_value text NOT NULL,
             PRIMARY KEY  (ANS_ID)'
-        );
-        $this->_get_table_manager()->addIndex('esp_answer', 'REG_ID', 'REG_ID');
-        $this->_get_table_manager()->addIndex('esp_answer', 'QST_ID', 'QST_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_answer', 'REG_ID', 'REG_ID');
+		$this->_get_table_manager()->addIndex('esp_answer', 'QST_ID', 'QST_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_attendee_meta',
-            "ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_attendee_meta',
+			"ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				ATT_ID bigint(20) unsigned NOT NULL,
 				ATT_fname varchar(45) NOT NULL,
 				ATT_lname varchar(45) NOT NULL,
@@ -100,43 +100,43 @@ 
 				ATT_email varchar(255) NOT NULL,
 				ATT_phone varchar(45) DEFAULT NULL,
 				PRIMARY KEY  (ATTM_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_attendee_meta', 'ATT_ID', 'ATT_ID');
-        $this->_get_table_manager()->addIndex(
-            'esp_attendee_meta',
-            'ATT_email',
-            'ATT_email',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            TableAnalysis::INDEX_COLUMN_SIZE
-        );
-        $this->_get_table_manager()->addIndex('esp_attendee_meta', 'ATT_lname', 'ATT_lname');
-        $this->_get_table_manager()->addIndex('esp_attendee_meta', 'ATT_fname', 'ATT_fname');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_checkin',
-            "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex('esp_attendee_meta', 'ATT_ID', 'ATT_ID');
+		$this->_get_table_manager()->addIndex(
+			'esp_attendee_meta',
+			'ATT_email',
+			'ATT_email',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			TableAnalysis::INDEX_COLUMN_SIZE
+		);
+		$this->_get_table_manager()->addIndex('esp_attendee_meta', 'ATT_lname', 'ATT_lname');
+		$this->_get_table_manager()->addIndex('esp_attendee_meta', 'ATT_fname', 'ATT_fname');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_checkin',
+			"CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				REG_ID int(10) unsigned NOT NULL,
 				DTT_ID int(10) unsigned NOT NULL,
 				CHK_in tinyint(1) unsigned NOT NULL DEFAULT 1,
 				CHK_timestamp datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 				PRIMARY KEY  (CHK_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_checkin', 'REG_ID', 'REG_ID');
-        $this->_get_table_manager()->addIndex('esp_checkin', 'DTT_ID', 'DTT_ID');
-        $this->_get_table_manager()->addIndex(
-            'esp_checkin',
-            'CHK_timestamp',
-            'CHK_timestamp',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            null,
-            true
-        );
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_country',
-            "CNT_ISO varchar(2) NOT NULL,
+		);
+		$this->_get_table_manager()->addIndex('esp_checkin', 'REG_ID', 'REG_ID');
+		$this->_get_table_manager()->addIndex('esp_checkin', 'DTT_ID', 'DTT_ID');
+		$this->_get_table_manager()->addIndex(
+			'esp_checkin',
+			'CHK_timestamp',
+			'CHK_timestamp',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			null,
+			true
+		);
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_country',
+			"CNT_ISO varchar(2) NOT NULL,
 				CNT_ISO3 varchar(3) NOT NULL,
 				RGN_ID tinyint(3) unsigned DEFAULT NULL,
 				CNT_name varchar(45) NOT NULL,
@@ -152,38 +152,38 @@ 
 				CNT_is_EU tinyint(1) DEFAULT '0',
 				CNT_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CNT_ISO)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_currency',
-            "CUR_code varchar(6) NOT NULL,
+		$this->_table_has_not_changed_since_previous(
+			'esp_currency',
+			"CUR_code varchar(6) NOT NULL,
 				CUR_single varchar(45) DEFAULT 'dollar',
 				CUR_plural varchar(45) DEFAULT 'dollars',
 				CUR_sign varchar(45) DEFAULT '$',
 				CUR_dec_plc varchar(1) NOT NULL DEFAULT '2',
 				CUR_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CUR_code)"
-        );
+		);
 
 
-        // note: although this table is no longer in use,
-        // it hasn't been removed because then queries to the model will have errors.
-        // but you should expect this table and its corresponding model to be removed in
-        // the next few months
-        $this->_table_is_new_in_this_version(
-            'esp_currency_payment_method',
-            "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
+		// note: although this table is no longer in use,
+		// it hasn't been removed because then queries to the model will have errors.
+		// but you should expect this table and its corresponding model to be removed in
+		// the next few months
+		$this->_table_is_new_in_this_version(
+			'esp_currency_payment_method',
+			"CPM_ID int(11) NOT NULL AUTO_INCREMENT,
 				CUR_code varchar(6) NOT NULL,
 				PMD_ID int(11) NOT NULL,
 				PRIMARY KEY  (CPM_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_currency_payment_method', 'PMD_ID', 'PMD_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_currency_payment_method', 'PMD_ID', 'PMD_ID');
 
 
-        $this->_table_is_changed_in_this_version(
-            'esp_datetime',
-            "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version(
+			'esp_datetime',
+			"DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 			    VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 				DTT_name varchar(255) NOT NULL DEFAULT '',
@@ -198,39 +198,39 @@ 
 				DTT_parent int(10) unsigned DEFAULT 0,
 				DTT_deleted tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (DTT_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_datetime', 'EVT_ID', 'EVT_ID');
-        // $this->_get_table_manager()->addIndex('esp_datetime', 'VNU_ID', 'VNU_ID');
-        $this->_get_table_manager()->addIndex('esp_datetime', 'DTT_EVT_start', 'DTT_EVT_start');
-        // $this->_get_table_manager()->addIndex('esp_datetime', 'DTT_EVT_end', 'DTT_EVT_end');
-        // $this->_get_table_manager()->dropIndex('esp_datetime', 'DTT_is_primary');
+		);
+		$this->_get_table_manager()->addIndex('esp_datetime', 'EVT_ID', 'EVT_ID');
+		// $this->_get_table_manager()->addIndex('esp_datetime', 'VNU_ID', 'VNU_ID');
+		$this->_get_table_manager()->addIndex('esp_datetime', 'DTT_EVT_start', 'DTT_EVT_start');
+		// $this->_get_table_manager()->addIndex('esp_datetime', 'DTT_EVT_end', 'DTT_EVT_end');
+		// $this->_get_table_manager()->dropIndex('esp_datetime', 'DTT_is_primary');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_datetime_ticket',
-            "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_datetime_ticket',
+			"DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				DTT_ID int(10) unsigned NOT NULL,
 				TKT_ID int(10) unsigned NOT NULL,
 				PRIMARY KEY  (DTK_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_datetime_ticket', 'DTT_ID', 'DTT_ID');
-        $this->_get_table_manager()->addIndex('esp_datetime_ticket', 'TKT_ID', 'TKT_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_datetime_ticket', 'DTT_ID', 'DTT_ID');
+		$this->_get_table_manager()->addIndex('esp_datetime_ticket', 'TKT_ID', 'TKT_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_event_message_template',
-            "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_event_message_template',
+			"EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 				GRP_ID int(10) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EMT_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_event_message_template', 'EVT_ID', 'EVT_ID');
-        $this->_get_table_manager()->addIndex('esp_event_message_template', 'GRP_ID', 'GRP_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_event_message_template', 'EVT_ID', 'EVT_ID');
+		$this->_get_table_manager()->addIndex('esp_event_message_template', 'GRP_ID', 'GRP_ID');
 
 
-        $this->_table_is_changed_in_this_version(
-            'esp_event_meta',
-            "EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version(
+			'esp_event_meta',
+			"EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 			    VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 				EVT_display_desc tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -246,77 +246,77 @@ 
 				EVT_donations tinyint(1) NULL,
 				FSC_UUID varchar(25) DEFAULT NULL,
 				PRIMARY KEY  (EVTM_ID)"
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_event_meta',
-            'EVT_ID',
-            'EVT_ID',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            null,
-            true
-        );
-        // $this->_get_table_manager()->addIndex('esp_event_meta', 'VNU_ID', 'VNU_ID');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_event_question_group',
-            "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_event_meta',
+			'EVT_ID',
+			'EVT_ID',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			null,
+			true
+		);
+		// $this->_get_table_manager()->addIndex('esp_event_meta', 'VNU_ID', 'VNU_ID');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_event_question_group',
+			"EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				QSG_ID int(10) unsigned NOT NULL,
 				EQG_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 				EQG_additional tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EQG_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_event_question_group', 'EVT_ID', 'EVT_ID');
-        $this->_get_table_manager()->addIndex('esp_event_question_group', 'QSG_ID', 'QSG_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_event_question_group', 'EVT_ID', 'EVT_ID');
+		$this->_get_table_manager()->addIndex('esp_event_question_group', 'QSG_ID', 'QSG_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_event_venue',
-            "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_event_venue',
+			"EVV_ID int(11) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				VNU_ID bigint(20) unsigned NOT NULL,
 				EVV_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EVV_ID)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_extra_meta',
-            "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_extra_meta',
+			"EXM_ID int(11) NOT NULL AUTO_INCREMENT,
 				OBJ_ID int(11) DEFAULT NULL,
 				EXM_type varchar(45) DEFAULT NULL,
 				EXM_key varchar(45) DEFAULT NULL,
 				EXM_value text,
 				PRIMARY KEY  (EXM_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_extra_meta', 'EXM_type', 'EXM_type,OBJ_ID,EXM_key');
+		);
+		$this->_get_table_manager()->addIndex('esp_extra_meta', 'EXM_type', 'EXM_type,OBJ_ID,EXM_key');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_extra_join',
-            "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_extra_join',
+			"EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
 				EXJ_first_model_id varchar(12) NOT NULL,
 				EXJ_first_model_name varchar(20) NOT NULL,
 				EXJ_second_model_id varchar(12) NOT NULL,
 				EXJ_second_model_name varchar(20) NOT NULL,
 				PRIMARY KEY  (EXJ_ID)"
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_extra_join',
-            'first_model',
-            'EXJ_first_model_name,EXJ_first_model_id'
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_extra_join',
-            'second_model',
-            'EXJ_second_model_name,EXJ_second_model_id'
-        );
-
-
-        $this->_table_is_new_in_this_version(
-            'esp_form_element',
-            "FIN_UUID varchar(25) NOT NULL,
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_extra_join',
+			'first_model',
+			'EXJ_first_model_name,EXJ_first_model_id'
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_extra_join',
+			'second_model',
+			'EXJ_second_model_name,EXJ_second_model_id'
+		);
+
+
+		$this->_table_is_new_in_this_version(
+			'esp_form_element',
+			"FIN_UUID varchar(25) NOT NULL,
 				FSC_UUID varchar(25) NOT NULL,
 				FIN_adminOnly tinyint(1) unsigned NOT NULL DEFAULT 0,
 				FIN_attributes text DEFAULT NULL,
@@ -330,15 +330,15 @@ 
 				FIN_type tinytext DEFAULT NULL,
 				FIN_wpUser bigint(20) unsigned DEFAULT NULL,
 				PRIMARY KEY  (FIN_UUID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_form_element', 'FSC_UUID', 'FSC_UUID');
-        // $this->_get_table_manager()->dropIndex('esp_form_element', 'FIN_order');
-        // $this->_get_table_manager()->dropIndex('esp_form_element', 'FIN_status');
+		);
+		$this->_get_table_manager()->addIndex('esp_form_element', 'FSC_UUID', 'FSC_UUID');
+		// $this->_get_table_manager()->dropIndex('esp_form_element', 'FIN_order');
+		// $this->_get_table_manager()->dropIndex('esp_form_element', 'FIN_status');
 
 
-        $this->_table_is_new_in_this_version(
-            'esp_form_section',
-            "FSC_UUID varchar(25) NOT NULL,
+		$this->_table_is_new_in_this_version(
+			'esp_form_section',
+			"FSC_UUID varchar(25) NOT NULL,
 				FSC_appliesTo tinytext NOT NULL,
 				FSC_attributes text DEFAULT NULL,
 				FSC_belongsTo varchar(25) DEFAULT NULL,
@@ -347,36 +347,36 @@ 
 				FSC_status varchar(32) NOT NULL DEFAULT 'active',
 				FSC_wpUser bigint(20) unsigned DEFAULT NULL,
 				PRIMARY KEY  (FSC_UUID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_form_section', 'FSC_belongsTo', 'FSC_belongsTo');
-        // $this->_get_table_manager()->dropIndex('esp_form_section', 'FSC_order');
-        // $this->_get_table_manager()->dropIndex('esp_form_section', 'FSC_status');
+		);
+		$this->_get_table_manager()->addIndex('esp_form_section', 'FSC_belongsTo', 'FSC_belongsTo');
+		// $this->_get_table_manager()->dropIndex('esp_form_section', 'FSC_order');
+		// $this->_get_table_manager()->dropIndex('esp_form_section', 'FSC_status');
 
 
-        $this->_table_is_new_in_this_version(
-            'esp_form_submission',
-            "FSB_UUID varchar(25) NOT NULL,
+		$this->_table_is_new_in_this_version(
+			'esp_form_submission',
+			"FSB_UUID varchar(25) NOT NULL,
                 FSC_UUID varchar(25) NOT NULL,
 				TXN_ID int(10) DEFAULT NULL,
 				FSB_data mediumtext DEFAULT NULL,
 				FSB_submitted datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 				PRIMARY KEY  (FSB_UUID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_form_submission', 'FSC_UUID', 'FSC_UUID');
-        $this->_get_table_manager()->addIndex('esp_form_submission', 'TXN_ID', 'TXN_ID');
-        $this->_get_table_manager()->addIndex(
-            'esp_form_submission',
-            'FSB_submitted',
-            'FSB_submitted',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            null,
-            true
-        );
-
-
-        $this->_table_is_changed_in_this_version(
-            'esp_line_item',
-            "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex('esp_form_submission', 'FSC_UUID', 'FSC_UUID');
+		$this->_get_table_manager()->addIndex('esp_form_submission', 'TXN_ID', 'TXN_ID');
+		$this->_get_table_manager()->addIndex(
+			'esp_form_submission',
+			'FSB_submitted',
+			'FSB_submitted',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			null,
+			true
+		);
+
+
+		$this->_table_is_changed_in_this_version(
+			'esp_line_item',
+			"LIN_ID int(11) NOT NULL AUTO_INCREMENT,
 				LIN_code varchar(245) NOT NULL DEFAULT '',
 				TXN_ID int(10) DEFAULT NULL,
 				LIN_name varchar(245) NOT NULL DEFAULT '',
@@ -394,24 +394,24 @@ 
 				OBJ_type varchar(45) DEFAULT NULL,
 				LIN_timestamp datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 				PRIMARY KEY  (LIN_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_line_item', 'parent_order', 'LIN_parent,LIN_order');
-        $this->_get_table_manager()->addIndex('esp_line_item', 'txn_type_timestamp', 'TXN_ID,LIN_type,LIN_timestamp');
-        $this->_get_table_manager()->addIndex('esp_line_item', 'txn_obj_id_obj_type', 'TXN_ID,OBJ_ID,OBJ_type');
-        $this->_get_table_manager()->addIndex('esp_line_item', 'obj_id_obj_type', 'OBJ_ID,OBJ_type');
-        $this->_get_table_manager()->addIndex(
-            'esp_line_item',
-            'LIN_timestamp',
-            'LIN_timestamp',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            null,
-            true
-        );
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_log',
-            "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex('esp_line_item', 'parent_order', 'LIN_parent,LIN_order');
+		$this->_get_table_manager()->addIndex('esp_line_item', 'txn_type_timestamp', 'TXN_ID,LIN_type,LIN_timestamp');
+		$this->_get_table_manager()->addIndex('esp_line_item', 'txn_obj_id_obj_type', 'TXN_ID,OBJ_ID,OBJ_type');
+		$this->_get_table_manager()->addIndex('esp_line_item', 'obj_id_obj_type', 'OBJ_ID,OBJ_type');
+		$this->_get_table_manager()->addIndex(
+			'esp_line_item',
+			'LIN_timestamp',
+			'LIN_timestamp',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			null,
+			true
+		);
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_log',
+			"LOG_ID int(11) NOT NULL AUTO_INCREMENT,
 				LOG_time datetime DEFAULT NULL,
 				OBJ_ID varchar(45) DEFAULT NULL,
 				OBJ_type varchar(45) DEFAULT NULL,
@@ -419,15 +419,15 @@ 
 				LOG_message text,
 				LOG_wp_user int(11) DEFAULT NULL,
 				PRIMARY KEY  (LOG_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_log', 'LOG_time', 'LOG_time');
-        $this->_get_table_manager()->addIndex('esp_log', 'LOG_type', 'LOG_type');
-        $this->_get_table_manager()->addIndex('esp_log', 'OBJ', 'OBJ_type,OBJ_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_log', 'LOG_time', 'LOG_time');
+		$this->_get_table_manager()->addIndex('esp_log', 'LOG_type', 'LOG_type');
+		$this->_get_table_manager()->addIndex('esp_log', 'OBJ', 'OBJ_type,OBJ_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_message',
-            "MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_message',
+			"MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 				GRP_ID int(10) unsigned NULL,
 				MSG_token varchar(255) NULL,
 				TXN_ID int(10) unsigned NULL,
@@ -445,50 +445,50 @@ 
 				MSG_created datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 				MSG_modified datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 				PRIMARY KEY  (MSG_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_message', 'GRP_ID', 'GRP_ID');
-        $this->_get_table_manager()->addIndex('esp_message', 'TXN_ID', 'TXN_ID');
-        $this->_get_table_manager()->addIndex('esp_message', 'MSG_recipient_ID', 'MSG_recipient_ID');
-        $this->_get_table_manager()->addIndex(
-            'esp_message',
-            'MSG_to',
-            'MSG_to',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            TableAnalysis::INDEX_COLUMN_SIZE
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_message',
-            'MSG_from',
-            'MSG_from',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            TableAnalysis::INDEX_COLUMN_SIZE
-        );
-        $this->_get_table_manager()->addIndex('esp_message', 'MSG_modified', 'MSG_modified');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'MSG_messenger');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'MSG_message_type');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'MSG_context');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'MSG_recipient_type');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'MSG_subject');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'MSG_created');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'MSG_priority');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'STS_ID');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_message_template',
-            "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex('esp_message', 'GRP_ID', 'GRP_ID');
+		$this->_get_table_manager()->addIndex('esp_message', 'TXN_ID', 'TXN_ID');
+		$this->_get_table_manager()->addIndex('esp_message', 'MSG_recipient_ID', 'MSG_recipient_ID');
+		$this->_get_table_manager()->addIndex(
+			'esp_message',
+			'MSG_to',
+			'MSG_to',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			TableAnalysis::INDEX_COLUMN_SIZE
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_message',
+			'MSG_from',
+			'MSG_from',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			TableAnalysis::INDEX_COLUMN_SIZE
+		);
+		$this->_get_table_manager()->addIndex('esp_message', 'MSG_modified', 'MSG_modified');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'MSG_messenger');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'MSG_message_type');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'MSG_context');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'MSG_recipient_type');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'MSG_subject');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'MSG_created');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'MSG_priority');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'STS_ID');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_message_template',
+			"MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				GRP_ID int(10) unsigned NOT NULL,
 				MTP_context varchar(50) NOT NULL,
 				MTP_template_field varchar(30) NOT NULL,
 				MTP_content text NOT NULL,
 				PRIMARY KEY  (MTP_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_message_template', 'GRP_ID', 'GRP_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_message_template', 'GRP_ID', 'GRP_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_message_template_group',
-            "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_message_template_group',
+			"GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				MTP_user_id int(10) NOT NULL DEFAULT '1',
 				MTP_name varchar(245) NOT NULL DEFAULT '',
 				MTP_description varchar(245) NOT NULL DEFAULT '',
@@ -499,13 +499,13 @@ 
 				MTP_deleted tinyint(1) NOT NULL DEFAULT '0',
 				MTP_is_active tinyint(1) NOT NULL DEFAULT '1',
 				PRIMARY KEY  (GRP_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_message_template_group', 'MTP_user_id', 'MTP_user_id');
+		);
+		$this->_get_table_manager()->addIndex('esp_message_template_group', 'MTP_user_id', 'MTP_user_id');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_payment',
-            "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_payment',
+			"PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_ID int(10) unsigned DEFAULT NULL,
 				STS_ID varchar(3) DEFAULT NULL,
 				PAY_timestamp datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
@@ -520,21 +520,21 @@ 
 				PAY_redirect_url varchar(300),
 				PAY_redirect_args text,
 				PRIMARY KEY  (PAY_ID)"
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_payment',
-            'PAY_timestamp',
-            'PAY_timestamp',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            null,
-            true
-        );
-        $this->_get_table_manager()->addIndex('esp_payment', 'TXN_ID', 'TXN_ID');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_payment_method',
-            "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_payment',
+			'PAY_timestamp',
+			'PAY_timestamp',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			null,
+			true
+		);
+		$this->_get_table_manager()->addIndex('esp_payment', 'TXN_ID', 'TXN_ID');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_payment_method',
+			"PMD_ID int(11) NOT NULL AUTO_INCREMENT,
 				PMD_type varchar(124) DEFAULT NULL,
 				PMD_name varchar(255) DEFAULT NULL,
 				PMD_desc text,
@@ -548,19 +548,19 @@ 
 				PMD_button_url varchar(1012) DEFAULT NULL,
 				PMD_scope varchar(255) NULL DEFAULT 'frontend',
 				PRIMARY KEY  (PMD_ID)"
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_payment_method',
-            'PMD_slug_UNIQUE',
-            'PMD_slug',
-            TableAnalysis::INDEX_TYPE_UNIQUE
-        );
-        // $this->_get_table_manager()->dropIndex('esp_payment_method', 'PMD_type');
-
-
-        $this->_table_is_changed_in_this_version(
-            'esp_price',
-            "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_payment_method',
+			'PMD_slug_UNIQUE',
+			'PMD_slug',
+			TableAnalysis::INDEX_TYPE_UNIQUE
+		);
+		// $this->_get_table_manager()->dropIndex('esp_payment_method', 'PMD_type');
+
+
+		$this->_table_is_changed_in_this_version(
+			'esp_price',
+			"PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				PRT_ID tinyint(3) unsigned NOT NULL,
 				PRC_amount decimal(12,6) NOT NULL DEFAULT '0.00',
 				PRC_name varchar(245) NOT NULL,
@@ -572,13 +572,13 @@ 
 				PRC_wp_user bigint(20) unsigned NULL,
 				PRC_parent int(10) unsigned DEFAULT 0,
 				PRIMARY KEY  (PRC_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_price', 'PRT_ID', 'PRT_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_price', 'PRT_ID', 'PRT_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_price_type',
-            "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_price_type',
+			"PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
 				PRT_name varchar(45) NOT NULL,
 				PBT_ID tinyint(3) unsigned NOT NULL DEFAULT '1',
 				PRT_is_percent tinyint(1) NOT NULL DEFAULT '0',
@@ -587,33 +587,33 @@ 
 				PRT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				UNIQUE KEY PRT_name_UNIQUE (PRT_name),
 				PRIMARY KEY  (PRT_ID)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_ticket_price',
-            "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_ticket_price',
+			"TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TKT_ID int(10) unsigned NOT NULL,
 				PRC_ID int(10) unsigned NOT NULL,
 				PRIMARY KEY  (TKP_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_ticket_price', 'TKT_ID', 'TKT_ID');
-        $this->_get_table_manager()->addIndex('esp_ticket_price', 'PRC_ID', 'PRC_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_ticket_price', 'TKT_ID', 'TKT_ID');
+		$this->_get_table_manager()->addIndex('esp_ticket_price', 'PRC_ID', 'PRC_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_ticket_template',
-            "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_ticket_template',
+			"TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TTM_name varchar(45) NOT NULL,
 				TTM_description text,
 				TTM_file varchar(45),
 				PRIMARY KEY  (TTM_ID)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_question',
-            "QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_question',
+			"QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QST_display_text text NOT NULL,
 				QST_admin_label varchar(255) NOT NULL,
 				QST_system varchar(25) DEFAULT NULL,
@@ -626,13 +626,13 @@ 
 				QST_wp_user bigint(20) unsigned NULL,
 				QST_deleted tinyint(2) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QST_ID)"
-        );
-        // $this->_get_table_manager()->dropIndex('esp_question', 'QST_order');
+		);
+		// $this->_get_table_manager()->dropIndex('esp_question', 'QST_order');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_question_group',
-            "QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_question_group',
+			"QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSG_name varchar(255) NOT NULL,
 				QSG_identifier varchar(100) NOT NULL,
 				QSG_desc text NULL,
@@ -643,31 +643,31 @@ 
 				QSG_deleted tinyint(1) unsigned NOT NULL DEFAULT 0,
 				QSG_wp_user bigint(20) unsigned NULL,
 				PRIMARY KEY  (QSG_ID)"
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_question_group',
-            'QSG_identifier_UNIQUE',
-            'QSG_identifier',
-            TableAnalysis::INDEX_TYPE_UNIQUE
-        );
-        // $this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_order');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_question_group_question',
-            "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_question_group',
+			'QSG_identifier_UNIQUE',
+			'QSG_identifier',
+			TableAnalysis::INDEX_TYPE_UNIQUE
+		);
+		// $this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_order');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_question_group_question',
+			"QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSG_ID int(10) unsigned NOT NULL,
 				QST_ID int(10) unsigned NOT NULL,
 				QGQ_order int(10) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QGQ_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_question_group_question', 'QST_ID', 'QST_ID');
-        // $this->_get_table_manager()->dropIndex('esp_question_group_question', 'QSG_ID_order');
+		);
+		$this->_get_table_manager()->addIndex('esp_question_group_question', 'QST_ID', 'QST_ID');
+		// $this->_get_table_manager()->dropIndex('esp_question_group_question', 'QSG_ID_order');
 
 
-        $this->_table_is_changed_in_this_version(
-            'esp_question_option',
-            "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version(
+			'esp_question_option',
+			"QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSO_value varchar(255) NOT NULL,
 				QSO_desc text NOT NULL,
 				QST_ID int(10) unsigned NOT NULL,
@@ -676,14 +676,14 @@ 
 				QSO_default tinyint(1) DEFAULT '0',
 				QSO_deleted tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QSO_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_question_option', 'QST_ID', 'QST_ID');
-        $this->_get_table_manager()->dropIndex('esp_question_option', 'QSO_order');
+		);
+		$this->_get_table_manager()->addIndex('esp_question_option', 'QST_ID', 'QST_ID');
+		$this->_get_table_manager()->dropIndex('esp_question_option', 'QSO_order');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_registration',
-            "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_registration',
+			"REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				ATT_ID bigint(20) unsigned NOT NULL,
 				TXN_ID int(10) unsigned NOT NULL,
@@ -700,67 +700,67 @@ 
 				REG_att_is_going tinyint(1) DEFAULT '0',
 				REG_deleted tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (REG_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_registration', 'REG_url_link', 'REG_url_link');
-        $this->_get_table_manager()->addIndex('esp_registration', 'REG_code', 'REG_code');
-        // $this->_get_table_manager()->addIndex(
-        //     'esp_registration',
-        //     'REG_date',
-        //     'REG_date',
-        //     TableAnalysis::INDEX_TYPE_INDEX,
-        //     null,
-        //     true
-        // );
-        $this->_get_table_manager()->addIndex('esp_registration', 'TXN_ID', 'TXN_ID');
-        $this->_get_table_manager()->addIndex('esp_registration', 'ATT_ID', 'ATT_ID');
-        $this->_get_table_manager()->addIndex('esp_registration', 'TKT_ID', 'TKT_ID');
-        $this->_get_table_manager()->addIndex('esp_registration', 'EVT_ID', 'EVT_ID');
-        $this->_get_table_manager()->dropIndex('esp_registration', 'REG_deleted');
-        // $this->_get_table_manager()->dropIndex('esp_registration', 'STS_ID');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_registration_payment',
-            "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex('esp_registration', 'REG_url_link', 'REG_url_link');
+		$this->_get_table_manager()->addIndex('esp_registration', 'REG_code', 'REG_code');
+		// $this->_get_table_manager()->addIndex(
+		//     'esp_registration',
+		//     'REG_date',
+		//     'REG_date',
+		//     TableAnalysis::INDEX_TYPE_INDEX,
+		//     null,
+		//     true
+		// );
+		$this->_get_table_manager()->addIndex('esp_registration', 'TXN_ID', 'TXN_ID');
+		$this->_get_table_manager()->addIndex('esp_registration', 'ATT_ID', 'ATT_ID');
+		$this->_get_table_manager()->addIndex('esp_registration', 'TKT_ID', 'TKT_ID');
+		$this->_get_table_manager()->addIndex('esp_registration', 'EVT_ID', 'EVT_ID');
+		$this->_get_table_manager()->dropIndex('esp_registration', 'REG_deleted');
+		// $this->_get_table_manager()->dropIndex('esp_registration', 'STS_ID');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_registration_payment',
+			"RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  REG_ID int(10) unsigned NOT NULL,
 					  PAY_ID int(10) unsigned NULL,
 					  RPY_amount decimal(12,3) NOT NULL DEFAULT '0.00',
 					  PRIMARY KEY  (RPY_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_registration_payment', 'REG_ID', 'REG_ID');
-        $this->_get_table_manager()->addIndex('esp_registration_payment', 'PAY_ID', 'PAY_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_registration_payment', 'REG_ID', 'REG_ID');
+		$this->_get_table_manager()->addIndex('esp_registration_payment', 'PAY_ID', 'PAY_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_state',
-            "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_state',
+			"STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
 				CNT_ISO varchar(2) NOT NULL,
 				STA_abbrev varchar(24) NOT NULL,
 				STA_name varchar(100) NOT NULL,
 				STA_active tinyint(1) DEFAULT '1',
 				PRIMARY KEY  (STA_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_state', 'STA_abbrev', 'STA_abbrev');
-        $this->_get_table_manager()->addIndex('esp_state', 'CNT_ISO', 'CNT_ISO');
+		);
+		$this->_get_table_manager()->addIndex('esp_state', 'STA_abbrev', 'STA_abbrev');
+		$this->_get_table_manager()->addIndex('esp_state', 'CNT_ISO', 'CNT_ISO');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_status',
-            "STS_ID varchar(3) NOT NULL,
+		$this->_table_has_not_changed_since_previous(
+			'esp_status',
+			"STS_ID varchar(3) NOT NULL,
 				STS_code varchar(45) NOT NULL,
 				STS_type varchar(45) NOT NULL,
 				STS_can_edit tinyint(1) NOT NULL DEFAULT 0,
 				STS_desc tinytext,
 				STS_open tinyint(1) NOT NULL DEFAULT 1,
 				PRIMARY KEY  (STS_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_status', 'STS_type', 'STS_type');
-        $this->_get_table_manager()->dropIndex('esp_status', 'STS_ID_UNIQUE');
+		);
+		$this->_get_table_manager()->addIndex('esp_status', 'STS_type', 'STS_type');
+		$this->_get_table_manager()->dropIndex('esp_status', 'STS_ID_UNIQUE');
 
 
-        $this->_table_is_changed_in_this_version(
-            'esp_ticket',
-            "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version(
+			'esp_ticket',
+			"TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TTM_ID int(10) unsigned NOT NULL,
 				TKT_name varchar(245) NOT NULL DEFAULT '',
 				TKT_description text NOT NULL,
@@ -784,14 +784,14 @@ 
 				TKT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				TKT_visibility smallint(6) unsigned NOT NULL DEFAULT 100,
 				PRIMARY KEY  (TKT_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_ticket', 'TKT_start_date', 'TKT_start_date');
-        // $this->_get_table_manager()->addIndex('esp_ticket', 'TKT_end_date', 'TKT_end_date');
+		);
+		$this->_get_table_manager()->addIndex('esp_ticket', 'TKT_start_date', 'TKT_start_date');
+		// $this->_get_table_manager()->addIndex('esp_ticket', 'TKT_end_date', 'TKT_end_date');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_transaction',
-            "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_transaction',
+			"TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_timestamp datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 				TXN_total decimal(12,3) DEFAULT '0.00',
 				TXN_paid decimal(12,3) NOT NULL DEFAULT '0.00',
@@ -801,21 +801,21 @@ 
 				PMD_ID int(11) DEFAULT NULL,
 				TXN_reg_steps text,
 				PRIMARY KEY  (TXN_ID)"
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_transaction',
-            'TXN_timestamp',
-            'TXN_timestamp',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            null,
-            true
-        );
-        // $this->_get_table_manager()->dropIndex('esp_transaction', 'STS_ID');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_venue_meta',
-            'VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_transaction',
+			'TXN_timestamp',
+			'TXN_timestamp',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			null,
+			true
+		);
+		// $this->_get_table_manager()->dropIndex('esp_transaction', 'STS_ID');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_venue_meta',
+			'VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
 			VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 			VNU_address varchar(255) DEFAULT NULL,
 			VNU_address2 varchar(255) DEFAULT NULL,
@@ -831,29 +831,29 @@ 
 			VNU_enable_for_gmap tinyint(1) DEFAULT 0,
 			VNU_google_map_link varchar(255) DEFAULT NULL,
 			PRIMARY KEY  (VNUM_ID)'
-        );
-        $this->_get_table_manager()->addIndex('esp_venue_meta', 'VNU_ID', 'VNU_ID');
-        $this->_get_table_manager()->addIndex('esp_venue_meta', 'STA_ID', 'STA_ID');
-        $this->_get_table_manager()->addIndex('esp_venue_meta', 'CNT_ISO', 'CNT_ISO');
+		);
+		$this->_get_table_manager()->addIndex('esp_venue_meta', 'VNU_ID', 'VNU_ID');
+		$this->_get_table_manager()->addIndex('esp_venue_meta', 'STA_ID', 'STA_ID');
+		$this->_get_table_manager()->addIndex('esp_venue_meta', 'CNT_ISO', 'CNT_ISO');
 
 
-        $this->previous_dms->insert_default_data();
-        $LegacyTextDomainOptions = new LegacyTextDomainOptions();
-        $LegacyTextDomainOptions->convertToConsolidatedFormat();
-        return true;
-    }
+		$this->previous_dms->insert_default_data();
+		$LegacyTextDomainOptions = new LegacyTextDomainOptions();
+		$LegacyTextDomainOptions->convertToConsolidatedFormat();
+		return true;
+	}
 
 
-    /**
-     * @return bool
-     */
-    public function schema_changes_after_migration(): bool
-    {
-        return true;
-    }
+	/**
+	 * @return bool
+	 */
+	public function schema_changes_after_migration(): bool
+	{
+		return true;
+	}
 
 
-    public function migration_page_hooks()
-    {
-    }
+	public function migration_page_hooks()
+	{
+	}
 }