eventespresso / event-espresso-core

core/db_classes/EE_Question_Form_Input.class.php

Spacing +32 added lines, -32 removed lines

@@ -114,7 +114,7 @@ 
      */
     public function set_question_form_input_meta($q_meta = [])
     {
-        $default_q_meta  = [
+        $default_q_meta = [
             'att_nmbr'       => 1,
             'ticket_id'      => '',
             'date'           => '',
@@ -160,13 +160,13 @@ 
      */
     private function _set_input_name($qstn_id)
     {
-        if (! empty($qstn_id)) {
+        if ( ! empty($qstn_id)) {
             $ANS_ID  = $this->get('ANS_ID');
-            $qstn_id = ! empty($ANS_ID) ? '[' . $qstn_id . '][' . $ANS_ID . ']' : '[' . $qstn_id . ']';
+            $qstn_id = ! empty($ANS_ID) ? '['.$qstn_id.']['.$ANS_ID.']' : '['.$qstn_id.']';
         }
         $this->QST_input_name = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
-            ? $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'] . $qstn_id
-            : $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'];
+            ? $this->_QST_meta['input_prefix'].$this->_QST_meta['input_name'].$qstn_id
+            : $this->_QST_meta['input_prefix'].$this->_QST_meta['input_name'];
     }
 
 
@@ -181,7 +181,7 @@ 
      */
     public function get($property = null)
     {
-        if (! empty($property)) {
+        if ( ! empty($property)) {
             if (EEM_Question::instance()->has_field($property)) {
                 return $this->_QST->get($property);
             } elseif (EEM_Answer::instance()->has_field($property)) {
@@ -207,7 +207,7 @@ 
     {
         // first try regular property exists method which works as expected in PHP 5.3+
         $prop = EEH_Class_Tools::has_property($classname, $property);
-        if (! $prop) {
+        if ( ! $prop) {
             // use reflection for < PHP 5.3 as a double check when property is not found, possible due to access restriction
             $reflector = new ReflectionClass($classname);
             $prop      = $reflector->hasProperty($property);
@@ -231,7 +231,7 @@ 
             ? $this->_QST_meta['input_id']
             : sanitize_key(strip_tags($this->_QST->get('QST_display_text')));
         $this->QST_input_id = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
-            ? $input_id . '-' . $qstn_id
+            ? $input_id.'-'.$qstn_id
             : $input_id;
     }
 
@@ -272,8 +272,8 @@ 
             $date = $this->_QST_meta['date'];
             $time = $this->_QST_meta['time'];
             $price_id = $this->_QST_meta['price_id'];
-            if (isset($this->form_data['qstn'][ $EVT_ID ][ $att_nmbr ][ $date ][ $time ][ $price_id ][ $qstn_id ])) {
-                $answer = $this->form_data['qstn'][ $EVT_ID ][ $att_nmbr ][ $date ][ $time ][ $price_id ][ $qstn_id ];
+            if (isset($this->form_data['qstn'][$EVT_ID][$att_nmbr][$date][$time][$price_id][$qstn_id])) {
+                $answer = $this->form_data['qstn'][$EVT_ID][$att_nmbr][$date][$time][$price_id][$qstn_id];
                 $this->_ANS->set('ANS_value', $answer);
             }
         }
@@ -292,42 +292,42 @@ 
      */
     public static function generate_question_form_inputs_for_object($object = false, $input_types = [])
     {
-        if (! is_object($object)) {
+        if ( ! is_object($object)) {
             return [];
         }
         $inputs = [];
         $fields = $object->get_model()->field_settings(false);
         foreach ($fields as $field_ID => $field) {
             if ($field instanceof EE_Model_Field_Base) {
-                if (isset($input_types[ $field_ID ])) {
+                if (isset($input_types[$field_ID])) {
                     // get saved value for field
                     $value = $object->get($field_ID);
                     // if no saved value, then use default
                     $value = $value !== null ? $value : $field->get_default_value();
                     // determine question type
-                    $type = isset($input_types[ $field_ID ]) ? $input_types[ $field_ID ]['type'] : 'TEXT';
+                    $type = isset($input_types[$field_ID]) ? $input_types[$field_ID]['type'] : 'TEXT';
                     // input name
-                    $input_name = isset($input_types[ $field_ID ]) && isset($input_types[ $field_ID ]['input_name'])
-                        ? $input_types[ $field_ID ]['input_name'] . '[' . $field_ID . ']'
+                    $input_name = isset($input_types[$field_ID]) && isset($input_types[$field_ID]['input_name'])
+                        ? $input_types[$field_ID]['input_name'].'['.$field_ID.']'
                         : $field_ID;
                     // css class for input
-                    $class = isset($input_types[ $field_ID ]['class']) && ! empty($input_types[ $field_ID ]['class'])
-                        ? ' ' . $input_types[ $field_ID ]['class']
+                    $class = isset($input_types[$field_ID]['class']) && ! empty($input_types[$field_ID]['class'])
+                        ? ' '.$input_types[$field_ID]['class']
                         : '';
                     // whether to apply htmlentities to answer
-                    $htmlentities = isset($input_types[ $field_ID ]['htmlentities'])
-                        ? $input_types[ $field_ID ]['htmlentities']
+                    $htmlentities = isset($input_types[$field_ID]['htmlentities'])
+                        ? $input_types[$field_ID]['htmlentities']
                         : true;
                     // whether to apply htmlentities to answer
-                    $label_b4 = isset($input_types[ $field_ID ]['label_b4'])
-                        ? $input_types[ $field_ID ]['label_b4']
+                    $label_b4 = isset($input_types[$field_ID]['label_b4'])
+                        ? $input_types[$field_ID]['label_b4']
                         : false;
                     // whether to apply htmlentities to answer
-                    $use_desc_4_label = isset($input_types[ $field_ID ]['use_desc_4_label'])
-                        ? $input_types[ $field_ID ]['use_desc_4_label']
+                    $use_desc_4_label = isset($input_types[$field_ID]['use_desc_4_label'])
+                        ? $input_types[$field_ID]['use_desc_4_label']
                         : false;
                     // whether input is disabled
-                    $disabled = isset($input_types[ $field_ID ]['disabled']) && $input_types[ $field_ID ]['disabled'];
+                    $disabled = isset($input_types[$field_ID]['disabled']) && $input_types[$field_ID]['disabled'];
 
                     // create EE_Question_Form_Input object
                     $QFI = new EE_Question_Form_Input(
@@ -347,9 +347,9 @@ 
                             ]
                         ),
                         [
-                            'input_id'         => $field_ID . '-' . $object->ID(),
+                            'input_id'         => $field_ID.'-'.$object->ID(),
                             'input_name'       => $input_name,
-                            'input_class'      => $field_ID . $class,
+                            'input_class'      => $field_ID.$class,
                             'input_prefix'     => '',
                             'append_qstn_id'   => false,
                             'htmlentities'     => $htmlentities,
@@ -360,10 +360,10 @@ 
                     // does question type have options ?
                     if (
                         in_array($type, ['DROPDOWN', 'RADIO_BTN', 'CHECKBOX'])
-                        && isset($input_types[ $field_ID ])
-                        && isset($input_types[ $field_ID ]['options'])
+                        && isset($input_types[$field_ID])
+                        && isset($input_types[$field_ID]['options'])
                     ) {
-                        foreach ($input_types[ $field_ID ]['options'] as $option) {
+                        foreach ($input_types[$field_ID]['options'] as $option) {
                             $option    = stripslashes_deep($option);
                             $option_id = ! empty($option['id']) ? $option['id'] : 0;
                             $QSO       = EE_Question_Option::new_instance(
@@ -381,7 +381,7 @@ 
                     if ($disabled || $field_ID == $object->get_model()->primary_key_name()) {
                         $QFI->set('QST_disabled', true);
                     }
-                    $inputs[ $field_ID ] = $QFI;
+                    $inputs[$field_ID] = $QFI;
                 }
             }
         }
@@ -414,7 +414,7 @@ 
      */
     public function set($property = null, $value = null)
     {
-        if (! empty($property)) {
+        if ( ! empty($property)) {
             if (EEM_Question::instance()->has_field($property)) {
                 $this->_QST->set($property, $value);
             } elseif (EEM_Answer::instance()->has_field($property)) {
@@ -460,6 +460,6 @@ 
      */
     public function get_meta($key = false)
     {
-        return $key && isset($this->_QST_meta[ $key ]) ? $this->_QST_meta[ $key ] : false;
+        return $key && isset($this->_QST_meta[$key]) ? $this->_QST_meta[$key] : false;
     }
 }

Indentation +446 added lines, -446 removed lines

@@ -15,450 +15,450 @@
  */
 class EE_Question_Form_Input
 {
-    /**
-     *    EE_Question object
-     *
-     * @access private
-     * @var object
-     */
-    private $_QST = null;
-
-    /**
-     *    EE_Answer object
-     *
-     * @access private
-     * @var object
-     */
-    private $_ANS = null;
-
-    /**
-     *    $_QST_meta
-     * @access private
-     * @var array
-     */
-    private $_QST_meta = [];
-
-    /**
-     *    $QST_input_name
-     * @access private
-     * @var string
-     */
-    private $QST_input_name = '';
-
-    /**
-     *    $QST_input_id
-     * @access private
-     * @var string
-     */
-    private $QST_input_id = '';
-
-    /**
-     *    $QST_input_class
-     * @access private
-     * @var string
-     */
-    private $QST_input_class = '';
-
-    /**
-     * @var bool $QST_disabled
-     */
-    private $QST_disabled = false;
-
-    /**
-     * @var RequestInterface
-     */
-    protected $request;
-
-    /**
-     * @var array
-     */
-    protected $form_data;
-
-
-    /**
-     * constructor for questions
-     *
-     * @param EE_Question $QST EE_Question object
-     * @param EE_Answer   $ANS EE_Answer object
-     * @param array       $q_meta
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(EE_Question $QST = null, EE_Answer $ANS = null, $q_meta = [])
-    {
-        $this->request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $this->form_data = $this->request->requestParams();
-        if (empty($QST) || empty($ANS)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. A valid EE_Question or EE_Answer object was not received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $this->_QST = $QST;
-        $this->_ANS = $ANS;
-        $this->set_question_form_input_meta($q_meta);
-        $this->set_question_form_input_init();
-    }
-
-
-    /**
-     * sets meta data for the question form input
-     *
-     * @access public
-     * @param array $q_meta
-     * @return void
-     */
-    public function set_question_form_input_meta($q_meta = [])
-    {
-        $default_q_meta  = [
-            'att_nmbr'       => 1,
-            'ticket_id'      => '',
-            'date'           => '',
-            'time'           => '',
-            'input_name'     => '',
-            'input_id'       => '',
-            'input_class'    => '',
-            'input_prefix'   => 'qstn',
-            'append_qstn_id' => true,
-            'htmlentities'   => true,
-            'allow_null'     => false,
-        ];
-        $this->_QST_meta = array_merge($default_q_meta, $q_meta);
-    }
-
-
-    /**
-     * set_question_form_input_init
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_question_form_input_init()
-    {
-        $qstn_id = $this->_QST->system_ID() ? $this->_QST->system_ID() : $this->_QST->ID();
-        $this->_set_input_name($qstn_id);
-        $this->_set_input_id($qstn_id);
-        $this->_set_input_class();
-        $this->set_question_form_input_answer($qstn_id);
-    }
-
-
-    /**
-     * set_input_name
-     *
-     * @access private
-     * @param $qstn_id
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _set_input_name($qstn_id)
-    {
-        if (! empty($qstn_id)) {
-            $ANS_ID  = $this->get('ANS_ID');
-            $qstn_id = ! empty($ANS_ID) ? '[' . $qstn_id . '][' . $ANS_ID . ']' : '[' . $qstn_id . ']';
-        }
-        $this->QST_input_name = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
-            ? $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'] . $qstn_id
-            : $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'];
-    }
-
-
-    /**
-     * get property values for question form input
-     *
-     * @access public
-     * @param string $property
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get($property = null)
-    {
-        if (! empty($property)) {
-            if (EEM_Question::instance()->has_field($property)) {
-                return $this->_QST->get($property);
-            } elseif (EEM_Answer::instance()->has_field($property)) {
-                return $this->_ANS->get($property);
-            } elseif ($this->_question_form_input_property_exists(__CLASS__, $property)) {
-                return $this->{$property};
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     *    _question_form_input_property_exists
-     *
-     * @access private
-     * @param string $classname
-     * @param string $property
-     * @return boolean
-     * @throws ReflectionException
-     */
-    private function _question_form_input_property_exists($classname, $property)
-    {
-        // first try regular property exists method which works as expected in PHP 5.3+
-        $prop = EEH_Class_Tools::has_property($classname, $property);
-        if (! $prop) {
-            // use reflection for < PHP 5.3 as a double check when property is not found, possible due to access restriction
-            $reflector = new ReflectionClass($classname);
-            $prop      = $reflector->hasProperty($property);
-        }
-        return $prop;
-    }
-
-
-    /**
-     * set_input_id
-     *
-     * @access private
-     * @param $qstn_id
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _set_input_id($qstn_id)
-    {
-        $input_id           = isset($this->_QST_meta['input_id']) && ! empty($this->_QST_meta['input_id'])
-            ? $this->_QST_meta['input_id']
-            : sanitize_key(strip_tags($this->_QST->get('QST_display_text')));
-        $this->QST_input_id = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
-            ? $input_id . '-' . $qstn_id
-            : $input_id;
-    }
-
-
-    /**
-     * set_input_class
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_input_class()
-    {
-        $this->QST_input_class = isset($this->_QST_meta['input_class']) ? $this->_QST_meta['input_class'] : '';
-    }
-
-
-    /**
-     * set_question_form_input_answer
-     *
-     * @access public
-     * @param mixed    int | string    $qstn_id
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_question_form_input_answer($qstn_id)
-    {
-        // check for answer in $this->form_data in case we are reprocessing a form after an error
-        if (
-            isset($this->_QST_meta['EVT_ID'])
-            && isset($this->_QST_meta['att_nmbr'])
-            && isset($this->_QST_meta['date'])
-            && isset($this->_QST_meta['time'])
-            && isset($this->_QST_meta['price_id'])
-        ) {
-            $EVT_ID = $this->_QST_meta['EVT_ID'];
-            $att_nmbr = $this->_QST_meta['att_nmbr'];
-            $date = $this->_QST_meta['date'];
-            $time = $this->_QST_meta['time'];
-            $price_id = $this->_QST_meta['price_id'];
-            if (isset($this->form_data['qstn'][ $EVT_ID ][ $att_nmbr ][ $date ][ $time ][ $price_id ][ $qstn_id ])) {
-                $answer = $this->form_data['qstn'][ $EVT_ID ][ $att_nmbr ][ $date ][ $time ][ $price_id ][ $qstn_id ];
-                $this->_ANS->set('ANS_value', $answer);
-            }
-        }
-    }
-
-
-    /**
-     *        generate_question_form_inputs_for_object
-     *
-     * @access    protected
-     * @param bool|object $object $object
-     * @param array       $input_types
-     * @return        array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_question_form_inputs_for_object($object = false, $input_types = [])
-    {
-        if (! is_object($object)) {
-            return [];
-        }
-        $inputs = [];
-        $fields = $object->get_model()->field_settings(false);
-        foreach ($fields as $field_ID => $field) {
-            if ($field instanceof EE_Model_Field_Base) {
-                if (isset($input_types[ $field_ID ])) {
-                    // get saved value for field
-                    $value = $object->get($field_ID);
-                    // if no saved value, then use default
-                    $value = $value !== null ? $value : $field->get_default_value();
-                    // determine question type
-                    $type = isset($input_types[ $field_ID ]) ? $input_types[ $field_ID ]['type'] : 'TEXT';
-                    // input name
-                    $input_name = isset($input_types[ $field_ID ]) && isset($input_types[ $field_ID ]['input_name'])
-                        ? $input_types[ $field_ID ]['input_name'] . '[' . $field_ID . ']'
-                        : $field_ID;
-                    // css class for input
-                    $class = isset($input_types[ $field_ID ]['class']) && ! empty($input_types[ $field_ID ]['class'])
-                        ? ' ' . $input_types[ $field_ID ]['class']
-                        : '';
-                    // whether to apply htmlentities to answer
-                    $htmlentities = isset($input_types[ $field_ID ]['htmlentities'])
-                        ? $input_types[ $field_ID ]['htmlentities']
-                        : true;
-                    // whether to apply htmlentities to answer
-                    $label_b4 = isset($input_types[ $field_ID ]['label_b4'])
-                        ? $input_types[ $field_ID ]['label_b4']
-                        : false;
-                    // whether to apply htmlentities to answer
-                    $use_desc_4_label = isset($input_types[ $field_ID ]['use_desc_4_label'])
-                        ? $input_types[ $field_ID ]['use_desc_4_label']
-                        : false;
-                    // whether input is disabled
-                    $disabled = isset($input_types[ $field_ID ]['disabled']) && $input_types[ $field_ID ]['disabled'];
-
-                    // create EE_Question_Form_Input object
-                    $QFI = new EE_Question_Form_Input(
-                        EE_Question::new_instance(
-                            [
-                                'QST_ID'           => 0,
-                                'QST_display_text' => $field->get_nicename(),
-                                'QST_type'         => $type,
-                            ]
-                        ),
-                        EE_Answer::new_instance(
-                            [
-                                'ANS_ID'    => 0,
-                                'QST_ID'    => 0,
-                                'REG_ID'    => 0,
-                                'ANS_value' => $value,
-                            ]
-                        ),
-                        [
-                            'input_id'         => $field_ID . '-' . $object->ID(),
-                            'input_name'       => $input_name,
-                            'input_class'      => $field_ID . $class,
-                            'input_prefix'     => '',
-                            'append_qstn_id'   => false,
-                            'htmlentities'     => $htmlentities,
-                            'label_b4'         => $label_b4,
-                            'use_desc_4_label' => $use_desc_4_label,
-                        ]
-                    );
-                    // does question type have options ?
-                    if (
-                        in_array($type, ['DROPDOWN', 'RADIO_BTN', 'CHECKBOX'])
-                        && isset($input_types[ $field_ID ])
-                        && isset($input_types[ $field_ID ]['options'])
-                    ) {
-                        foreach ($input_types[ $field_ID ]['options'] as $option) {
-                            $option    = stripslashes_deep($option);
-                            $option_id = ! empty($option['id']) ? $option['id'] : 0;
-                            $QSO       = EE_Question_Option::new_instance(
-                                [
-                                    'QSO_value'   => (string) $option_id,
-                                    'QSO_desc'    => $option['text'],
-                                    'QSO_deleted' => false,
-                                ]
-                            );
-                            // all QST (and ANS) properties can be accessed indirectly thru QFI
-                            $QFI->add_temp_option($QSO);
-                        }
-                    }
-                    // we don't want ppl manually changing primary keys cuz that would just lead to total craziness man
-                    if ($disabled || $field_ID == $object->get_model()->primary_key_name()) {
-                        $QFI->set('QST_disabled', true);
-                    }
-                    $inputs[ $field_ID ] = $QFI;
-                }
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     *    add_temp_option
-     *
-     * @access public
-     * @param EE_Question_Option $QSO EE_Question_Option
-     * @return void
-     */
-    public function add_temp_option(EE_Question_Option $QSO)
-    {
-        $this->_QST->add_temp_option($QSO);
-    }
-
-
-    /**
-     * set property values for question form input
-     *
-     * @access public
-     * @param string $property
-     * @param mixed  $value
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set($property = null, $value = null)
-    {
-        if (! empty($property)) {
-            if (EEM_Question::instance()->has_field($property)) {
-                $this->_QST->set($property, $value);
-            } elseif (EEM_Answer::instance()->has_field($property)) {
-                $this->_ANS->set($property, $value);
-            } elseif ($this->_question_form_input_property_exists(__CLASS__, $property)) {
-                $this->{$property} = $value;
-            }
-        }
-    }
-
-
-    /**
-     *    _question_form_input_property_exists
-     *
-     * @access public
-     * @param boolean      $notDeletedOptionsOnly            1
-     *                                                       whether to return ALL options, or only the ones which have
-     *                                                       not yet been deleted
-     * @param string|array $selected_value_to_always_include , when retrieving options to an ANSWERED question,
-     *                                                       we want to usually only show non-deleted options AND the
-     *                                                       value that was selected for the answer, whether it was
-     *                                                       trashed or not.
-     * @return EE_Question_Option
-     */
-    public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
-    {
-        $temp_options = $this->_QST->temp_options();
-        return ! empty($temp_options)
-            ? $temp_options
-            : $this->_QST->options(
-                $notDeletedOptionsOnly,
-                $selected_value_to_always_include
-            );
-    }
-
-
-    /**
-     *    get_meta
-     *
-     * @access public
-     * @param mixed $key
-     * @return mixed
-     */
-    public function get_meta($key = false)
-    {
-        return $key && isset($this->_QST_meta[ $key ]) ? $this->_QST_meta[ $key ] : false;
-    }
+	/**
+	 *    EE_Question object
+	 *
+	 * @access private
+	 * @var object
+	 */
+	private $_QST = null;
+
+	/**
+	 *    EE_Answer object
+	 *
+	 * @access private
+	 * @var object
+	 */
+	private $_ANS = null;
+
+	/**
+	 *    $_QST_meta
+	 * @access private
+	 * @var array
+	 */
+	private $_QST_meta = [];
+
+	/**
+	 *    $QST_input_name
+	 * @access private
+	 * @var string
+	 */
+	private $QST_input_name = '';
+
+	/**
+	 *    $QST_input_id
+	 * @access private
+	 * @var string
+	 */
+	private $QST_input_id = '';
+
+	/**
+	 *    $QST_input_class
+	 * @access private
+	 * @var string
+	 */
+	private $QST_input_class = '';
+
+	/**
+	 * @var bool $QST_disabled
+	 */
+	private $QST_disabled = false;
+
+	/**
+	 * @var RequestInterface
+	 */
+	protected $request;
+
+	/**
+	 * @var array
+	 */
+	protected $form_data;
+
+
+	/**
+	 * constructor for questions
+	 *
+	 * @param EE_Question $QST EE_Question object
+	 * @param EE_Answer   $ANS EE_Answer object
+	 * @param array       $q_meta
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(EE_Question $QST = null, EE_Answer $ANS = null, $q_meta = [])
+	{
+		$this->request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$this->form_data = $this->request->requestParams();
+		if (empty($QST) || empty($ANS)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. A valid EE_Question or EE_Answer object was not received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$this->_QST = $QST;
+		$this->_ANS = $ANS;
+		$this->set_question_form_input_meta($q_meta);
+		$this->set_question_form_input_init();
+	}
+
+
+	/**
+	 * sets meta data for the question form input
+	 *
+	 * @access public
+	 * @param array $q_meta
+	 * @return void
+	 */
+	public function set_question_form_input_meta($q_meta = [])
+	{
+		$default_q_meta  = [
+			'att_nmbr'       => 1,
+			'ticket_id'      => '',
+			'date'           => '',
+			'time'           => '',
+			'input_name'     => '',
+			'input_id'       => '',
+			'input_class'    => '',
+			'input_prefix'   => 'qstn',
+			'append_qstn_id' => true,
+			'htmlentities'   => true,
+			'allow_null'     => false,
+		];
+		$this->_QST_meta = array_merge($default_q_meta, $q_meta);
+	}
+
+
+	/**
+	 * set_question_form_input_init
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_question_form_input_init()
+	{
+		$qstn_id = $this->_QST->system_ID() ? $this->_QST->system_ID() : $this->_QST->ID();
+		$this->_set_input_name($qstn_id);
+		$this->_set_input_id($qstn_id);
+		$this->_set_input_class();
+		$this->set_question_form_input_answer($qstn_id);
+	}
+
+
+	/**
+	 * set_input_name
+	 *
+	 * @access private
+	 * @param $qstn_id
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _set_input_name($qstn_id)
+	{
+		if (! empty($qstn_id)) {
+			$ANS_ID  = $this->get('ANS_ID');
+			$qstn_id = ! empty($ANS_ID) ? '[' . $qstn_id . '][' . $ANS_ID . ']' : '[' . $qstn_id . ']';
+		}
+		$this->QST_input_name = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
+			? $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'] . $qstn_id
+			: $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'];
+	}
+
+
+	/**
+	 * get property values for question form input
+	 *
+	 * @access public
+	 * @param string $property
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get($property = null)
+	{
+		if (! empty($property)) {
+			if (EEM_Question::instance()->has_field($property)) {
+				return $this->_QST->get($property);
+			} elseif (EEM_Answer::instance()->has_field($property)) {
+				return $this->_ANS->get($property);
+			} elseif ($this->_question_form_input_property_exists(__CLASS__, $property)) {
+				return $this->{$property};
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 *    _question_form_input_property_exists
+	 *
+	 * @access private
+	 * @param string $classname
+	 * @param string $property
+	 * @return boolean
+	 * @throws ReflectionException
+	 */
+	private function _question_form_input_property_exists($classname, $property)
+	{
+		// first try regular property exists method which works as expected in PHP 5.3+
+		$prop = EEH_Class_Tools::has_property($classname, $property);
+		if (! $prop) {
+			// use reflection for < PHP 5.3 as a double check when property is not found, possible due to access restriction
+			$reflector = new ReflectionClass($classname);
+			$prop      = $reflector->hasProperty($property);
+		}
+		return $prop;
+	}
+
+
+	/**
+	 * set_input_id
+	 *
+	 * @access private
+	 * @param $qstn_id
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _set_input_id($qstn_id)
+	{
+		$input_id           = isset($this->_QST_meta['input_id']) && ! empty($this->_QST_meta['input_id'])
+			? $this->_QST_meta['input_id']
+			: sanitize_key(strip_tags($this->_QST->get('QST_display_text')));
+		$this->QST_input_id = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
+			? $input_id . '-' . $qstn_id
+			: $input_id;
+	}
+
+
+	/**
+	 * set_input_class
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_input_class()
+	{
+		$this->QST_input_class = isset($this->_QST_meta['input_class']) ? $this->_QST_meta['input_class'] : '';
+	}
+
+
+	/**
+	 * set_question_form_input_answer
+	 *
+	 * @access public
+	 * @param mixed    int | string    $qstn_id
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_question_form_input_answer($qstn_id)
+	{
+		// check for answer in $this->form_data in case we are reprocessing a form after an error
+		if (
+			isset($this->_QST_meta['EVT_ID'])
+			&& isset($this->_QST_meta['att_nmbr'])
+			&& isset($this->_QST_meta['date'])
+			&& isset($this->_QST_meta['time'])
+			&& isset($this->_QST_meta['price_id'])
+		) {
+			$EVT_ID = $this->_QST_meta['EVT_ID'];
+			$att_nmbr = $this->_QST_meta['att_nmbr'];
+			$date = $this->_QST_meta['date'];
+			$time = $this->_QST_meta['time'];
+			$price_id = $this->_QST_meta['price_id'];
+			if (isset($this->form_data['qstn'][ $EVT_ID ][ $att_nmbr ][ $date ][ $time ][ $price_id ][ $qstn_id ])) {
+				$answer = $this->form_data['qstn'][ $EVT_ID ][ $att_nmbr ][ $date ][ $time ][ $price_id ][ $qstn_id ];
+				$this->_ANS->set('ANS_value', $answer);
+			}
+		}
+	}
+
+
+	/**
+	 *        generate_question_form_inputs_for_object
+	 *
+	 * @access    protected
+	 * @param bool|object $object $object
+	 * @param array       $input_types
+	 * @return        array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_question_form_inputs_for_object($object = false, $input_types = [])
+	{
+		if (! is_object($object)) {
+			return [];
+		}
+		$inputs = [];
+		$fields = $object->get_model()->field_settings(false);
+		foreach ($fields as $field_ID => $field) {
+			if ($field instanceof EE_Model_Field_Base) {
+				if (isset($input_types[ $field_ID ])) {
+					// get saved value for field
+					$value = $object->get($field_ID);
+					// if no saved value, then use default
+					$value = $value !== null ? $value : $field->get_default_value();
+					// determine question type
+					$type = isset($input_types[ $field_ID ]) ? $input_types[ $field_ID ]['type'] : 'TEXT';
+					// input name
+					$input_name = isset($input_types[ $field_ID ]) && isset($input_types[ $field_ID ]['input_name'])
+						? $input_types[ $field_ID ]['input_name'] . '[' . $field_ID . ']'
+						: $field_ID;
+					// css class for input
+					$class = isset($input_types[ $field_ID ]['class']) && ! empty($input_types[ $field_ID ]['class'])
+						? ' ' . $input_types[ $field_ID ]['class']
+						: '';
+					// whether to apply htmlentities to answer
+					$htmlentities = isset($input_types[ $field_ID ]['htmlentities'])
+						? $input_types[ $field_ID ]['htmlentities']
+						: true;
+					// whether to apply htmlentities to answer
+					$label_b4 = isset($input_types[ $field_ID ]['label_b4'])
+						? $input_types[ $field_ID ]['label_b4']
+						: false;
+					// whether to apply htmlentities to answer
+					$use_desc_4_label = isset($input_types[ $field_ID ]['use_desc_4_label'])
+						? $input_types[ $field_ID ]['use_desc_4_label']
+						: false;
+					// whether input is disabled
+					$disabled = isset($input_types[ $field_ID ]['disabled']) && $input_types[ $field_ID ]['disabled'];
+
+					// create EE_Question_Form_Input object
+					$QFI = new EE_Question_Form_Input(
+						EE_Question::new_instance(
+							[
+								'QST_ID'           => 0,
+								'QST_display_text' => $field->get_nicename(),
+								'QST_type'         => $type,
+							]
+						),
+						EE_Answer::new_instance(
+							[
+								'ANS_ID'    => 0,
+								'QST_ID'    => 0,
+								'REG_ID'    => 0,
+								'ANS_value' => $value,
+							]
+						),
+						[
+							'input_id'         => $field_ID . '-' . $object->ID(),
+							'input_name'       => $input_name,
+							'input_class'      => $field_ID . $class,
+							'input_prefix'     => '',
+							'append_qstn_id'   => false,
+							'htmlentities'     => $htmlentities,
+							'label_b4'         => $label_b4,
+							'use_desc_4_label' => $use_desc_4_label,
+						]
+					);
+					// does question type have options ?
+					if (
+						in_array($type, ['DROPDOWN', 'RADIO_BTN', 'CHECKBOX'])
+						&& isset($input_types[ $field_ID ])
+						&& isset($input_types[ $field_ID ]['options'])
+					) {
+						foreach ($input_types[ $field_ID ]['options'] as $option) {
+							$option    = stripslashes_deep($option);
+							$option_id = ! empty($option['id']) ? $option['id'] : 0;
+							$QSO       = EE_Question_Option::new_instance(
+								[
+									'QSO_value'   => (string) $option_id,
+									'QSO_desc'    => $option['text'],
+									'QSO_deleted' => false,
+								]
+							);
+							// all QST (and ANS) properties can be accessed indirectly thru QFI
+							$QFI->add_temp_option($QSO);
+						}
+					}
+					// we don't want ppl manually changing primary keys cuz that would just lead to total craziness man
+					if ($disabled || $field_ID == $object->get_model()->primary_key_name()) {
+						$QFI->set('QST_disabled', true);
+					}
+					$inputs[ $field_ID ] = $QFI;
+				}
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 *    add_temp_option
+	 *
+	 * @access public
+	 * @param EE_Question_Option $QSO EE_Question_Option
+	 * @return void
+	 */
+	public function add_temp_option(EE_Question_Option $QSO)
+	{
+		$this->_QST->add_temp_option($QSO);
+	}
+
+
+	/**
+	 * set property values for question form input
+	 *
+	 * @access public
+	 * @param string $property
+	 * @param mixed  $value
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set($property = null, $value = null)
+	{
+		if (! empty($property)) {
+			if (EEM_Question::instance()->has_field($property)) {
+				$this->_QST->set($property, $value);
+			} elseif (EEM_Answer::instance()->has_field($property)) {
+				$this->_ANS->set($property, $value);
+			} elseif ($this->_question_form_input_property_exists(__CLASS__, $property)) {
+				$this->{$property} = $value;
+			}
+		}
+	}
+
+
+	/**
+	 *    _question_form_input_property_exists
+	 *
+	 * @access public
+	 * @param boolean      $notDeletedOptionsOnly            1
+	 *                                                       whether to return ALL options, or only the ones which have
+	 *                                                       not yet been deleted
+	 * @param string|array $selected_value_to_always_include , when retrieving options to an ANSWERED question,
+	 *                                                       we want to usually only show non-deleted options AND the
+	 *                                                       value that was selected for the answer, whether it was
+	 *                                                       trashed or not.
+	 * @return EE_Question_Option
+	 */
+	public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
+	{
+		$temp_options = $this->_QST->temp_options();
+		return ! empty($temp_options)
+			? $temp_options
+			: $this->_QST->options(
+				$notDeletedOptionsOnly,
+				$selected_value_to_always_include
+			);
+	}
+
+
+	/**
+	 *    get_meta
+	 *
+	 * @access public
+	 * @param mixed $key
+	 * @return mixed
+	 */
+	public function get_meta($key = false)
+	{
+		return $key && isset($this->_QST_meta[ $key ]) ? $this->_QST_meta[ $key ] : false;
+	}
 }

core/db_classes/EE_Line_Item.class.php

Spacing +14 added lines, -14 removed lines

@@ -88,7 +88,7 @@ 
     protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
     {
         parent::__construct($fieldValues, $bydb, $timezone);
-        if (! $this->get('LIN_code')) {
+        if ( ! $this->get('LIN_code')) {
             $this->set_code($this->generate_code());
         }
     }
@@ -155,7 +155,7 @@ 
     public function name()
     {
         $name = $this->get('LIN_name');
-        if (! $name) {
+        if ( ! $name) {
             $name = ucwords(str_replace('-', ' ', $this->type()));
         }
         return $name;
@@ -615,7 +615,7 @@ 
                 )
             );
         }
-        if (! is_array($this->_children)) {
+        if ( ! is_array($this->_children)) {
             $this->_children = array();
         }
         return $this->_children;
@@ -856,7 +856,7 @@ 
             }
             return $line_item->save();
         }
-        $this->_children[ $line_item->code() ] = $line_item;
+        $this->_children[$line_item->code()] = $line_item;
         if ($line_item->parent() !== $this) {
             $line_item->set_parent($this);
         }
@@ -880,7 +880,7 @@ 
     public function set_parent($line_item)
     {
         if ($this->ID()) {
-            if (! $line_item->ID()) {
+            if ( ! $line_item->ID()) {
                 $line_item->save();
             }
             $this->set_parent_ID($line_item->ID());
@@ -912,8 +912,8 @@ 
                 array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code))
             );
         }
-        return isset($this->_children[ $code ])
-            ? $this->_children[ $code ]
+        return isset($this->_children[$code])
+            ? $this->_children[$code]
             : null;
     }
 
@@ -973,8 +973,8 @@ 
             }
             return $items_deleted;
         }
-        if (isset($this->_children[ $code ])) {
-            unset($this->_children[ $code ]);
+        if (isset($this->_children[$code])) {
+            unset($this->_children[$code]);
             return 1;
         }
         return 0;
@@ -1015,7 +1015,7 @@ 
     public function generate_code()
     {
         // each line item in the cart requires a unique identifier
-        return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime());
+        return md5($this->get('OBJ_type').$this->get('OBJ_ID').microtime());
     }
 
 
@@ -1228,7 +1228,7 @@ 
         $has_children = ! empty($my_children);
         if ($has_children && $this->is_line_item()) {
             $total = $this->_recalculate_pretax_total_for_line_item($total, $my_children);
-        } elseif (! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) {
+        } elseif ( ! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) {
             $total = $this->unit_price() * $this->quantity();
         } elseif ($this->is_sub_total() || $this->is_total()) {
             $total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children);
@@ -1243,13 +1243,13 @@ 
             if ($this->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_EVENT) {
                 $this->set_quantity(1);
             }
-            if (! $this->is_percent()) {
+            if ( ! $this->is_percent()) {
                 $this->set_unit_price($total);
             }
         }
         // we don't want to bother saving grand totals, because that needs to factor in taxes anyways
         // so it ought to be
-        if (! $this->is_total()) {
+        if ( ! $this->is_total()) {
             $this->set_total($total);
             // if not a percent line item, make sure we keep the unit price in sync
             if (
@@ -1597,7 +1597,7 @@ 
     public function save_this_and_descendants_to_txn($txn_id = null)
     {
         $count = 0;
-        if (! $txn_id) {
+        if ( ! $txn_id) {
             $txn_id = $this->TXN_ID();
         }
         $this->set_TXN_ID($txn_id);

Indentation +1738 added lines, -1738 removed lines

@@ -13,1742 +13,1742 @@
  */
 class EE_Line_Item extends EE_Base_Class implements EEI_Line_Item
 {
-    /**
-     * for children line items (currently not a normal relation)
-     *
-     * @type EE_Line_Item[]
-     */
-    protected $_children = array();
-
-    /**
-     * for the parent line item
-     *
-     * @var EE_Line_Item
-     */
-    protected $_parent;
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object(
-            $props_n_values,
-            __CLASS__,
-            $timezone,
-            $date_formats
-        );
-        return $has_object
-            ? $has_object
-            : new self($props_n_values, false, $timezone);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Adds some defaults if they're not specified
-     *
-     * @param array  $fieldValues
-     * @param bool   $bydb
-     * @param string $timezone
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
-    {
-        parent::__construct($fieldValues, $bydb, $timezone);
-        if (! $this->get('LIN_code')) {
-            $this->set_code($this->generate_code());
-        }
-    }
-
-
-    /**
-     * Gets ID
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ID()
-    {
-        return $this->get('LIN_ID');
-    }
-
-
-    /**
-     * Gets TXN_ID
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * Sets TXN_ID
-     *
-     * @param int $TXN_ID
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_TXN_ID($TXN_ID)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function name()
-    {
-        $name = $this->get('LIN_name');
-        if (! $name) {
-            $name = ucwords(str_replace('-', ' ', $this->type()));
-        }
-        return $name;
-    }
-
-
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_name($name)
-    {
-        $this->set('LIN_name', $name);
-    }
-
-
-    /**
-     * Gets desc
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function desc()
-    {
-        return $this->get('LIN_desc');
-    }
-
-
-    /**
-     * Sets desc
-     *
-     * @param string $desc
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_desc($desc)
-    {
-        $this->set('LIN_desc', $desc);
-    }
-
-
-    /**
-     * Gets quantity
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function quantity()
-    {
-        return $this->get('LIN_quantity');
-    }
-
-
-    /**
-     * Sets quantity
-     *
-     * @param int $quantity
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_quantity($quantity)
-    {
-        $this->set('LIN_quantity', max($quantity, 0));
-    }
-
-
-    /**
-     * Gets item_id
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function OBJ_ID()
-    {
-        return $this->get('OBJ_ID');
-    }
-
-
-    /**
-     * Sets item_id
-     *
-     * @param string $item_id
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_OBJ_ID($item_id)
-    {
-        $this->set('OBJ_ID', $item_id);
-    }
-
-
-    /**
-     * Gets item_type
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function OBJ_type()
-    {
-        return $this->get('OBJ_type');
-    }
-
-
-    /**
-     * Gets item_type
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function OBJ_type_i18n()
-    {
-        $obj_type = $this->OBJ_type();
-        switch ($obj_type) {
-            case EEM_Line_Item::OBJ_TYPE_EVENT:
-                $obj_type = esc_html__('Event', 'event_espresso');
-                break;
-            case EEM_Line_Item::OBJ_TYPE_PRICE:
-                $obj_type = esc_html__('Price', 'event_espresso');
-                break;
-            case EEM_Line_Item::OBJ_TYPE_PROMOTION:
-                $obj_type = esc_html__('Promotion', 'event_espresso');
-                break;
-            case EEM_Line_Item::OBJ_TYPE_TICKET:
-                $obj_type = esc_html__('Ticket', 'event_espresso');
-                break;
-            case EEM_Line_Item::OBJ_TYPE_TRANSACTION:
-                $obj_type = esc_html__('Transaction', 'event_espresso');
-                break;
-        }
-        return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this);
-    }
-
-
-    /**
-     * Sets item_type
-     *
-     * @param string $OBJ_type
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_OBJ_type($OBJ_type)
-    {
-        $this->set('OBJ_type', $OBJ_type);
-    }
-
-
-    /**
-     * Gets unit_price
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function unit_price()
-    {
-        return $this->get('LIN_unit_price');
-    }
-
-
-    /**
-     * Sets unit_price
-     *
-     * @param float $unit_price
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_unit_price($unit_price)
-    {
-        $this->set('LIN_unit_price', $unit_price);
-    }
-
-
-    /**
-     * Checks if this item is a percentage modifier or not
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_percent()
-    {
-        if ($this->is_tax_sub_total()) {
-            // tax subtotals HAVE a percent on them, that percentage only applies
-            // to taxable items, so its' an exception. Treat it like a flat line item
-            return false;
-        }
-        $unit_price = abs($this->get('LIN_unit_price'));
-        $percent = abs($this->get('LIN_percent'));
-        if ($unit_price < .001 && $percent) {
-            return true;
-        }
-        if ($unit_price >= .001 && ! $percent) {
-            return false;
-        }
-        if ($unit_price >= .001 && $percent) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'A Line Item can not have a unit price of (%s) AND a percent (%s)!',
-                        'event_espresso'
-                    ),
-                    $unit_price,
-                    $percent
-                )
-            );
-        }
-        // if they're both 0, assume its not a percent item
-        return false;
-    }
-
-
-    /**
-     * Gets percent (between 100-.001)
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function percent()
-    {
-        return $this->get('LIN_percent');
-    }
-
-
-    /**
-     * Sets percent (between 100-0.01)
-     *
-     * @param float $percent
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_percent($percent)
-    {
-        $this->set('LIN_percent', $percent);
-    }
-
-
-    /**
-     * Gets total
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function total()
-    {
-        return $this->get('LIN_total');
-    }
-
-
-    /**
-     * Sets total
-     *
-     * @param float $total
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_total($total)
-    {
-        $this->set('LIN_total', $total);
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function order()
-    {
-        return $this->get('LIN_order');
-    }
-
-
-    /**
-     * Sets order
-     *
-     * @param int $order
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_order($order)
-    {
-        $this->set('LIN_order', $order);
-    }
-
-
-    /**
-     * Gets parent
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function parent_ID()
-    {
-        return $this->get('LIN_parent');
-    }
-
-
-    /**
-     * Sets parent
-     *
-     * @param int $parent
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_parent_ID($parent)
-    {
-        $this->set('LIN_parent', $parent);
-    }
-
-
-    /**
-     * Gets type
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function type()
-    {
-        return $this->get('LIN_type');
-    }
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_type($type)
-    {
-        $this->set('LIN_type', $type);
-    }
-
-
-    /**
-     * Gets the line item of which this item is a composite. Eg, if this is a subtotal, the parent might be a total\
-     * If this line item is saved to the DB, fetches the parent from the DB. However, if this line item isn't in the DB
-     * it uses its cached reference to its parent line item (which would have been set by `EE_Line_Item::set_parent()`
-     * or indirectly by `EE_Line_item::add_child_line_item()`)
-     *
-     * @return EE_Base_Class|EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function parent()
-    {
-        return $this->ID()
-            ? $this->get_model()->get_one_by_ID($this->parent_ID())
-            : $this->_parent;
-    }
-
-
-    /**
-     * Gets ALL the children of this line item (ie, all the parts that contribute towards this total).
-     *
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function children()
-    {
-        if ($this->ID()) {
-            return $this->get_model()->get_all(
-                array(
-                    array('LIN_parent' => $this->ID()),
-                    'order_by' => array('LIN_order' => 'ASC'),
-                )
-            );
-        }
-        if (! is_array($this->_children)) {
-            $this->_children = array();
-        }
-        return $this->_children;
-    }
-
-
-    /**
-     * Gets code
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function code()
-    {
-        return $this->get('LIN_code');
-    }
-
-
-    /**
-     * Sets code
-     *
-     * @param string $code
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_code($code)
-    {
-        $this->set('LIN_code', $code);
-    }
-
-
-    /**
-     * Gets is_taxable
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_taxable()
-    {
-        return $this->get('LIN_is_taxable');
-    }
-
-
-    /**
-     * Sets is_taxable
-     *
-     * @param boolean $is_taxable
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_is_taxable($is_taxable)
-    {
-        $this->set('LIN_is_taxable', $is_taxable);
-    }
-
-
-    /**
-     * Gets the object that this model-joins-to.
-     * returns one of the model objects that the field OBJ_ID can point to... see the 'OBJ_ID' field on
-     * EEM_Promotion_Object
-     *        Eg, if this line item join model object is for a ticket, this will return the EE_Ticket object
-     *
-     * @return EE_Base_Class | NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_object()
-    {
-        $model_name_of_related_obj = $this->OBJ_type();
-        return $this->get_model()->has_relation($model_name_of_related_obj)
-            ? $this->get_first_related($model_name_of_related_obj)
-            : null;
-    }
-
-
-    /**
-     * Like EE_Line_Item::get_object(), but can only ever actually return an EE_Ticket.
-     * (IE, if this line item is for a price or something else, will return NULL)
-     *
-     * @param array $query_params
-     * @return EE_Base_Class|EE_Ticket
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket($query_params = array())
-    {
-        // we're going to assume that when this method is called
-        // we always want to receive the attached ticket EVEN if that ticket is archived.
-        // This can be overridden via the incoming $query_params argument
-        $remove_defaults = array('default_where_conditions' => 'none');
-        $query_params = array_merge($remove_defaults, $query_params);
-        return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TICKET, $query_params);
-    }
-
-
-    /**
-     * Gets the EE_Datetime that's related to the ticket, IF this is for a ticket
-     *
-     * @return EE_Datetime | NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_ticket_datetime()
-    {
-        if ($this->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) {
-            $ticket = $this->ticket();
-            if ($ticket instanceof EE_Ticket) {
-                $datetime = $ticket->first_datetime();
-                if ($datetime instanceof EE_Datetime) {
-                    return $datetime;
-                }
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the event's name that's related to the ticket, if this is for
-     * a ticket
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket_event_name()
-    {
-        $event_name = esc_html__('Unknown', 'event_espresso');
-        $event = $this->ticket_event();
-        if ($event instanceof EE_Event) {
-            $event_name = $event->name();
-        }
-        return $event_name;
-    }
-
-
-    /**
-     * Gets the event that's related to the ticket, if this line item represents a ticket.
-     *
-     * @return EE_Event|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket_event()
-    {
-        $event = null;
-        $ticket = $this->ticket();
-        if ($ticket instanceof EE_Ticket) {
-            $datetime = $ticket->first_datetime();
-            if ($datetime instanceof EE_Datetime) {
-                $event = $datetime->event();
-            }
-        }
-        return $event;
-    }
-
-
-    /**
-     * Gets the first datetime for this lien item, assuming it's for a ticket
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket_datetime_start($date_format = '', $time_format = '')
-    {
-        $first_datetime_string = esc_html__('Unknown', 'event_espresso');
-        $datetime = $this->get_ticket_datetime();
-        if ($datetime) {
-            $first_datetime_string = $datetime->start_date_and_time($date_format, $time_format);
-        }
-        return $first_datetime_string;
-    }
-
-
-    /**
-     * Adds the line item as a child to this line item. If there is another child line
-     * item with the same LIN_code, it is overwritten by this new one
-     *
-     * @param EEI_Line_Item $line_item
-     * @param bool          $set_order
-     * @return bool success
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true)
-    {
-        // should we calculate the LIN_order for this line item ?
-        if ($set_order || $line_item->order() === null) {
-            $line_item->set_order(count($this->children()));
-        }
-        if ($this->ID()) {
-            // check for any duplicate line items (with the same code), if so, this replaces it
-            $line_item_with_same_code = $this->get_child_line_item($line_item->code());
-            if ($line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item) {
-                $this->delete_child_line_item($line_item_with_same_code->code());
-            }
-            $line_item->set_parent_ID($this->ID());
-            if ($this->TXN_ID()) {
-                $line_item->set_TXN_ID($this->TXN_ID());
-            }
-            return $line_item->save();
-        }
-        $this->_children[ $line_item->code() ] = $line_item;
-        if ($line_item->parent() !== $this) {
-            $line_item->set_parent($this);
-        }
-        return true;
-    }
-
-
-    /**
-     * Similar to EE_Base_Class::_add_relation_to, except this isn't a normal relation.
-     * If this line item is saved to the DB, this is just a wrapper for set_parent_ID() and save()
-     * However, if this line item is NOT saved to the DB, this just caches the parent on
-     * the EE_Line_Item::_parent property.
-     *
-     * @param EE_Line_Item $line_item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_parent($line_item)
-    {
-        if ($this->ID()) {
-            if (! $line_item->ID()) {
-                $line_item->save();
-            }
-            $this->set_parent_ID($line_item->ID());
-            $this->save();
-        } else {
-            $this->_parent = $line_item;
-            $this->set_parent_ID($line_item->ID());
-        }
-    }
-
-
-    /**
-     * Gets the child line item as specified by its code. Because this returns an object (by reference)
-     * you can modify this child line item and the parent (this object) can know about them
-     * because it also has a reference to that line item
-     *
-     * @param string $code
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_child_line_item($code)
-    {
-        if ($this->ID()) {
-            return $this->get_model()->get_one(
-                array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code))
-            );
-        }
-        return isset($this->_children[ $code ])
-            ? $this->_children[ $code ]
-            : null;
-    }
-
-
-    /**
-     * Returns how many items are deleted (or, if this item has not been saved ot the DB yet, just how many it HAD
-     * cached on it)
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function delete_children_line_items()
-    {
-        if ($this->ID()) {
-            return $this->get_model()->delete(array(array('LIN_parent' => $this->ID())));
-        }
-        $count = count($this->_children);
-        $this->_children = array();
-        return $count;
-    }
-
-
-    /**
-     * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line
-     * HAS NOT been saved to the DB, removes the child line item with index $code.
-     * Also searches through the child's children for a matching line item. However, once a line item has been found
-     * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be
-     * deleted)
-     *
-     * @param string $code
-     * @param bool   $stop_search_once_found
-     * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to
-     *             the DB yet)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function delete_child_line_item($code, $stop_search_once_found = true)
-    {
-        if ($this->ID()) {
-            $items_deleted = 0;
-            if ($this->code() === $code) {
-                $items_deleted += EEH_Line_Item::delete_all_child_items($this);
-                $items_deleted += (int) $this->delete();
-                if ($stop_search_once_found) {
-                    return $items_deleted;
-                }
-            }
-            foreach ($this->children() as $child_line_item) {
-                $items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found);
-            }
-            return $items_deleted;
-        }
-        if (isset($this->_children[ $code ])) {
-            unset($this->_children[ $code ]);
-            return 1;
-        }
-        return 0;
-    }
-
-
-    /**
-     * If this line item is in the database, is of the type subtotal, and
-     * has no children, why do we have it? It should be deleted so this function
-     * does that
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function delete_if_childless_subtotal()
-    {
-        if ($this->ID() && $this->type() === EEM_Line_Item::type_sub_total && ! $this->children()) {
-            return $this->delete();
-        }
-        return false;
-    }
-
-
-    /**
-     * Creates a code and returns a string. doesn't assign the code to this model object
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function generate_code()
-    {
-        // each line item in the cart requires a unique identifier
-        return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime());
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_tax()
-    {
-        return $this->type() === EEM_Line_Item::type_tax;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_tax_sub_total()
-    {
-        return $this->type() === EEM_Line_Item::type_tax_sub_total;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_line_item()
-    {
-        return $this->type() === EEM_Line_Item::type_line_item;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_sub_line_item()
-    {
-        return $this->type() === EEM_Line_Item::type_sub_line_item;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_sub_total()
-    {
-        return $this->type() === EEM_Line_Item::type_sub_total;
-    }
-
-
-    /**
-     * Whether or not this line item is a cancellation line item
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_cancellation()
-    {
-        return EEM_Line_Item::type_cancellation === $this->type();
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_total()
-    {
-        return $this->type() === EEM_Line_Item::type_total;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_cancelled()
-    {
-        return $this->type() === EEM_Line_Item::type_cancellation;
-    }
-
-
-    /**
-     * @return string like '2, 004.00', formatted according to the localized currency
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function unit_price_no_code()
-    {
-        return $this->get_pretty('LIN_unit_price', 'no_currency_code');
-    }
-
-
-    /**
-     * @return string like '2, 004.00', formatted according to the localized currency
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function total_no_code()
-    {
-        return $this->get_pretty('LIN_total', 'no_currency_code');
-    }
-
-
-    /**
-     * Gets the final total on this item, taking taxes into account.
-     * Has the side-effect of setting the sub-total as it was just calculated.
-     * If this is used on a grand-total line item, also updates the transaction's
-     * TXN_total (provided this line item is allowed to persist, otherwise we don't
-     * want to change a persistable transaction with info from a non-persistent line item)
-     *
-     * @param bool $update_txn_status
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function recalculate_total_including_taxes($update_txn_status = false)
-    {
-        $pre_tax_total = $this->recalculate_pre_tax_total();
-        $tax_total = $this->recalculate_taxes_and_tax_total();
-        $total = $pre_tax_total + $tax_total;
-        // no negative totals plz
-        $total = max($total, 0);
-        $this->set_total($total);
-        // only update the related transaction's total
-        // if we intend to save this line item and its a grand total
-        if (
-            $this->allow_persist() && $this->type() === EEM_Line_Item::type_total
-            && $this->transaction()
-               instanceof
-               EE_Transaction
-        ) {
-            $this->transaction()->set_total($total);
-            if ($update_txn_status) {
-                // don't save the TXN because that will be done below
-                // and the following method only saves if the status changes
-                $this->transaction()->update_status_based_on_total_paid(false);
-            }
-            if ($this->transaction()->ID()) {
-                $this->transaction()->save();
-            }
-        }
-        $this->maybe_save();
-        return $total;
-    }
-
-
-    /**
-     * Recursively goes through all the children and recalculates sub-totals EXCEPT for
-     * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its
-     * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and
-     * when this is called on the grand total
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function recalculate_pre_tax_total()
-    {
-        $total = 0;
-        $my_children = $this->children();
-        $has_children = ! empty($my_children);
-        if ($has_children && $this->is_line_item()) {
-            $total = $this->_recalculate_pretax_total_for_line_item($total, $my_children);
-        } elseif (! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) {
-            $total = $this->unit_price() * $this->quantity();
-        } elseif ($this->is_sub_total() || $this->is_total()) {
-            $total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children);
-        } elseif ($this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled()) {
-            // completely ignore tax totals, tax sub-totals, and cancelled line items, when calculating the pre-tax-total
-            return 0;
-        }
-        // ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events)
-        if (
-            ! $this->is_line_item() && ! $this->is_sub_line_item() && ! $this->is_cancellation()
-        ) {
-            if ($this->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_EVENT) {
-                $this->set_quantity(1);
-            }
-            if (! $this->is_percent()) {
-                $this->set_unit_price($total);
-            }
-        }
-        // we don't want to bother saving grand totals, because that needs to factor in taxes anyways
-        // so it ought to be
-        if (! $this->is_total()) {
-            $this->set_total($total);
-            // if not a percent line item, make sure we keep the unit price in sync
-            if (
-                $has_children
-                && $this->is_line_item()
-                && ! $this->is_percent()
-            ) {
-                if ($this->quantity() === 0) {
-                    $new_unit_price = 0;
-                } else {
-                    $new_unit_price = $this->total() / $this->quantity();
-                }
-                $this->set_unit_price($new_unit_price);
-            }
-            $this->maybe_save();
-        }
-        return $total;
-    }
-
-
-    /**
-     * Calculates the pretax total when this line item is a subtotal or total line item.
-     * Basically does a sum-then-round approach (ie, any percent line item that are children
-     * will calculate their total based on the un-rounded total we're working with so far, and
-     * THEN round the result; instead of rounding as we go like with sub-line-items)
-     *
-     * @param float          $calculated_total_so_far
-     * @param EE_Line_Item[] $my_children
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _recalculate_pretax_total_for_subtotal($calculated_total_so_far, $my_children = null)
-    {
-        if ($my_children === null) {
-            $my_children = $this->children();
-        }
-        $subtotal_quantity = 0;
-        // get the total of all its children
-        foreach ($my_children as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) {
-                // percentage line items are based on total so far
-                if ($child_line_item->is_percent()) {
-                    // round as we go so that the line items add up ok
-                    $percent_total = round(
-                        $calculated_total_so_far * $child_line_item->percent() / 100,
-                        EE_Registry::instance()->CFG->currency->dec_plc
-                    );
-                    $child_line_item->set_total($percent_total);
-                    // so far all percent line items should have a quantity of 1
-                    // (ie, no double percent discounts. Although that might be requested someday)
-                    $child_line_item->set_quantity(1);
-                    $child_line_item->maybe_save();
-                    $calculated_total_so_far += $percent_total;
-                } else {
-                    // verify flat sub-line-item quantities match their parent
-                    if ($child_line_item->is_sub_line_item()) {
-                        $child_line_item->set_quantity($this->quantity());
-                    }
-                    $calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
-                    $subtotal_quantity += $child_line_item->quantity();
-                }
-            }
-        }
-        if ($this->is_sub_total()) {
-            // no negative totals plz
-            $calculated_total_so_far = max($calculated_total_so_far, 0);
-            $subtotal_quantity = $subtotal_quantity > 0 ? 1 : 0;
-            $this->set_quantity($subtotal_quantity);
-            $this->maybe_save();
-        }
-        return $calculated_total_so_far;
-    }
-
-
-    /**
-     * Calculates the pretax total for a normal line item, in a round-then-sum approach
-     * (where each sub-line-item is applied to the base price for the line item
-     * and the result is immediately rounded, rather than summing all the sub-line-items
-     * then rounding, like we do when recalculating pretax totals on totals and subtotals).
-     *
-     * @param float          $calculated_total_so_far
-     * @param EE_Line_Item[] $my_children
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _recalculate_pretax_total_for_line_item($calculated_total_so_far, $my_children = null)
-    {
-        if ($my_children === null) {
-            $my_children = $this->children();
-        }
-        // we need to keep track of the running total for a single item,
-        // because we need to round as we go
-        $unit_price_for_total = 0;
-        $quantity_for_total = 1;
-        // get the total of all its children
-        foreach ($my_children as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) {
-                if ($child_line_item->is_percent()) {
-                    // it should be the unit-price-so-far multiplied by teh percent multiplied by the quantity
-                    // not total multiplied by percent, because that ignores rounding along-the-way
-                    $percent_unit_price = round(
-                        $unit_price_for_total * $child_line_item->percent() / 100,
-                        EE_Registry::instance()->CFG->currency->dec_plc
-                    );
-                    $percent_total = $percent_unit_price * $quantity_for_total;
-                    $child_line_item->set_total($percent_total);
-                    // so far all percent line items should have a quantity of 1
-                    // (ie, no double percent discounts. Although that might be requested someday)
-                    $child_line_item->set_quantity(1);
-                    $child_line_item->maybe_save();
-                    $calculated_total_so_far += $percent_total;
-                    $unit_price_for_total += $percent_unit_price;
-                } else {
-                    // verify flat sub-line-item quantities match their parent
-                    if ($child_line_item->is_sub_line_item()) {
-                        $child_line_item->set_quantity($this->quantity());
-                    }
-                    $quantity_for_total = $child_line_item->quantity();
-                    $calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
-                    $unit_price_for_total += $child_line_item->unit_price();
-                }
-            }
-        }
-        return $calculated_total_so_far;
-    }
-
-
-    /**
-     * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets
-     * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items
-     * and tax sub-total if already in the DB
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function recalculate_taxes_and_tax_total()
-    {
-        // get all taxes
-        $taxes = $this->tax_descendants();
-        // calculate the pretax total
-        $taxable_total = $this->taxable_total();
-        $tax_total = 0;
-        foreach ($taxes as $tax) {
-            $total_on_this_tax = $taxable_total * $tax->percent() / 100;
-            // remember the total on this line item
-            $tax->set_total($total_on_this_tax);
-            $tax->maybe_save();
-            $tax_total += $tax->total();
-        }
-        $this->_recalculate_tax_sub_total();
-        return $tax_total;
-    }
-
-
-    /**
-     * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _recalculate_tax_sub_total()
-    {
-        if ($this->is_tax_sub_total()) {
-            $total = 0;
-            $total_percent = 0;
-            // simply loop through all its children (which should be taxes) and sum their total
-            foreach ($this->children() as $child_tax) {
-                if ($child_tax instanceof EE_Line_Item) {
-                    $total += $child_tax->total();
-                    $total_percent += $child_tax->percent();
-                }
-            }
-            $this->set_total($total);
-            $this->set_percent($total_percent);
-            $this->maybe_save();
-        } elseif ($this->is_total()) {
-            foreach ($this->children() as $maybe_tax_subtotal) {
-                if ($maybe_tax_subtotal instanceof EE_Line_Item) {
-                    $maybe_tax_subtotal->_recalculate_tax_sub_total();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Gets the total tax on this line item. Assumes taxes have already been calculated using
-     * recalculate_taxes_and_total
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_total_tax()
-    {
-        $this->_recalculate_tax_sub_total();
-        $total = 0;
-        foreach ($this->tax_descendants() as $tax_line_item) {
-            if ($tax_line_item instanceof EE_Line_Item) {
-                $total += $tax_line_item->total();
-            }
-        }
-        return $total;
-    }
-
-
-    /**
-     * Gets the total for all the items purchased only
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_items_total()
-    {
-        // by default, let's make sure we're consistent with the existing line item
-        if ($this->is_total()) {
-            $pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal($this);
-            if ($pretax_subtotal_li instanceof EE_Line_Item) {
-                return $pretax_subtotal_li->total();
-            }
-        }
-        $total = 0;
-        foreach ($this->get_items() as $item) {
-            if ($item instanceof EE_Line_Item) {
-                $total += $item->total();
-            }
-        }
-        return $total;
-    }
-
-
-    /**
-     * Gets all the descendants (ie, children or children of children etc) that
-     * are of the type 'tax'
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     */
-    public function tax_descendants()
-    {
-        return EEH_Line_Item::get_tax_descendants($this);
-    }
-
-
-    /**
-     * Gets all the real items purchased which are children of this item
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     */
-    public function get_items()
-    {
-        return EEH_Line_Item::get_line_item_descendants($this);
-    }
-
-
-    /**
-     * Returns the amount taxable among this line item's children (or if it has no children,
-     * how much of it is taxable). Does not recalculate totals or subtotals.
-     * If the taxable total is negative, (eg, if none of the tickets were taxable,
-     * but there is a "Taxable" discount), returns 0.
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function taxable_total()
-    {
-        $total = 0;
-        if ($this->children()) {
-            foreach ($this->children() as $child_line_item) {
-                if ($child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) {
-                    // if it's a percent item, only take into account the percent
-                    // that's taxable too (the taxable total so far)
-                    if ($child_line_item->is_percent()) {
-                        $total += ($total * $child_line_item->percent() / 100);
-                    } else {
-                        $total += $child_line_item->total();
-                    }
-                } elseif ($child_line_item->type() === EEM_Line_Item::type_sub_total) {
-                    $total += $child_line_item->taxable_total();
-                }
-            }
-        }
-        return max($total, 0);
-    }
-
-
-    /**
-     * Gets the transaction for this line item
-     *
-     * @return EE_Base_Class|EE_Transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function transaction()
-    {
-        return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TRANSACTION);
-    }
-
-
-    /**
-     * Saves this line item to the DB, and recursively saves its descendants.
-     * Because there currently is no proper parent-child relation on the model,
-     * save_this_and_cached() will NOT save the descendants.
-     * Also sets the transaction on this line item and all its descendants before saving
-     *
-     * @param int $txn_id if none is provided, assumes $this->TXN_ID()
-     * @return int count of items saved
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function save_this_and_descendants_to_txn($txn_id = null)
-    {
-        $count = 0;
-        if (! $txn_id) {
-            $txn_id = $this->TXN_ID();
-        }
-        $this->set_TXN_ID($txn_id);
-        $children = $this->children();
-        $count += $this->save()
-            ? 1
-            : 0;
-        foreach ($children as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                $child_line_item->set_parent_ID($this->ID());
-                $count += $child_line_item->save_this_and_descendants_to_txn($txn_id);
-            }
-        }
-        return $count;
-    }
-
-
-    /**
-     * Saves this line item to the DB, and recursively saves its descendants.
-     *
-     * @return int count of items saved
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function save_this_and_descendants()
-    {
-        $count = 0;
-        $children = $this->children();
-        $count += $this->save()
-            ? 1
-            : 0;
-        foreach ($children as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                $child_line_item->set_parent_ID($this->ID());
-                $count += $child_line_item->save_this_and_descendants();
-            }
-        }
-        return $count;
-    }
-
-
-    /**
-     * returns the cancellation line item if this item was cancelled
-     *
-     * @return EE_Line_Item[]
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function get_cancellations()
-    {
-        EE_Registry::instance()->load_helper('Line_Item');
-        return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation);
-    }
-
-
-    /**
-     * If this item has an ID, then this saves it again to update the db
-     *
-     * @return int count of items saved
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function maybe_save()
-    {
-        if ($this->ID()) {
-            return $this->save();
-        }
-        return false;
-    }
-
-
-    /**
-     * clears the cached children and parent from the line item
-     *
-     * @return void
-     */
-    public function clear_related_line_item_cache()
-    {
-        $this->_children = array();
-        $this->_parent = null;
-    }
-
-
-    /**
-     * @param bool $raw
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function timestamp($raw = false)
-    {
-        return $raw
-            ? $this->get_raw('LIN_timestamp')
-            : $this->get('LIN_timestamp');
-    }
-
-
-
-
-    /************************* DEPRECATED *************************/
-    /**
-     * @deprecated 4.6.0
-     * @param string $type one of the constants on EEM_Line_Item
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     */
-    protected function _get_descendants_of_type($type)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Line_Item::_get_descendants_of_type()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::get_descendants_of_type()'
-            ),
-            '4.6.0'
-        );
-        return EEH_Line_Item::get_descendants_of_type($this, $type);
-    }
-
-
-    /**
-     * @deprecated 4.6.0
-     * @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
-     */
-    public function get_nearest_descendant_of_type($type)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Line_Item::get_nearest_descendant_of_type()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::get_nearest_descendant_of_type()'
-            ),
-            '4.6.0'
-        );
-        return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
-    }
+	/**
+	 * for children line items (currently not a normal relation)
+	 *
+	 * @type EE_Line_Item[]
+	 */
+	protected $_children = array();
+
+	/**
+	 * for the parent line item
+	 *
+	 * @var EE_Line_Item
+	 */
+	protected $_parent;
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object(
+			$props_n_values,
+			__CLASS__,
+			$timezone,
+			$date_formats
+		);
+		return $has_object
+			? $has_object
+			: new self($props_n_values, false, $timezone);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Adds some defaults if they're not specified
+	 *
+	 * @param array  $fieldValues
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
+	{
+		parent::__construct($fieldValues, $bydb, $timezone);
+		if (! $this->get('LIN_code')) {
+			$this->set_code($this->generate_code());
+		}
+	}
+
+
+	/**
+	 * Gets ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ID()
+	{
+		return $this->get('LIN_ID');
+	}
+
+
+	/**
+	 * Gets TXN_ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * Sets TXN_ID
+	 *
+	 * @param int $TXN_ID
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_TXN_ID($TXN_ID)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function name()
+	{
+		$name = $this->get('LIN_name');
+		if (! $name) {
+			$name = ucwords(str_replace('-', ' ', $this->type()));
+		}
+		return $name;
+	}
+
+
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_name($name)
+	{
+		$this->set('LIN_name', $name);
+	}
+
+
+	/**
+	 * Gets desc
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function desc()
+	{
+		return $this->get('LIN_desc');
+	}
+
+
+	/**
+	 * Sets desc
+	 *
+	 * @param string $desc
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_desc($desc)
+	{
+		$this->set('LIN_desc', $desc);
+	}
+
+
+	/**
+	 * Gets quantity
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function quantity()
+	{
+		return $this->get('LIN_quantity');
+	}
+
+
+	/**
+	 * Sets quantity
+	 *
+	 * @param int $quantity
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_quantity($quantity)
+	{
+		$this->set('LIN_quantity', max($quantity, 0));
+	}
+
+
+	/**
+	 * Gets item_id
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function OBJ_ID()
+	{
+		return $this->get('OBJ_ID');
+	}
+
+
+	/**
+	 * Sets item_id
+	 *
+	 * @param string $item_id
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_OBJ_ID($item_id)
+	{
+		$this->set('OBJ_ID', $item_id);
+	}
+
+
+	/**
+	 * Gets item_type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function OBJ_type()
+	{
+		return $this->get('OBJ_type');
+	}
+
+
+	/**
+	 * Gets item_type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function OBJ_type_i18n()
+	{
+		$obj_type = $this->OBJ_type();
+		switch ($obj_type) {
+			case EEM_Line_Item::OBJ_TYPE_EVENT:
+				$obj_type = esc_html__('Event', 'event_espresso');
+				break;
+			case EEM_Line_Item::OBJ_TYPE_PRICE:
+				$obj_type = esc_html__('Price', 'event_espresso');
+				break;
+			case EEM_Line_Item::OBJ_TYPE_PROMOTION:
+				$obj_type = esc_html__('Promotion', 'event_espresso');
+				break;
+			case EEM_Line_Item::OBJ_TYPE_TICKET:
+				$obj_type = esc_html__('Ticket', 'event_espresso');
+				break;
+			case EEM_Line_Item::OBJ_TYPE_TRANSACTION:
+				$obj_type = esc_html__('Transaction', 'event_espresso');
+				break;
+		}
+		return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this);
+	}
+
+
+	/**
+	 * Sets item_type
+	 *
+	 * @param string $OBJ_type
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_OBJ_type($OBJ_type)
+	{
+		$this->set('OBJ_type', $OBJ_type);
+	}
+
+
+	/**
+	 * Gets unit_price
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function unit_price()
+	{
+		return $this->get('LIN_unit_price');
+	}
+
+
+	/**
+	 * Sets unit_price
+	 *
+	 * @param float $unit_price
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_unit_price($unit_price)
+	{
+		$this->set('LIN_unit_price', $unit_price);
+	}
+
+
+	/**
+	 * Checks if this item is a percentage modifier or not
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_percent()
+	{
+		if ($this->is_tax_sub_total()) {
+			// tax subtotals HAVE a percent on them, that percentage only applies
+			// to taxable items, so its' an exception. Treat it like a flat line item
+			return false;
+		}
+		$unit_price = abs($this->get('LIN_unit_price'));
+		$percent = abs($this->get('LIN_percent'));
+		if ($unit_price < .001 && $percent) {
+			return true;
+		}
+		if ($unit_price >= .001 && ! $percent) {
+			return false;
+		}
+		if ($unit_price >= .001 && $percent) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'A Line Item can not have a unit price of (%s) AND a percent (%s)!',
+						'event_espresso'
+					),
+					$unit_price,
+					$percent
+				)
+			);
+		}
+		// if they're both 0, assume its not a percent item
+		return false;
+	}
+
+
+	/**
+	 * Gets percent (between 100-.001)
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function percent()
+	{
+		return $this->get('LIN_percent');
+	}
+
+
+	/**
+	 * Sets percent (between 100-0.01)
+	 *
+	 * @param float $percent
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_percent($percent)
+	{
+		$this->set('LIN_percent', $percent);
+	}
+
+
+	/**
+	 * Gets total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function total()
+	{
+		return $this->get('LIN_total');
+	}
+
+
+	/**
+	 * Sets total
+	 *
+	 * @param float $total
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_total($total)
+	{
+		$this->set('LIN_total', $total);
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function order()
+	{
+		return $this->get('LIN_order');
+	}
+
+
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_order($order)
+	{
+		$this->set('LIN_order', $order);
+	}
+
+
+	/**
+	 * Gets parent
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function parent_ID()
+	{
+		return $this->get('LIN_parent');
+	}
+
+
+	/**
+	 * Sets parent
+	 *
+	 * @param int $parent
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_parent_ID($parent)
+	{
+		$this->set('LIN_parent', $parent);
+	}
+
+
+	/**
+	 * Gets type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function type()
+	{
+		return $this->get('LIN_type');
+	}
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_type($type)
+	{
+		$this->set('LIN_type', $type);
+	}
+
+
+	/**
+	 * Gets the line item of which this item is a composite. Eg, if this is a subtotal, the parent might be a total\
+	 * If this line item is saved to the DB, fetches the parent from the DB. However, if this line item isn't in the DB
+	 * it uses its cached reference to its parent line item (which would have been set by `EE_Line_Item::set_parent()`
+	 * or indirectly by `EE_Line_item::add_child_line_item()`)
+	 *
+	 * @return EE_Base_Class|EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function parent()
+	{
+		return $this->ID()
+			? $this->get_model()->get_one_by_ID($this->parent_ID())
+			: $this->_parent;
+	}
+
+
+	/**
+	 * Gets ALL the children of this line item (ie, all the parts that contribute towards this total).
+	 *
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function children()
+	{
+		if ($this->ID()) {
+			return $this->get_model()->get_all(
+				array(
+					array('LIN_parent' => $this->ID()),
+					'order_by' => array('LIN_order' => 'ASC'),
+				)
+			);
+		}
+		if (! is_array($this->_children)) {
+			$this->_children = array();
+		}
+		return $this->_children;
+	}
+
+
+	/**
+	 * Gets code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function code()
+	{
+		return $this->get('LIN_code');
+	}
+
+
+	/**
+	 * Sets code
+	 *
+	 * @param string $code
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_code($code)
+	{
+		$this->set('LIN_code', $code);
+	}
+
+
+	/**
+	 * Gets is_taxable
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_taxable()
+	{
+		return $this->get('LIN_is_taxable');
+	}
+
+
+	/**
+	 * Sets is_taxable
+	 *
+	 * @param boolean $is_taxable
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_is_taxable($is_taxable)
+	{
+		$this->set('LIN_is_taxable', $is_taxable);
+	}
+
+
+	/**
+	 * Gets the object that this model-joins-to.
+	 * returns one of the model objects that the field OBJ_ID can point to... see the 'OBJ_ID' field on
+	 * EEM_Promotion_Object
+	 *        Eg, if this line item join model object is for a ticket, this will return the EE_Ticket object
+	 *
+	 * @return EE_Base_Class | NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_object()
+	{
+		$model_name_of_related_obj = $this->OBJ_type();
+		return $this->get_model()->has_relation($model_name_of_related_obj)
+			? $this->get_first_related($model_name_of_related_obj)
+			: null;
+	}
+
+
+	/**
+	 * Like EE_Line_Item::get_object(), but can only ever actually return an EE_Ticket.
+	 * (IE, if this line item is for a price or something else, will return NULL)
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class|EE_Ticket
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket($query_params = array())
+	{
+		// we're going to assume that when this method is called
+		// we always want to receive the attached ticket EVEN if that ticket is archived.
+		// This can be overridden via the incoming $query_params argument
+		$remove_defaults = array('default_where_conditions' => 'none');
+		$query_params = array_merge($remove_defaults, $query_params);
+		return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TICKET, $query_params);
+	}
+
+
+	/**
+	 * Gets the EE_Datetime that's related to the ticket, IF this is for a ticket
+	 *
+	 * @return EE_Datetime | NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_ticket_datetime()
+	{
+		if ($this->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) {
+			$ticket = $this->ticket();
+			if ($ticket instanceof EE_Ticket) {
+				$datetime = $ticket->first_datetime();
+				if ($datetime instanceof EE_Datetime) {
+					return $datetime;
+				}
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the event's name that's related to the ticket, if this is for
+	 * a ticket
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket_event_name()
+	{
+		$event_name = esc_html__('Unknown', 'event_espresso');
+		$event = $this->ticket_event();
+		if ($event instanceof EE_Event) {
+			$event_name = $event->name();
+		}
+		return $event_name;
+	}
+
+
+	/**
+	 * Gets the event that's related to the ticket, if this line item represents a ticket.
+	 *
+	 * @return EE_Event|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket_event()
+	{
+		$event = null;
+		$ticket = $this->ticket();
+		if ($ticket instanceof EE_Ticket) {
+			$datetime = $ticket->first_datetime();
+			if ($datetime instanceof EE_Datetime) {
+				$event = $datetime->event();
+			}
+		}
+		return $event;
+	}
+
+
+	/**
+	 * Gets the first datetime for this lien item, assuming it's for a ticket
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket_datetime_start($date_format = '', $time_format = '')
+	{
+		$first_datetime_string = esc_html__('Unknown', 'event_espresso');
+		$datetime = $this->get_ticket_datetime();
+		if ($datetime) {
+			$first_datetime_string = $datetime->start_date_and_time($date_format, $time_format);
+		}
+		return $first_datetime_string;
+	}
+
+
+	/**
+	 * Adds the line item as a child to this line item. If there is another child line
+	 * item with the same LIN_code, it is overwritten by this new one
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @param bool          $set_order
+	 * @return bool success
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true)
+	{
+		// should we calculate the LIN_order for this line item ?
+		if ($set_order || $line_item->order() === null) {
+			$line_item->set_order(count($this->children()));
+		}
+		if ($this->ID()) {
+			// check for any duplicate line items (with the same code), if so, this replaces it
+			$line_item_with_same_code = $this->get_child_line_item($line_item->code());
+			if ($line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item) {
+				$this->delete_child_line_item($line_item_with_same_code->code());
+			}
+			$line_item->set_parent_ID($this->ID());
+			if ($this->TXN_ID()) {
+				$line_item->set_TXN_ID($this->TXN_ID());
+			}
+			return $line_item->save();
+		}
+		$this->_children[ $line_item->code() ] = $line_item;
+		if ($line_item->parent() !== $this) {
+			$line_item->set_parent($this);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Similar to EE_Base_Class::_add_relation_to, except this isn't a normal relation.
+	 * If this line item is saved to the DB, this is just a wrapper for set_parent_ID() and save()
+	 * However, if this line item is NOT saved to the DB, this just caches the parent on
+	 * the EE_Line_Item::_parent property.
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_parent($line_item)
+	{
+		if ($this->ID()) {
+			if (! $line_item->ID()) {
+				$line_item->save();
+			}
+			$this->set_parent_ID($line_item->ID());
+			$this->save();
+		} else {
+			$this->_parent = $line_item;
+			$this->set_parent_ID($line_item->ID());
+		}
+	}
+
+
+	/**
+	 * Gets the child line item as specified by its code. Because this returns an object (by reference)
+	 * you can modify this child line item and the parent (this object) can know about them
+	 * because it also has a reference to that line item
+	 *
+	 * @param string $code
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_child_line_item($code)
+	{
+		if ($this->ID()) {
+			return $this->get_model()->get_one(
+				array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code))
+			);
+		}
+		return isset($this->_children[ $code ])
+			? $this->_children[ $code ]
+			: null;
+	}
+
+
+	/**
+	 * Returns how many items are deleted (or, if this item has not been saved ot the DB yet, just how many it HAD
+	 * cached on it)
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function delete_children_line_items()
+	{
+		if ($this->ID()) {
+			return $this->get_model()->delete(array(array('LIN_parent' => $this->ID())));
+		}
+		$count = count($this->_children);
+		$this->_children = array();
+		return $count;
+	}
+
+
+	/**
+	 * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line
+	 * HAS NOT been saved to the DB, removes the child line item with index $code.
+	 * Also searches through the child's children for a matching line item. However, once a line item has been found
+	 * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be
+	 * deleted)
+	 *
+	 * @param string $code
+	 * @param bool   $stop_search_once_found
+	 * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to
+	 *             the DB yet)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function delete_child_line_item($code, $stop_search_once_found = true)
+	{
+		if ($this->ID()) {
+			$items_deleted = 0;
+			if ($this->code() === $code) {
+				$items_deleted += EEH_Line_Item::delete_all_child_items($this);
+				$items_deleted += (int) $this->delete();
+				if ($stop_search_once_found) {
+					return $items_deleted;
+				}
+			}
+			foreach ($this->children() as $child_line_item) {
+				$items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found);
+			}
+			return $items_deleted;
+		}
+		if (isset($this->_children[ $code ])) {
+			unset($this->_children[ $code ]);
+			return 1;
+		}
+		return 0;
+	}
+
+
+	/**
+	 * If this line item is in the database, is of the type subtotal, and
+	 * has no children, why do we have it? It should be deleted so this function
+	 * does that
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function delete_if_childless_subtotal()
+	{
+		if ($this->ID() && $this->type() === EEM_Line_Item::type_sub_total && ! $this->children()) {
+			return $this->delete();
+		}
+		return false;
+	}
+
+
+	/**
+	 * Creates a code and returns a string. doesn't assign the code to this model object
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function generate_code()
+	{
+		// each line item in the cart requires a unique identifier
+		return md5($this->get('OBJ_type') . $this->get('OBJ_ID') . microtime());
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_tax()
+	{
+		return $this->type() === EEM_Line_Item::type_tax;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_tax_sub_total()
+	{
+		return $this->type() === EEM_Line_Item::type_tax_sub_total;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_line_item()
+	{
+		return $this->type() === EEM_Line_Item::type_line_item;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_sub_line_item()
+	{
+		return $this->type() === EEM_Line_Item::type_sub_line_item;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_sub_total()
+	{
+		return $this->type() === EEM_Line_Item::type_sub_total;
+	}
+
+
+	/**
+	 * Whether or not this line item is a cancellation line item
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_cancellation()
+	{
+		return EEM_Line_Item::type_cancellation === $this->type();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_total()
+	{
+		return $this->type() === EEM_Line_Item::type_total;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_cancelled()
+	{
+		return $this->type() === EEM_Line_Item::type_cancellation;
+	}
+
+
+	/**
+	 * @return string like '2, 004.00', formatted according to the localized currency
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function unit_price_no_code()
+	{
+		return $this->get_pretty('LIN_unit_price', 'no_currency_code');
+	}
+
+
+	/**
+	 * @return string like '2, 004.00', formatted according to the localized currency
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function total_no_code()
+	{
+		return $this->get_pretty('LIN_total', 'no_currency_code');
+	}
+
+
+	/**
+	 * Gets the final total on this item, taking taxes into account.
+	 * Has the side-effect of setting the sub-total as it was just calculated.
+	 * If this is used on a grand-total line item, also updates the transaction's
+	 * TXN_total (provided this line item is allowed to persist, otherwise we don't
+	 * want to change a persistable transaction with info from a non-persistent line item)
+	 *
+	 * @param bool $update_txn_status
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function recalculate_total_including_taxes($update_txn_status = false)
+	{
+		$pre_tax_total = $this->recalculate_pre_tax_total();
+		$tax_total = $this->recalculate_taxes_and_tax_total();
+		$total = $pre_tax_total + $tax_total;
+		// no negative totals plz
+		$total = max($total, 0);
+		$this->set_total($total);
+		// only update the related transaction's total
+		// if we intend to save this line item and its a grand total
+		if (
+			$this->allow_persist() && $this->type() === EEM_Line_Item::type_total
+			&& $this->transaction()
+			   instanceof
+			   EE_Transaction
+		) {
+			$this->transaction()->set_total($total);
+			if ($update_txn_status) {
+				// don't save the TXN because that will be done below
+				// and the following method only saves if the status changes
+				$this->transaction()->update_status_based_on_total_paid(false);
+			}
+			if ($this->transaction()->ID()) {
+				$this->transaction()->save();
+			}
+		}
+		$this->maybe_save();
+		return $total;
+	}
+
+
+	/**
+	 * Recursively goes through all the children and recalculates sub-totals EXCEPT for
+	 * tax-sub-totals (they're a an odd beast). Updates the 'total' on each line item according to either its
+	 * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and
+	 * when this is called on the grand total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function recalculate_pre_tax_total()
+	{
+		$total = 0;
+		$my_children = $this->children();
+		$has_children = ! empty($my_children);
+		if ($has_children && $this->is_line_item()) {
+			$total = $this->_recalculate_pretax_total_for_line_item($total, $my_children);
+		} elseif (! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) {
+			$total = $this->unit_price() * $this->quantity();
+		} elseif ($this->is_sub_total() || $this->is_total()) {
+			$total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children);
+		} elseif ($this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled()) {
+			// completely ignore tax totals, tax sub-totals, and cancelled line items, when calculating the pre-tax-total
+			return 0;
+		}
+		// ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events)
+		if (
+			! $this->is_line_item() && ! $this->is_sub_line_item() && ! $this->is_cancellation()
+		) {
+			if ($this->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_EVENT) {
+				$this->set_quantity(1);
+			}
+			if (! $this->is_percent()) {
+				$this->set_unit_price($total);
+			}
+		}
+		// we don't want to bother saving grand totals, because that needs to factor in taxes anyways
+		// so it ought to be
+		if (! $this->is_total()) {
+			$this->set_total($total);
+			// if not a percent line item, make sure we keep the unit price in sync
+			if (
+				$has_children
+				&& $this->is_line_item()
+				&& ! $this->is_percent()
+			) {
+				if ($this->quantity() === 0) {
+					$new_unit_price = 0;
+				} else {
+					$new_unit_price = $this->total() / $this->quantity();
+				}
+				$this->set_unit_price($new_unit_price);
+			}
+			$this->maybe_save();
+		}
+		return $total;
+	}
+
+
+	/**
+	 * Calculates the pretax total when this line item is a subtotal or total line item.
+	 * Basically does a sum-then-round approach (ie, any percent line item that are children
+	 * will calculate their total based on the un-rounded total we're working with so far, and
+	 * THEN round the result; instead of rounding as we go like with sub-line-items)
+	 *
+	 * @param float          $calculated_total_so_far
+	 * @param EE_Line_Item[] $my_children
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _recalculate_pretax_total_for_subtotal($calculated_total_so_far, $my_children = null)
+	{
+		if ($my_children === null) {
+			$my_children = $this->children();
+		}
+		$subtotal_quantity = 0;
+		// get the total of all its children
+		foreach ($my_children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) {
+				// percentage line items are based on total so far
+				if ($child_line_item->is_percent()) {
+					// round as we go so that the line items add up ok
+					$percent_total = round(
+						$calculated_total_so_far * $child_line_item->percent() / 100,
+						EE_Registry::instance()->CFG->currency->dec_plc
+					);
+					$child_line_item->set_total($percent_total);
+					// so far all percent line items should have a quantity of 1
+					// (ie, no double percent discounts. Although that might be requested someday)
+					$child_line_item->set_quantity(1);
+					$child_line_item->maybe_save();
+					$calculated_total_so_far += $percent_total;
+				} else {
+					// verify flat sub-line-item quantities match their parent
+					if ($child_line_item->is_sub_line_item()) {
+						$child_line_item->set_quantity($this->quantity());
+					}
+					$calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
+					$subtotal_quantity += $child_line_item->quantity();
+				}
+			}
+		}
+		if ($this->is_sub_total()) {
+			// no negative totals plz
+			$calculated_total_so_far = max($calculated_total_so_far, 0);
+			$subtotal_quantity = $subtotal_quantity > 0 ? 1 : 0;
+			$this->set_quantity($subtotal_quantity);
+			$this->maybe_save();
+		}
+		return $calculated_total_so_far;
+	}
+
+
+	/**
+	 * Calculates the pretax total for a normal line item, in a round-then-sum approach
+	 * (where each sub-line-item is applied to the base price for the line item
+	 * and the result is immediately rounded, rather than summing all the sub-line-items
+	 * then rounding, like we do when recalculating pretax totals on totals and subtotals).
+	 *
+	 * @param float          $calculated_total_so_far
+	 * @param EE_Line_Item[] $my_children
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _recalculate_pretax_total_for_line_item($calculated_total_so_far, $my_children = null)
+	{
+		if ($my_children === null) {
+			$my_children = $this->children();
+		}
+		// we need to keep track of the running total for a single item,
+		// because we need to round as we go
+		$unit_price_for_total = 0;
+		$quantity_for_total = 1;
+		// get the total of all its children
+		foreach ($my_children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) {
+				if ($child_line_item->is_percent()) {
+					// it should be the unit-price-so-far multiplied by teh percent multiplied by the quantity
+					// not total multiplied by percent, because that ignores rounding along-the-way
+					$percent_unit_price = round(
+						$unit_price_for_total * $child_line_item->percent() / 100,
+						EE_Registry::instance()->CFG->currency->dec_plc
+					);
+					$percent_total = $percent_unit_price * $quantity_for_total;
+					$child_line_item->set_total($percent_total);
+					// so far all percent line items should have a quantity of 1
+					// (ie, no double percent discounts. Although that might be requested someday)
+					$child_line_item->set_quantity(1);
+					$child_line_item->maybe_save();
+					$calculated_total_so_far += $percent_total;
+					$unit_price_for_total += $percent_unit_price;
+				} else {
+					// verify flat sub-line-item quantities match their parent
+					if ($child_line_item->is_sub_line_item()) {
+						$child_line_item->set_quantity($this->quantity());
+					}
+					$quantity_for_total = $child_line_item->quantity();
+					$calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
+					$unit_price_for_total += $child_line_item->unit_price();
+				}
+			}
+		}
+		return $calculated_total_so_far;
+	}
+
+
+	/**
+	 * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets
+	 * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items
+	 * and tax sub-total if already in the DB
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function recalculate_taxes_and_tax_total()
+	{
+		// get all taxes
+		$taxes = $this->tax_descendants();
+		// calculate the pretax total
+		$taxable_total = $this->taxable_total();
+		$tax_total = 0;
+		foreach ($taxes as $tax) {
+			$total_on_this_tax = $taxable_total * $tax->percent() / 100;
+			// remember the total on this line item
+			$tax->set_total($total_on_this_tax);
+			$tax->maybe_save();
+			$tax_total += $tax->total();
+		}
+		$this->_recalculate_tax_sub_total();
+		return $tax_total;
+	}
+
+
+	/**
+	 * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _recalculate_tax_sub_total()
+	{
+		if ($this->is_tax_sub_total()) {
+			$total = 0;
+			$total_percent = 0;
+			// simply loop through all its children (which should be taxes) and sum their total
+			foreach ($this->children() as $child_tax) {
+				if ($child_tax instanceof EE_Line_Item) {
+					$total += $child_tax->total();
+					$total_percent += $child_tax->percent();
+				}
+			}
+			$this->set_total($total);
+			$this->set_percent($total_percent);
+			$this->maybe_save();
+		} elseif ($this->is_total()) {
+			foreach ($this->children() as $maybe_tax_subtotal) {
+				if ($maybe_tax_subtotal instanceof EE_Line_Item) {
+					$maybe_tax_subtotal->_recalculate_tax_sub_total();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Gets the total tax on this line item. Assumes taxes have already been calculated using
+	 * recalculate_taxes_and_total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_total_tax()
+	{
+		$this->_recalculate_tax_sub_total();
+		$total = 0;
+		foreach ($this->tax_descendants() as $tax_line_item) {
+			if ($tax_line_item instanceof EE_Line_Item) {
+				$total += $tax_line_item->total();
+			}
+		}
+		return $total;
+	}
+
+
+	/**
+	 * Gets the total for all the items purchased only
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_items_total()
+	{
+		// by default, let's make sure we're consistent with the existing line item
+		if ($this->is_total()) {
+			$pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal($this);
+			if ($pretax_subtotal_li instanceof EE_Line_Item) {
+				return $pretax_subtotal_li->total();
+			}
+		}
+		$total = 0;
+		foreach ($this->get_items() as $item) {
+			if ($item instanceof EE_Line_Item) {
+				$total += $item->total();
+			}
+		}
+		return $total;
+	}
+
+
+	/**
+	 * Gets all the descendants (ie, children or children of children etc) that
+	 * are of the type 'tax'
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 */
+	public function tax_descendants()
+	{
+		return EEH_Line_Item::get_tax_descendants($this);
+	}
+
+
+	/**
+	 * Gets all the real items purchased which are children of this item
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 */
+	public function get_items()
+	{
+		return EEH_Line_Item::get_line_item_descendants($this);
+	}
+
+
+	/**
+	 * Returns the amount taxable among this line item's children (or if it has no children,
+	 * how much of it is taxable). Does not recalculate totals or subtotals.
+	 * If the taxable total is negative, (eg, if none of the tickets were taxable,
+	 * but there is a "Taxable" discount), returns 0.
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function taxable_total()
+	{
+		$total = 0;
+		if ($this->children()) {
+			foreach ($this->children() as $child_line_item) {
+				if ($child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) {
+					// if it's a percent item, only take into account the percent
+					// that's taxable too (the taxable total so far)
+					if ($child_line_item->is_percent()) {
+						$total += ($total * $child_line_item->percent() / 100);
+					} else {
+						$total += $child_line_item->total();
+					}
+				} elseif ($child_line_item->type() === EEM_Line_Item::type_sub_total) {
+					$total += $child_line_item->taxable_total();
+				}
+			}
+		}
+		return max($total, 0);
+	}
+
+
+	/**
+	 * Gets the transaction for this line item
+	 *
+	 * @return EE_Base_Class|EE_Transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function transaction()
+	{
+		return $this->get_first_related(EEM_Line_Item::OBJ_TYPE_TRANSACTION);
+	}
+
+
+	/**
+	 * Saves this line item to the DB, and recursively saves its descendants.
+	 * Because there currently is no proper parent-child relation on the model,
+	 * save_this_and_cached() will NOT save the descendants.
+	 * Also sets the transaction on this line item and all its descendants before saving
+	 *
+	 * @param int $txn_id if none is provided, assumes $this->TXN_ID()
+	 * @return int count of items saved
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function save_this_and_descendants_to_txn($txn_id = null)
+	{
+		$count = 0;
+		if (! $txn_id) {
+			$txn_id = $this->TXN_ID();
+		}
+		$this->set_TXN_ID($txn_id);
+		$children = $this->children();
+		$count += $this->save()
+			? 1
+			: 0;
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
+				$count += $child_line_item->save_this_and_descendants_to_txn($txn_id);
+			}
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Saves this line item to the DB, and recursively saves its descendants.
+	 *
+	 * @return int count of items saved
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function save_this_and_descendants()
+	{
+		$count = 0;
+		$children = $this->children();
+		$count += $this->save()
+			? 1
+			: 0;
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
+				$count += $child_line_item->save_this_and_descendants();
+			}
+		}
+		return $count;
+	}
+
+
+	/**
+	 * returns the cancellation line item if this item was cancelled
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function get_cancellations()
+	{
+		EE_Registry::instance()->load_helper('Line_Item');
+		return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation);
+	}
+
+
+	/**
+	 * If this item has an ID, then this saves it again to update the db
+	 *
+	 * @return int count of items saved
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function maybe_save()
+	{
+		if ($this->ID()) {
+			return $this->save();
+		}
+		return false;
+	}
+
+
+	/**
+	 * clears the cached children and parent from the line item
+	 *
+	 * @return void
+	 */
+	public function clear_related_line_item_cache()
+	{
+		$this->_children = array();
+		$this->_parent = null;
+	}
+
+
+	/**
+	 * @param bool $raw
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function timestamp($raw = false)
+	{
+		return $raw
+			? $this->get_raw('LIN_timestamp')
+			: $this->get('LIN_timestamp');
+	}
+
+
+
+
+	/************************* DEPRECATED *************************/
+	/**
+	 * @deprecated 4.6.0
+	 * @param string $type one of the constants on EEM_Line_Item
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 */
+	protected function _get_descendants_of_type($type)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Line_Item::_get_descendants_of_type()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::get_descendants_of_type()'
+			),
+			'4.6.0'
+		);
+		return EEH_Line_Item::get_descendants_of_type($this, $type);
+	}
+
+
+	/**
+	 * @deprecated 4.6.0
+	 * @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
+	 */
+	public function get_nearest_descendant_of_type($type)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Line_Item::get_nearest_descendant_of_type()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::get_nearest_descendant_of_type()'
+			),
+			'4.6.0'
+		);
+		return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
+	}
 }

core/domain/entities/editor/blocks/EventAttendees.php

Spacing +6 added lines, -6 removed lines

@@ -154,19 +154,19 @@
         $sanitized_attributes = array();
         foreach ($attributes as $attribute => $value) {
             $convert = $this->getAttributesMap();
-            if (isset($convert[ $attribute ])) {
-                $sanitize = $convert[ $attribute ];
+            if (isset($convert[$attribute])) {
+                $sanitize = $convert[$attribute];
                 if ($sanitize === 'bool') {
-                    $sanitized_attributes[ $attribute ] = filter_var(
+                    $sanitized_attributes[$attribute] = filter_var(
                         $value,
                         FILTER_VALIDATE_BOOLEAN
                     );
                 } else {
-                    $sanitized_attributes[ $attribute ] = $sanitize($value);
+                    $sanitized_attributes[$attribute] = $sanitize($value);
                 }
                 // don't pass along attributes with a 0 value
-                if ($sanitized_attributes[ $attribute ] === 0) {
-                    unset($sanitized_attributes[ $attribute ]);
+                if ($sanitized_attributes[$attribute] === 0) {
+                    unset($sanitized_attributes[$attribute]);
                 }
             }
         }

Indentation +157 added lines, -157 removed lines

@@ -20,172 +20,172 @@
  */
 class EventAttendees extends Block
 {
-    const BLOCK_TYPE = 'event-attendees';
+	const BLOCK_TYPE = 'event-attendees';
 
-    /**
-     * @var EventAttendeesBlockRenderer $renderer
-     */
-    protected $renderer;
+	/**
+	 * @var EventAttendeesBlockRenderer $renderer
+	 */
+	protected $renderer;
 
 
-    /**
-     * EventAttendees constructor.
-     *
-     * @param CoreBlocksAssetManager      $block_asset_manager
-     * @param RequestInterface            $request
-     * @param EventAttendeesBlockRenderer $renderer
-     */
-    public function __construct(
-        CoreBlocksAssetManager $block_asset_manager,
-        RequestInterface $request,
-        EventAttendeesBlockRenderer $renderer
-    ) {
-        parent::__construct($block_asset_manager, $request);
-        $this->renderer = $renderer;
-    }
+	/**
+	 * EventAttendees constructor.
+	 *
+	 * @param CoreBlocksAssetManager      $block_asset_manager
+	 * @param RequestInterface            $request
+	 * @param EventAttendeesBlockRenderer $renderer
+	 */
+	public function __construct(
+		CoreBlocksAssetManager $block_asset_manager,
+		RequestInterface $request,
+		EventAttendeesBlockRenderer $renderer
+	) {
+		parent::__construct($block_asset_manager, $request);
+		$this->renderer = $renderer;
+	}
 
 
-    /**
-     * Perform any early setup required by the block
-     * including setting the block type and supported post types
-     *
-     * @return void
-     */
-    public function initialize()
-    {
-        $this->setBlockType(self::BLOCK_TYPE);
-        $this->setSupportedRoutes(
-            array(
-                'EventEspresso\core\domain\entities\route_match\specifications\admin\EspressoStandardPostTypeEditor',
-                'EventEspresso\core\domain\entities\route_match\specifications\admin\WordPressPostTypeEditor',
-                'EventEspresso\core\domain\entities\route_match\specifications\frontend\EspressoBlockRenderer',
-                'EventEspresso\core\domain\entities\route_match\specifications\frontend\AnyFrontendRequest'
-            )
-        );
-        $EVT_ID = $this->request->getRequestParam('page') === 'espresso_events'
-            ? $this->request->getRequestParam('post', 0, 'int')
-            : 0;
-        $this->setAttributes(
-            array(
-                'eventId'           => array(
-                    'type'    => 'number',
-                    'default' => $EVT_ID,
-                ),
-                'datetimeId'        => array(
-                    'type'    => 'number',
-                    'default' => 0,
-                ),
-                'ticketId'          => array(
-                    'type'    => 'number',
-                    'default' => 0,
-                ),
-                'status'            => array(
-                    'type'    => 'string',
-                    'default' => EEM_Registration::status_id_approved,
-                ),
-                'limit'             => array(
-                    'type'    => 'number',
-                    'default' => 100,
-                ),
-                'order' => array(
-                    'type' => 'string',
-                    'default' => 'ASC'
-                ),
-                'orderBy' => array(
-                    'type' => 'string',
-                    'default' => 'lastThenFirstName',
-                ),
-                'showGravatar'      => array(
-                    'type'    => 'boolean',
-                    'default' => false,
-                ),
-                'avatarClass' => array(
-                    'type' => 'string',
-                    'default' => 'contact',
-                ),
-                'avatarSize' => array(
-                    'type' => 'number',
-                    'default' => 24,
-                ),
-                'displayOnArchives' => array(
-                    'type'    => 'boolean',
-                    'default' => false,
-                ),
-            )
-        );
-        $this->setDynamic();
-    }
+	/**
+	 * Perform any early setup required by the block
+	 * including setting the block type and supported post types
+	 *
+	 * @return void
+	 */
+	public function initialize()
+	{
+		$this->setBlockType(self::BLOCK_TYPE);
+		$this->setSupportedRoutes(
+			array(
+				'EventEspresso\core\domain\entities\route_match\specifications\admin\EspressoStandardPostTypeEditor',
+				'EventEspresso\core\domain\entities\route_match\specifications\admin\WordPressPostTypeEditor',
+				'EventEspresso\core\domain\entities\route_match\specifications\frontend\EspressoBlockRenderer',
+				'EventEspresso\core\domain\entities\route_match\specifications\frontend\AnyFrontendRequest'
+			)
+		);
+		$EVT_ID = $this->request->getRequestParam('page') === 'espresso_events'
+			? $this->request->getRequestParam('post', 0, 'int')
+			: 0;
+		$this->setAttributes(
+			array(
+				'eventId'           => array(
+					'type'    => 'number',
+					'default' => $EVT_ID,
+				),
+				'datetimeId'        => array(
+					'type'    => 'number',
+					'default' => 0,
+				),
+				'ticketId'          => array(
+					'type'    => 'number',
+					'default' => 0,
+				),
+				'status'            => array(
+					'type'    => 'string',
+					'default' => EEM_Registration::status_id_approved,
+				),
+				'limit'             => array(
+					'type'    => 'number',
+					'default' => 100,
+				),
+				'order' => array(
+					'type' => 'string',
+					'default' => 'ASC'
+				),
+				'orderBy' => array(
+					'type' => 'string',
+					'default' => 'lastThenFirstName',
+				),
+				'showGravatar'      => array(
+					'type'    => 'boolean',
+					'default' => false,
+				),
+				'avatarClass' => array(
+					'type' => 'string',
+					'default' => 'contact',
+				),
+				'avatarSize' => array(
+					'type' => 'number',
+					'default' => 24,
+				),
+				'displayOnArchives' => array(
+					'type'    => 'boolean',
+					'default' => false,
+				),
+			)
+		);
+		$this->setDynamic();
+	}
 
 
-    /**
-     * Returns an array where the key corresponds to the incoming attribute name from the WP block
-     * and the value corresponds to the attribute name for the existing EspressoEventAttendees shortcode
-     *
-     * @since 4.9.71.p
-     * @return array
-     */
-    private function getAttributesMap()
-    {
-        return array(
-            'eventId'           => 'absint',
-            'datetimeId'        => 'absint',
-            'ticketId'          => 'absint',
-            'status'            => 'sanitize_text_field',
-            'limit'             => 'intval',
-            'showGravatar'      => 'bool',
-            'avatarClass'       => 'sanitize_text_field',
-            'avatarSize'        => 'absint',
-            'displayOnArchives' => 'bool',
-            'order' => 'sanitize_text_field',
-            'orderBy' => 'sanitize_text_field',
-        );
-    }
+	/**
+	 * Returns an array where the key corresponds to the incoming attribute name from the WP block
+	 * and the value corresponds to the attribute name for the existing EspressoEventAttendees shortcode
+	 *
+	 * @since 4.9.71.p
+	 * @return array
+	 */
+	private function getAttributesMap()
+	{
+		return array(
+			'eventId'           => 'absint',
+			'datetimeId'        => 'absint',
+			'ticketId'          => 'absint',
+			'status'            => 'sanitize_text_field',
+			'limit'             => 'intval',
+			'showGravatar'      => 'bool',
+			'avatarClass'       => 'sanitize_text_field',
+			'avatarSize'        => 'absint',
+			'displayOnArchives' => 'bool',
+			'order' => 'sanitize_text_field',
+			'orderBy' => 'sanitize_text_field',
+		);
+	}
 
 
-    /**
-     * Sanitizes attributes.
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function sanitizeAttributes(array $attributes)
-    {
-        $sanitized_attributes = array();
-        foreach ($attributes as $attribute => $value) {
-            $convert = $this->getAttributesMap();
-            if (isset($convert[ $attribute ])) {
-                $sanitize = $convert[ $attribute ];
-                if ($sanitize === 'bool') {
-                    $sanitized_attributes[ $attribute ] = filter_var(
-                        $value,
-                        FILTER_VALIDATE_BOOLEAN
-                    );
-                } else {
-                    $sanitized_attributes[ $attribute ] = $sanitize($value);
-                }
-                // don't pass along attributes with a 0 value
-                if ($sanitized_attributes[ $attribute ] === 0) {
-                    unset($sanitized_attributes[ $attribute ]);
-                }
-            }
-        }
-        return $attributes;
-    }
+	/**
+	 * Sanitizes attributes.
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function sanitizeAttributes(array $attributes)
+	{
+		$sanitized_attributes = array();
+		foreach ($attributes as $attribute => $value) {
+			$convert = $this->getAttributesMap();
+			if (isset($convert[ $attribute ])) {
+				$sanitize = $convert[ $attribute ];
+				if ($sanitize === 'bool') {
+					$sanitized_attributes[ $attribute ] = filter_var(
+						$value,
+						FILTER_VALIDATE_BOOLEAN
+					);
+				} else {
+					$sanitized_attributes[ $attribute ] = $sanitize($value);
+				}
+				// don't pass along attributes with a 0 value
+				if ($sanitized_attributes[ $attribute ] === 0) {
+					unset($sanitized_attributes[ $attribute ]);
+				}
+			}
+		}
+		return $attributes;
+	}
 
 
-    /**
-     * Returns the rendered HTML for the block
-     *
-     * @param array $attributes
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function renderBlock(array $attributes = array())
-    {
-        $attributes = $this->sanitizeAttributes($attributes);
-        return (is_archive() || is_front_page() || is_home()) && ! $attributes['displayOnArchives']
-            ? ''
-            : $this->renderer->render($attributes);
-    }
+	/**
+	 * Returns the rendered HTML for the block
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function renderBlock(array $attributes = array())
+	{
+		$attributes = $this->sanitizeAttributes($attributes);
+		return (is_archive() || is_front_page() || is_home()) && ! $attributes['displayOnArchives']
+			? ''
+			: $this->renderer->render($attributes);
+	}
 }

core/db_models/strategies/EE_Restriction_Generator_Default_Protected.strategy.php

Indentation +75 added lines, -75 removed lines

@@ -17,85 +17,85 @@
  */
 class EE_Restriction_Generator_Default_Protected extends EE_Restriction_Generator_Base
 {
-    /**
-     * Name of the field on this model (or a related model, including the model chain to it)
-     * that is a boolean indicating whether or not a model object is considered "Default" or not
-     * @var string
-     */
-    protected $_default_field_name;
+	/**
+	 * Name of the field on this model (or a related model, including the model chain to it)
+	 * that is a boolean indicating whether or not a model object is considered "Default" or not
+	 * @var string
+	 */
+	protected $_default_field_name;
 
-    /**
-     * The model chain to follow to get to the event model, including the event model itself.
-     * Eg 'Ticket.Datetime.Event'
-     * @var string
-     */
-    protected $_path_to_event_model;
-    /**
-     *
-     * @param string $default_field_name the name of the field Name of the field on this model (or a related model, including the model chain to it)
-     * that is a boolean indicating whether or not a model object is considered "Default" or not
-     * @param string $path_to_event_model The model chain to follow to get to the event model, including the event model itself.
-     * Eg 'Ticket.Datetime.Event'
-     */
-    public function __construct($default_field_name, $path_to_event_model)
-    {
-        $this->_default_field_name = $default_field_name;
-        if (substr($path_to_event_model, -1, 1) != '.') {
-            $path_to_event_model .= '.';
-        }
-        $this->_path_to_event_model = $path_to_event_model;
-    }
+	/**
+	 * The model chain to follow to get to the event model, including the event model itself.
+	 * Eg 'Ticket.Datetime.Event'
+	 * @var string
+	 */
+	protected $_path_to_event_model;
+	/**
+	 *
+	 * @param string $default_field_name the name of the field Name of the field on this model (or a related model, including the model chain to it)
+	 * that is a boolean indicating whether or not a model object is considered "Default" or not
+	 * @param string $path_to_event_model The model chain to follow to get to the event model, including the event model itself.
+	 * Eg 'Ticket.Datetime.Event'
+	 */
+	public function __construct($default_field_name, $path_to_event_model)
+	{
+		$this->_default_field_name = $default_field_name;
+		if (substr($path_to_event_model, -1, 1) != '.') {
+			$path_to_event_model .= '.';
+		}
+		$this->_path_to_event_model = $path_to_event_model;
+	}
 
 
 
-    /**
-     *
-     * @return \EE_Default_Where_Conditions
-     */
-    protected function _generate_restrictions()
-    {
-        // if there are no standard caps for this model, then for now all we know is
-        // if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
-            return array(
-                self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions()
-            );
-        }
+	/**
+	 *
+	 * @return \EE_Default_Where_Conditions
+	 */
+	protected function _generate_restrictions()
+	{
+		// if there are no standard caps for this model, then for now all we know is
+		// if they need the default cap to access this
+		if (! $this->model()->cap_slug()) {
+			return array(
+				self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions()
+			);
+		}
 
-        $event_model = EEM_Event::instance();
+		$event_model = EEM_Event::instance();
 
-        $restrictions =  array(
-            // first: basically access to non-defaults is essentially controlled by which events are accessible
-            // if they don't have the basic event cap, they can't access ANY non-default items
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action()) => new EE_Default_Where_Conditions(array( $this->_default_field_name => true )),
-            // if they don't have the others event cap, they can't access others' non-default items
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => new EE_Default_Where_Conditions(array(
-                'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => array(
-                    $this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder ),
-                    $this->_default_field_name => true )),
-            // if they have basic and others, but not private, they can't access others' private non-default items
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => new EE_Default_Where_Conditions(array(
-                'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => array(
-                $this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
-                $this->_path_to_event_model . 'status' => array( '!=', 'private' ),
-                $this->_default_field_name => true ) )),
-            // second: access to defaults is controlled by the defaulty capabilities
-            // if they don't have the default capability, restrict access to only non-default items
-            EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_default') => new EE_Default_Where_Conditions(array( $this->_default_field_name => false )),
-            // if they don't have the "others" default capability, restrict access to only their default ones, and non-default ones
-             );
-        if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action() . '_others_default')) {
-            $restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others_default') ] = new EE_Default_Where_Conditions(array(
-                    // if they don't have the others default cap, they can't access others default items (but they can access
-                    // their own default items, and non-default items)
-                    'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others_default') => array(
-                        'AND' => array(
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
-                            $this->_default_field_name => true
-                            ),
-                        $this->_default_field_name => false
-                    ) ));
-        }
-        return $restrictions;
-    }
+		$restrictions =  array(
+			// first: basically access to non-defaults is essentially controlled by which events are accessible
+			// if they don't have the basic event cap, they can't access ANY non-default items
+			EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action()) => new EE_Default_Where_Conditions(array( $this->_default_field_name => true )),
+			// if they don't have the others event cap, they can't access others' non-default items
+			EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => new EE_Default_Where_Conditions(array(
+				'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => array(
+					$this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder ),
+					$this->_default_field_name => true )),
+			// if they have basic and others, but not private, they can't access others' private non-default items
+			EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => new EE_Default_Where_Conditions(array(
+				'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => array(
+				$this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
+				$this->_path_to_event_model . 'status' => array( '!=', 'private' ),
+				$this->_default_field_name => true ) )),
+			// second: access to defaults is controlled by the defaulty capabilities
+			// if they don't have the default capability, restrict access to only non-default items
+			EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_default') => new EE_Default_Where_Conditions(array( $this->_default_field_name => false )),
+			// if they don't have the "others" default capability, restrict access to only their default ones, and non-default ones
+			 );
+		if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action() . '_others_default')) {
+			$restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others_default') ] = new EE_Default_Where_Conditions(array(
+					// if they don't have the others default cap, they can't access others default items (but they can access
+					// their own default items, and non-default items)
+					'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others_default') => array(
+						'AND' => array(
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
+							$this->_default_field_name => true
+							),
+						$this->_default_field_name => false
+					) ));
+		}
+		return $restrictions;
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -56,7 +56,7 @@ 
     {
         // if there are no standard caps for this model, then for now all we know is
         // if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return array(
                 self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions()
             );
@@ -64,33 +64,33 @@ 
 
         $event_model = EEM_Event::instance();
 
-        $restrictions =  array(
+        $restrictions = array(
             // first: basically access to non-defaults is essentially controlled by which events are accessible
             // if they don't have the basic event cap, they can't access ANY non-default items
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action()) => new EE_Default_Where_Conditions(array( $this->_default_field_name => true )),
+            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action()) => new EE_Default_Where_Conditions(array($this->_default_field_name => true)),
             // if they don't have the others event cap, they can't access others' non-default items
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => new EE_Default_Where_Conditions(array(
-                'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => array(
-                    $this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder ),
+            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action().'_others') => new EE_Default_Where_Conditions(array(
+                'OR*no_'.EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action().'_others') => array(
+                    $this->_path_to_event_model.'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder ),
                     $this->_default_field_name => true )),
             // if they have basic and others, but not private, they can't access others' private non-default items
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => new EE_Default_Where_Conditions(array(
-                'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => array(
-                $this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
-                $this->_path_to_event_model . 'status' => array( '!=', 'private' ),
+            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action().'_private') => new EE_Default_Where_Conditions(array(
+                'OR*no_'.EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action().'_private') => array(
+                $this->_path_to_event_model.'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
+                $this->_path_to_event_model.'status' => array('!=', 'private'),
                 $this->_default_field_name => true ) )),
             // second: access to defaults is controlled by the defaulty capabilities
             // if they don't have the default capability, restrict access to only non-default items
-            EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_default') => new EE_Default_Where_Conditions(array( $this->_default_field_name => false )),
+            EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action().'_default') => new EE_Default_Where_Conditions(array($this->_default_field_name => false)),
             // if they don't have the "others" default capability, restrict access to only their default ones, and non-default ones
              );
-        if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action() . '_others_default')) {
-            $restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others_default') ] = new EE_Default_Where_Conditions(array(
+        if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action().'_others_default')) {
+            $restrictions[EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action().'_others_default')] = new EE_Default_Where_Conditions(array(
                     // if they don't have the others default cap, they can't access others default items (but they can access
                     // their own default items, and non-default items)
-                    'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others_default') => array(
+                    'OR*no_'.EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action().'_others_default') => array(
                         'AND' => array(
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
                             $this->_default_field_name => true
                             ),
                         $this->_default_field_name => false

core/helpers/EEH_Event_Query.helper.php

Spacing +40 added lines, -40 removed lines

@@ -216,7 +216,7 @@ 
     {
         if (EEH_Event_Query::apply_query_filters($wp_query)) {
             global $wpdb;
-            $clauses['groupby'] = $wpdb->posts . '.ID ';
+            $clauses['groupby'] = $wpdb->posts.'.ID ';
         }
         return $clauses;
     }
@@ -251,23 +251,23 @@ 
      */
     public static function posts_fields_sql_for_orderby(array $orderby_params = [])
     {
-        $SQL = ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+        $SQL = ', MIN( '.EEM_Datetime::instance()->table().'.DTT_EVT_start ) as event_start_date ';
         foreach ($orderby_params as $orderby) {
             switch ($orderby) {
                 case 'ticket_start':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_start_date';
+                    $SQL .= ', '.EEM_Ticket::instance()->table().'.TKT_start_date';
                     break;
                 case 'ticket_end':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_end_date';
+                    $SQL .= ', '.EEM_Ticket::instance()->table().'.TKT_end_date';
                     break;
                 case 'venue_title':
                     $SQL .= ', Venue.post_title AS venue_title';
                     break;
                 case 'city':
-                    $SQL .= ', ' . EEM_Venue::instance()->second_table() . '.VNU_city';
+                    $SQL .= ', '.EEM_Venue::instance()->second_table().'.VNU_city';
                     break;
                 case 'state':
-                    $SQL .= ', ' . EEM_State::instance()->table() . '.STA_name';
+                    $SQL .= ', '.EEM_State::instance()->table().'.STA_name';
                     break;
             }
         }
@@ -307,12 +307,12 @@ 
      */
     public static function posts_join_sql_for_show_expired($SQL = '', $show_expired = false)
     {
-        if (! $show_expired) {
-            $join = EEM_Event::instance()->table() . '.ID = ';
-            $join .= EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+        if ( ! $show_expired) {
+            $join = EEM_Event::instance()->table().'.ID = ';
+            $join .= EEM_Datetime::instance()->table().'.'.EEM_Event::instance()->primary_key_name();
             // don't add if this is already in the SQL
             if (strpos($SQL, $join) === false) {
-                $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' ) ';
+                $SQL .= ' INNER JOIN '.EEM_Datetime::instance()->table().' ON ( '.$join.' ) ';
             }
         }
         return $SQL;
@@ -327,7 +327,7 @@ 
      */
     public static function posts_join_sql_for_terms($SQL = '', $join_terms = '')
     {
-        if (! empty($join_terms)) {
+        if ( ! empty($join_terms)) {
             global $wpdb;
             $SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
             $SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
@@ -356,13 +356,13 @@ 
                 case 'ticket_end':
                     $SQL .= EEH_Event_Query::_posts_join_for_datetime(
                         $SQL,
-                        EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Datetime::instance()->primary_key_name()
+                        EEM_Datetime_Ticket::instance()->table().'.'.EEM_Datetime::instance()->primary_key_name()
                     );
-                    $SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table();
+                    $SQL .= ' LEFT JOIN '.EEM_Ticket::instance()->table();
                     $SQL .= ' ON (';
-                    $SQL .= EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+                    $SQL .= EEM_Datetime_Ticket::instance()->table().'.'.EEM_Ticket::instance()->primary_key_name();
                     $SQL .= ' = ';
-                    $SQL .= EEM_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+                    $SQL .= EEM_Ticket::instance()->table().'.'.EEM_Ticket::instance()->primary_key_name();
                     $SQL .= ' )';
                     break;
                 case 'venue_title':
@@ -375,7 +375,7 @@ 
                     break;
                 case 'start_date':
                 default:
-                    $SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table() . '.ID');
+                    $SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table().'.ID');
                     break;
             }
         }
@@ -394,10 +394,10 @@ 
      */
     protected static function _posts_join_for_datetime($SQL = '', $join = '')
     {
-        if (! empty($join)) {
-            $join .= ' = ' . EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+        if ( ! empty($join)) {
+            $join .= ' = '.EEM_Datetime::instance()->table().'.'.EEM_Event::instance()->primary_key_name();
             if (strpos($SQL, $join) === false) {
-                return ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' )';
+                return ' INNER JOIN '.EEM_Datetime::instance()->table().' ON ( '.$join.' )';
             }
         }
         return '';
@@ -417,8 +417,8 @@ 
         // Event Venue table name
         $event_venue_table = EEM_Event_Venue::instance()->table();
         // generate conditions for:  Event <=> Event Venue  JOIN clause
-        $event_to_event_venue_join = EEM_Event::instance()->table() . '.ID = ';
-        $event_to_event_venue_join .= $event_venue_table . '.' . EEM_Event::instance()->primary_key_name();
+        $event_to_event_venue_join = EEM_Event::instance()->table().'.ID = ';
+        $event_to_event_venue_join .= $event_venue_table.'.'.EEM_Event::instance()->primary_key_name();
         // don't add joins if they have already been added
         if (strpos($SQL, $event_to_event_venue_join) === false) {
             // Venue table name
@@ -506,7 +506,7 @@ 
     public static function posts_where_sql_for_show_expired($show_expired = false)
     {
         return ! $show_expired
-            ? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > \'' . current_time('mysql', true) . '\' '
+            ? ' AND '.EEM_Datetime::instance()->table().'.DTT_EVT_end > \''.current_time('mysql', true).'\' '
             : '';
     }
 
@@ -518,7 +518,7 @@ 
     public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
     {
         global $wpdb;
-        if (! empty($event_category_slug)) {
+        if ( ! empty($event_category_slug)) {
             $event_category_slugs_array   = array_map('trim', explode(',', $event_category_slug));
             $event_category_slugs_prepare = implode(', ', array_fill(0, count($event_category_slugs_array), '%s'));
             return $wpdb->prepare(
@@ -541,14 +541,14 @@ 
     public static function posts_where_sql_for_event_list_month($month = null)
     {
         $SQL = '';
-        if (! empty($month)) {
+        if ( ! empty($month)) {
             $datetime_table = EEM_Datetime::instance()->table();
             // event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
             $SQL = " AND {$datetime_table}.DTT_EVT_start <= '";
-            $SQL .= date('Y-m-t 23:59:59', EEH_DTT_Helper::first_of_month_timestamp($month)) . "'";
+            $SQL .= date('Y-m-t 23:59:59', EEH_DTT_Helper::first_of_month_timestamp($month))."'";
             // event end date is GREATER than the start of the month ( so nothing that ended before this month )
             $SQL .= " AND {$datetime_table}.DTT_EVT_end >= '";
-            $SQL .= date('Y-m-01 0:0:00', EEH_DTT_Helper::first_of_month_timestamp($month)) . "' ";
+            $SQL .= date('Y-m-01 0:0:00', EEH_DTT_Helper::first_of_month_timestamp($month))."' ";
         }
         return $SQL;
     }
@@ -609,15 +609,15 @@ 
             ? strtoupper($sort)
             : 'ASC';
         // make sure 'orderby' is set in query params
-        if (! isset(self::$_query_params['orderby'])) {
+        if ( ! isset(self::$_query_params['orderby'])) {
             self::$_query_params['orderby'] = [];
         }
         // loop thru $orderby_params (type cast as array)
         foreach ($orderby_params as $orderby) {
             // check if we have already added this param
-            if (isset(self::$_query_params['orderby'][ $orderby ])) {
+            if (isset(self::$_query_params['orderby'][$orderby])) {
                 // if so then remove from the $orderby_params so that the count() method below is accurate
-                unset($orderby_params[ $orderby ]);
+                unset($orderby_params[$orderby]);
                 // then bump ahead to the next param
                 continue;
             }
@@ -627,39 +627,39 @@ 
             switch ($orderby) {
                 case 'id':
                 case 'ID':
-                    $SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
+                    $SQL .= $glue.$wpdb->posts.'.ID '.$sort;
                     break;
                 case 'end_date':
-                    $SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
+                    $SQL .= $glue.EEM_Datetime::instance()->table().'.DTT_EVT_end '.$sort;
                     break;
                 case 'event_name':
-                    $SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
+                    $SQL .= $glue.$wpdb->posts.'.post_title '.$sort;
                     break;
                 case 'category_slug':
-                    $SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
+                    $SQL .= $glue.$wpdb->terms.'.slug '.$sort;
                     break;
                 case 'ticket_start':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
+                    $SQL .= $glue.EEM_Ticket::instance()->table().'.TKT_start_date '.$sort;
                     break;
                 case 'ticket_end':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
+                    $SQL .= $glue.EEM_Ticket::instance()->table().'.TKT_end_date '.$sort;
                     break;
                 case 'venue_title':
-                    $SQL .= $glue . 'venue_title ' . $sort;
+                    $SQL .= $glue.'venue_title '.$sort;
                     break;
                 case 'city':
-                    $SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
+                    $SQL .= $glue.EEM_Venue::instance()->second_table().'.VNU_city '.$sort;
                     break;
                 case 'state':
-                    $SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
+                    $SQL .= $glue.EEM_State::instance()->table().'.STA_name '.$sort;
                     break;
                 case 'start_date':
                 default:
-                    $SQL .= $glue . ' event_start_date ' . $sort;
+                    $SQL .= $glue.' event_start_date '.$sort;
                     break;
             }
             // add to array of orderby params that have been added
-            self::$_query_params['orderby'][ $orderby ] = true;
+            self::$_query_params['orderby'][$orderby] = true;
             $counter++;
         }
         return $SQL;

Indentation +662 added lines, -662 removed lines

@@ -17,666 +17,666 @@
  */
 class EEH_Event_Query
 {
-    /**
-     * Start Date
-     *
-     * @var $_event_query_month
-     */
-    protected static $_event_query_month;
-
-    /**
-     * Category
-     *
-     * @var $_event_query_category
-     */
-    protected static $_event_query_category;
-
-    /**
-     * whether to display expired events in the event list
-     *
-     * @var bool $_show_expired
-     */
-    protected static $_event_query_show_expired = false;
-
-    /**
-     * list of params for controlling how the query results are ordered
-     *
-     * @var array $_event_query_orderby
-     */
-    protected static $_event_query_orderby = [];
-
-    /**
-     * direction list is sorted
-     *
-     * @var string $_event_query_sort
-     */
-    protected static $_event_query_sort;
-
-    /**
-     * list of params used to build the query's various clauses
-     *
-     * @var $_query_params
-     */
-    protected static $_query_params = [];
-
-
-    /**
-     * @return void
-     */
-    public static function add_query_filters()
-    {
-        // add query filters
-        add_action('pre_get_posts', ['EEH_Event_Query', 'filter_query_parts'], 10, 1);
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return bool
-     */
-    public static function apply_query_filters(WP_Query $WP_Query)
-    {
-        return (
-                   isset($WP_Query->query['post_type'])
-                   && $WP_Query->query['post_type'] === 'espresso_events'
-               )
-               || apply_filters('FHEE__EEH_Event_Query__apply_query_filters', false);
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     */
-    public static function filter_query_parts(WP_Query $WP_Query)
-    {
-        // ONLY add our filters if this isn't the main wp_query,
-        // because if this is the main wp_query we already have
-        // our cpt strategies take care of adding things in.
-        if ($WP_Query instanceof WP_Query && ! $WP_Query->is_main_query()) {
-            // build event list query
-            add_filter('posts_fields', ['EEH_Event_Query', 'posts_fields'], 10, 2);
-            add_filter('posts_join', ['EEH_Event_Query', 'posts_join'], 10, 2);
-            add_filter('posts_where', ['EEH_Event_Query', 'posts_where'], 10, 2);
-            add_filter('posts_orderby', ['EEH_Event_Query', 'posts_orderby'], 10, 2);
-            add_filter('posts_clauses_request', ['EEH_Event_Query', 'posts_clauses'], 10, 2);
-        }
-    }
-
-
-    /**
-     * @param string $month
-     * @param string $category
-     * @param bool   $show_expired
-     * @param array|string $orderby
-     * @param string $sort
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_query_params(
-        $month = '',
-        $category = '',
-        $show_expired = false,
-        $orderby = 'start_date',
-        $sort = 'ASC'
-    ) {
-        self::$_query_params                        = [];
-        EEH_Event_Query::$_event_query_month        = EEH_Event_Query::_display_month($month);
-        EEH_Event_Query::$_event_query_category     = EEH_Event_Query::_event_category_slug($category);
-        EEH_Event_Query::$_event_query_show_expired = EEH_Event_Query::_show_expired($show_expired);
-        EEH_Event_Query::$_event_query_orderby      = EEH_Event_Query::_orderby($orderby);
-        EEH_Event_Query::$_event_query_sort         = EEH_Event_Query::_sort($sort);
-    }
-
-
-    /**
-     * what month should the event list display events for?
-     *
-     * @param string $month
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _display_month($month = '')
-    {
-        return self::getRequest()->getRequestParam('event_query_month', $month);
-    }
-
-
-    /**
-     * @param string $category
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _event_category_slug($category = '')
-    {
-        return self::getRequest()->getRequestParam('event_query_category', $category);
-    }
-
-
-    /**
-     * @param bool $show_expired
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _show_expired($show_expired = false)
-    {
-        // override default expired option if set via filter
-        return self::getRequest()->getRequestParam('event_query_show_expired', $show_expired, 'bool');
-    }
-
-
-    /**
-     * @param array|string $orderby
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _orderby($orderby = 'start_date')
-    {
-        $event_query_orderby = self::getRequest()->getRequestParam(
-            'event_query_orderby',
-            (array) $orderby,
-            DataType::STRING,
-            true
-        );
-        $event_query_orderby = is_array($event_query_orderby)
-            ? $event_query_orderby
-            : explode(',', $event_query_orderby);
-        $event_query_orderby = array_map('trim', $event_query_orderby);
-        return array_map('sanitize_text_field', $event_query_orderby);
-    }
-
-
-    /**
-     * @param string $sort
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _sort($sort = 'ASC')
-    {
-        $sort = self::getRequest()->getRequestParam('event_query_sort', $sort);
-        return in_array($sort, ['ASC', 'asc', 'DESC', 'desc'], true)
-            ? strtoupper($sort)
-            : 'ASC';
-    }
-
-
-    /**
-     * Filters the clauses for the WP_Query object
-     *
-     * @param array    $clauses array of clauses
-     * @param WP_Query $wp_query
-     * @return array   array of clauses
-     */
-    public static function posts_clauses($clauses, WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            global $wpdb;
-            $clauses['groupby'] = $wpdb->posts . '.ID ';
-        }
-        return $clauses;
-    }
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_fields($SQL, WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            // adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
-            $SQL .= EEH_Event_Query::posts_fields_sql_for_orderby(EEH_Event_Query::$_event_query_orderby);
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @param array $orderby_params
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_fields_sql_for_orderby(array $orderby_params = [])
-    {
-        $SQL = ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
-        foreach ($orderby_params as $orderby) {
-            switch ($orderby) {
-                case 'ticket_start':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_start_date';
-                    break;
-                case 'ticket_end':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_end_date';
-                    break;
-                case 'venue_title':
-                    $SQL .= ', Venue.post_title AS venue_title';
-                    break;
-                case 'city':
-                    $SQL .= ', ' . EEM_Venue::instance()->second_table() . '.VNU_city';
-                    break;
-                case 'state':
-                    $SQL .= ', ' . EEM_State::instance()->table() . '.STA_name';
-                    break;
-            }
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_join($SQL, WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            // Category
-            $SQL = EEH_Event_Query::posts_join_sql_for_show_expired($SQL, EEH_Event_Query::$_event_query_show_expired);
-            $SQL = EEH_Event_Query::posts_join_sql_for_terms($SQL, EEH_Event_Query::$_event_query_category);
-            $SQL = EEH_Event_Query::posts_join_for_orderby($SQL, EEH_Event_Query::$_event_query_orderby);
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @param string  $SQL
-     * @param boolean $show_expired if TRUE, then displayed past events
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_join_sql_for_show_expired($SQL = '', $show_expired = false)
-    {
-        if (! $show_expired) {
-            $join = EEM_Event::instance()->table() . '.ID = ';
-            $join .= EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
-            // don't add if this is already in the SQL
-            if (strpos($SQL, $join) === false) {
-                $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' ) ';
-            }
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @param string $SQL
-     * @param string $join_terms    pass TRUE or term string, doesn't really matter since this value doesn't really get
-     *                              used for anything yet
-     * @return string
-     */
-    public static function posts_join_sql_for_terms($SQL = '', $join_terms = '')
-    {
-        if (! empty($join_terms)) {
-            global $wpdb;
-            $SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
-            $SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
-            $SQL .= " LEFT JOIN $wpdb->terms ON ($wpdb->terms.term_id = $wpdb->term_taxonomy.term_id) ";
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * usage:  $SQL .= EEH_Event_Query::posts_join_for_orderby( $orderby_params );
-     *
-     * @param string $SQL
-     * @param array  $orderby_params
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_join_for_orderby($SQL = '', array $orderby_params = [])
-    {
-        foreach ($orderby_params as $orderby) {
-            switch ($orderby) {
-                case 'ticket_start':
-                case 'ticket_end':
-                    $SQL .= EEH_Event_Query::_posts_join_for_datetime(
-                        $SQL,
-                        EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Datetime::instance()->primary_key_name()
-                    );
-                    $SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table();
-                    $SQL .= ' ON (';
-                    $SQL .= EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
-                    $SQL .= ' = ';
-                    $SQL .= EEM_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
-                    $SQL .= ' )';
-                    break;
-                case 'venue_title':
-                case 'city':
-                    $SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
-                    break;
-                case 'state':
-                    $SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
-                    $SQL .= EEH_Event_Query::_posts_join_for_venue_state($SQL);
-                    break;
-                case 'start_date':
-                default:
-                    $SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table() . '.ID');
-                    break;
-            }
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @param string $SQL
-     * @param string $join
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _posts_join_for_datetime($SQL = '', $join = '')
-    {
-        if (! empty($join)) {
-            $join .= ' = ' . EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
-            if (strpos($SQL, $join) === false) {
-                return ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' )';
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * @param string $SQL
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _posts_join_for_event_venue($SQL = '')
-    {
-        // Event Venue table name
-        $event_venue_table = EEM_Event_Venue::instance()->table();
-        // generate conditions for:  Event <=> Event Venue  JOIN clause
-        $event_to_event_venue_join = EEM_Event::instance()->table() . '.ID = ';
-        $event_to_event_venue_join .= $event_venue_table . '.' . EEM_Event::instance()->primary_key_name();
-        // don't add joins if they have already been added
-        if (strpos($SQL, $event_to_event_venue_join) === false) {
-            // Venue table name
-            $venue_table = EEM_Venue::instance()->table();
-            // Venue table pk
-            $venue_table_pk = EEM_Venue::instance()->primary_key_name();
-            // Venue Meta table name
-            $venue_meta_table = EEM_Venue::instance()->second_table();
-            // generate JOIN clause for: Event <=> Event Venue
-            $venue_SQL = " LEFT JOIN $event_venue_table ON ( $event_to_event_venue_join )";
-            // generate JOIN clause for: Event Venue <=> Venue
-            $venue_SQL .= " LEFT JOIN $venue_table as Venue ON ( $event_venue_table.$venue_table_pk = Venue.ID )";
-            // generate JOIN clause for: Venue <=> Venue Meta
-            $venue_SQL .= " LEFT JOIN $venue_meta_table ON ( Venue.ID = $venue_meta_table.$venue_table_pk )";
-            unset($event_venue_table, $event_to_event_venue_join, $venue_table, $venue_table_pk, $venue_meta_table);
-            return $venue_SQL;
-        }
-        unset($event_venue_table, $event_to_event_venue_join);
-        return '';
-    }
-
-
-    /**
-     * @param string $SQL
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _posts_join_for_venue_state($SQL = '')
-    {
-        // Venue Meta table name
-        $venue_meta_table = EEM_Venue::instance()->second_table();
-        // State table name
-        $state_table = EEM_State::instance()->table();
-        // State table pk
-        $state_table_pk = EEM_State::instance()->primary_key_name();
-        // verify vars
-        if ($venue_meta_table && $state_table && $state_table_pk) {
-            // like: wp_esp_venue_meta.STA_ID = wp_esp_state.STA_ID
-            $join = "$venue_meta_table.$state_table_pk = $state_table.$state_table_pk";
-            // don't add join if it has already been added
-            if (strpos($SQL, $join) === false) {
-                unset($state_table_pk, $venue_meta_table, $venue_table_pk);
-                return " LEFT JOIN $state_table ON ( $join )";
-            }
-        }
-        unset($join, $state_table, $state_table_pk, $venue_meta_table, $venue_table_pk);
-        return '';
-    }
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_where($SQL, WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            // Show Expired ?
-            $SQL .= EEH_Event_Query::posts_where_sql_for_show_expired(EEH_Event_Query::$_event_query_show_expired);
-            // Category
-            $SQL .= EEH_Event_Query::posts_where_sql_for_event_category_slug(EEH_Event_Query::$_event_query_category);
-            // Start Date
-            $SQL .= EEH_Event_Query::posts_where_sql_for_event_list_month(EEH_Event_Query::$_event_query_month);
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @param boolean $show_expired if TRUE, then displayed past events
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_where_sql_for_show_expired($show_expired = false)
-    {
-        return ! $show_expired
-            ? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > \'' . current_time('mysql', true) . '\' '
-            : '';
-    }
-
-
-    /**
-     * @param boolean $event_category_slug
-     * @return string
-     */
-    public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
-    {
-        global $wpdb;
-        if (! empty($event_category_slug)) {
-            $event_category_slugs_array   = array_map('trim', explode(',', $event_category_slug));
-            $event_category_slugs_prepare = implode(', ', array_fill(0, count($event_category_slugs_array), '%s'));
-            return $wpdb->prepare(
-                " AND {$wpdb->terms}.slug IN ({$event_category_slugs_prepare}) ",
-                $event_category_slugs_array
-            );
-        }
-        return '';
-    }
-
-
-    /**
-     * @param boolean $month
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_where_sql_for_event_list_month($month = null)
-    {
-        $SQL = '';
-        if (! empty($month)) {
-            $datetime_table = EEM_Datetime::instance()->table();
-            // event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
-            $SQL = " AND {$datetime_table}.DTT_EVT_start <= '";
-            $SQL .= date('Y-m-t 23:59:59', EEH_DTT_Helper::first_of_month_timestamp($month)) . "'";
-            // event end date is GREATER than the start of the month ( so nothing that ended before this month )
-            $SQL .= " AND {$datetime_table}.DTT_EVT_end >= '";
-            $SQL .= date('Y-m-01 0:0:00', EEH_DTT_Helper::first_of_month_timestamp($month)) . "' ";
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_orderby($SQL, WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            $SQL = EEH_Event_Query::posts_orderby_sql(
-                EEH_Event_Query::$_event_query_orderby,
-                EEH_Event_Query::$_event_query_sort
-            );
-        }
-        return $SQL;
-    }
-
-
-    /**
-     *    posts_orderby_sql
-     *    possible parameters:
-     *    ID
-     *    start_date
-     *    end_date
-     *    event_name
-     *    category_slug
-     *    ticket_start
-     *    ticket_end
-     *    venue_title
-     *    city
-     *    state
-     *    **IMPORTANT**
-     *    make sure to also send the $orderby_params array to the posts_join_for_orderby() method
-     *    or else some of the table references below will result in MySQL errors
-     *
-     * @param array  $orderby_params
-     * @param string $sort
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_orderby_sql(array $orderby_params = [], $sort = 'ASC')
-    {
-        global $wpdb;
-        $SQL     = '';
-        $counter = 0;
-        $sort    = in_array($sort, ['ASC', 'asc', 'DESC', 'desc'], true)
-            ? strtoupper($sort)
-            : 'ASC';
-        // make sure 'orderby' is set in query params
-        if (! isset(self::$_query_params['orderby'])) {
-            self::$_query_params['orderby'] = [];
-        }
-        // loop thru $orderby_params (type cast as array)
-        foreach ($orderby_params as $orderby) {
-            // check if we have already added this param
-            if (isset(self::$_query_params['orderby'][ $orderby ])) {
-                // if so then remove from the $orderby_params so that the count() method below is accurate
-                unset($orderby_params[ $orderby ]);
-                // then bump ahead to the next param
-                continue;
-            }
-            // this will ad a comma depending on whether this is the first or last param
-            $glue = $counter === 0 || $counter === count($orderby_params) ? ' ' : ', ';
-            // ok what's we dealing with?
-            switch ($orderby) {
-                case 'id':
-                case 'ID':
-                    $SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
-                    break;
-                case 'end_date':
-                    $SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
-                    break;
-                case 'event_name':
-                    $SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
-                    break;
-                case 'category_slug':
-                    $SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
-                    break;
-                case 'ticket_start':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
-                    break;
-                case 'ticket_end':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
-                    break;
-                case 'venue_title':
-                    $SQL .= $glue . 'venue_title ' . $sort;
-                    break;
-                case 'city':
-                    $SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
-                    break;
-                case 'state':
-                    $SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
-                    break;
-                case 'start_date':
-                default:
-                    $SQL .= $glue . ' event_start_date ' . $sort;
-                    break;
-            }
-            // add to array of orderby params that have been added
-            self::$_query_params['orderby'][ $orderby ] = true;
-            $counter++;
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @return RequestInterface
-     * @since   4.10.14.p
-     */
-    private static function getRequest()
-    {
-        return LoaderFactory::getLoader()->getShared(RequestInterface::class);
-    }
+	/**
+	 * Start Date
+	 *
+	 * @var $_event_query_month
+	 */
+	protected static $_event_query_month;
+
+	/**
+	 * Category
+	 *
+	 * @var $_event_query_category
+	 */
+	protected static $_event_query_category;
+
+	/**
+	 * whether to display expired events in the event list
+	 *
+	 * @var bool $_show_expired
+	 */
+	protected static $_event_query_show_expired = false;
+
+	/**
+	 * list of params for controlling how the query results are ordered
+	 *
+	 * @var array $_event_query_orderby
+	 */
+	protected static $_event_query_orderby = [];
+
+	/**
+	 * direction list is sorted
+	 *
+	 * @var string $_event_query_sort
+	 */
+	protected static $_event_query_sort;
+
+	/**
+	 * list of params used to build the query's various clauses
+	 *
+	 * @var $_query_params
+	 */
+	protected static $_query_params = [];
+
+
+	/**
+	 * @return void
+	 */
+	public static function add_query_filters()
+	{
+		// add query filters
+		add_action('pre_get_posts', ['EEH_Event_Query', 'filter_query_parts'], 10, 1);
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return bool
+	 */
+	public static function apply_query_filters(WP_Query $WP_Query)
+	{
+		return (
+				   isset($WP_Query->query['post_type'])
+				   && $WP_Query->query['post_type'] === 'espresso_events'
+			   )
+			   || apply_filters('FHEE__EEH_Event_Query__apply_query_filters', false);
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 */
+	public static function filter_query_parts(WP_Query $WP_Query)
+	{
+		// ONLY add our filters if this isn't the main wp_query,
+		// because if this is the main wp_query we already have
+		// our cpt strategies take care of adding things in.
+		if ($WP_Query instanceof WP_Query && ! $WP_Query->is_main_query()) {
+			// build event list query
+			add_filter('posts_fields', ['EEH_Event_Query', 'posts_fields'], 10, 2);
+			add_filter('posts_join', ['EEH_Event_Query', 'posts_join'], 10, 2);
+			add_filter('posts_where', ['EEH_Event_Query', 'posts_where'], 10, 2);
+			add_filter('posts_orderby', ['EEH_Event_Query', 'posts_orderby'], 10, 2);
+			add_filter('posts_clauses_request', ['EEH_Event_Query', 'posts_clauses'], 10, 2);
+		}
+	}
+
+
+	/**
+	 * @param string $month
+	 * @param string $category
+	 * @param bool   $show_expired
+	 * @param array|string $orderby
+	 * @param string $sort
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_query_params(
+		$month = '',
+		$category = '',
+		$show_expired = false,
+		$orderby = 'start_date',
+		$sort = 'ASC'
+	) {
+		self::$_query_params                        = [];
+		EEH_Event_Query::$_event_query_month        = EEH_Event_Query::_display_month($month);
+		EEH_Event_Query::$_event_query_category     = EEH_Event_Query::_event_category_slug($category);
+		EEH_Event_Query::$_event_query_show_expired = EEH_Event_Query::_show_expired($show_expired);
+		EEH_Event_Query::$_event_query_orderby      = EEH_Event_Query::_orderby($orderby);
+		EEH_Event_Query::$_event_query_sort         = EEH_Event_Query::_sort($sort);
+	}
+
+
+	/**
+	 * what month should the event list display events for?
+	 *
+	 * @param string $month
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _display_month($month = '')
+	{
+		return self::getRequest()->getRequestParam('event_query_month', $month);
+	}
+
+
+	/**
+	 * @param string $category
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _event_category_slug($category = '')
+	{
+		return self::getRequest()->getRequestParam('event_query_category', $category);
+	}
+
+
+	/**
+	 * @param bool $show_expired
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _show_expired($show_expired = false)
+	{
+		// override default expired option if set via filter
+		return self::getRequest()->getRequestParam('event_query_show_expired', $show_expired, 'bool');
+	}
+
+
+	/**
+	 * @param array|string $orderby
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _orderby($orderby = 'start_date')
+	{
+		$event_query_orderby = self::getRequest()->getRequestParam(
+			'event_query_orderby',
+			(array) $orderby,
+			DataType::STRING,
+			true
+		);
+		$event_query_orderby = is_array($event_query_orderby)
+			? $event_query_orderby
+			: explode(',', $event_query_orderby);
+		$event_query_orderby = array_map('trim', $event_query_orderby);
+		return array_map('sanitize_text_field', $event_query_orderby);
+	}
+
+
+	/**
+	 * @param string $sort
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _sort($sort = 'ASC')
+	{
+		$sort = self::getRequest()->getRequestParam('event_query_sort', $sort);
+		return in_array($sort, ['ASC', 'asc', 'DESC', 'desc'], true)
+			? strtoupper($sort)
+			: 'ASC';
+	}
+
+
+	/**
+	 * Filters the clauses for the WP_Query object
+	 *
+	 * @param array    $clauses array of clauses
+	 * @param WP_Query $wp_query
+	 * @return array   array of clauses
+	 */
+	public static function posts_clauses($clauses, WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			global $wpdb;
+			$clauses['groupby'] = $wpdb->posts . '.ID ';
+		}
+		return $clauses;
+	}
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_fields($SQL, WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			// adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
+			$SQL .= EEH_Event_Query::posts_fields_sql_for_orderby(EEH_Event_Query::$_event_query_orderby);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @param array $orderby_params
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_fields_sql_for_orderby(array $orderby_params = [])
+	{
+		$SQL = ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+		foreach ($orderby_params as $orderby) {
+			switch ($orderby) {
+				case 'ticket_start':
+					$SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_start_date';
+					break;
+				case 'ticket_end':
+					$SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_end_date';
+					break;
+				case 'venue_title':
+					$SQL .= ', Venue.post_title AS venue_title';
+					break;
+				case 'city':
+					$SQL .= ', ' . EEM_Venue::instance()->second_table() . '.VNU_city';
+					break;
+				case 'state':
+					$SQL .= ', ' . EEM_State::instance()->table() . '.STA_name';
+					break;
+			}
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_join($SQL, WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			// Category
+			$SQL = EEH_Event_Query::posts_join_sql_for_show_expired($SQL, EEH_Event_Query::$_event_query_show_expired);
+			$SQL = EEH_Event_Query::posts_join_sql_for_terms($SQL, EEH_Event_Query::$_event_query_category);
+			$SQL = EEH_Event_Query::posts_join_for_orderby($SQL, EEH_Event_Query::$_event_query_orderby);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @param string  $SQL
+	 * @param boolean $show_expired if TRUE, then displayed past events
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_join_sql_for_show_expired($SQL = '', $show_expired = false)
+	{
+		if (! $show_expired) {
+			$join = EEM_Event::instance()->table() . '.ID = ';
+			$join .= EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+			// don't add if this is already in the SQL
+			if (strpos($SQL, $join) === false) {
+				$SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' ) ';
+			}
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @param string $SQL
+	 * @param string $join_terms    pass TRUE or term string, doesn't really matter since this value doesn't really get
+	 *                              used for anything yet
+	 * @return string
+	 */
+	public static function posts_join_sql_for_terms($SQL = '', $join_terms = '')
+	{
+		if (! empty($join_terms)) {
+			global $wpdb;
+			$SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
+			$SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
+			$SQL .= " LEFT JOIN $wpdb->terms ON ($wpdb->terms.term_id = $wpdb->term_taxonomy.term_id) ";
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * usage:  $SQL .= EEH_Event_Query::posts_join_for_orderby( $orderby_params );
+	 *
+	 * @param string $SQL
+	 * @param array  $orderby_params
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_join_for_orderby($SQL = '', array $orderby_params = [])
+	{
+		foreach ($orderby_params as $orderby) {
+			switch ($orderby) {
+				case 'ticket_start':
+				case 'ticket_end':
+					$SQL .= EEH_Event_Query::_posts_join_for_datetime(
+						$SQL,
+						EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Datetime::instance()->primary_key_name()
+					);
+					$SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table();
+					$SQL .= ' ON (';
+					$SQL .= EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+					$SQL .= ' = ';
+					$SQL .= EEM_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+					$SQL .= ' )';
+					break;
+				case 'venue_title':
+				case 'city':
+					$SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
+					break;
+				case 'state':
+					$SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
+					$SQL .= EEH_Event_Query::_posts_join_for_venue_state($SQL);
+					break;
+				case 'start_date':
+				default:
+					$SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table() . '.ID');
+					break;
+			}
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @param string $SQL
+	 * @param string $join
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _posts_join_for_datetime($SQL = '', $join = '')
+	{
+		if (! empty($join)) {
+			$join .= ' = ' . EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+			if (strpos($SQL, $join) === false) {
+				return ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' )';
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * @param string $SQL
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _posts_join_for_event_venue($SQL = '')
+	{
+		// Event Venue table name
+		$event_venue_table = EEM_Event_Venue::instance()->table();
+		// generate conditions for:  Event <=> Event Venue  JOIN clause
+		$event_to_event_venue_join = EEM_Event::instance()->table() . '.ID = ';
+		$event_to_event_venue_join .= $event_venue_table . '.' . EEM_Event::instance()->primary_key_name();
+		// don't add joins if they have already been added
+		if (strpos($SQL, $event_to_event_venue_join) === false) {
+			// Venue table name
+			$venue_table = EEM_Venue::instance()->table();
+			// Venue table pk
+			$venue_table_pk = EEM_Venue::instance()->primary_key_name();
+			// Venue Meta table name
+			$venue_meta_table = EEM_Venue::instance()->second_table();
+			// generate JOIN clause for: Event <=> Event Venue
+			$venue_SQL = " LEFT JOIN $event_venue_table ON ( $event_to_event_venue_join )";
+			// generate JOIN clause for: Event Venue <=> Venue
+			$venue_SQL .= " LEFT JOIN $venue_table as Venue ON ( $event_venue_table.$venue_table_pk = Venue.ID )";
+			// generate JOIN clause for: Venue <=> Venue Meta
+			$venue_SQL .= " LEFT JOIN $venue_meta_table ON ( Venue.ID = $venue_meta_table.$venue_table_pk )";
+			unset($event_venue_table, $event_to_event_venue_join, $venue_table, $venue_table_pk, $venue_meta_table);
+			return $venue_SQL;
+		}
+		unset($event_venue_table, $event_to_event_venue_join);
+		return '';
+	}
+
+
+	/**
+	 * @param string $SQL
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _posts_join_for_venue_state($SQL = '')
+	{
+		// Venue Meta table name
+		$venue_meta_table = EEM_Venue::instance()->second_table();
+		// State table name
+		$state_table = EEM_State::instance()->table();
+		// State table pk
+		$state_table_pk = EEM_State::instance()->primary_key_name();
+		// verify vars
+		if ($venue_meta_table && $state_table && $state_table_pk) {
+			// like: wp_esp_venue_meta.STA_ID = wp_esp_state.STA_ID
+			$join = "$venue_meta_table.$state_table_pk = $state_table.$state_table_pk";
+			// don't add join if it has already been added
+			if (strpos($SQL, $join) === false) {
+				unset($state_table_pk, $venue_meta_table, $venue_table_pk);
+				return " LEFT JOIN $state_table ON ( $join )";
+			}
+		}
+		unset($join, $state_table, $state_table_pk, $venue_meta_table, $venue_table_pk);
+		return '';
+	}
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_where($SQL, WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			// Show Expired ?
+			$SQL .= EEH_Event_Query::posts_where_sql_for_show_expired(EEH_Event_Query::$_event_query_show_expired);
+			// Category
+			$SQL .= EEH_Event_Query::posts_where_sql_for_event_category_slug(EEH_Event_Query::$_event_query_category);
+			// Start Date
+			$SQL .= EEH_Event_Query::posts_where_sql_for_event_list_month(EEH_Event_Query::$_event_query_month);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @param boolean $show_expired if TRUE, then displayed past events
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_where_sql_for_show_expired($show_expired = false)
+	{
+		return ! $show_expired
+			? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > \'' . current_time('mysql', true) . '\' '
+			: '';
+	}
+
+
+	/**
+	 * @param boolean $event_category_slug
+	 * @return string
+	 */
+	public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
+	{
+		global $wpdb;
+		if (! empty($event_category_slug)) {
+			$event_category_slugs_array   = array_map('trim', explode(',', $event_category_slug));
+			$event_category_slugs_prepare = implode(', ', array_fill(0, count($event_category_slugs_array), '%s'));
+			return $wpdb->prepare(
+				" AND {$wpdb->terms}.slug IN ({$event_category_slugs_prepare}) ",
+				$event_category_slugs_array
+			);
+		}
+		return '';
+	}
+
+
+	/**
+	 * @param boolean $month
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_where_sql_for_event_list_month($month = null)
+	{
+		$SQL = '';
+		if (! empty($month)) {
+			$datetime_table = EEM_Datetime::instance()->table();
+			// event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
+			$SQL = " AND {$datetime_table}.DTT_EVT_start <= '";
+			$SQL .= date('Y-m-t 23:59:59', EEH_DTT_Helper::first_of_month_timestamp($month)) . "'";
+			// event end date is GREATER than the start of the month ( so nothing that ended before this month )
+			$SQL .= " AND {$datetime_table}.DTT_EVT_end >= '";
+			$SQL .= date('Y-m-01 0:0:00', EEH_DTT_Helper::first_of_month_timestamp($month)) . "' ";
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_orderby($SQL, WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			$SQL = EEH_Event_Query::posts_orderby_sql(
+				EEH_Event_Query::$_event_query_orderby,
+				EEH_Event_Query::$_event_query_sort
+			);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 *    posts_orderby_sql
+	 *    possible parameters:
+	 *    ID
+	 *    start_date
+	 *    end_date
+	 *    event_name
+	 *    category_slug
+	 *    ticket_start
+	 *    ticket_end
+	 *    venue_title
+	 *    city
+	 *    state
+	 *    **IMPORTANT**
+	 *    make sure to also send the $orderby_params array to the posts_join_for_orderby() method
+	 *    or else some of the table references below will result in MySQL errors
+	 *
+	 * @param array  $orderby_params
+	 * @param string $sort
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_orderby_sql(array $orderby_params = [], $sort = 'ASC')
+	{
+		global $wpdb;
+		$SQL     = '';
+		$counter = 0;
+		$sort    = in_array($sort, ['ASC', 'asc', 'DESC', 'desc'], true)
+			? strtoupper($sort)
+			: 'ASC';
+		// make sure 'orderby' is set in query params
+		if (! isset(self::$_query_params['orderby'])) {
+			self::$_query_params['orderby'] = [];
+		}
+		// loop thru $orderby_params (type cast as array)
+		foreach ($orderby_params as $orderby) {
+			// check if we have already added this param
+			if (isset(self::$_query_params['orderby'][ $orderby ])) {
+				// if so then remove from the $orderby_params so that the count() method below is accurate
+				unset($orderby_params[ $orderby ]);
+				// then bump ahead to the next param
+				continue;
+			}
+			// this will ad a comma depending on whether this is the first or last param
+			$glue = $counter === 0 || $counter === count($orderby_params) ? ' ' : ', ';
+			// ok what's we dealing with?
+			switch ($orderby) {
+				case 'id':
+				case 'ID':
+					$SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
+					break;
+				case 'end_date':
+					$SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
+					break;
+				case 'event_name':
+					$SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
+					break;
+				case 'category_slug':
+					$SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
+					break;
+				case 'ticket_start':
+					$SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
+					break;
+				case 'ticket_end':
+					$SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
+					break;
+				case 'venue_title':
+					$SQL .= $glue . 'venue_title ' . $sort;
+					break;
+				case 'city':
+					$SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
+					break;
+				case 'state':
+					$SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
+					break;
+				case 'start_date':
+				default:
+					$SQL .= $glue . ' event_start_date ' . $sort;
+					break;
+			}
+			// add to array of orderby params that have been added
+			self::$_query_params['orderby'][ $orderby ] = true;
+			$counter++;
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @return RequestInterface
+	 * @since   4.10.14.p
+	 */
+	private static function getRequest()
+	{
+		return LoaderFactory::getLoader()->getShared(RequestInterface::class);
+	}
 }

core/EE_Session.core.php

Spacing +53 added lines, -53 removed lines

@@ -246,22 +246,22 @@ 
         // but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
         // (which currently fires on the init hook at priority 9),
         // can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! apply_filters('FHEE_load_EE_Session', true)) {
+        if ( ! apply_filters('FHEE_load_EE_Session', true)) {
             return;
         }
         $this->session_start_handler = $session_start_handler;
         $this->session_lifespan = $lifespan;
         $this->request = $request;
-        if (! defined('ESPRESSO_SESSION')) {
+        if ( ! defined('ESPRESSO_SESSION')) {
             define('ESPRESSO_SESSION', true);
         }
         // retrieve session options from db
         $session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        if (! empty($session_settings)) {
+        if ( ! empty($session_settings)) {
             // cycle though existing session options
             foreach ($session_settings as $var_name => $session_setting) {
                 // set values for class properties
-                $var_name = '_' . $var_name;
+                $var_name = '_'.$var_name;
                 $this->{$var_name} = $session_setting;
             }
         }
@@ -322,7 +322,7 @@ 
     public function open_session()
     {
         // check for existing session and retrieve it from db
-        if (! $this->_espresso_session()) {
+        if ( ! $this->_espresso_session()) {
             // or just start a new one
             $this->_create_espresso_session();
         }
@@ -399,7 +399,7 @@ 
             EE_Session::SAVE_STATE_CLEAN,
             EE_Session::SAVE_STATE_DIRTY,
         ];
-        if (! in_array($save_state, $valid_save_states, true)) {
+        if ( ! in_array($save_state, $valid_save_states, true)) {
             $save_state = EE_Session::SAVE_STATE_DIRTY;
         }
         $this->save_state = $save_state;
@@ -417,9 +417,9 @@ 
         // set some defaults
         foreach ($this->_default_session_vars as $key => $default_var) {
             if (is_array($default_var)) {
-                $this->_session_data[ $key ] = array();
+                $this->_session_data[$key] = array();
             } else {
-                $this->_session_data[ $key ] = '';
+                $this->_session_data[$key] = '';
             }
         }
     }
@@ -555,8 +555,8 @@ 
             $this->reset_checkout();
             $this->reset_transaction();
         }
-        if (! empty($key)) {
-            return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
+        if ( ! empty($key)) {
+            return isset($this->_session_data[$key]) ? $this->_session_data[$key] : null;
         }
         return $this->_session_data;
     }
@@ -584,7 +584,7 @@ 
             return false;
         }
         foreach ($data as $key => $value) {
-            if (isset($this->_default_session_vars[ $key ])) {
+            if (isset($this->_default_session_vars[$key])) {
                 EE_Error::add_error(
                     sprintf(
                         esc_html__(
@@ -599,7 +599,7 @@ 
                 );
                 return false;
             }
-            $this->_session_data[ $key ] = $value;
+            $this->_session_data[$key] = $value;
             $this->setSaveState();
         }
         return true;
@@ -630,7 +630,7 @@ 
         $this->_user_agent = $this->request->userAgent();
         // now let's retrieve what's in the db
         $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
+        if ( ! empty($session_data)) {
             // get the current time in UTC
             $this->_time = $this->_time !== null ? $this->_time : time();
             // and reset the session expiration
@@ -641,7 +641,7 @@ 
             // set initial site access time and the session expiration
             $this->_set_init_access_and_expiration();
             // set referer
-            $this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = esc_attr(
+            $this->_session_data['pages_visited'][$this->_session_data['init_access']] = esc_attr(
                 $this->request->getServerParam('HTTP_REFERER')
             );
             // no previous session = go back and create one (on top of the data above)
@@ -679,7 +679,7 @@ 
      */
     protected function _retrieve_session_data()
     {
-        $ssn_key = EE_Session::session_id_prefix . $this->_sid;
+        $ssn_key = EE_Session::session_id_prefix.$this->_sid;
         try {
             // we're using WP's Transient API to store session data using the PHP session ID as the option name
             $session_data = $this->cache_storage->get($ssn_key, false);
@@ -688,7 +688,7 @@ 
             }
             if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
                 $hash_check = $this->cache_storage->get(
-                    EE_Session::hash_check_prefix . $this->_sid,
+                    EE_Session::hash_check_prefix.$this->_sid,
                     false
                 );
                 if ($hash_check && $hash_check !== md5($session_data)) {
@@ -698,7 +698,7 @@ 
                                 'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
                                 'event_espresso'
                             ),
-                            EE_Session::session_id_prefix . $this->_sid
+                            EE_Session::session_id_prefix.$this->_sid
                         ),
                         __FILE__,
                         __FUNCTION__,
@@ -712,17 +712,17 @@ 
             $row = $wpdb->get_row(
                 $wpdb->prepare(
                     "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                    '_transient_' . $ssn_key
+                    '_transient_'.$ssn_key
                 )
             );
             $session_data = is_object($row) ? $row->option_value : null;
             if ($session_data) {
                 $session_data = preg_replace_callback(
                     '!s:(d+):"(.*?)";!',
-                    function ($match) {
+                    function($match) {
                         return $match[1] === strlen($match[2])
                             ? $match[0]
-                            : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+                            : 's:'.strlen($match[2]).':"'.$match[2].'";';
                     },
                     $session_data
                 );
@@ -733,7 +733,7 @@ 
         $session_data = $this->encryption instanceof EE_Encryption
             ? $this->encryption->base64_string_decode($session_data)
             : $session_data;
-        if (! is_array($session_data)) {
+        if ( ! is_array($session_data)) {
             try {
                 $session_data = maybe_unserialize($session_data);
             } catch (Exception $e) {
@@ -747,21 +747,21 @@ 
                       . '</pre><br>'
                       . $this->find_serialize_error($session_data)
                     : '';
-                $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+                $this->cache_storage->delete(EE_Session::session_id_prefix.$this->_sid);
                 throw new InvalidSessionDataException($msg, 0, $e);
             }
         }
         // just a check to make sure the session array is indeed an array
-        if (! is_array($session_data)) {
+        if ( ! is_array($session_data)) {
             // no?!?! then something is wrong
             $msg = esc_html__(
                 'The session data is missing, invalid, or corrupted.',
                 'event_espresso'
             );
             $msg .= WP_DEBUG
-                ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+                ? '<br><pre>'.print_r($session_data, true).'</pre><br>'.$this->find_serialize_error($session_data)
                 : '';
-            $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+            $this->cache_storage->delete(EE_Session::session_id_prefix.$this->_sid);
             throw new InvalidSessionDataException($msg);
         }
         if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
@@ -787,7 +787,7 @@ 
         // check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
         $session_id = $this->request->requestParamIsSet('EESID')
             ? $this->request->getRequestParam('EESID')
-            : md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
+            : md5(session_id().get_current_blog_id().$this->_get_sid_salt());
         return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
     }
 
@@ -889,19 +889,19 @@ 
                     $page_visit = $this->_get_page_visit();
                     if ($page_visit) {
                         // set pages visited where the first will be the http referrer
-                        $this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
+                        $this->_session_data['pages_visited'][$this->_time] = $page_visit;
                         // we'll only save the last 10 page visits.
                         $session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
                     }
                     break;
                 default:
                     // carry any other data over
-                    $session_data[ $key ] = $this->_session_data[ $key ];
+                    $session_data[$key] = $this->_session_data[$key];
             }
         }
         $this->_session_data = $session_data;
         // creating a new session does not require saving to the db just yet
-        if (! $new_session) {
+        if ( ! $new_session) {
             // ready? let's save
             if ($this->_save_session_to_db()) {
                 return true;
@@ -979,7 +979,7 @@ 
         }
         $transaction = $this->transaction();
         if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
+            if ( ! $transaction->ID()) {
                 $transaction->save();
             }
             $this->_session_data['transaction'] = $transaction->ID();
@@ -993,14 +993,14 @@ 
         // maybe save hash check
         if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
             $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
+                EE_Session::hash_check_prefix.$this->_sid,
                 md5($session_data),
                 $this->session_lifespan->inSeconds()
             );
         }
         // we're using the Transient API for storing session data,
         $saved = $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
+            EE_Session::session_id_prefix.$this->_sid,
             $session_data,
             $this->session_lifespan->inSeconds()
         );
@@ -1015,7 +1015,7 @@ 
      */
     public function _get_page_visit()
     {
-        $page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+        $page_visit = home_url('/').'wp-admin/admin-ajax.php';
         // check for request url
         if ($this->request->serverParamIsSet('REQUEST_URI')) {
             $page_id = '?';
@@ -1027,14 +1027,14 @@ 
             // check for page_id in SERVER REQUEST
             if ($this->request->requestParamIsSet('page_id')) {
                 // rebuild $e_reg without any of the extra parameters
-                $page_id .= 'page_id=' . $this->request->getRequestParam('page_id', 0, 'int') . '&amp;';
+                $page_id .= 'page_id='.$this->request->getRequestParam('page_id', 0, 'int').'&amp;';
             }
             // check for $e_reg in SERVER REQUEST
             if ($this->request->requestParamIsSet('ee')) {
                 // rebuild $e_reg without any of the extra parameters
-                $e_reg = 'ee=' . $this->request->getRequestParam('ee');
+                $e_reg = 'ee='.$this->request->getRequestParam('ee');
             }
-            $page_visit = esc_url(rtrim($http_host . $request_uri . $page_id . $e_reg, '?'));
+            $page_visit = esc_url(rtrim($http_host.$request_uri.$page_id.$e_reg, '?'));
         }
         return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
     }
@@ -1071,7 +1071,7 @@ 
 // <span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/>
 // <span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b>
 // </h3>';
-        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
+        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : '.$class.'::'.$function.'()');
         $this->reset_cart();
         $this->reset_checkout();
         $this->reset_transaction();
@@ -1094,7 +1094,7 @@ 
     public function reset_data($data_to_reset = array(), $show_all_notices = false)
     {
         // if $data_to_reset is not in an array, then put it in one
-        if (! is_array($data_to_reset)) {
+        if ( ! is_array($data_to_reset)) {
             $data_to_reset = array($data_to_reset);
         }
         // nothing ??? go home!
@@ -1114,11 +1114,11 @@ 
         // since $data_to_reset is an array, cycle through the values
         foreach ($data_to_reset as $reset) {
             // first check to make sure it is a valid session var
-            if (isset($this->_session_data[ $reset ])) {
+            if (isset($this->_session_data[$reset])) {
                 // then check to make sure it is not a default var
-                if (! array_key_exists($reset, $this->_default_session_vars)) {
+                if ( ! array_key_exists($reset, $this->_default_session_vars)) {
                     // remove session var
-                    unset($this->_session_data[ $reset ]);
+                    unset($this->_session_data[$reset]);
                     $this->setSaveState();
                     if ($show_all_notices) {
                         EE_Error::add_success(
@@ -1221,7 +1221,7 @@ 
             // or use that for the new transient cleanup query limit
             add_filter(
                 'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                function () use ($expired_session_transient_delete_query_limit) {
+                function() use ($expired_session_transient_delete_query_limit) {
                     return $expired_session_transient_delete_query_limit;
                 }
             );
@@ -1239,7 +1239,7 @@ 
         $error = '<pre>';
         $data2 = preg_replace_callback(
             '!s:(\d+):"(.*?)";!',
-            function ($match) {
+            function($match) {
                 return ($match[1] === strlen($match[2]))
                     ? $match[0]
                     : 's:'
@@ -1251,13 +1251,13 @@ 
             $data1
         );
         $max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
+        $error .= $data1.PHP_EOL;
+        $error .= $data2.PHP_EOL;
         for ($i = 0; $i < $max; $i++) {
-            if (@$data1[ $i ] !== @$data2[ $i ]) {
-                $error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-                $error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
-                $error .= "\t-> Line Number = $i" . PHP_EOL;
+            if (@$data1[$i] !== @$data2[$i]) {
+                $error .= 'Difference '.@$data1[$i].' != '.@$data2[$i].PHP_EOL;
+                $error .= "\t-> ORD number ".ord(@$data1[$i]).' != '.ord(@$data2[$i]).PHP_EOL;
+                $error .= "\t-> Line Number = $i".PHP_EOL;
                 $start = ($i - 20);
                 $start = ($start < 0) ? 0 : $start;
                 $length = 40;
@@ -1272,7 +1272,7 @@ 
                 $error .= "\t-> Section Data1  = ";
                 $error .= substr_replace(
                     substr($data1, $start, $length),
-                    "<b style=\"color:green\">{$data1[ $i ]}</b>",
+                    "<b style=\"color:green\">{$data1[$i]}</b>",
                     $rpoint,
                     $rlength
                 );
@@ -1280,7 +1280,7 @@ 
                 $error .= "\t-> Section Data2  = ";
                 $error .= substr_replace(
                     substr($data2, $start, $length),
-                    "<b style=\"color:red\">{$data2[ $i ]}</b>",
+                    "<b style=\"color:red\">{$data2[$i]}</b>",
                     $rpoint,
                     $rlength
                 );
@@ -1311,7 +1311,7 @@ 
     public function garbageCollection()
     {
         // only perform during regular requests if last garbage collection was over an hour ago
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
             $this->_last_gc = time();
             $this->updateSessionSettings(array('last_gc' => $this->_last_gc));
             /** @type WPDB $wpdb */
@@ -1346,7 +1346,7 @@ 
                 // AND option_value < 1508368198 LIMIT 50
                 $expired_sessions = $wpdb->get_col($SQL);
                 // valid results?
-                if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
+                if ( ! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
                     $this->cache_storage->deleteMany($expired_sessions, true);
                 }
             }

Indentation +1312 added lines, -1312 removed lines

@@ -23,1310 +23,1310 @@ 
  */
 class EE_Session implements SessionIdentifierInterface
 {
-    const session_id_prefix = 'ee_ssn_';
-
-    const hash_check_prefix = 'ee_shc_';
-
-    const OPTION_NAME_SETTINGS = 'ee_session_settings';
-
-    const STATUS_CLOSED = 0;
-
-    const STATUS_OPEN = 1;
-
-    const SAVE_STATE_CLEAN = 'clean';
-    const SAVE_STATE_DIRTY = 'dirty';
-
-
-    /**
-     * instance of the EE_Session object
-     *
-     * @var EE_Session
-     */
-    private static $_instance;
-
-    /**
-     * @var CacheStorageInterface $cache_storage
-     */
-    protected $cache_storage;
-
-    /**
-     * @var EE_Encryption $encryption
-     */
-    protected $encryption;
-
-    /**
-     * @var SessionStartHandler $session_start_handler
-     */
-    protected $session_start_handler;
-
-    /**
-     * the session id
-     *
-     * @var string
-     */
-    private $_sid;
-
-    /**
-     * session id salt
-     *
-     * @var string
-     */
-    private $_sid_salt;
-
-    /**
-     * session data
-     *
-     * @var array
-     */
-    private $_session_data = array();
-
-    /**
-     * how long an EE session lasts
-     * default session lifespan of 1 hour (for not so instant IPNs)
-     *
-     * @var SessionLifespan $session_lifespan
-     */
-    private $session_lifespan;
-
-    /**
-     * session expiration time as Unix timestamp in GMT
-     *
-     * @var int
-     */
-    private $_expiration;
-
-    /**
-     * whether or not session has expired at some point
-     *
-     * @var boolean
-     */
-    private $_expired = false;
-
-    /**
-     * current time as Unix timestamp in GMT
-     *
-     * @var int
-     */
-    private $_time;
-
-    /**
-     * whether to encrypt session data
-     *
-     * @var bool
-     */
-    private $_use_encryption;
-
-    /**
-     * well... according to the server...
-     *
-     * @var null
-     */
-    private $_user_agent;
-
-    /**
-     * do you really trust the server ?
-     *
-     * @var null
-     */
-    private $_ip_address;
-
-    /**
-     * current WP user_id
-     *
-     * @var null
-     */
-    private $_wp_user_id;
-
-    /**
-     * array for defining default session vars
-     *
-     * @var array
-     */
-    private $_default_session_vars = array(
-        'id'            => null,
-        'user_id'       => null,
-        'ip_address'    => null,
-        'user_agent'    => null,
-        'init_access'   => null,
-        'last_access'   => null,
-        'expiration'    => null,
-        'pages_visited' => array(),
-    );
-
-    /**
-     * timestamp for when last garbage collection cycle was performed
-     *
-     * @var int $_last_gc
-     */
-    private $_last_gc;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * whether session is active or not
-     *
-     * @var int $status
-     */
-    private $status = EE_Session::STATUS_CLOSED;
-
-    /**
-     * whether session data has changed therefore requiring a session save
-     *
-     * @var string $save_state
-     */
-    private $save_state = EE_Session::SAVE_STATE_CLEAN;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param CacheStorageInterface $cache_storage
-     * @param SessionLifespan|null  $lifespan
-     * @param RequestInterface      $request
-     * @param SessionStartHandler   $session_start_handler
-     * @param EE_Encryption         $encryption
-     * @return EE_Session
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function instance(
-        CacheStorageInterface $cache_storage = null,
-        SessionLifespan $lifespan = null,
-        RequestInterface $request = null,
-        SessionStartHandler $session_start_handler = null,
-        EE_Encryption $encryption = null
-    ) {
-        // check if class object is instantiated
-        // session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
-        // add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (
-            ! self::$_instance instanceof EE_Session
-            && $cache_storage instanceof CacheStorageInterface
-            && $lifespan instanceof SessionLifespan
-            && $request instanceof RequestInterface
-            && $session_start_handler instanceof SessionStartHandler
-            && apply_filters('FHEE_load_EE_Session', true)
-        ) {
-            self::$_instance = new self(
-                $cache_storage,
-                $lifespan,
-                $request,
-                $session_start_handler,
-                $encryption
-            );
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @param CacheStorageInterface $cache_storage
-     * @param SessionLifespan       $lifespan
-     * @param RequestInterface      $request
-     * @param SessionStartHandler   $session_start_handler
-     * @param EE_Encryption         $encryption
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function __construct(
-        CacheStorageInterface $cache_storage,
-        SessionLifespan $lifespan,
-        RequestInterface $request,
-        SessionStartHandler $session_start_handler,
-        EE_Encryption $encryption = null
-    ) {
-        // session loading is turned ON by default,
-        // but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
-        // (which currently fires on the init hook at priority 9),
-        // can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! apply_filters('FHEE_load_EE_Session', true)) {
-            return;
-        }
-        $this->session_start_handler = $session_start_handler;
-        $this->session_lifespan = $lifespan;
-        $this->request = $request;
-        if (! defined('ESPRESSO_SESSION')) {
-            define('ESPRESSO_SESSION', true);
-        }
-        // retrieve session options from db
-        $session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        if (! empty($session_settings)) {
-            // cycle though existing session options
-            foreach ($session_settings as $var_name => $session_setting) {
-                // set values for class properties
-                $var_name = '_' . $var_name;
-                $this->{$var_name} = $session_setting;
-            }
-        }
-        $this->cache_storage = $cache_storage;
-        // are we using encryption?
-        $this->_use_encryption = $encryption instanceof EE_Encryption
-                                 && EE_Registry::instance()->CFG->admin->encode_session_data();
-        // encrypt data via: $this->encryption->encrypt();
-        $this->encryption = $encryption;
-        // filter hook allows outside functions/classes/plugins to change default empty cart
-        $extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
-        array_merge($this->_default_session_vars, $extra_default_session_vars);
-        // apply default session vars
-        $this->_set_defaults();
-        add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
-        // check request for 'clear_session' param
-        add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
-        // once everything is all said and done,
-        add_action('shutdown', array($this, 'update'), 100);
-        add_action('shutdown', array($this, 'garbageCollection'), 1000);
-        $this->configure_garbage_collection_filters();
-    }
-
-
-    /**
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function isLoadedAndActive()
-    {
-        return did_action('AHEE__EE_System__core_loaded_and_ready')
-               && EE_Session::instance() instanceof EE_Session
-               && EE_Session::instance()->isActive();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActive()
-    {
-        return $this->status === EE_Session::STATUS_OPEN;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function open_session()
-    {
-        // check for existing session and retrieve it from db
-        if (! $this->_espresso_session()) {
-            // or just start a new one
-            $this->_create_espresso_session();
-        }
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function expired()
-    {
-        return $this->_expired;
-    }
-
-
-    /**
-     * @return void
-     */
-    public function reset_expired()
-    {
-        $this->_expired = false;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function expiration()
-    {
-        return $this->_expiration;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function extension()
-    {
-        return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS);
-    }
-
-
-    /**
-     * @param int $time number of seconds to add to session expiration
-     */
-    public function extend_expiration($time = 0)
-    {
-        $time = $time ? $time : $this->extension();
-        $this->_expiration += absint($time);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function lifespan()
-    {
-        return $this->session_lifespan->inSeconds();
-    }
-
-
-    /**
-     * Marks whether the session data has been updated or not.
-     * Valid options are:
-     *      EE_Session::SAVE_STATE_CLEAN - session data remains unchanged and updating is not necessary
-     *      EE_Session::SAVE_STATE_DIRTY - session data has changed since last save and needs to be updated
-     * default value is EE_Session::SAVE_STATE_DIRTY
-     *
-     * @param string $save_state
-     */
-    public function setSaveState($save_state = EE_Session::SAVE_STATE_DIRTY)
-    {
-        $valid_save_states = [
-            EE_Session::SAVE_STATE_CLEAN,
-            EE_Session::SAVE_STATE_DIRTY,
-        ];
-        if (! in_array($save_state, $valid_save_states, true)) {
-            $save_state = EE_Session::SAVE_STATE_DIRTY;
-        }
-        $this->save_state = $save_state;
-    }
-
-
-
-    /**
-     * This just sets some defaults for the _session data property
-     *
-     * @return void
-     */
-    private function _set_defaults()
-    {
-        // set some defaults
-        foreach ($this->_default_session_vars as $key => $default_var) {
-            if (is_array($default_var)) {
-                $this->_session_data[ $key ] = array();
-            } else {
-                $this->_session_data[ $key ] = '';
-            }
-        }
-    }
-
-
-    /**
-     * @retrieve  session data
-     * @return    string
-     */
-    public function id()
-    {
-        return $this->_sid;
-    }
-
-
-    /**
-     * @param \EE_Cart $cart
-     * @return bool
-     */
-    public function set_cart(EE_Cart $cart)
-    {
-        $this->_session_data['cart'] = $cart;
-        $this->setSaveState();
-        return true;
-    }
-
-
-    /**
-     * reset_cart
-     */
-    public function reset_cart()
-    {
-        do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
-        $this->_session_data['cart'] = null;
-        $this->setSaveState();
-    }
-
-
-    /**
-     * @return \EE_Cart
-     */
-    public function cart()
-    {
-        return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
-            ? $this->_session_data['cart']
-            : null;
-    }
-
-
-    /**
-     * @param \EE_Checkout $checkout
-     * @return bool
-     */
-    public function set_checkout(EE_Checkout $checkout)
-    {
-        $this->_session_data['checkout'] = $checkout;
-        $this->setSaveState();
-        return true;
-    }
-
-
-    /**
-     * reset_checkout
-     */
-    public function reset_checkout()
-    {
-        do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
-        $this->_session_data['checkout'] = null;
-        $this->setSaveState();
-    }
-
-
-    /**
-     * @return \EE_Checkout
-     */
-    public function checkout()
-    {
-        return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
-            ? $this->_session_data['checkout']
-            : null;
-    }
-
-
-    /**
-     * @param \EE_Transaction $transaction
-     * @return bool
-     * @throws EE_Error
-     */
-    public function set_transaction(EE_Transaction $transaction)
-    {
-        // first remove the session from the transaction before we save the transaction in the session
-        $transaction->set_txn_session_data(null);
-        $this->_session_data['transaction'] = $transaction;
-        $this->setSaveState();
-        return true;
-    }
-
-
-    /**
-     * reset_transaction
-     */
-    public function reset_transaction()
-    {
-        do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
-        $this->_session_data['transaction'] = null;
-        $this->setSaveState();
-    }
-
-
-    /**
-     * @return \EE_Transaction
-     */
-    public function transaction()
-    {
-        return isset($this->_session_data['transaction'])
-               && $this->_session_data['transaction'] instanceof EE_Transaction
-            ? $this->_session_data['transaction']
-            : null;
-    }
-
-
-    /**
-     * retrieve session data
-     *
-     * @param null $key
-     * @param bool $reset_cache
-     * @return array
-     */
-    public function get_session_data($key = null, $reset_cache = false)
-    {
-        if ($reset_cache) {
-            $this->reset_cart();
-            $this->reset_checkout();
-            $this->reset_transaction();
-        }
-        if (! empty($key)) {
-            return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
-        }
-        return $this->_session_data;
-    }
-
-
-    /**
-     * Returns TRUE on success, FALSE on fail
-     *
-     * @param array $data
-     * @return bool
-     */
-    public function set_session_data($data)
-    {
-        // nothing ??? bad data ??? go home!
-        if (empty($data) || ! is_array($data)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'No session data or invalid session data was provided.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        foreach ($data as $key => $value) {
-            if (isset($this->_default_session_vars[ $key ])) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'Sorry! %s is a default session datum and can not be reset.',
-                            'event_espresso'
-                        ),
-                        $key
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            $this->_session_data[ $key ] = $value;
-            $this->setSaveState();
-        }
-        return true;
-    }
-
-
-    /**
-     * @initiate session
-     * @return bool TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    private function _espresso_session()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->session_start_handler->startSession();
-        $this->status = EE_Session::STATUS_OPEN;
-        // get our modified session ID
-        $this->_sid = $this->_generate_session_id();
-        // and the visitors IP
-        $this->_ip_address = $this->request->ipAddress();
-        // set the "user agent"
-        $this->_user_agent = $this->request->userAgent();
-        // now let's retrieve what's in the db
-        $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
-            // get the current time in UTC
-            $this->_time = $this->_time !== null ? $this->_time : time();
-            // and reset the session expiration
-            $this->_expiration = isset($session_data['expiration'])
-                ? $session_data['expiration']
-                : $this->_time + $this->session_lifespan->inSeconds();
-        } else {
-            // set initial site access time and the session expiration
-            $this->_set_init_access_and_expiration();
-            // set referer
-            $this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = esc_attr(
-                $this->request->getServerParam('HTTP_REFERER')
-            );
-            // no previous session = go back and create one (on top of the data above)
-            return false;
-        }
-        // now the user agent
-        if ($session_data['user_agent'] !== $this->_user_agent) {
-            return false;
-        }
-        // wait a minute... how old are you?
-        if ($this->_time > $this->_expiration) {
-            // yer too old fer me!
-            $this->_expired = true;
-            // wipe out everything that isn't a default session datum
-            $this->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // make event espresso session data available to plugin
-        $this->_session_data = array_merge($this->_session_data, $session_data);
-        return true;
-    }
-
-
-    /**
-     * _get_session_data
-     * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup
-     * databases
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidSessionDataException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    protected function _retrieve_session_data()
-    {
-        $ssn_key = EE_Session::session_id_prefix . $this->_sid;
-        try {
-            // we're using WP's Transient API to store session data using the PHP session ID as the option name
-            $session_data = $this->cache_storage->get($ssn_key, false);
-            if (empty($session_data)) {
-                return array();
-            }
-            if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-                $hash_check = $this->cache_storage->get(
-                    EE_Session::hash_check_prefix . $this->_sid,
-                    false
-                );
-                if ($hash_check && $hash_check !== md5($session_data)) {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
-                                'event_espresso'
-                            ),
-                            EE_Session::session_id_prefix . $this->_sid
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        } catch (Exception $e) {
-            // let's just eat that error for now and attempt to correct any corrupted data
-            global $wpdb;
-            $row = $wpdb->get_row(
-                $wpdb->prepare(
-                    "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                    '_transient_' . $ssn_key
-                )
-            );
-            $session_data = is_object($row) ? $row->option_value : null;
-            if ($session_data) {
-                $session_data = preg_replace_callback(
-                    '!s:(d+):"(.*?)";!',
-                    function ($match) {
-                        return $match[1] === strlen($match[2])
-                            ? $match[0]
-                            : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
-                    },
-                    $session_data
-                );
-            }
-            $session_data = maybe_unserialize($session_data);
-        }
-        // in case the data is encoded... try to decode it
-        $session_data = $this->encryption instanceof EE_Encryption
-            ? $this->encryption->base64_string_decode($session_data)
-            : $session_data;
-        if (! is_array($session_data)) {
-            try {
-                $session_data = maybe_unserialize($session_data);
-            } catch (Exception $e) {
-                $msg = esc_html__(
-                    'An error occurred while attempting to unserialize the session data.',
-                    'event_espresso'
-                );
-                $msg .= WP_DEBUG
-                    ? '<br><pre>'
-                      . print_r($session_data, true)
-                      . '</pre><br>'
-                      . $this->find_serialize_error($session_data)
-                    : '';
-                $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
-                throw new InvalidSessionDataException($msg, 0, $e);
-            }
-        }
-        // just a check to make sure the session array is indeed an array
-        if (! is_array($session_data)) {
-            // no?!?! then something is wrong
-            $msg = esc_html__(
-                'The session data is missing, invalid, or corrupted.',
-                'event_espresso'
-            );
-            $msg .= WP_DEBUG
-                ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
-                : '';
-            $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
-            throw new InvalidSessionDataException($msg);
-        }
-        if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
-            $session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
-                $session_data['transaction']
-            );
-        }
-        return $session_data;
-    }
-
-
-    /**
-     * _generate_session_id
-     * Retrieves the PHP session id either directly from the PHP session,
-     * or from the request array if it was passed in from an AJAX request.
-     * The session id is then salted and hashed (mmm sounds tasty)
-     * so that it can be safely used as a request param
-     *
-     * @return string
-     */
-    protected function _generate_session_id()
-    {
-        // check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
-        $session_id = $this->request->requestParamIsSet('EESID')
-            ? $this->request->getRequestParam('EESID')
-            : md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
-        return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
-    }
-
-
-    /**
-     * _get_sid_salt
-     *
-     * @return string
-     */
-    protected function _get_sid_salt()
-    {
-        // was session id salt already saved to db ?
-        if (empty($this->_sid_salt)) {
-            // no?  then maybe use WP defined constant
-            if (defined('AUTH_SALT')) {
-                $this->_sid_salt = AUTH_SALT;
-            }
-            // if salt doesn't exist or is too short
-            if (strlen($this->_sid_salt) < 32) {
-                // create a new one
-                $this->_sid_salt = wp_generate_password(64);
-            }
-            // and save it as a permanent session setting
-            $this->updateSessionSettings(array('sid_salt' => $this->_sid_salt));
-        }
-        return $this->_sid_salt;
-    }
-
-
-    /**
-     * _set_init_access_and_expiration
-     *
-     * @return void
-     */
-    protected function _set_init_access_and_expiration()
-    {
-        $this->_time = time();
-        $this->_expiration = $this->_time + $this->session_lifespan->inSeconds();
-        // set initial site access time
-        $this->_session_data['init_access'] = $this->_time;
-        // and the session expiration
-        $this->_session_data['expiration'] = $this->_expiration;
-    }
-
-
-    /**
-     * @update session data  prior to saving to the db
-     * @param bool $new_session
-     * @return bool TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function update($new_session = false)
-    {
-        $this->_session_data = is_array($this->_session_data) && isset($this->_session_data['id'])
-            ? $this->_session_data
-            : array();
-        if (empty($this->_session_data)) {
-            $this->_set_defaults();
-        }
-        $session_data = array();
-        foreach ($this->_session_data as $key => $value) {
-            switch ($key) {
-                case 'id':
-                    // session ID
-                    $session_data['id'] = $this->_sid;
-                    break;
-                case 'ip_address':
-                    // visitor ip address
-                    $session_data['ip_address'] = $this->request->ipAddress();
-                    break;
-                case 'user_agent':
-                    // visitor user_agent
-                    $session_data['user_agent'] = $this->_user_agent;
-                    break;
-                case 'init_access':
-                    $session_data['init_access'] = absint($value);
-                    break;
-                case 'last_access':
-                    // current access time
-                    $session_data['last_access'] = $this->_time;
-                    break;
-                case 'expiration':
-                    // when the session expires
-                    $session_data['expiration'] = ! empty($this->_expiration)
-                        ? $this->_expiration
-                        : $session_data['init_access'] + $this->session_lifespan->inSeconds();
-                    break;
-                case 'user_id':
-                    // current user if logged in
-                    $session_data['user_id'] = $this->_wp_user_id();
-                    break;
-                case 'pages_visited':
-                    $page_visit = $this->_get_page_visit();
-                    if ($page_visit) {
-                        // set pages visited where the first will be the http referrer
-                        $this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
-                        // we'll only save the last 10 page visits.
-                        $session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
-                    }
-                    break;
-                default:
-                    // carry any other data over
-                    $session_data[ $key ] = $this->_session_data[ $key ];
-            }
-        }
-        $this->_session_data = $session_data;
-        // creating a new session does not require saving to the db just yet
-        if (! $new_session) {
-            // ready? let's save
-            if ($this->_save_session_to_db()) {
-                return true;
-            }
-            return false;
-        }
-        // meh, why not?
-        return true;
-    }
-
-
-    /**
-     * @create session data array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _create_espresso_session()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
-        // use the update function for now with $new_session arg set to TRUE
-        $this->update(true);
-    }
-
-    /**
-     * Detects if there is anything worth saving in the session (eg the cart is a good one, notices are pretty good
-     * too). This is used when determining if we want to save the session or not.
-     * @since 4.9.67.p
-     * @return bool
-     */
-    private function sessionHasStuffWorthSaving()
-    {
-        return $this->save_state === EE_Session::SAVE_STATE_DIRTY
-               // we may want to eventually remove the following
-               // on the assumption that the above check is enough
-               || $this->cart() instanceof EE_Cart
-               || (
-                   isset($this->_session_data['ee_notices'])
-                   && (
-                       ! empty($this->_session_data['ee_notices']['attention'])
-                       || ! empty($this->_session_data['ee_notices']['errors'])
-                       || ! empty($this->_session_data['ee_notices']['success'])
-                   )
-               );
-    }
-
-
-    /**
-     * _save_session_to_db
-     *
-     * @param bool $clear_session
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _save_session_to_db($clear_session = false)
-    {
-        // don't save sessions for crawlers
-        // and unless we're deleting the session data, don't save anything if there isn't a cart
-        if (
-            $this->request->isBot()
-            || (
-                ! $clear_session
-                && ! $this->sessionHasStuffWorthSaving()
-                && apply_filters('FHEE__EE_Session___save_session_to_db__abort_session_save', true)
-            )
-        ) {
-            return false;
-        }
-        $transaction = $this->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
-                $transaction->save();
-            }
-            $this->_session_data['transaction'] = $transaction->ID();
-        }
-        // then serialize all of our session data
-        $session_data = serialize($this->_session_data);
-        // do we need to also encode it to avoid corrupted data when saved to the db?
-        $session_data = $this->_use_encryption
-            ? $this->encryption->base64_string_encode($session_data)
-            : $session_data;
-        // maybe save hash check
-        if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-            $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
-                md5($session_data),
-                $this->session_lifespan->inSeconds()
-            );
-        }
-        // we're using the Transient API for storing session data,
-        $saved = $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
-            $session_data,
-            $this->session_lifespan->inSeconds()
-        );
-        $this->setSaveState(EE_Session::SAVE_STATE_CLEAN);
-        return $saved;
-    }
-
-
-    /**
-     * @get    the full page request the visitor is accessing
-     * @return string
-     */
-    public function _get_page_visit()
-    {
-        $page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
-        // check for request url
-        if ($this->request->serverParamIsSet('REQUEST_URI')) {
-            $page_id = '?';
-            $e_reg = '';
-            $request_uri = $this->request->getServerParam('REQUEST_URI');
-            $ru_bits = explode('?', $request_uri);
-            $request_uri = $ru_bits[0];
-            $http_host = $this->request->getServerParam('HTTP_HOST');
-            // check for page_id in SERVER REQUEST
-            if ($this->request->requestParamIsSet('page_id')) {
-                // rebuild $e_reg without any of the extra parameters
-                $page_id .= 'page_id=' . $this->request->getRequestParam('page_id', 0, 'int') . '&amp;';
-            }
-            // check for $e_reg in SERVER REQUEST
-            if ($this->request->requestParamIsSet('ee')) {
-                // rebuild $e_reg without any of the extra parameters
-                $e_reg = 'ee=' . $this->request->getRequestParam('ee');
-            }
-            $page_visit = esc_url(rtrim($http_host . $request_uri . $page_id . $e_reg, '?'));
-        }
-        return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
-    }
-
-
-    /**
-     * @the    current wp user id
-     * @return int
-     */
-    public function _wp_user_id()
-    {
-        // if I need to explain the following lines of code, then you shouldn't be looking at this!
-        $this->_wp_user_id = get_current_user_id();
-        return $this->_wp_user_id;
-    }
-
-
-    /**
-     * Clear EE_Session data
-     *
-     * @param string $class
-     * @param string $function
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function clear_session($class = '', $function = '')
-    {
+	const session_id_prefix = 'ee_ssn_';
+
+	const hash_check_prefix = 'ee_shc_';
+
+	const OPTION_NAME_SETTINGS = 'ee_session_settings';
+
+	const STATUS_CLOSED = 0;
+
+	const STATUS_OPEN = 1;
+
+	const SAVE_STATE_CLEAN = 'clean';
+	const SAVE_STATE_DIRTY = 'dirty';
+
+
+	/**
+	 * instance of the EE_Session object
+	 *
+	 * @var EE_Session
+	 */
+	private static $_instance;
+
+	/**
+	 * @var CacheStorageInterface $cache_storage
+	 */
+	protected $cache_storage;
+
+	/**
+	 * @var EE_Encryption $encryption
+	 */
+	protected $encryption;
+
+	/**
+	 * @var SessionStartHandler $session_start_handler
+	 */
+	protected $session_start_handler;
+
+	/**
+	 * the session id
+	 *
+	 * @var string
+	 */
+	private $_sid;
+
+	/**
+	 * session id salt
+	 *
+	 * @var string
+	 */
+	private $_sid_salt;
+
+	/**
+	 * session data
+	 *
+	 * @var array
+	 */
+	private $_session_data = array();
+
+	/**
+	 * how long an EE session lasts
+	 * default session lifespan of 1 hour (for not so instant IPNs)
+	 *
+	 * @var SessionLifespan $session_lifespan
+	 */
+	private $session_lifespan;
+
+	/**
+	 * session expiration time as Unix timestamp in GMT
+	 *
+	 * @var int
+	 */
+	private $_expiration;
+
+	/**
+	 * whether or not session has expired at some point
+	 *
+	 * @var boolean
+	 */
+	private $_expired = false;
+
+	/**
+	 * current time as Unix timestamp in GMT
+	 *
+	 * @var int
+	 */
+	private $_time;
+
+	/**
+	 * whether to encrypt session data
+	 *
+	 * @var bool
+	 */
+	private $_use_encryption;
+
+	/**
+	 * well... according to the server...
+	 *
+	 * @var null
+	 */
+	private $_user_agent;
+
+	/**
+	 * do you really trust the server ?
+	 *
+	 * @var null
+	 */
+	private $_ip_address;
+
+	/**
+	 * current WP user_id
+	 *
+	 * @var null
+	 */
+	private $_wp_user_id;
+
+	/**
+	 * array for defining default session vars
+	 *
+	 * @var array
+	 */
+	private $_default_session_vars = array(
+		'id'            => null,
+		'user_id'       => null,
+		'ip_address'    => null,
+		'user_agent'    => null,
+		'init_access'   => null,
+		'last_access'   => null,
+		'expiration'    => null,
+		'pages_visited' => array(),
+	);
+
+	/**
+	 * timestamp for when last garbage collection cycle was performed
+	 *
+	 * @var int $_last_gc
+	 */
+	private $_last_gc;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * whether session is active or not
+	 *
+	 * @var int $status
+	 */
+	private $status = EE_Session::STATUS_CLOSED;
+
+	/**
+	 * whether session data has changed therefore requiring a session save
+	 *
+	 * @var string $save_state
+	 */
+	private $save_state = EE_Session::SAVE_STATE_CLEAN;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param CacheStorageInterface $cache_storage
+	 * @param SessionLifespan|null  $lifespan
+	 * @param RequestInterface      $request
+	 * @param SessionStartHandler   $session_start_handler
+	 * @param EE_Encryption         $encryption
+	 * @return EE_Session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function instance(
+		CacheStorageInterface $cache_storage = null,
+		SessionLifespan $lifespan = null,
+		RequestInterface $request = null,
+		SessionStartHandler $session_start_handler = null,
+		EE_Encryption $encryption = null
+	) {
+		// check if class object is instantiated
+		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
+		// add_filter( 'FHEE_load_EE_Session', '__return_false' );
+		if (
+			! self::$_instance instanceof EE_Session
+			&& $cache_storage instanceof CacheStorageInterface
+			&& $lifespan instanceof SessionLifespan
+			&& $request instanceof RequestInterface
+			&& $session_start_handler instanceof SessionStartHandler
+			&& apply_filters('FHEE_load_EE_Session', true)
+		) {
+			self::$_instance = new self(
+				$cache_storage,
+				$lifespan,
+				$request,
+				$session_start_handler,
+				$encryption
+			);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @param CacheStorageInterface $cache_storage
+	 * @param SessionLifespan       $lifespan
+	 * @param RequestInterface      $request
+	 * @param SessionStartHandler   $session_start_handler
+	 * @param EE_Encryption         $encryption
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function __construct(
+		CacheStorageInterface $cache_storage,
+		SessionLifespan $lifespan,
+		RequestInterface $request,
+		SessionStartHandler $session_start_handler,
+		EE_Encryption $encryption = null
+	) {
+		// session loading is turned ON by default,
+		// but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
+		// (which currently fires on the init hook at priority 9),
+		// can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
+		if (! apply_filters('FHEE_load_EE_Session', true)) {
+			return;
+		}
+		$this->session_start_handler = $session_start_handler;
+		$this->session_lifespan = $lifespan;
+		$this->request = $request;
+		if (! defined('ESPRESSO_SESSION')) {
+			define('ESPRESSO_SESSION', true);
+		}
+		// retrieve session options from db
+		$session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
+		if (! empty($session_settings)) {
+			// cycle though existing session options
+			foreach ($session_settings as $var_name => $session_setting) {
+				// set values for class properties
+				$var_name = '_' . $var_name;
+				$this->{$var_name} = $session_setting;
+			}
+		}
+		$this->cache_storage = $cache_storage;
+		// are we using encryption?
+		$this->_use_encryption = $encryption instanceof EE_Encryption
+								 && EE_Registry::instance()->CFG->admin->encode_session_data();
+		// encrypt data via: $this->encryption->encrypt();
+		$this->encryption = $encryption;
+		// filter hook allows outside functions/classes/plugins to change default empty cart
+		$extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
+		array_merge($this->_default_session_vars, $extra_default_session_vars);
+		// apply default session vars
+		$this->_set_defaults();
+		add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
+		// check request for 'clear_session' param
+		add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
+		// once everything is all said and done,
+		add_action('shutdown', array($this, 'update'), 100);
+		add_action('shutdown', array($this, 'garbageCollection'), 1000);
+		$this->configure_garbage_collection_filters();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function isLoadedAndActive()
+	{
+		return did_action('AHEE__EE_System__core_loaded_and_ready')
+			   && EE_Session::instance() instanceof EE_Session
+			   && EE_Session::instance()->isActive();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActive()
+	{
+		return $this->status === EE_Session::STATUS_OPEN;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function open_session()
+	{
+		// check for existing session and retrieve it from db
+		if (! $this->_espresso_session()) {
+			// or just start a new one
+			$this->_create_espresso_session();
+		}
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function expired()
+	{
+		return $this->_expired;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function reset_expired()
+	{
+		$this->_expired = false;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function expiration()
+	{
+		return $this->_expiration;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function extension()
+	{
+		return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS);
+	}
+
+
+	/**
+	 * @param int $time number of seconds to add to session expiration
+	 */
+	public function extend_expiration($time = 0)
+	{
+		$time = $time ? $time : $this->extension();
+		$this->_expiration += absint($time);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function lifespan()
+	{
+		return $this->session_lifespan->inSeconds();
+	}
+
+
+	/**
+	 * Marks whether the session data has been updated or not.
+	 * Valid options are:
+	 *      EE_Session::SAVE_STATE_CLEAN - session data remains unchanged and updating is not necessary
+	 *      EE_Session::SAVE_STATE_DIRTY - session data has changed since last save and needs to be updated
+	 * default value is EE_Session::SAVE_STATE_DIRTY
+	 *
+	 * @param string $save_state
+	 */
+	public function setSaveState($save_state = EE_Session::SAVE_STATE_DIRTY)
+	{
+		$valid_save_states = [
+			EE_Session::SAVE_STATE_CLEAN,
+			EE_Session::SAVE_STATE_DIRTY,
+		];
+		if (! in_array($save_state, $valid_save_states, true)) {
+			$save_state = EE_Session::SAVE_STATE_DIRTY;
+		}
+		$this->save_state = $save_state;
+	}
+
+
+
+	/**
+	 * This just sets some defaults for the _session data property
+	 *
+	 * @return void
+	 */
+	private function _set_defaults()
+	{
+		// set some defaults
+		foreach ($this->_default_session_vars as $key => $default_var) {
+			if (is_array($default_var)) {
+				$this->_session_data[ $key ] = array();
+			} else {
+				$this->_session_data[ $key ] = '';
+			}
+		}
+	}
+
+
+	/**
+	 * @retrieve  session data
+	 * @return    string
+	 */
+	public function id()
+	{
+		return $this->_sid;
+	}
+
+
+	/**
+	 * @param \EE_Cart $cart
+	 * @return bool
+	 */
+	public function set_cart(EE_Cart $cart)
+	{
+		$this->_session_data['cart'] = $cart;
+		$this->setSaveState();
+		return true;
+	}
+
+
+	/**
+	 * reset_cart
+	 */
+	public function reset_cart()
+	{
+		do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
+		$this->_session_data['cart'] = null;
+		$this->setSaveState();
+	}
+
+
+	/**
+	 * @return \EE_Cart
+	 */
+	public function cart()
+	{
+		return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
+			? $this->_session_data['cart']
+			: null;
+	}
+
+
+	/**
+	 * @param \EE_Checkout $checkout
+	 * @return bool
+	 */
+	public function set_checkout(EE_Checkout $checkout)
+	{
+		$this->_session_data['checkout'] = $checkout;
+		$this->setSaveState();
+		return true;
+	}
+
+
+	/**
+	 * reset_checkout
+	 */
+	public function reset_checkout()
+	{
+		do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
+		$this->_session_data['checkout'] = null;
+		$this->setSaveState();
+	}
+
+
+	/**
+	 * @return \EE_Checkout
+	 */
+	public function checkout()
+	{
+		return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
+			? $this->_session_data['checkout']
+			: null;
+	}
+
+
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function set_transaction(EE_Transaction $transaction)
+	{
+		// first remove the session from the transaction before we save the transaction in the session
+		$transaction->set_txn_session_data(null);
+		$this->_session_data['transaction'] = $transaction;
+		$this->setSaveState();
+		return true;
+	}
+
+
+	/**
+	 * reset_transaction
+	 */
+	public function reset_transaction()
+	{
+		do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
+		$this->_session_data['transaction'] = null;
+		$this->setSaveState();
+	}
+
+
+	/**
+	 * @return \EE_Transaction
+	 */
+	public function transaction()
+	{
+		return isset($this->_session_data['transaction'])
+			   && $this->_session_data['transaction'] instanceof EE_Transaction
+			? $this->_session_data['transaction']
+			: null;
+	}
+
+
+	/**
+	 * retrieve session data
+	 *
+	 * @param null $key
+	 * @param bool $reset_cache
+	 * @return array
+	 */
+	public function get_session_data($key = null, $reset_cache = false)
+	{
+		if ($reset_cache) {
+			$this->reset_cart();
+			$this->reset_checkout();
+			$this->reset_transaction();
+		}
+		if (! empty($key)) {
+			return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
+		}
+		return $this->_session_data;
+	}
+
+
+	/**
+	 * Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array $data
+	 * @return bool
+	 */
+	public function set_session_data($data)
+	{
+		// nothing ??? bad data ??? go home!
+		if (empty($data) || ! is_array($data)) {
+			EE_Error::add_error(
+				esc_html__(
+					'No session data or invalid session data was provided.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		foreach ($data as $key => $value) {
+			if (isset($this->_default_session_vars[ $key ])) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'Sorry! %s is a default session datum and can not be reset.',
+							'event_espresso'
+						),
+						$key
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			$this->_session_data[ $key ] = $value;
+			$this->setSaveState();
+		}
+		return true;
+	}
+
+
+	/**
+	 * @initiate session
+	 * @return bool TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	private function _espresso_session()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->session_start_handler->startSession();
+		$this->status = EE_Session::STATUS_OPEN;
+		// get our modified session ID
+		$this->_sid = $this->_generate_session_id();
+		// and the visitors IP
+		$this->_ip_address = $this->request->ipAddress();
+		// set the "user agent"
+		$this->_user_agent = $this->request->userAgent();
+		// now let's retrieve what's in the db
+		$session_data = $this->_retrieve_session_data();
+		if (! empty($session_data)) {
+			// get the current time in UTC
+			$this->_time = $this->_time !== null ? $this->_time : time();
+			// and reset the session expiration
+			$this->_expiration = isset($session_data['expiration'])
+				? $session_data['expiration']
+				: $this->_time + $this->session_lifespan->inSeconds();
+		} else {
+			// set initial site access time and the session expiration
+			$this->_set_init_access_and_expiration();
+			// set referer
+			$this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = esc_attr(
+				$this->request->getServerParam('HTTP_REFERER')
+			);
+			// no previous session = go back and create one (on top of the data above)
+			return false;
+		}
+		// now the user agent
+		if ($session_data['user_agent'] !== $this->_user_agent) {
+			return false;
+		}
+		// wait a minute... how old are you?
+		if ($this->_time > $this->_expiration) {
+			// yer too old fer me!
+			$this->_expired = true;
+			// wipe out everything that isn't a default session datum
+			$this->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// make event espresso session data available to plugin
+		$this->_session_data = array_merge($this->_session_data, $session_data);
+		return true;
+	}
+
+
+	/**
+	 * _get_session_data
+	 * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup
+	 * databases
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidSessionDataException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	protected function _retrieve_session_data()
+	{
+		$ssn_key = EE_Session::session_id_prefix . $this->_sid;
+		try {
+			// we're using WP's Transient API to store session data using the PHP session ID as the option name
+			$session_data = $this->cache_storage->get($ssn_key, false);
+			if (empty($session_data)) {
+				return array();
+			}
+			if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+				$hash_check = $this->cache_storage->get(
+					EE_Session::hash_check_prefix . $this->_sid,
+					false
+				);
+				if ($hash_check && $hash_check !== md5($session_data)) {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
+								'event_espresso'
+							),
+							EE_Session::session_id_prefix . $this->_sid
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		} catch (Exception $e) {
+			// let's just eat that error for now and attempt to correct any corrupted data
+			global $wpdb;
+			$row = $wpdb->get_row(
+				$wpdb->prepare(
+					"SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
+					'_transient_' . $ssn_key
+				)
+			);
+			$session_data = is_object($row) ? $row->option_value : null;
+			if ($session_data) {
+				$session_data = preg_replace_callback(
+					'!s:(d+):"(.*?)";!',
+					function ($match) {
+						return $match[1] === strlen($match[2])
+							? $match[0]
+							: 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+					},
+					$session_data
+				);
+			}
+			$session_data = maybe_unserialize($session_data);
+		}
+		// in case the data is encoded... try to decode it
+		$session_data = $this->encryption instanceof EE_Encryption
+			? $this->encryption->base64_string_decode($session_data)
+			: $session_data;
+		if (! is_array($session_data)) {
+			try {
+				$session_data = maybe_unserialize($session_data);
+			} catch (Exception $e) {
+				$msg = esc_html__(
+					'An error occurred while attempting to unserialize the session data.',
+					'event_espresso'
+				);
+				$msg .= WP_DEBUG
+					? '<br><pre>'
+					  . print_r($session_data, true)
+					  . '</pre><br>'
+					  . $this->find_serialize_error($session_data)
+					: '';
+				$this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+				throw new InvalidSessionDataException($msg, 0, $e);
+			}
+		}
+		// just a check to make sure the session array is indeed an array
+		if (! is_array($session_data)) {
+			// no?!?! then something is wrong
+			$msg = esc_html__(
+				'The session data is missing, invalid, or corrupted.',
+				'event_espresso'
+			);
+			$msg .= WP_DEBUG
+				? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+				: '';
+			$this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+			throw new InvalidSessionDataException($msg);
+		}
+		if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
+			$session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
+				$session_data['transaction']
+			);
+		}
+		return $session_data;
+	}
+
+
+	/**
+	 * _generate_session_id
+	 * Retrieves the PHP session id either directly from the PHP session,
+	 * or from the request array if it was passed in from an AJAX request.
+	 * The session id is then salted and hashed (mmm sounds tasty)
+	 * so that it can be safely used as a request param
+	 *
+	 * @return string
+	 */
+	protected function _generate_session_id()
+	{
+		// check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
+		$session_id = $this->request->requestParamIsSet('EESID')
+			? $this->request->getRequestParam('EESID')
+			: md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
+		return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
+	}
+
+
+	/**
+	 * _get_sid_salt
+	 *
+	 * @return string
+	 */
+	protected function _get_sid_salt()
+	{
+		// was session id salt already saved to db ?
+		if (empty($this->_sid_salt)) {
+			// no?  then maybe use WP defined constant
+			if (defined('AUTH_SALT')) {
+				$this->_sid_salt = AUTH_SALT;
+			}
+			// if salt doesn't exist or is too short
+			if (strlen($this->_sid_salt) < 32) {
+				// create a new one
+				$this->_sid_salt = wp_generate_password(64);
+			}
+			// and save it as a permanent session setting
+			$this->updateSessionSettings(array('sid_salt' => $this->_sid_salt));
+		}
+		return $this->_sid_salt;
+	}
+
+
+	/**
+	 * _set_init_access_and_expiration
+	 *
+	 * @return void
+	 */
+	protected function _set_init_access_and_expiration()
+	{
+		$this->_time = time();
+		$this->_expiration = $this->_time + $this->session_lifespan->inSeconds();
+		// set initial site access time
+		$this->_session_data['init_access'] = $this->_time;
+		// and the session expiration
+		$this->_session_data['expiration'] = $this->_expiration;
+	}
+
+
+	/**
+	 * @update session data  prior to saving to the db
+	 * @param bool $new_session
+	 * @return bool TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function update($new_session = false)
+	{
+		$this->_session_data = is_array($this->_session_data) && isset($this->_session_data['id'])
+			? $this->_session_data
+			: array();
+		if (empty($this->_session_data)) {
+			$this->_set_defaults();
+		}
+		$session_data = array();
+		foreach ($this->_session_data as $key => $value) {
+			switch ($key) {
+				case 'id':
+					// session ID
+					$session_data['id'] = $this->_sid;
+					break;
+				case 'ip_address':
+					// visitor ip address
+					$session_data['ip_address'] = $this->request->ipAddress();
+					break;
+				case 'user_agent':
+					// visitor user_agent
+					$session_data['user_agent'] = $this->_user_agent;
+					break;
+				case 'init_access':
+					$session_data['init_access'] = absint($value);
+					break;
+				case 'last_access':
+					// current access time
+					$session_data['last_access'] = $this->_time;
+					break;
+				case 'expiration':
+					// when the session expires
+					$session_data['expiration'] = ! empty($this->_expiration)
+						? $this->_expiration
+						: $session_data['init_access'] + $this->session_lifespan->inSeconds();
+					break;
+				case 'user_id':
+					// current user if logged in
+					$session_data['user_id'] = $this->_wp_user_id();
+					break;
+				case 'pages_visited':
+					$page_visit = $this->_get_page_visit();
+					if ($page_visit) {
+						// set pages visited where the first will be the http referrer
+						$this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
+						// we'll only save the last 10 page visits.
+						$session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
+					}
+					break;
+				default:
+					// carry any other data over
+					$session_data[ $key ] = $this->_session_data[ $key ];
+			}
+		}
+		$this->_session_data = $session_data;
+		// creating a new session does not require saving to the db just yet
+		if (! $new_session) {
+			// ready? let's save
+			if ($this->_save_session_to_db()) {
+				return true;
+			}
+			return false;
+		}
+		// meh, why not?
+		return true;
+	}
+
+
+	/**
+	 * @create session data array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _create_espresso_session()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
+		// use the update function for now with $new_session arg set to TRUE
+		$this->update(true);
+	}
+
+	/**
+	 * Detects if there is anything worth saving in the session (eg the cart is a good one, notices are pretty good
+	 * too). This is used when determining if we want to save the session or not.
+	 * @since 4.9.67.p
+	 * @return bool
+	 */
+	private function sessionHasStuffWorthSaving()
+	{
+		return $this->save_state === EE_Session::SAVE_STATE_DIRTY
+			   // we may want to eventually remove the following
+			   // on the assumption that the above check is enough
+			   || $this->cart() instanceof EE_Cart
+			   || (
+				   isset($this->_session_data['ee_notices'])
+				   && (
+					   ! empty($this->_session_data['ee_notices']['attention'])
+					   || ! empty($this->_session_data['ee_notices']['errors'])
+					   || ! empty($this->_session_data['ee_notices']['success'])
+				   )
+			   );
+	}
+
+
+	/**
+	 * _save_session_to_db
+	 *
+	 * @param bool $clear_session
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _save_session_to_db($clear_session = false)
+	{
+		// don't save sessions for crawlers
+		// and unless we're deleting the session data, don't save anything if there isn't a cart
+		if (
+			$this->request->isBot()
+			|| (
+				! $clear_session
+				&& ! $this->sessionHasStuffWorthSaving()
+				&& apply_filters('FHEE__EE_Session___save_session_to_db__abort_session_save', true)
+			)
+		) {
+			return false;
+		}
+		$transaction = $this->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			if (! $transaction->ID()) {
+				$transaction->save();
+			}
+			$this->_session_data['transaction'] = $transaction->ID();
+		}
+		// then serialize all of our session data
+		$session_data = serialize($this->_session_data);
+		// do we need to also encode it to avoid corrupted data when saved to the db?
+		$session_data = $this->_use_encryption
+			? $this->encryption->base64_string_encode($session_data)
+			: $session_data;
+		// maybe save hash check
+		if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+			$this->cache_storage->add(
+				EE_Session::hash_check_prefix . $this->_sid,
+				md5($session_data),
+				$this->session_lifespan->inSeconds()
+			);
+		}
+		// we're using the Transient API for storing session data,
+		$saved = $this->cache_storage->add(
+			EE_Session::session_id_prefix . $this->_sid,
+			$session_data,
+			$this->session_lifespan->inSeconds()
+		);
+		$this->setSaveState(EE_Session::SAVE_STATE_CLEAN);
+		return $saved;
+	}
+
+
+	/**
+	 * @get    the full page request the visitor is accessing
+	 * @return string
+	 */
+	public function _get_page_visit()
+	{
+		$page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+		// check for request url
+		if ($this->request->serverParamIsSet('REQUEST_URI')) {
+			$page_id = '?';
+			$e_reg = '';
+			$request_uri = $this->request->getServerParam('REQUEST_URI');
+			$ru_bits = explode('?', $request_uri);
+			$request_uri = $ru_bits[0];
+			$http_host = $this->request->getServerParam('HTTP_HOST');
+			// check for page_id in SERVER REQUEST
+			if ($this->request->requestParamIsSet('page_id')) {
+				// rebuild $e_reg without any of the extra parameters
+				$page_id .= 'page_id=' . $this->request->getRequestParam('page_id', 0, 'int') . '&amp;';
+			}
+			// check for $e_reg in SERVER REQUEST
+			if ($this->request->requestParamIsSet('ee')) {
+				// rebuild $e_reg without any of the extra parameters
+				$e_reg = 'ee=' . $this->request->getRequestParam('ee');
+			}
+			$page_visit = esc_url(rtrim($http_host . $request_uri . $page_id . $e_reg, '?'));
+		}
+		return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
+	}
+
+
+	/**
+	 * @the    current wp user id
+	 * @return int
+	 */
+	public function _wp_user_id()
+	{
+		// if I need to explain the following lines of code, then you shouldn't be looking at this!
+		$this->_wp_user_id = get_current_user_id();
+		return $this->_wp_user_id;
+	}
+
+
+	/**
+	 * Clear EE_Session data
+	 *
+	 * @param string $class
+	 * @param string $function
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function clear_session($class = '', $function = '')
+	{
 //         echo '
 // <h3 style="color:#999;line-height:.9em;">
 // <span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/>
 // <span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b>
 // </h3>';
-        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
-        $this->reset_cart();
-        $this->reset_checkout();
-        $this->reset_transaction();
-        // wipe out everything that isn't a default session datum
-        $this->reset_data(array_keys($this->_session_data));
-        // reset initial site access time and the session expiration
-        $this->_set_init_access_and_expiration();
-        $this->setSaveState();
-        $this->_save_session_to_db(true);
-    }
-
-
-    /**
-     * resets all non-default session vars. Returns TRUE on success, FALSE on fail
-     *
-     * @param array|mixed $data_to_reset
-     * @param bool        $show_all_notices
-     * @return bool
-     */
-    public function reset_data($data_to_reset = array(), $show_all_notices = false)
-    {
-        // if $data_to_reset is not in an array, then put it in one
-        if (! is_array($data_to_reset)) {
-            $data_to_reset = array($data_to_reset);
-        }
-        // nothing ??? go home!
-        if (empty($data_to_reset)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'No session data could be reset, because no session var name was provided.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $return_value = true;
-        // since $data_to_reset is an array, cycle through the values
-        foreach ($data_to_reset as $reset) {
-            // first check to make sure it is a valid session var
-            if (isset($this->_session_data[ $reset ])) {
-                // then check to make sure it is not a default var
-                if (! array_key_exists($reset, $this->_default_session_vars)) {
-                    // remove session var
-                    unset($this->_session_data[ $reset ]);
-                    $this->setSaveState();
-                    if ($show_all_notices) {
-                        EE_Error::add_success(
-                            sprintf(
-                                esc_html__('The session variable %s was removed.', 'event_espresso'),
-                                $reset
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                } else {
-                    // yeeeeeeeeerrrrrrrrrrr OUT !!!!
-                    if ($show_all_notices) {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'Sorry! %s is a default session datum and can not be reset.',
-                                    'event_espresso'
-                                ),
-                                $reset
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                    $return_value = false;
-                }
-            } elseif ($show_all_notices) {
-                // oops! that session var does not exist!
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The session item provided, %s, is invalid or does not exist.',
-                            'event_espresso'
-                        ),
-                        $reset
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $return_value = false;
-            }
-        } // end of foreach
-        return $return_value;
-    }
-
-
-    /**
-     *   wp_loaded
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function wp_loaded()
-    {
-        if ($this->request->requestParamIsSet('clear_session')) {
-            $this->clear_session(__CLASS__, __FUNCTION__);
-        }
-    }
-
-
-    /**
-     * Used to reset the entire object (for tests).
-     *
-     * @since 4.3.0
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function reset_instance()
-    {
-        $this->clear_session();
-        self::$_instance = null;
-    }
-
-
-    public function configure_garbage_collection_filters()
-    {
-        // run old filter we had for controlling session cleanup
-        $expired_session_transient_delete_query_limit = absint(
-            apply_filters(
-                'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                50
-            )
-        );
-        // is there a value? or one that is different than the default 50 records?
-        if ($expired_session_transient_delete_query_limit === 0) {
-            // hook into TransientCacheStorage in case Session cleanup was turned off
-            add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
-        } elseif ($expired_session_transient_delete_query_limit !== 50) {
-            // or use that for the new transient cleanup query limit
-            add_filter(
-                'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                function () use ($expired_session_transient_delete_query_limit) {
-                    return $expired_session_transient_delete_query_limit;
-                }
-            );
-        }
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/10152904/unserialize-function-unserialize-error-at-offset/21389439#10152996
-     * @param $data1
-     * @return string
-     */
-    private function find_serialize_error($data1)
-    {
-        $error = '<pre>';
-        $data2 = preg_replace_callback(
-            '!s:(\d+):"(.*?)";!',
-            function ($match) {
-                return ($match[1] === strlen($match[2]))
-                    ? $match[0]
-                    : 's:'
-                      . strlen($match[2])
-                      . ':"'
-                      . $match[2]
-                      . '";';
-            },
-            $data1
-        );
-        $max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
-        for ($i = 0; $i < $max; $i++) {
-            if (@$data1[ $i ] !== @$data2[ $i ]) {
-                $error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-                $error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
-                $error .= "\t-> Line Number = $i" . PHP_EOL;
-                $start = ($i - 20);
-                $start = ($start < 0) ? 0 : $start;
-                $length = 40;
-                $point = $max - $i;
-                if ($point < 20) {
-                    $rlength = 1;
-                    $rpoint = -$point;
-                } else {
-                    $rpoint = $length - 20;
-                    $rlength = 1;
-                }
-                $error .= "\t-> Section Data1  = ";
-                $error .= substr_replace(
-                    substr($data1, $start, $length),
-                    "<b style=\"color:green\">{$data1[ $i ]}</b>",
-                    $rpoint,
-                    $rlength
-                );
-                $error .= PHP_EOL;
-                $error .= "\t-> Section Data2  = ";
-                $error .= substr_replace(
-                    substr($data2, $start, $length),
-                    "<b style=\"color:red\">{$data2[ $i ]}</b>",
-                    $rpoint,
-                    $rlength
-                );
-                $error .= PHP_EOL;
-            }
-        }
-        $error .= '</pre>';
-        return $error;
-    }
-
-
-    /**
-     * Saves an  array of settings used for configuring aspects of session behaviour
-     *
-     * @param array $updated_settings
-     */
-    private function updateSessionSettings(array $updated_settings = array())
-    {
-        // add existing settings, but only if not included in incoming $updated_settings array
-        $updated_settings += get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        update_option(EE_Session::OPTION_NAME_SETTINGS, $updated_settings);
-    }
-
-
-    /**
-     * garbage_collection
-     */
-    public function garbageCollection()
-    {
-        // only perform during regular requests if last garbage collection was over an hour ago
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
-            $this->_last_gc = time();
-            $this->updateSessionSettings(array('last_gc' => $this->_last_gc));
-            /** @type WPDB $wpdb */
-            global $wpdb;
-            // filter the query limit. Set to 0 to turn off garbage collection
-            $expired_session_transient_delete_query_limit = absint(
-                apply_filters(
-                    'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                    50
-                )
-            );
-            // non-zero LIMIT means take out the trash
-            if ($expired_session_transient_delete_query_limit) {
-                $session_key = str_replace('_', '\_', EE_Session::session_id_prefix);
-                $hash_check_key = str_replace('_', '\_', EE_Session::hash_check_prefix);
-                // since transient expiration timestamps are set in the future, we can compare against NOW
-                // but we only want to pick up any trash that's been around for more than a day
-                $expiration = time() - DAY_IN_SECONDS;
-                $SQL = "
+		do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
+		$this->reset_cart();
+		$this->reset_checkout();
+		$this->reset_transaction();
+		// wipe out everything that isn't a default session datum
+		$this->reset_data(array_keys($this->_session_data));
+		// reset initial site access time and the session expiration
+		$this->_set_init_access_and_expiration();
+		$this->setSaveState();
+		$this->_save_session_to_db(true);
+	}
+
+
+	/**
+	 * resets all non-default session vars. Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array|mixed $data_to_reset
+	 * @param bool        $show_all_notices
+	 * @return bool
+	 */
+	public function reset_data($data_to_reset = array(), $show_all_notices = false)
+	{
+		// if $data_to_reset is not in an array, then put it in one
+		if (! is_array($data_to_reset)) {
+			$data_to_reset = array($data_to_reset);
+		}
+		// nothing ??? go home!
+		if (empty($data_to_reset)) {
+			EE_Error::add_error(
+				esc_html__(
+					'No session data could be reset, because no session var name was provided.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$return_value = true;
+		// since $data_to_reset is an array, cycle through the values
+		foreach ($data_to_reset as $reset) {
+			// first check to make sure it is a valid session var
+			if (isset($this->_session_data[ $reset ])) {
+				// then check to make sure it is not a default var
+				if (! array_key_exists($reset, $this->_default_session_vars)) {
+					// remove session var
+					unset($this->_session_data[ $reset ]);
+					$this->setSaveState();
+					if ($show_all_notices) {
+						EE_Error::add_success(
+							sprintf(
+								esc_html__('The session variable %s was removed.', 'event_espresso'),
+								$reset
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				} else {
+					// yeeeeeeeeerrrrrrrrrrr OUT !!!!
+					if ($show_all_notices) {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'Sorry! %s is a default session datum and can not be reset.',
+									'event_espresso'
+								),
+								$reset
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+					$return_value = false;
+				}
+			} elseif ($show_all_notices) {
+				// oops! that session var does not exist!
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The session item provided, %s, is invalid or does not exist.',
+							'event_espresso'
+						),
+						$reset
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$return_value = false;
+			}
+		} // end of foreach
+		return $return_value;
+	}
+
+
+	/**
+	 *   wp_loaded
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function wp_loaded()
+	{
+		if ($this->request->requestParamIsSet('clear_session')) {
+			$this->clear_session(__CLASS__, __FUNCTION__);
+		}
+	}
+
+
+	/**
+	 * Used to reset the entire object (for tests).
+	 *
+	 * @since 4.3.0
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function reset_instance()
+	{
+		$this->clear_session();
+		self::$_instance = null;
+	}
+
+
+	public function configure_garbage_collection_filters()
+	{
+		// run old filter we had for controlling session cleanup
+		$expired_session_transient_delete_query_limit = absint(
+			apply_filters(
+				'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+				50
+			)
+		);
+		// is there a value? or one that is different than the default 50 records?
+		if ($expired_session_transient_delete_query_limit === 0) {
+			// hook into TransientCacheStorage in case Session cleanup was turned off
+			add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
+		} elseif ($expired_session_transient_delete_query_limit !== 50) {
+			// or use that for the new transient cleanup query limit
+			add_filter(
+				'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
+				function () use ($expired_session_transient_delete_query_limit) {
+					return $expired_session_transient_delete_query_limit;
+				}
+			);
+		}
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/10152904/unserialize-function-unserialize-error-at-offset/21389439#10152996
+	 * @param $data1
+	 * @return string
+	 */
+	private function find_serialize_error($data1)
+	{
+		$error = '<pre>';
+		$data2 = preg_replace_callback(
+			'!s:(\d+):"(.*?)";!',
+			function ($match) {
+				return ($match[1] === strlen($match[2]))
+					? $match[0]
+					: 's:'
+					  . strlen($match[2])
+					  . ':"'
+					  . $match[2]
+					  . '";';
+			},
+			$data1
+		);
+		$max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
+		$error .= $data1 . PHP_EOL;
+		$error .= $data2 . PHP_EOL;
+		for ($i = 0; $i < $max; $i++) {
+			if (@$data1[ $i ] !== @$data2[ $i ]) {
+				$error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
+				$error .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
+				$error .= "\t-> Line Number = $i" . PHP_EOL;
+				$start = ($i - 20);
+				$start = ($start < 0) ? 0 : $start;
+				$length = 40;
+				$point = $max - $i;
+				if ($point < 20) {
+					$rlength = 1;
+					$rpoint = -$point;
+				} else {
+					$rpoint = $length - 20;
+					$rlength = 1;
+				}
+				$error .= "\t-> Section Data1  = ";
+				$error .= substr_replace(
+					substr($data1, $start, $length),
+					"<b style=\"color:green\">{$data1[ $i ]}</b>",
+					$rpoint,
+					$rlength
+				);
+				$error .= PHP_EOL;
+				$error .= "\t-> Section Data2  = ";
+				$error .= substr_replace(
+					substr($data2, $start, $length),
+					"<b style=\"color:red\">{$data2[ $i ]}</b>",
+					$rpoint,
+					$rlength
+				);
+				$error .= PHP_EOL;
+			}
+		}
+		$error .= '</pre>';
+		return $error;
+	}
+
+
+	/**
+	 * Saves an  array of settings used for configuring aspects of session behaviour
+	 *
+	 * @param array $updated_settings
+	 */
+	private function updateSessionSettings(array $updated_settings = array())
+	{
+		// add existing settings, but only if not included in incoming $updated_settings array
+		$updated_settings += get_option(EE_Session::OPTION_NAME_SETTINGS, array());
+		update_option(EE_Session::OPTION_NAME_SETTINGS, $updated_settings);
+	}
+
+
+	/**
+	 * garbage_collection
+	 */
+	public function garbageCollection()
+	{
+		// only perform during regular requests if last garbage collection was over an hour ago
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
+			$this->_last_gc = time();
+			$this->updateSessionSettings(array('last_gc' => $this->_last_gc));
+			/** @type WPDB $wpdb */
+			global $wpdb;
+			// filter the query limit. Set to 0 to turn off garbage collection
+			$expired_session_transient_delete_query_limit = absint(
+				apply_filters(
+					'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+					50
+				)
+			);
+			// non-zero LIMIT means take out the trash
+			if ($expired_session_transient_delete_query_limit) {
+				$session_key = str_replace('_', '\_', EE_Session::session_id_prefix);
+				$hash_check_key = str_replace('_', '\_', EE_Session::hash_check_prefix);
+				// since transient expiration timestamps are set in the future, we can compare against NOW
+				// but we only want to pick up any trash that's been around for more than a day
+				$expiration = time() - DAY_IN_SECONDS;
+				$SQL = "
                     SELECT option_name
                     FROM {$wpdb->options}
                     WHERE
@@ -1335,17 +1335,17 @@ 
                     AND option_value < {$expiration}
                     LIMIT {$expired_session_transient_delete_query_limit}
                 ";
-                // produces something like:
-                // SELECT option_name FROM wp_options
-                // WHERE ( option_name LIKE '\_transient\_timeout\_ee\_ssn\_%'
-                // OR option_name LIKE '\_transient\_timeout\_ee\_shc\_%' )
-                // AND option_value < 1508368198 LIMIT 50
-                $expired_sessions = $wpdb->get_col($SQL);
-                // valid results?
-                if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
-                    $this->cache_storage->deleteMany($expired_sessions, true);
-                }
-            }
-        }
-    }
+				// produces something like:
+				// SELECT option_name FROM wp_options
+				// WHERE ( option_name LIKE '\_transient\_timeout\_ee\_ssn\_%'
+				// OR option_name LIKE '\_transient\_timeout\_ee\_shc\_%' )
+				// AND option_value < 1508368198 LIMIT 50
+				$expired_sessions = $wpdb->get_col($SQL);
+				// valid results?
+				if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
+					$this->cache_storage->deleteMany($expired_sessions, true);
+				}
+			}
+		}
+	}
 }

core/EE_Addon.core.php

Spacing +10 added lines, -10 removed lines

@@ -576,7 +576,7 @@ 
      */
     public function get_activation_indicator_option_name()
     {
-        return 'ee_activation_' . $this->name();
+        return 'ee_activation_'.$this->name();
     }
 
 
@@ -663,13 +663,13 @@ 
      */
     public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
     {
-        if (! $version_history) {
+        if ( ! $version_history) {
             $version_history = $this->get_activation_history();
         }
         if ($current_version_to_add === null) {
             $current_version_to_add = $this->version();
         }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
         // resave
         return update_option($this->get_activation_history_option_name(), $version_history);
     }
@@ -682,7 +682,7 @@ 
      */
     public function get_activation_history_option_name()
     {
-        return self::ee_addon_version_history_option_prefix . $this->name();
+        return self::ee_addon_version_history_option_prefix.$this->name();
     }
 
 
@@ -757,7 +757,7 @@ 
         // is admin and not in M-Mode ?
         if (is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
             add_filter('plugin_action_links', array($this, 'plugin_action_links'), 10, 2);
-            add_filter('after_plugin_row_' . $this->_plugin_basename, array($this, 'after_plugin_row'), 10, 3);
+            add_filter('after_plugin_row_'.$this->_plugin_basename, array($this, 'after_plugin_row'), 10, 3);
         }
     }
 
@@ -776,7 +776,7 @@ 
             // before other links
             array_unshift(
                 $links,
-                '<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
+                '<a href="admin.php?page='.$this->plugin_action_slug().'">'
                 . esc_html__('Settings', 'event_espresso')
                 . '</a>'
             );
@@ -799,15 +799,15 @@ 
     {
         $after_plugin_row = '';
         $plugins_page_row = $this->get_plugins_page_row();
-        if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
+        if ( ! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
             $class = $status ? 'active' : 'inactive';
             $link_text = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
             $link_url = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
             $description = isset($plugins_page_row['description'])
                 ? $plugins_page_row['description']
                 : '';
-            if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
-                $after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
+            if ( ! empty($link_text) && ! empty($link_url) && ! empty($description)) {
+                $after_plugin_row .= '<tr id="'.sanitize_title($plugin_file).'-ee-addon" class="'.$class.'">';
                 $after_plugin_row .= '<th class="check-column" scope="row"></th>';
                 $after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
                 $after_plugin_row .= '<style>
@@ -849,7 +849,7 @@ 
 </style>';
                 $after_plugin_row .= '
 <p class="ee-addon-upsell-info-dv">
-	<a class="ee-button" href="' . $link_url . '">'
+	<a class="ee-button" href="' . $link_url.'">'
                                      . $link_text
                                      . ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span>'
                                      . '</a>

Indentation +844 added lines, -844 removed lines

@@ -17,798 +17,798 @@ 
  */
 abstract class EE_Addon extends EE_Configurable implements RequiresDependencyMapInterface, RequiresDomainInterface
 {
-    /**
-     * prefix to be added onto an addon's plugin slug to make a wp option name
-     * which will be used to store the plugin's activation history
-     */
-    const ee_addon_version_history_option_prefix = 'ee_version_history_';
-
-    /**
-     * @var $_version
-     * @type string
-     */
-    protected $_version = '';
-
-    /**
-     * @var $_min_core_version
-     * @type string
-     */
-    protected $_min_core_version = '';
-
-    /**
-     * derived from plugin 'main_file_path using plugin_basename()
-     *
-     * @type string $_plugin_basename
-     */
-    protected $_plugin_basename = '';
-
-    /**
-     * A non-internationalized name to identify this addon for use in URLs, etc
-     *
-     * @type string $_plugin_slug
-     */
-    protected $_plugin_slug = '';
-
-    /**
-     * A non-internationalized name to identify this addon. Eg 'Calendar','MailChimp',etc/
-     *
-     * @type string _addon_name
-     */
-    protected $_addon_name = '';
-
-    /**
-     * one of the EE_System::req_type_* constants
-     *
-     * @type int $_req_type
-     */
-    protected $_req_type;
-
-    /**
-     * page slug to be used when generating the "Settings" link on the WP plugin page
-     *
-     * @type string $_plugin_action_slug
-     */
-    protected $_plugin_action_slug = '';
-
-    /**
-     * if not empty, inserts a new table row after this plugin's row on the WP Plugins page
-     * that can be used for adding upgrading/marketing info
-     *
-     * @type array $_plugins_page_row
-     */
-    protected $_plugins_page_row = array();
-
-
-    /**
-     *    filepath to the main file, which can be used for register_activation_hook, register_deactivation_hook, etc.
-     *
-     * @type string
-     */
-    protected $_main_plugin_file;
-
-    /**
-     *    This is the slug used to identify this add-on within the plugin update engine.
-     *
-     * @type string
-     */
-    protected $pue_slug;
-
-
-    /**
-     * @var EE_Dependency_Map $dependency_map
-     */
-    private $dependency_map;
-
-
-    /**
-     * @var DomainInterface $domain
-     */
-    private $domain;
-
-
-    /**
-     * @param EE_Dependency_Map $dependency_map [optional]
-     * @param DomainInterface   $domain         [optional]
-     */
-    public function __construct(EE_Dependency_Map $dependency_map = null, DomainInterface $domain = null)
-    {
-        if ($dependency_map instanceof EE_Dependency_Map) {
-            $this->setDependencyMap($dependency_map);
-        }
-        if ($domain instanceof DomainInterface) {
-            $this->setDomain($domain);
-        }
-        add_action('AHEE__EE_System__load_controllers__load_admin_controllers', array($this, 'admin_init'));
-    }
-
-
-    /**
-     * @param EE_Dependency_Map $dependency_map
-     */
-    public function setDependencyMap($dependency_map)
-    {
-        $this->dependency_map = $dependency_map;
-    }
-
-
-    /**
-     * @return EE_Dependency_Map
-     */
-    public function dependencyMap()
-    {
-        return $this->dependency_map;
-    }
-
-
-    /**
-     * @param DomainInterface $domain
-     */
-    public function setDomain(DomainInterface $domain)
-    {
-        $this->domain = $domain;
-    }
-
-    /**
-     * @return DomainInterface
-     */
-    public function domain()
-    {
-        return $this->domain;
-    }
-
-
-    /**
-     * @param mixed $version
-     */
-    public function set_version($version = null)
-    {
-        $this->_version = $version;
-    }
-
-
-    /**
-     * get__version
-     *
-     * @return string
-     */
-    public function version()
-    {
-        return $this->_version;
-    }
-
-
-    /**
-     * @param mixed $min_core_version
-     */
-    public function set_min_core_version($min_core_version = null)
-    {
-        $this->_min_core_version = $min_core_version;
-    }
-
-
-    /**
-     * get__min_core_version
-     *
-     * @return string
-     */
-    public function min_core_version()
-    {
-        return $this->_min_core_version;
-    }
-
-
-    /**
-     * Sets addon_name
-     *
-     * @param string $addon_name
-     * @return boolean
-     */
-    public function set_name($addon_name)
-    {
-        return $this->_addon_name = $addon_name;
-    }
-
-
-    /**
-     * Gets addon_name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->_addon_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_basename()
-    {
-
-        return $this->_plugin_basename;
-    }
-
-
-    /**
-     * @param string $plugin_basename
-     */
-    public function set_plugin_basename($plugin_basename)
-    {
-
-        $this->_plugin_basename = $plugin_basename;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_slug()
-    {
-
-        return $this->_plugin_slug;
-    }
-
-
-    /**
-     * @param string $plugin_slug
-     */
-    public function set_plugin_slug($plugin_slug)
-    {
-
-        $this->_plugin_slug = $plugin_slug;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_action_slug()
-    {
-
-        return $this->_plugin_action_slug;
-    }
-
-
-    /**
-     * @param string $plugin_action_slug
-     */
-    public function set_plugin_action_slug($plugin_action_slug)
-    {
-
-        $this->_plugin_action_slug = $plugin_action_slug;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_plugins_page_row()
-    {
-
-        return $this->_plugins_page_row;
-    }
-
-
-    /**
-     * @param array $plugins_page_row
-     */
-    public function set_plugins_page_row($plugins_page_row = array())
-    {
-        // sigh.... check for example content that I stupidly merged to master and remove it if found
-        if (
-            ! is_array($plugins_page_row)
-            && strpos($plugins_page_row, '<h3>Promotions Addon Upsell Info</h3>') !== false
-        ) {
-            $plugins_page_row = array();
-        }
-        $this->_plugins_page_row = (array) $plugins_page_row;
-    }
-
-
-    /**
-     * Called when EE core detects this addon has been activated for the first time.
-     * If the site isn't in maintenance mode, should setup the addon's database
-     *
-     * @return void
-     */
-    public function new_install()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__new_install");
-        do_action('AHEE__EE_Addon__new_install', $this);
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required')
-        );
-    }
-
-
-    /**
-     * Called when EE core detects this addon has been reactivated. When this happens,
-     * it's good to just check that your data is still intact
-     *
-     * @return void
-     */
-    public function reactivation()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__reactivation");
-        do_action('AHEE__EE_Addon__reactivation', $this);
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required')
-        );
-    }
-
-
-    /**
-     * Called when the registered deactivation hook for this addon fires.
-     *
-     * @throws EE_Error
-     */
-    public function deactivation()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__deactivation");
-        do_action('AHEE__EE_Addon__deactivation', $this);
-        // check if the site no longer needs to be in maintenance mode
-        EE_Register_Addon::deregister($this->name());
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-    }
-
-
-    /**
-     * Takes care of double-checking that we're not in maintenance mode, and then
-     * initializing this addon's necessary initial data. This is called by default on new activations
-     * and reactivations.
-     *
-     * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data.
-     *                               This is a resource-intensive job so we prefer to only do it when necessary
-     * @return void
-     * @throws \EE_Error
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function initialize_db_if_no_migrations_required($verify_schema = true)
-    {
-        if ($verify_schema === '') {
-            // wp core bug imo: if no args are passed to `do_action('some_hook_name')` besides the hook's name
-            // (ie, no 2nd or 3rd arguments), instead of calling the registered callbacks with no arguments, it
-            // calls them with an argument of an empty string (ie ""), which evaluates to false
-            // so we need to treat the empty string as if nothing had been passed, and should instead use the default
-            $verify_schema = true;
-        }
-        if (EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            if ($verify_schema) {
-                $this->initialize_db();
-            }
-            $this->initialize_default_data();
-            // @todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
-            EE_Data_Migration_Manager::instance()->update_current_database_state_to(
-                array(
-                    'slug'    => $this->name(),
-                    'version' => $this->version(),
-                )
-            );
-            /* make sure core's data is a-ok
+	/**
+	 * prefix to be added onto an addon's plugin slug to make a wp option name
+	 * which will be used to store the plugin's activation history
+	 */
+	const ee_addon_version_history_option_prefix = 'ee_version_history_';
+
+	/**
+	 * @var $_version
+	 * @type string
+	 */
+	protected $_version = '';
+
+	/**
+	 * @var $_min_core_version
+	 * @type string
+	 */
+	protected $_min_core_version = '';
+
+	/**
+	 * derived from plugin 'main_file_path using plugin_basename()
+	 *
+	 * @type string $_plugin_basename
+	 */
+	protected $_plugin_basename = '';
+
+	/**
+	 * A non-internationalized name to identify this addon for use in URLs, etc
+	 *
+	 * @type string $_plugin_slug
+	 */
+	protected $_plugin_slug = '';
+
+	/**
+	 * A non-internationalized name to identify this addon. Eg 'Calendar','MailChimp',etc/
+	 *
+	 * @type string _addon_name
+	 */
+	protected $_addon_name = '';
+
+	/**
+	 * one of the EE_System::req_type_* constants
+	 *
+	 * @type int $_req_type
+	 */
+	protected $_req_type;
+
+	/**
+	 * page slug to be used when generating the "Settings" link on the WP plugin page
+	 *
+	 * @type string $_plugin_action_slug
+	 */
+	protected $_plugin_action_slug = '';
+
+	/**
+	 * if not empty, inserts a new table row after this plugin's row on the WP Plugins page
+	 * that can be used for adding upgrading/marketing info
+	 *
+	 * @type array $_plugins_page_row
+	 */
+	protected $_plugins_page_row = array();
+
+
+	/**
+	 *    filepath to the main file, which can be used for register_activation_hook, register_deactivation_hook, etc.
+	 *
+	 * @type string
+	 */
+	protected $_main_plugin_file;
+
+	/**
+	 *    This is the slug used to identify this add-on within the plugin update engine.
+	 *
+	 * @type string
+	 */
+	protected $pue_slug;
+
+
+	/**
+	 * @var EE_Dependency_Map $dependency_map
+	 */
+	private $dependency_map;
+
+
+	/**
+	 * @var DomainInterface $domain
+	 */
+	private $domain;
+
+
+	/**
+	 * @param EE_Dependency_Map $dependency_map [optional]
+	 * @param DomainInterface   $domain         [optional]
+	 */
+	public function __construct(EE_Dependency_Map $dependency_map = null, DomainInterface $domain = null)
+	{
+		if ($dependency_map instanceof EE_Dependency_Map) {
+			$this->setDependencyMap($dependency_map);
+		}
+		if ($domain instanceof DomainInterface) {
+			$this->setDomain($domain);
+		}
+		add_action('AHEE__EE_System__load_controllers__load_admin_controllers', array($this, 'admin_init'));
+	}
+
+
+	/**
+	 * @param EE_Dependency_Map $dependency_map
+	 */
+	public function setDependencyMap($dependency_map)
+	{
+		$this->dependency_map = $dependency_map;
+	}
+
+
+	/**
+	 * @return EE_Dependency_Map
+	 */
+	public function dependencyMap()
+	{
+		return $this->dependency_map;
+	}
+
+
+	/**
+	 * @param DomainInterface $domain
+	 */
+	public function setDomain(DomainInterface $domain)
+	{
+		$this->domain = $domain;
+	}
+
+	/**
+	 * @return DomainInterface
+	 */
+	public function domain()
+	{
+		return $this->domain;
+	}
+
+
+	/**
+	 * @param mixed $version
+	 */
+	public function set_version($version = null)
+	{
+		$this->_version = $version;
+	}
+
+
+	/**
+	 * get__version
+	 *
+	 * @return string
+	 */
+	public function version()
+	{
+		return $this->_version;
+	}
+
+
+	/**
+	 * @param mixed $min_core_version
+	 */
+	public function set_min_core_version($min_core_version = null)
+	{
+		$this->_min_core_version = $min_core_version;
+	}
+
+
+	/**
+	 * get__min_core_version
+	 *
+	 * @return string
+	 */
+	public function min_core_version()
+	{
+		return $this->_min_core_version;
+	}
+
+
+	/**
+	 * Sets addon_name
+	 *
+	 * @param string $addon_name
+	 * @return boolean
+	 */
+	public function set_name($addon_name)
+	{
+		return $this->_addon_name = $addon_name;
+	}
+
+
+	/**
+	 * Gets addon_name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->_addon_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_basename()
+	{
+
+		return $this->_plugin_basename;
+	}
+
+
+	/**
+	 * @param string $plugin_basename
+	 */
+	public function set_plugin_basename($plugin_basename)
+	{
+
+		$this->_plugin_basename = $plugin_basename;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_slug()
+	{
+
+		return $this->_plugin_slug;
+	}
+
+
+	/**
+	 * @param string $plugin_slug
+	 */
+	public function set_plugin_slug($plugin_slug)
+	{
+
+		$this->_plugin_slug = $plugin_slug;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_action_slug()
+	{
+
+		return $this->_plugin_action_slug;
+	}
+
+
+	/**
+	 * @param string $plugin_action_slug
+	 */
+	public function set_plugin_action_slug($plugin_action_slug)
+	{
+
+		$this->_plugin_action_slug = $plugin_action_slug;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_plugins_page_row()
+	{
+
+		return $this->_plugins_page_row;
+	}
+
+
+	/**
+	 * @param array $plugins_page_row
+	 */
+	public function set_plugins_page_row($plugins_page_row = array())
+	{
+		// sigh.... check for example content that I stupidly merged to master and remove it if found
+		if (
+			! is_array($plugins_page_row)
+			&& strpos($plugins_page_row, '<h3>Promotions Addon Upsell Info</h3>') !== false
+		) {
+			$plugins_page_row = array();
+		}
+		$this->_plugins_page_row = (array) $plugins_page_row;
+	}
+
+
+	/**
+	 * Called when EE core detects this addon has been activated for the first time.
+	 * If the site isn't in maintenance mode, should setup the addon's database
+	 *
+	 * @return void
+	 */
+	public function new_install()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__new_install");
+		do_action('AHEE__EE_Addon__new_install', $this);
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required')
+		);
+	}
+
+
+	/**
+	 * Called when EE core detects this addon has been reactivated. When this happens,
+	 * it's good to just check that your data is still intact
+	 *
+	 * @return void
+	 */
+	public function reactivation()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__reactivation");
+		do_action('AHEE__EE_Addon__reactivation', $this);
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required')
+		);
+	}
+
+
+	/**
+	 * Called when the registered deactivation hook for this addon fires.
+	 *
+	 * @throws EE_Error
+	 */
+	public function deactivation()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__deactivation");
+		do_action('AHEE__EE_Addon__deactivation', $this);
+		// check if the site no longer needs to be in maintenance mode
+		EE_Register_Addon::deregister($this->name());
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+	}
+
+
+	/**
+	 * Takes care of double-checking that we're not in maintenance mode, and then
+	 * initializing this addon's necessary initial data. This is called by default on new activations
+	 * and reactivations.
+	 *
+	 * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data.
+	 *                               This is a resource-intensive job so we prefer to only do it when necessary
+	 * @return void
+	 * @throws \EE_Error
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function initialize_db_if_no_migrations_required($verify_schema = true)
+	{
+		if ($verify_schema === '') {
+			// wp core bug imo: if no args are passed to `do_action('some_hook_name')` besides the hook's name
+			// (ie, no 2nd or 3rd arguments), instead of calling the registered callbacks with no arguments, it
+			// calls them with an argument of an empty string (ie ""), which evaluates to false
+			// so we need to treat the empty string as if nothing had been passed, and should instead use the default
+			$verify_schema = true;
+		}
+		if (EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			if ($verify_schema) {
+				$this->initialize_db();
+			}
+			$this->initialize_default_data();
+			// @todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
+			EE_Data_Migration_Manager::instance()->update_current_database_state_to(
+				array(
+					'slug'    => $this->name(),
+					'version' => $this->version(),
+				)
+			);
+			/* make sure core's data is a-ok
              * (at the time of writing, we especially want to verify all the caps are present
              * because payment method type capabilities are added dynamically, and it's
              * possible this addon added a payment method. But it's also possible
              * other data needs to be verified)
              */
-            EEH_Activation::initialize_db_content();
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flushRewriteRules();
-            // in case there are lots of addons being activated at once, let's force garbage collection
-            // to help avoid memory limit errors
-            // EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
-            gc_collect_cycles();
-        } else {
-            // ask the data migration manager to init this addon's data
-            // when migrations are finished because we can't do it now
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for($this->name());
-        }
-    }
-
-
-    /**
-     * Used to setup this addon's database tables, but not necessarily any default
-     * data in them. The default is to actually use the most up-to-date data migration script
-     * for this addon, and just use its schema_changes_before_migration() and schema_changes_after_migration()
-     * methods to setup the db.
-     */
-    public function initialize_db()
-    {
-        // find the migration script that sets the database to be compatible with the code
-        $current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms($this->name());
-        if ($current_dms_name) {
-            $current_data_migration_script = EE_Registry::instance()->load_dms($current_dms_name);
-            $current_data_migration_script->set_migrating(false);
-            $current_data_migration_script->schema_changes_before_migration();
-            $current_data_migration_script->schema_changes_after_migration();
-            if ($current_data_migration_script->get_errors()) {
-                foreach ($current_data_migration_script->get_errors() as $error) {
-                    EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-        }
-        // if not DMS was found that should be ok. This addon just doesn't require any database changes
-        EE_Data_Migration_Manager::instance()->update_current_database_state_to(
-            array(
-                'slug'    => $this->name(),
-                'version' => $this->version(),
-            )
-        );
-    }
-
-
-    /**
-     * If you want to setup default data for the addon, override this method, and call
-     * parent::initialize_default_data() from within it. This is normally called
-     * from EE_Addon::initialize_db_if_no_migrations_required(), just after EE_Addon::initialize_db()
-     * and should verify default data is present (but this is also called
-     * on reactivations and just after migrations, so please verify you actually want
-     * to ADD default data, because it may already be present).
-     * However, please call this parent (currently it just fires a hook which other
-     * addons may be depending on)
-     */
-    public function initialize_default_data()
-    {
-        /**
-         * Called when an addon is ensuring its default data is set (possibly called
-         * on a reactivation, so first check for the absence of other data before setting
-         * default data)
-         *
-         * @param EE_Addon $addon the addon that called this
-         */
-        do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
-        // override to insert default data. It is safe to use the models here
-        // because the site should not be in maintenance mode
-    }
-
-
-    /**
-     * EE Core detected that this addon has been upgraded. We should check if there
-     * are any new migration scripts, and if so put the site into maintenance mode until
-     * they're ran
-     *
-     * @return void
-     */
-    public function upgrade()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__upgrade");
-        do_action('AHEE__EE_Addon__upgrade', $this);
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-        // also it's possible there is new default data that needs to be added
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required')
-        );
-    }
-
-
-    /**
-     * If Core detects this addon has been downgraded, you may want to invoke some special logic here.
-     */
-    public function downgrade()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__downgrade");
-        do_action('AHEE__EE_Addon__downgrade', $this);
-        // it's possible there's old default data that needs to be double-checked
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required')
-        );
-    }
-
-
-    /**
-     * set_db_update_option_name
-     * Until we do something better, we'll just check for migration scripts upon
-     * plugin activation only. In the future, we'll want to do it on plugin updates too
-     *
-     * @return bool
-     */
-    public function set_db_update_option_name()
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'EE_Addon::set_db_update_option_name was renamed to EE_Addon::set_activation_indicator_option',
-                'event_espresso'
-            ),
-            '4.3.0.alpha.016'
-        );
-        // let's just handle this on the next request, ok? right now we're just not really ready
-        return $this->set_activation_indicator_option();
-    }
-
-
-    /**
-     * Returns the name of the activation indicator option
-     * (an option which is set temporarily to indicate that this addon was just activated)
-     *
-     * @deprecated since version 4.3.0.alpha.016
-     * @return string
-     */
-    public function get_db_update_option_name()
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'EE_Addon::get_db_update_option was renamed to EE_Addon::get_activation_indicator_option_name',
-                'event_espresso'
-            ),
-            '4.3.0.alpha.016'
-        );
-        return $this->get_activation_indicator_option_name();
-    }
-
-
-    /**
-     * When the addon is activated, this should be called to set a wordpress option that
-     * indicates it was activated. This is especially useful for detecting reactivations.
-     *
-     * @return bool
-     */
-    public function set_activation_indicator_option()
-    {
-        // let's just handle this on the next request, ok? right now we're just not really ready
-        return update_option($this->get_activation_indicator_option_name(), true);
-    }
-
-
-    /**
-     * Gets the name of the wp option which is used to temporarily indicate that this addon was activated
-     *
-     * @return string
-     */
-    public function get_activation_indicator_option_name()
-    {
-        return 'ee_activation_' . $this->name();
-    }
-
-
-    /**
-     * Used by EE_System to set the request type of this addon. Should not be used by addon developers
-     *
-     * @param int $req_type
-     */
-    public function set_req_type($req_type)
-    {
-        $this->_req_type = $req_type;
-    }
-
-
-    /**
-     * Returns the request type of this addon (ie, EE_System::req_type_normal, EE_System::req_type_new_activation,
-     * EE_System::req_type_reactivation, EE_System::req_type_upgrade, or EE_System::req_type_downgrade). This is set by
-     * EE_System when it is checking for new install or upgrades of addons
-     */
-    public function detect_req_type($redetect = false)
-    {
-        if ($this->_req_type === null || $redetect) {
-            $this->detect_activation_or_upgrade();
-        }
-        return $this->_req_type;
-    }
-
-
-    /**
-     * Detects the request type for this addon (whether it was just activated, upgrades, a normal request, etc.)
-     * Should only be called once per request
-     *
-     * @return void
-     */
-    public function detect_activation_or_upgrade()
-    {
-        $activation_history_for_addon = $this->get_activation_history();
-        $request_type = EE_System::detect_req_type_given_activation_history(
-            $activation_history_for_addon,
-            $this->get_activation_indicator_option_name(),
-            $this->version()
-        );
-        $this->set_req_type($request_type);
-        $classname = get_class($this);
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__new_activation");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__new_activation', $this);
-                $this->new_install();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__reactivation");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__reactivation', $this);
-                $this->reactivation();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__upgrade");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__upgrade', $this);
-                $this->upgrade();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_downgrade:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__downgrade");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__downgrade', $this);
-                $this->downgrade();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                break;
-        }
-
-        do_action("AHEE__{$classname}__detect_if_activation_or_upgrade__complete");
-    }
-
-    /**
-     * Updates the version history for this addon
-     *
-     * @param array  $version_history
-     * @param string $current_version_to_add
-     * @return boolean success
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
-    {
-        if (! $version_history) {
-            $version_history = $this->get_activation_history();
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = $this->version();
-        }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
-        // resave
-        return update_option($this->get_activation_history_option_name(), $version_history);
-    }
-
-    /**
-     * Gets the name of the wp option that stores the activation history
-     * of this addon
-     *
-     * @return string
-     */
-    public function get_activation_history_option_name()
-    {
-        return self::ee_addon_version_history_option_prefix . $this->name();
-    }
-
-
-    /**
-     * Gets the wp option which stores the activation history for this addon
-     *
-     * @return array
-     */
-    public function get_activation_history()
-    {
-        return get_option($this->get_activation_history_option_name(), null);
-    }
-
-
-    /**
-     * @param string $config_section
-     */
-    public function set_config_section($config_section = '')
-    {
-        $this->_config_section = ! empty($config_section) ? $config_section : 'addons';
-    }
-
-    /**
-     * Sets the filepath to the main plugin file
-     *
-     * @param string $filepath
-     */
-    public function set_main_plugin_file($filepath)
-    {
-        $this->_main_plugin_file = $filepath;
-    }
-
-    /**
-     * gets the filepath to teh main file
-     *
-     * @return string
-     */
-    public function get_main_plugin_file()
-    {
-        return $this->_main_plugin_file;
-    }
-
-    /**
-     * Gets the filename (no path) of the main file (the main file loaded
-     * by WP)
-     *
-     * @return string
-     */
-    public function get_main_plugin_file_basename()
-    {
-        return plugin_basename($this->get_main_plugin_file());
-    }
-
-    /**
-     * Gets the folder name which contains the main plugin file
-     *
-     * @return string
-     */
-    public function get_main_plugin_file_dirname()
-    {
-        return dirname($this->get_main_plugin_file());
-    }
-
-
-    /**
-     * sets hooks used in the admin
-     *
-     * @return void
-     */
-    public function admin_init()
-    {
-        // is admin and not in M-Mode ?
-        if (is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
-            add_filter('plugin_action_links', array($this, 'plugin_action_links'), 10, 2);
-            add_filter('after_plugin_row_' . $this->_plugin_basename, array($this, 'after_plugin_row'), 10, 3);
-        }
-    }
-
-
-    /**
-     * plugin_actions
-     * Add a settings link to the Plugins page, so people can go straight from the plugin page to the settings page.
-     *
-     * @param $links
-     * @param $file
-     * @return array
-     */
-    public function plugin_action_links($links, $file)
-    {
-        if ($file === $this->plugin_basename() && $this->plugin_action_slug() !== '') {
-            // before other links
-            array_unshift(
-                $links,
-                '<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
-                . esc_html__('Settings', 'event_espresso')
-                . '</a>'
-            );
-        }
-        return $links;
-    }
-
-
-    /**
-     * after_plugin_row
-     * Add additional content to the plugins page plugin row
-     * Inserts another row
-     *
-     * @param $plugin_file
-     * @param $plugin_data
-     * @param $status
-     * @return void
-     */
-    public function after_plugin_row($plugin_file, $plugin_data, $status)
-    {
-        $after_plugin_row = '';
-        $plugins_page_row = $this->get_plugins_page_row();
-        if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
-            $class = $status ? 'active' : 'inactive';
-            $link_text = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
-            $link_url = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
-            $description = isset($plugins_page_row['description'])
-                ? $plugins_page_row['description']
-                : '';
-            if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
-                $after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
-                $after_plugin_row .= '<th class="check-column" scope="row"></th>';
-                $after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
-                $after_plugin_row .= '<style>
+			EEH_Activation::initialize_db_content();
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flushRewriteRules();
+			// in case there are lots of addons being activated at once, let's force garbage collection
+			// to help avoid memory limit errors
+			// EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
+			gc_collect_cycles();
+		} else {
+			// ask the data migration manager to init this addon's data
+			// when migrations are finished because we can't do it now
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for($this->name());
+		}
+	}
+
+
+	/**
+	 * Used to setup this addon's database tables, but not necessarily any default
+	 * data in them. The default is to actually use the most up-to-date data migration script
+	 * for this addon, and just use its schema_changes_before_migration() and schema_changes_after_migration()
+	 * methods to setup the db.
+	 */
+	public function initialize_db()
+	{
+		// find the migration script that sets the database to be compatible with the code
+		$current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms($this->name());
+		if ($current_dms_name) {
+			$current_data_migration_script = EE_Registry::instance()->load_dms($current_dms_name);
+			$current_data_migration_script->set_migrating(false);
+			$current_data_migration_script->schema_changes_before_migration();
+			$current_data_migration_script->schema_changes_after_migration();
+			if ($current_data_migration_script->get_errors()) {
+				foreach ($current_data_migration_script->get_errors() as $error) {
+					EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+		}
+		// if not DMS was found that should be ok. This addon just doesn't require any database changes
+		EE_Data_Migration_Manager::instance()->update_current_database_state_to(
+			array(
+				'slug'    => $this->name(),
+				'version' => $this->version(),
+			)
+		);
+	}
+
+
+	/**
+	 * If you want to setup default data for the addon, override this method, and call
+	 * parent::initialize_default_data() from within it. This is normally called
+	 * from EE_Addon::initialize_db_if_no_migrations_required(), just after EE_Addon::initialize_db()
+	 * and should verify default data is present (but this is also called
+	 * on reactivations and just after migrations, so please verify you actually want
+	 * to ADD default data, because it may already be present).
+	 * However, please call this parent (currently it just fires a hook which other
+	 * addons may be depending on)
+	 */
+	public function initialize_default_data()
+	{
+		/**
+		 * Called when an addon is ensuring its default data is set (possibly called
+		 * on a reactivation, so first check for the absence of other data before setting
+		 * default data)
+		 *
+		 * @param EE_Addon $addon the addon that called this
+		 */
+		do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
+		// override to insert default data. It is safe to use the models here
+		// because the site should not be in maintenance mode
+	}
+
+
+	/**
+	 * EE Core detected that this addon has been upgraded. We should check if there
+	 * are any new migration scripts, and if so put the site into maintenance mode until
+	 * they're ran
+	 *
+	 * @return void
+	 */
+	public function upgrade()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__upgrade");
+		do_action('AHEE__EE_Addon__upgrade', $this);
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+		// also it's possible there is new default data that needs to be added
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required')
+		);
+	}
+
+
+	/**
+	 * If Core detects this addon has been downgraded, you may want to invoke some special logic here.
+	 */
+	public function downgrade()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__downgrade");
+		do_action('AHEE__EE_Addon__downgrade', $this);
+		// it's possible there's old default data that needs to be double-checked
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required')
+		);
+	}
+
+
+	/**
+	 * set_db_update_option_name
+	 * Until we do something better, we'll just check for migration scripts upon
+	 * plugin activation only. In the future, we'll want to do it on plugin updates too
+	 *
+	 * @return bool
+	 */
+	public function set_db_update_option_name()
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'EE_Addon::set_db_update_option_name was renamed to EE_Addon::set_activation_indicator_option',
+				'event_espresso'
+			),
+			'4.3.0.alpha.016'
+		);
+		// let's just handle this on the next request, ok? right now we're just not really ready
+		return $this->set_activation_indicator_option();
+	}
+
+
+	/**
+	 * Returns the name of the activation indicator option
+	 * (an option which is set temporarily to indicate that this addon was just activated)
+	 *
+	 * @deprecated since version 4.3.0.alpha.016
+	 * @return string
+	 */
+	public function get_db_update_option_name()
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'EE_Addon::get_db_update_option was renamed to EE_Addon::get_activation_indicator_option_name',
+				'event_espresso'
+			),
+			'4.3.0.alpha.016'
+		);
+		return $this->get_activation_indicator_option_name();
+	}
+
+
+	/**
+	 * When the addon is activated, this should be called to set a wordpress option that
+	 * indicates it was activated. This is especially useful for detecting reactivations.
+	 *
+	 * @return bool
+	 */
+	public function set_activation_indicator_option()
+	{
+		// let's just handle this on the next request, ok? right now we're just not really ready
+		return update_option($this->get_activation_indicator_option_name(), true);
+	}
+
+
+	/**
+	 * Gets the name of the wp option which is used to temporarily indicate that this addon was activated
+	 *
+	 * @return string
+	 */
+	public function get_activation_indicator_option_name()
+	{
+		return 'ee_activation_' . $this->name();
+	}
+
+
+	/**
+	 * Used by EE_System to set the request type of this addon. Should not be used by addon developers
+	 *
+	 * @param int $req_type
+	 */
+	public function set_req_type($req_type)
+	{
+		$this->_req_type = $req_type;
+	}
+
+
+	/**
+	 * Returns the request type of this addon (ie, EE_System::req_type_normal, EE_System::req_type_new_activation,
+	 * EE_System::req_type_reactivation, EE_System::req_type_upgrade, or EE_System::req_type_downgrade). This is set by
+	 * EE_System when it is checking for new install or upgrades of addons
+	 */
+	public function detect_req_type($redetect = false)
+	{
+		if ($this->_req_type === null || $redetect) {
+			$this->detect_activation_or_upgrade();
+		}
+		return $this->_req_type;
+	}
+
+
+	/**
+	 * Detects the request type for this addon (whether it was just activated, upgrades, a normal request, etc.)
+	 * Should only be called once per request
+	 *
+	 * @return void
+	 */
+	public function detect_activation_or_upgrade()
+	{
+		$activation_history_for_addon = $this->get_activation_history();
+		$request_type = EE_System::detect_req_type_given_activation_history(
+			$activation_history_for_addon,
+			$this->get_activation_indicator_option_name(),
+			$this->version()
+		);
+		$this->set_req_type($request_type);
+		$classname = get_class($this);
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__new_activation");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__new_activation', $this);
+				$this->new_install();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__reactivation");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__reactivation', $this);
+				$this->reactivation();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__upgrade");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__upgrade', $this);
+				$this->upgrade();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_downgrade:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__downgrade");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__downgrade', $this);
+				$this->downgrade();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				break;
+		}
+
+		do_action("AHEE__{$classname}__detect_if_activation_or_upgrade__complete");
+	}
+
+	/**
+	 * Updates the version history for this addon
+	 *
+	 * @param array  $version_history
+	 * @param string $current_version_to_add
+	 * @return boolean success
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
+	{
+		if (! $version_history) {
+			$version_history = $this->get_activation_history();
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = $this->version();
+		}
+		$version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+		// resave
+		return update_option($this->get_activation_history_option_name(), $version_history);
+	}
+
+	/**
+	 * Gets the name of the wp option that stores the activation history
+	 * of this addon
+	 *
+	 * @return string
+	 */
+	public function get_activation_history_option_name()
+	{
+		return self::ee_addon_version_history_option_prefix . $this->name();
+	}
+
+
+	/**
+	 * Gets the wp option which stores the activation history for this addon
+	 *
+	 * @return array
+	 */
+	public function get_activation_history()
+	{
+		return get_option($this->get_activation_history_option_name(), null);
+	}
+
+
+	/**
+	 * @param string $config_section
+	 */
+	public function set_config_section($config_section = '')
+	{
+		$this->_config_section = ! empty($config_section) ? $config_section : 'addons';
+	}
+
+	/**
+	 * Sets the filepath to the main plugin file
+	 *
+	 * @param string $filepath
+	 */
+	public function set_main_plugin_file($filepath)
+	{
+		$this->_main_plugin_file = $filepath;
+	}
+
+	/**
+	 * gets the filepath to teh main file
+	 *
+	 * @return string
+	 */
+	public function get_main_plugin_file()
+	{
+		return $this->_main_plugin_file;
+	}
+
+	/**
+	 * Gets the filename (no path) of the main file (the main file loaded
+	 * by WP)
+	 *
+	 * @return string
+	 */
+	public function get_main_plugin_file_basename()
+	{
+		return plugin_basename($this->get_main_plugin_file());
+	}
+
+	/**
+	 * Gets the folder name which contains the main plugin file
+	 *
+	 * @return string
+	 */
+	public function get_main_plugin_file_dirname()
+	{
+		return dirname($this->get_main_plugin_file());
+	}
+
+
+	/**
+	 * sets hooks used in the admin
+	 *
+	 * @return void
+	 */
+	public function admin_init()
+	{
+		// is admin and not in M-Mode ?
+		if (is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
+			add_filter('plugin_action_links', array($this, 'plugin_action_links'), 10, 2);
+			add_filter('after_plugin_row_' . $this->_plugin_basename, array($this, 'after_plugin_row'), 10, 3);
+		}
+	}
+
+
+	/**
+	 * plugin_actions
+	 * Add a settings link to the Plugins page, so people can go straight from the plugin page to the settings page.
+	 *
+	 * @param $links
+	 * @param $file
+	 * @return array
+	 */
+	public function plugin_action_links($links, $file)
+	{
+		if ($file === $this->plugin_basename() && $this->plugin_action_slug() !== '') {
+			// before other links
+			array_unshift(
+				$links,
+				'<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
+				. esc_html__('Settings', 'event_espresso')
+				. '</a>'
+			);
+		}
+		return $links;
+	}
+
+
+	/**
+	 * after_plugin_row
+	 * Add additional content to the plugins page plugin row
+	 * Inserts another row
+	 *
+	 * @param $plugin_file
+	 * @param $plugin_data
+	 * @param $status
+	 * @return void
+	 */
+	public function after_plugin_row($plugin_file, $plugin_data, $status)
+	{
+		$after_plugin_row = '';
+		$plugins_page_row = $this->get_plugins_page_row();
+		if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
+			$class = $status ? 'active' : 'inactive';
+			$link_text = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
+			$link_url = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
+			$description = isset($plugins_page_row['description'])
+				? $plugins_page_row['description']
+				: '';
+			if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
+				$after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
+				$after_plugin_row .= '<th class="check-column" scope="row"></th>';
+				$after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
+				$after_plugin_row .= '<style>
 .ee-button,
 .ee-button:active,
 .ee-button:visited {
@@ -845,64 +845,64 @@ 
 }
 .ee-button:active { top:0; }
 </style>';
-                $after_plugin_row .= '
+				$after_plugin_row .= '
 <p class="ee-addon-upsell-info-dv">
 	<a class="ee-button" href="' . $link_url . '">'
-                                     . $link_text
-                                     . ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span>'
-                                     . '</a>
+									 . $link_text
+									 . ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span>'
+									 . '</a>
 </p>';
-                $after_plugin_row .= '</td>';
-                $after_plugin_row .= '<td class="ee-addon-upsell-info-desc-td column-description desc">';
-                $after_plugin_row .= $description;
-                $after_plugin_row .= '</td>';
-                $after_plugin_row .= '</tr>';
-            } else {
-                $after_plugin_row .= $description;
-            }
-        }
-
-        echo $after_plugin_row;
-    }
-
-
-    /**
-     * A safe space for addons to add additional logic like setting hooks that need to be set early in the request.
-     * Child classes that have logic like that to run can override this method declaration.  This was not made abstract
-     * for back compat reasons.
-     *
-     * This will fire on the `AHEE__EE_System__load_espresso_addons__complete` hook at priority 999.
-     *
-     * It is recommended, if client code is `de-registering` an add-on, then do it on the
-     * `AHEE__EE_System__load_espresso_addons__complete` hook before priority 999 so as to ensure any code logic in this
-     * callback does not get run/set in that request.
-     *
-     * Also, keep in mind that if a registered add-on happens to be deactivated via
-     * EE_System::_deactivate_incompatible_addons() because its incompatible, any code executed in this method
-     * (including setting hooks etc) will have executed before the plugin was deactivated.  If you use
-     * `after_registration` to set any filter and/or action hooks and want to ensure they are removed on this add-on's
-     * deactivation, you can override `EE_Addon::deactivation` and unset your hooks and filters there.  Just remember
-     * to call `parent::deactivation`.
-     *
-     * @since 4.9.26
-     */
-    public function after_registration()
-    {
-        // cricket chirp... cricket chirp...
-    }
-
-    /**
-     * @return string
-     */
-    public function getPueSlug()
-    {
-        return $this->pue_slug;
-    }
-    /**
-     * @param string $pue_slug
-     */
-    public function setPueSlug($pue_slug)
-    {
-        $this->pue_slug = $pue_slug;
-    }
+				$after_plugin_row .= '</td>';
+				$after_plugin_row .= '<td class="ee-addon-upsell-info-desc-td column-description desc">';
+				$after_plugin_row .= $description;
+				$after_plugin_row .= '</td>';
+				$after_plugin_row .= '</tr>';
+			} else {
+				$after_plugin_row .= $description;
+			}
+		}
+
+		echo $after_plugin_row;
+	}
+
+
+	/**
+	 * A safe space for addons to add additional logic like setting hooks that need to be set early in the request.
+	 * Child classes that have logic like that to run can override this method declaration.  This was not made abstract
+	 * for back compat reasons.
+	 *
+	 * This will fire on the `AHEE__EE_System__load_espresso_addons__complete` hook at priority 999.
+	 *
+	 * It is recommended, if client code is `de-registering` an add-on, then do it on the
+	 * `AHEE__EE_System__load_espresso_addons__complete` hook before priority 999 so as to ensure any code logic in this
+	 * callback does not get run/set in that request.
+	 *
+	 * Also, keep in mind that if a registered add-on happens to be deactivated via
+	 * EE_System::_deactivate_incompatible_addons() because its incompatible, any code executed in this method
+	 * (including setting hooks etc) will have executed before the plugin was deactivated.  If you use
+	 * `after_registration` to set any filter and/or action hooks and want to ensure they are removed on this add-on's
+	 * deactivation, you can override `EE_Addon::deactivation` and unset your hooks and filters there.  Just remember
+	 * to call `parent::deactivation`.
+	 *
+	 * @since 4.9.26
+	 */
+	public function after_registration()
+	{
+		// cricket chirp... cricket chirp...
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getPueSlug()
+	{
+		return $this->pue_slug;
+	}
+	/**
+	 * @param string $pue_slug
+	 */
+	public function setPueSlug($pue_slug)
+	{
+		$this->pue_slug = $pue_slug;
+	}
 }

core/services/orm/tree_traversal/ModelObjNode.php

Indentation +188 added lines, -188 removed lines

@@ -22,206 +22,206 @@
  */
 class ModelObjNode extends BaseNode
 {
-    /**
-     * @var int|string
-     */
-    protected $id;
+	/**
+	 * @var int|string
+	 */
+	protected $id;
 
-    /**
-     * @var EEM_Base
-     */
-    protected $model;
+	/**
+	 * @var EEM_Base
+	 */
+	protected $model;
 
-    /**
-     * @var RelationNode[]
-     */
-    protected $nodes;
+	/**
+	 * @var RelationNode[]
+	 */
+	protected $nodes;
 
-    /**
-     * We don't pass the model objects because this needs to serialize to something tiny for effiency.
-     * @param $model_obj_id
-     * @param EEM_Base $model
-     * @param array $dont_traverse_models array of model names we DON'T want to traverse.
-     */
-    public function __construct($model_obj_id, EEM_Base $model, array $dont_traverse_models = [])
-    {
-        $this->id = $model_obj_id;
-        $this->model = $model;
-        $this->dont_traverse_models = $dont_traverse_models;
-    }
+	/**
+	 * We don't pass the model objects because this needs to serialize to something tiny for effiency.
+	 * @param $model_obj_id
+	 * @param EEM_Base $model
+	 * @param array $dont_traverse_models array of model names we DON'T want to traverse.
+	 */
+	public function __construct($model_obj_id, EEM_Base $model, array $dont_traverse_models = [])
+	{
+		$this->id = $model_obj_id;
+		$this->model = $model;
+		$this->dont_traverse_models = $dont_traverse_models;
+	}
 
-    /**
-     * Creates a relation node for each relation of this model's relations.
-     * Does NOT call `discover` on them yet though.
-     * @since 4.10.12.p
-     * @throws \EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function discover()
-    {
-        $this->nodes = [];
-        foreach ($this->model->relation_settings() as $relationName => $relation) {
-            // Make sure this isn't one of the models we were told to not traverse into.
-            if (in_array($relationName, $this->dont_traverse_models)) {
-                continue;
-            }
-            if ($relation instanceof EE_Has_Many_Relation) {
-                $this->nodes[ $relationName ] = new RelationNode(
-                    $this->id,
-                    $this->model,
-                    $relation->get_other_model(),
-                    $this->dont_traverse_models
-                );
-            } elseif (
-                $relation instanceof EE_HABTM_Relation &&
-                ! in_array(
-                    $relation->get_join_model()->get_this_model_name(),
-                    $this->dont_traverse_models
-                )
-            ) {
-                $this->nodes[ $relation->get_join_model()->get_this_model_name() ] = new RelationNode(
-                    $this->id,
-                    $this->model,
-                    $relation->get_join_model(),
-                    $this->dont_traverse_models
-                );
-            }
-        }
-        ksort($this->nodes);
-    }
+	/**
+	 * Creates a relation node for each relation of this model's relations.
+	 * Does NOT call `discover` on them yet though.
+	 * @since 4.10.12.p
+	 * @throws \EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function discover()
+	{
+		$this->nodes = [];
+		foreach ($this->model->relation_settings() as $relationName => $relation) {
+			// Make sure this isn't one of the models we were told to not traverse into.
+			if (in_array($relationName, $this->dont_traverse_models)) {
+				continue;
+			}
+			if ($relation instanceof EE_Has_Many_Relation) {
+				$this->nodes[ $relationName ] = new RelationNode(
+					$this->id,
+					$this->model,
+					$relation->get_other_model(),
+					$this->dont_traverse_models
+				);
+			} elseif (
+				$relation instanceof EE_HABTM_Relation &&
+				! in_array(
+					$relation->get_join_model()->get_this_model_name(),
+					$this->dont_traverse_models
+				)
+			) {
+				$this->nodes[ $relation->get_join_model()->get_this_model_name() ] = new RelationNode(
+					$this->id,
+					$this->model,
+					$relation->get_join_model(),
+					$this->dont_traverse_models
+				);
+			}
+		}
+		ksort($this->nodes);
+	}
 
 
-    /**
-     * Whether this item has already been initialized
-     */
-    protected function isDiscovered()
-    {
-        return $this->nodes !== null && is_array($this->nodes);
-    }
+	/**
+	 * Whether this item has already been initialized
+	 */
+	protected function isDiscovered()
+	{
+		return $this->nodes !== null && is_array($this->nodes);
+	}
 
-    /**
-     * @since 4.10.12.p
-     * @return boolean
-     */
-    public function isComplete()
-    {
-        if ($this->complete === null) {
-            $this->complete = false;
-        }
-        return $this->complete;
-    }
+	/**
+	 * @since 4.10.12.p
+	 * @return boolean
+	 */
+	public function isComplete()
+	{
+		if ($this->complete === null) {
+			$this->complete = false;
+		}
+		return $this->complete;
+	}
 
-    /**
-     * Triggers working on each child relation node that has work to do.
-     * @since 4.10.12.p
-     * @param $model_objects_to_identify
-     * @return int units of work done
-     */
-    protected function work($model_objects_to_identify)
-    {
-        $num_identified = 0;
-        // Begin assuming we'll finish all the work on this node and its children...
-        $this->complete = true;
-        foreach ($this->nodes as $model_name => $relation_node) {
-            $num_identified += $relation_node->visit($model_objects_to_identify - $num_identified);
-            // To save on space when serializing, only bother keeping a record of relation nodes that actually found
-            // related model objects.
-            if ($relation_node->isComplete() && $relation_node->countSubNodes() === 0) {
-                unset($this->nodes[ $model_name ]);
-            }
-            if ($num_identified >= $model_objects_to_identify) {
-                // ...but admit we're wrong if the work exceeded the budget.
-                $this->complete = false;
-                break;
-            }
-        }
-        return $num_identified;
-    }
+	/**
+	 * Triggers working on each child relation node that has work to do.
+	 * @since 4.10.12.p
+	 * @param $model_objects_to_identify
+	 * @return int units of work done
+	 */
+	protected function work($model_objects_to_identify)
+	{
+		$num_identified = 0;
+		// Begin assuming we'll finish all the work on this node and its children...
+		$this->complete = true;
+		foreach ($this->nodes as $model_name => $relation_node) {
+			$num_identified += $relation_node->visit($model_objects_to_identify - $num_identified);
+			// To save on space when serializing, only bother keeping a record of relation nodes that actually found
+			// related model objects.
+			if ($relation_node->isComplete() && $relation_node->countSubNodes() === 0) {
+				unset($this->nodes[ $model_name ]);
+			}
+			if ($num_identified >= $model_objects_to_identify) {
+				// ...but admit we're wrong if the work exceeded the budget.
+				$this->complete = false;
+				break;
+			}
+		}
+		return $num_identified;
+	}
 
-    /**
-     * @since 4.10.12.p
-     * @return array
-     * @throws \EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function toArray()
-    {
-        $tree = [
-            'id' => $this->id,
-            'complete' => $this->isComplete(),
-            'rels' => []
-        ];
-        if ($this->nodes === null) {
-            $tree['rels'] = null;
-        } else {
-            foreach ($this->nodes as $relation_name => $relation_node) {
-                $tree['rels'][ $relation_name ] = $relation_node->toArray();
-            }
-        }
-        return $tree;
-    }
+	/**
+	 * @since 4.10.12.p
+	 * @return array
+	 * @throws \EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function toArray()
+	{
+		$tree = [
+			'id' => $this->id,
+			'complete' => $this->isComplete(),
+			'rels' => []
+		];
+		if ($this->nodes === null) {
+			$tree['rels'] = null;
+		} else {
+			foreach ($this->nodes as $relation_name => $relation_node) {
+				$tree['rels'][ $relation_name ] = $relation_node->toArray();
+			}
+		}
+		return $tree;
+	}
 
-    /**
-     * @since 4.10.12.p
-     * @return array|mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws \EE_Error
-     */
-    public function getIds()
-    {
-        $ids = [
-            $this->model->get_this_model_name() => [
-                $this->id => $this->id
-            ]
-        ];
-        if ($this->nodes && is_array($this->nodes)) {
-            foreach ($this->nodes as $relation_node) {
-                $ids = array_replace_recursive($ids, $relation_node->getIds());
-            }
-        }
-        return $ids;
-    }
+	/**
+	 * @since 4.10.12.p
+	 * @return array|mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws \EE_Error
+	 */
+	public function getIds()
+	{
+		$ids = [
+			$this->model->get_this_model_name() => [
+				$this->id => $this->id
+			]
+		];
+		if ($this->nodes && is_array($this->nodes)) {
+			foreach ($this->nodes as $relation_node) {
+				$ids = array_replace_recursive($ids, $relation_node->getIds());
+			}
+		}
+		return $ids;
+	}
 
-    /**
-     * Don't serialize the models. Just record their names on some dynamic properties.
-     * @since 4.10.12.p
-     */
-    public function __sleep()
-    {
-        $this->m = $this->model->get_this_model_name();
-        return array_merge(
-            [
-                'm',
-                'id',
-                'nodes',
-            ],
-            parent::__sleep()
-        );
-    }
+	/**
+	 * Don't serialize the models. Just record their names on some dynamic properties.
+	 * @since 4.10.12.p
+	 */
+	public function __sleep()
+	{
+		$this->m = $this->model->get_this_model_name();
+		return array_merge(
+			[
+				'm',
+				'id',
+				'nodes',
+			],
+			parent::__sleep()
+		);
+	}
 
-    /**
-     * Use the dynamic properties to instantiate the models we use.
-     * @since 4.10.12.p
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __wakeup()
-    {
-        $this->model = EE_Registry::instance()->load_model($this->m);
-        parent::__wakeup();
-    }
+	/**
+	 * Use the dynamic properties to instantiate the models we use.
+	 * @since 4.10.12.p
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __wakeup()
+	{
+		$this->model = EE_Registry::instance()->load_model($this->m);
+		parent::__wakeup();
+	}
 }
 // End of file Visitor.php
 // Location: EventEspresso\core\services\orm\tree_traversal/Visitor.php

Spacing +4 added lines, -4 removed lines

@@ -69,7 +69,7 @@ 
                 continue;
             }
             if ($relation instanceof EE_Has_Many_Relation) {
-                $this->nodes[ $relationName ] = new RelationNode(
+                $this->nodes[$relationName] = new RelationNode(
                     $this->id,
                     $this->model,
                     $relation->get_other_model(),
@@ -82,7 +82,7 @@ 
                     $this->dont_traverse_models
                 )
             ) {
-                $this->nodes[ $relation->get_join_model()->get_this_model_name() ] = new RelationNode(
+                $this->nodes[$relation->get_join_model()->get_this_model_name()] = new RelationNode(
                     $this->id,
                     $this->model,
                     $relation->get_join_model(),
@@ -130,7 +130,7 @@ 
             // To save on space when serializing, only bother keeping a record of relation nodes that actually found
             // related model objects.
             if ($relation_node->isComplete() && $relation_node->countSubNodes() === 0) {
-                unset($this->nodes[ $model_name ]);
+                unset($this->nodes[$model_name]);
             }
             if ($num_identified >= $model_objects_to_identify) {
                 // ...but admit we're wrong if the work exceeded the budget.
@@ -161,7 +161,7 @@ 
             $tree['rels'] = null;
         } else {
             foreach ($this->nodes as $relation_name => $relation_node) {
-                $tree['rels'][ $relation_name ] = $relation_node->toArray();
+                $tree['rels'][$relation_name] = $relation_node->toArray();
             }
         }
         return $tree;

core/libraries/plugin_api/EE_Register_Model_Extensions.lib.php

Spacing +12 added lines, -12 removed lines

@@ -68,11 +68,11 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $identifier ])) {
+        if (isset(self::$_registry[$identifier])) {
             return;
         }
         // check correct loading
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
             EE_Error::doing_it_wrong(
                 __METHOD__,
                 sprintf(
@@ -89,30 +89,30 @@ 
             );
         }
 
-        self::$_registry[ $identifier ]   = $setup_args;
-        self::$_extensions[ $identifier ] = [];
+        self::$_registry[$identifier]   = $setup_args;
+        self::$_extensions[$identifier] = [];
 
         if (isset($setup_args['model_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
+            require_once(EE_LIBRARIES.'plugin_api/db/EEME_Base.lib.php');
             $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_extension_paths']);
             // remove all files that are not PHP
             foreach ($class_to_filepath_map as $class => $path) {
                 if (substr($path, strlen($path) - 3) !== 'php') {
-                    unset($class_to_filepath_map[ $class ]);
+                    unset($class_to_filepath_map[$class]);
                 }
             }
             EEH_Autoloader::register_autoloader($class_to_filepath_map);
             foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $identifier ]['models'][ $classname ] = new $classname();
+                self::$_extensions[$identifier]['models'][$classname] = new $classname();
             }
             unset($setup_args['model_extension_paths']);
         }
         if (isset($setup_args['class_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
+            require_once(EE_LIBRARIES.'plugin_api/db/EEE_Base_Class.lib.php');
             $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_extension_paths']);
             EEH_Autoloader::register_autoloader($class_to_filepath_map);
             foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $identifier ]['classes'][ $classname ] = new $classname();
+                self::$_extensions[$identifier]['classes'][$classname] = new $classname();
             }
             unset($setup_args['class_extension_paths']);
         }
@@ -131,9 +131,9 @@ 
      */
     public static function deregister($identifier = '')
     {
-        if (isset(self::$_registry[ $identifier ])) {
-            unset(self::$_registry[ $identifier ]);
-            foreach (self::$_extensions[ $identifier ] as $extension_of_type) {
+        if (isset(self::$_registry[$identifier])) {
+            unset(self::$_registry[$identifier]);
+            foreach (self::$_extensions[$identifier] as $extension_of_type) {
                 foreach ($extension_of_type as $extension) {
                     $extension->deregister();
                 }

Indentation +120 added lines, -120 removed lines

@@ -11,132 +11,132 @@
  */
 class EE_Register_Model_Extensions implements EEI_Plugin_API
 {
-    protected static $_registry;
+	protected static $_registry;
 
-    protected static $_extensions = [];
+	protected static $_extensions = [];
 
 
-    /**
-     * register method for setting up model extensions
-     *
-     * @param string $identifier            unique id for the extensions being setup
-     * @param array  $setup_args            {
-     * @return void
-     * @throws EE_Error
-     * @type  array  $model_extension_paths array of folders containing DB model extensions, where each file follows
-     *                                      the models naming convention, which is:
-     *                                      EEME_{your_plugin_slug}_model_name_extended}.model_ext.php.
-     *                                      Where {your_plugin_slug} is really anything you want (but something having
-     *                                      to do with your addon, like 'Calendar' or '3D_View') and
-     *                                      model_name_extended} is the model extended.
-     *                                      The class contained in teh file should extend
-     *                                      EEME_Base_{model_name_extended}.model_ext.php.
-     *                                      Where {your_plugin_slug} is really anything you want (but something
-     *                                      having to do with your addon, like 'Calendar' or '3D_View') and
-     *                                      {model_name_extended} is the model extended. The class contained in teh
-     *                                      file should extend EEME_Base
-     * @type array   $class_extension_paths array of folders containing DB class extensions, where each file follows
-     *                                      the model class extension naming convention, which is:
-     *                                      EEE_{your_plugin_slug}_model_name_extended}.class_ext.php.
-     *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
-     *                                      and model_name_extended} is the name of the model extended, eg
-     *                                      'Attendee','Event',etc.
-     *                                      The class contained in the file should extend EEE_Base_Class
-     *                                      ._{model_name_extended}.class_ext.php.
-     *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
-     *                                      and {model_name_extended} is the name of the model extended, eg
-     *                                      'Attendee','Event',etc. The class contained in the file should extend
-     *                                      EEE_Base_Class.
-     *                                      }
-     *
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (
-            empty($identifier)
-            || ! is_array($setup_args)
-            || (empty($setup_args['model_extension_paths']) && empty($setup_args['class_extension_paths']))
-        ) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Model extensions with EE_Register_Model_Extensions::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_extension_paths" (an array of full server paths to folders that contain model extensions), and "class_extension_paths" (an array of full server paths to folders that contain class extensions)',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 * register method for setting up model extensions
+	 *
+	 * @param string $identifier            unique id for the extensions being setup
+	 * @param array  $setup_args            {
+	 * @return void
+	 * @throws EE_Error
+	 * @type  array  $model_extension_paths array of folders containing DB model extensions, where each file follows
+	 *                                      the models naming convention, which is:
+	 *                                      EEME_{your_plugin_slug}_model_name_extended}.model_ext.php.
+	 *                                      Where {your_plugin_slug} is really anything you want (but something having
+	 *                                      to do with your addon, like 'Calendar' or '3D_View') and
+	 *                                      model_name_extended} is the model extended.
+	 *                                      The class contained in teh file should extend
+	 *                                      EEME_Base_{model_name_extended}.model_ext.php.
+	 *                                      Where {your_plugin_slug} is really anything you want (but something
+	 *                                      having to do with your addon, like 'Calendar' or '3D_View') and
+	 *                                      {model_name_extended} is the model extended. The class contained in teh
+	 *                                      file should extend EEME_Base
+	 * @type array   $class_extension_paths array of folders containing DB class extensions, where each file follows
+	 *                                      the model class extension naming convention, which is:
+	 *                                      EEE_{your_plugin_slug}_model_name_extended}.class_ext.php.
+	 *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
+	 *                                      and model_name_extended} is the name of the model extended, eg
+	 *                                      'Attendee','Event',etc.
+	 *                                      The class contained in the file should extend EEE_Base_Class
+	 *                                      ._{model_name_extended}.class_ext.php.
+	 *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
+	 *                                      and {model_name_extended} is the name of the model extended, eg
+	 *                                      'Attendee','Event',etc. The class contained in the file should extend
+	 *                                      EEE_Base_Class.
+	 *                                      }
+	 *
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (
+			empty($identifier)
+			|| ! is_array($setup_args)
+			|| (empty($setup_args['model_extension_paths']) && empty($setup_args['class_extension_paths']))
+		) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Model extensions with EE_Register_Model_Extensions::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_extension_paths" (an array of full server paths to folders that contain model extensions), and "class_extension_paths" (an array of full server paths to folders that contain class extensions)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $identifier ])) {
-            return;
-        }
-        // check correct loading
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'An attempt was made to register "%1$s" as a Model extension has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.%2$s Hook Status: %2$s "AHEE__EE_System__load_espresso_addons" : %3$s %2$s "AHEE__EE_Admin__loaded" : %4$s%2$s',
-                        'event_espresso'
-                    ),
-                    $identifier,
-                    '<br />',
-                    did_action('AHEE__EE_System__load_espresso_addons') ? 'action done' : 'action NOT done',
-                    did_action('AHEE__EE_Admin__loaded') ? 'action done' : 'action NOT done'
-                ),
-                '4.3'
-            );
-        }
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $identifier ])) {
+			return;
+		}
+		// check correct loading
+		if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'An attempt was made to register "%1$s" as a Model extension has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.%2$s Hook Status: %2$s "AHEE__EE_System__load_espresso_addons" : %3$s %2$s "AHEE__EE_Admin__loaded" : %4$s%2$s',
+						'event_espresso'
+					),
+					$identifier,
+					'<br />',
+					did_action('AHEE__EE_System__load_espresso_addons') ? 'action done' : 'action NOT done',
+					did_action('AHEE__EE_Admin__loaded') ? 'action done' : 'action NOT done'
+				),
+				'4.3'
+			);
+		}
 
-        self::$_registry[ $identifier ]   = $setup_args;
-        self::$_extensions[ $identifier ] = [];
+		self::$_registry[ $identifier ]   = $setup_args;
+		self::$_extensions[ $identifier ] = [];
 
-        if (isset($setup_args['model_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_extension_paths']);
-            // remove all files that are not PHP
-            foreach ($class_to_filepath_map as $class => $path) {
-                if (substr($path, strlen($path) - 3) !== 'php') {
-                    unset($class_to_filepath_map[ $class ]);
-                }
-            }
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $identifier ]['models'][ $classname ] = new $classname();
-            }
-            unset($setup_args['model_extension_paths']);
-        }
-        if (isset($setup_args['class_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_extension_paths']);
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $identifier ]['classes'][ $classname ] = new $classname();
-            }
-            unset($setup_args['class_extension_paths']);
-        }
-        foreach ($setup_args as $unknown_key => $unknown_config) {
-            throw new EE_Error(
-                sprintf(esc_html__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
-            );
-        }
-    }
+		if (isset($setup_args['model_extension_paths'])) {
+			require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_extension_paths']);
+			// remove all files that are not PHP
+			foreach ($class_to_filepath_map as $class => $path) {
+				if (substr($path, strlen($path) - 3) !== 'php') {
+					unset($class_to_filepath_map[ $class ]);
+				}
+			}
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			foreach (array_keys($class_to_filepath_map) as $classname) {
+				self::$_extensions[ $identifier ]['models'][ $classname ] = new $classname();
+			}
+			unset($setup_args['model_extension_paths']);
+		}
+		if (isset($setup_args['class_extension_paths'])) {
+			require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_extension_paths']);
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			foreach (array_keys($class_to_filepath_map) as $classname) {
+				self::$_extensions[ $identifier ]['classes'][ $classname ] = new $classname();
+			}
+			unset($setup_args['class_extension_paths']);
+		}
+		foreach ($setup_args as $unknown_key => $unknown_config) {
+			throw new EE_Error(
+				sprintf(esc_html__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
+			);
+		}
+	}
 
 
-    /**
-     * deregister
-     *
-     * @param string $identifier
-     */
-    public static function deregister($identifier = '')
-    {
-        if (isset(self::$_registry[ $identifier ])) {
-            unset(self::$_registry[ $identifier ]);
-            foreach (self::$_extensions[ $identifier ] as $extension_of_type) {
-                foreach ($extension_of_type as $extension) {
-                    $extension->deregister();
-                }
-            }
-        }
-    }
+	/**
+	 * deregister
+	 *
+	 * @param string $identifier
+	 */
+	public static function deregister($identifier = '')
+	{
+		if (isset(self::$_registry[ $identifier ])) {
+			unset(self::$_registry[ $identifier ]);
+			foreach (self::$_extensions[ $identifier ] as $extension_of_type) {
+				foreach ($extension_of_type as $extension) {
+					$extension->deregister();
+				}
+			}
+		}
+	}
 }