eventespresso / event-espresso-core

caffeinated/admin/extend/registration_form/espresso_events_Registration_Form_Hooks_Extend.class.php

Indentation +189 added lines, -189 removed lines

@@ -16,208 +16,208 @@
 class espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks
 {
 
-    /**
-     * extending the properties set in espresso_events_Registration_From_Hooks
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _extend_properties()
-    {
-        $this->_metaboxes = array_merge(
-            $this->_metaboxes,
-            array(
-                1 => array(
-                    'page_route' => array('create_new', 'edit'),
-                    'func'       => 'additional_questions',
-                    'label'      => esc_html__('Questions for Additional Registrants', 'event_espresso'),
-                    'priority'   => 'default',
-                    'context'    => 'side',
-                ),
-            )
-        );
-        $this->_scripts_styles = array(
-            'registers' => array(
-                'extended-event-editor' => array(
-                    'url'     => EE_CORE_CAF_ADMIN_EXTEND_URL
-                                 . 'registration_form/assets/event-editor-question-groups.js',
-                    'depends' => array('jquery'),
-                ),
-            ),
-            'enqueues'  => array(
-                'extended-event-editor' => array('edit', 'create_new'),
-            ),
-        );
-    }
-
-
-    /**
-     * @param Callable[] $callbacks
-     * @return array
-     */
-    public function modify_callbacks($callbacks)
-    {
-        $callbacks = parent::modify_callbacks($callbacks);
-        $callbacks[] = array($this, 'additional_question_group_update');
-        return $callbacks;
-    }
-
-
-    /**
-     * Call back hooked into revision restores.
-     *
-     * @param $post_id
-     * @param $revision_id
-     * @return EE_Base_Class|void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function restore_revision($post_id, $revision_id)
-    {
-        $post_evt = parent::restore_revision($post_id, $revision_id);
-
-        // restore revision for additional questions
-        $post_evt->restore_revision(
-            $revision_id,
-            ['Question_Group'],
-            [
-                'Question_Group' => ['Event_Question_Group.EQG_additional' => true],
-            ]
-        );
-    }
-
-
-    /**
-     * @param $post_id
-     * @param $post
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function additional_questions($post_id, $post)
-    {
-        $this->_event = $this->_adminpage_obj->get_event_object();
-        $event_id = $this->_event->ID();
-        ?>
+	/**
+	 * extending the properties set in espresso_events_Registration_From_Hooks
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _extend_properties()
+	{
+		$this->_metaboxes = array_merge(
+			$this->_metaboxes,
+			array(
+				1 => array(
+					'page_route' => array('create_new', 'edit'),
+					'func'       => 'additional_questions',
+					'label'      => esc_html__('Questions for Additional Registrants', 'event_espresso'),
+					'priority'   => 'default',
+					'context'    => 'side',
+				),
+			)
+		);
+		$this->_scripts_styles = array(
+			'registers' => array(
+				'extended-event-editor' => array(
+					'url'     => EE_CORE_CAF_ADMIN_EXTEND_URL
+								 . 'registration_form/assets/event-editor-question-groups.js',
+					'depends' => array('jquery'),
+				),
+			),
+			'enqueues'  => array(
+				'extended-event-editor' => array('edit', 'create_new'),
+			),
+		);
+	}
+
+
+	/**
+	 * @param Callable[] $callbacks
+	 * @return array
+	 */
+	public function modify_callbacks($callbacks)
+	{
+		$callbacks = parent::modify_callbacks($callbacks);
+		$callbacks[] = array($this, 'additional_question_group_update');
+		return $callbacks;
+	}
+
+
+	/**
+	 * Call back hooked into revision restores.
+	 *
+	 * @param $post_id
+	 * @param $revision_id
+	 * @return EE_Base_Class|void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function restore_revision($post_id, $revision_id)
+	{
+		$post_evt = parent::restore_revision($post_id, $revision_id);
+
+		// restore revision for additional questions
+		$post_evt->restore_revision(
+			$revision_id,
+			['Question_Group'],
+			[
+				'Question_Group' => ['Event_Question_Group.EQG_additional' => true],
+			]
+		);
+	}
+
+
+	/**
+	 * @param $post_id
+	 * @param $post
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function additional_questions($post_id, $post)
+	{
+		$this->_event = $this->_adminpage_obj->get_event_object();
+		$event_id = $this->_event->ID();
+		?>
         <div class="inside">
             <p><strong>
                     <?php _e('Question Groups', 'event_espresso'); ?>
                 </strong><br/>
                 <?php
-                printf(
-                    esc_html__(
-                        'Add a pre-populated %1$sgroup of questions%2$s to your event.',
-                        'event_espresso'
-                    ),
-                    '<a href="admin.php?page=espresso_registration_form" target="_blank">',
-                    '</a>'
-                );
-                ?>
+				printf(
+					esc_html__(
+						'Add a pre-populated %1$sgroup of questions%2$s to your event.',
+						'event_espresso'
+					),
+					'<a href="admin.php?page=espresso_registration_form" target="_blank">',
+					'</a>'
+				);
+				?>
             </p>
             <?php
 
-            $qsg_where['QSG_deleted'] = false;
-            $query_params = apply_filters(
-                'FHEE__espresso_events_Registration_Form_Hooks_Extend__additional_questions__question_group_query_parameters',
-                array($qsg_where, 'order_by' => array('QSG_order' => 'ASC'))
-            );
-            $QSGs = EEM_Question_Group::instance()->get_all($query_params);
-            $EQGs = ! empty($event_id)
-                ? $this->_event->get_many_related(
-                    'Question_Group',
-                    [['Event_Question_Group.EQG_additional' => true]]
-                )
-                : [];
-            $EQGids = array_keys($EQGs);
-
-            if (! empty($QSGs)) {
-                $html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
-                foreach ($QSGs as $QSG) {
-                    $checked = in_array($QSG->ID(), $EQGids, true) ? ' checked="checked" ' : '';
-                    $edit_link = EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action' => 'edit_question_group',
-                            'QSG_ID' => $QSG->ID(),
-                        ),
-                        EE_FORMS_ADMIN_URL
-                    );
-
-                    $html .= '
+			$qsg_where['QSG_deleted'] = false;
+			$query_params = apply_filters(
+				'FHEE__espresso_events_Registration_Form_Hooks_Extend__additional_questions__question_group_query_parameters',
+				array($qsg_where, 'order_by' => array('QSG_order' => 'ASC'))
+			);
+			$QSGs = EEM_Question_Group::instance()->get_all($query_params);
+			$EQGs = ! empty($event_id)
+				? $this->_event->get_many_related(
+					'Question_Group',
+					[['Event_Question_Group.EQG_additional' => true]]
+				)
+				: [];
+			$EQGids = array_keys($EQGs);
+
+			if (! empty($QSGs)) {
+				$html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
+				foreach ($QSGs as $QSG) {
+					$checked = in_array($QSG->ID(), $EQGids, true) ? ' checked="checked" ' : '';
+					$edit_link = EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action' => 'edit_question_group',
+							'QSG_ID' => $QSG->ID(),
+						),
+						EE_FORMS_ADMIN_URL
+					);
+
+					$html .= '
 					<p id="event-question-group-' . $QSG->ID() . '">
 						<input value="' . $QSG->ID() . '"'
-                             . ' type="checkbox" name="add_attendee_question_groups[' . $QSG->ID() . ']"' . $checked . ' />
+							 . ' type="checkbox" name="add_attendee_question_groups[' . $QSG->ID() . ']"' . $checked . ' />
 						<a href="' . $edit_link . '" title="'
-                             . sprintf(
-                                 esc_attr__('Edit %s Group', 'event_espresso'),
-                                 $QSG->get('QSG_name')
-                             )
-                             . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
+							 . sprintf(
+								 esc_attr__('Edit %s Group', 'event_espresso'),
+								 $QSG->get('QSG_name')
+							 )
+							 . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
 					</p>';
-                    if ($QSG->ID() === 2) {
-                        $html .= '
+					if ($QSG->ID() === 2) {
+						$html .= '
 					<p id="question-group-requirements-notice-pg" class="important-notice small-text" style="display: none;">'
-                                 . esc_html__(
-                                     'The Personal Information question group is required whenever the Address Information question group is activated.',
-                                     'event_espresso'
-                                 )
-                                 . '</p>';
-                    }
-                }
-                $html .= count($QSGs) > 10 ? '</div>' : '';
-
-                echo $html;
-            } else {
-                esc_html_e(
-                    'There seems to be a problem with your questions. Please contact support@eventespresso.com',
-                    'event_espresso'
-                );
-            }
-            do_action('AHEE__espresso_events_Registration_Form_Hooks__additional_questions__after_content');
-            ?>
+								 . esc_html__(
+									 'The Personal Information question group is required whenever the Address Information question group is activated.',
+									 'event_espresso'
+								 )
+								 . '</p>';
+					}
+				}
+				$html .= count($QSGs) > 10 ? '</div>' : '';
+
+				echo $html;
+			} else {
+				esc_html_e(
+					'There seems to be a problem with your questions. Please contact support@eventespresso.com',
+					'event_espresso'
+				);
+			}
+			do_action('AHEE__espresso_events_Registration_Form_Hooks__additional_questions__after_content');
+			?>
         </div>
         <?php
-    }
-
-
-    public function additional_question_group_update($evtobj, $data)
-    {
-        $question_groups = ! empty($data['add_attendee_question_groups'])
-            ? (array) $data['add_attendee_question_groups']
-            : [];
-        $added_qgs = array_keys($question_groups);
-        $success = [];
-
-        // let's get all current question groups associated with this event.
-        $current_qgs = $evtobj->get_many_related(
-            'Question_Group',
-            [['Event_Question_Group.EQG_additional' => true]]
-        );
-        $current_qgs = array_keys($current_qgs); // we just want the ids
-
-        // now let's get the groups selected in the editor and update (IF we have data)
-        if (! empty($question_groups)) {
-            foreach ($question_groups as $qgid) {
-                // add to event
-                if ($qgid) {
-                    $qg = $evtobj->add_question_group($qgid, false);
-                }
-                $success[] = ! empty($qg) ? 1 : 0;
-            }
-        }
-
-        // wait a minute... are there question groups missing in the saved groups that ARE with the current event?
-        $removed_qgs = array_diff($current_qgs, $added_qgs);
-
-        foreach ($removed_qgs as $qgid) {
-            $qg = $evtobj->remove_question_group($qgid, false);
-            $success[] = ! empty($qg) ? 1 : 0;
-        }
-
-
-        return in_array(0, $success, true) ? false : true;
-    }
+	}
+
+
+	public function additional_question_group_update($evtobj, $data)
+	{
+		$question_groups = ! empty($data['add_attendee_question_groups'])
+			? (array) $data['add_attendee_question_groups']
+			: [];
+		$added_qgs = array_keys($question_groups);
+		$success = [];
+
+		// let's get all current question groups associated with this event.
+		$current_qgs = $evtobj->get_many_related(
+			'Question_Group',
+			[['Event_Question_Group.EQG_additional' => true]]
+		);
+		$current_qgs = array_keys($current_qgs); // we just want the ids
+
+		// now let's get the groups selected in the editor and update (IF we have data)
+		if (! empty($question_groups)) {
+			foreach ($question_groups as $qgid) {
+				// add to event
+				if ($qgid) {
+					$qg = $evtobj->add_question_group($qgid, false);
+				}
+				$success[] = ! empty($qg) ? 1 : 0;
+			}
+		}
+
+		// wait a minute... are there question groups missing in the saved groups that ARE with the current event?
+		$removed_qgs = array_diff($current_qgs, $added_qgs);
+
+		foreach ($removed_qgs as $qgid) {
+			$qg = $evtobj->remove_question_group($qgid, false);
+			$success[] = ! empty($qg) ? 1 : 0;
+		}
+
+
+		return in_array(0, $success, true) ? false : true;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -134,7 +134,7 @@ 
                 : [];
             $EQGids = array_keys($EQGs);
 
-            if (! empty($QSGs)) {
+            if ( ! empty($QSGs)) {
                 $html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
                 foreach ($QSGs as $QSG) {
                     $checked = in_array($QSG->ID(), $EQGids, true) ? ' checked="checked" ' : '';
@@ -147,15 +147,15 @@ 
                     );
 
                     $html .= '
-					<p id="event-question-group-' . $QSG->ID() . '">
-						<input value="' . $QSG->ID() . '"'
-                             . ' type="checkbox" name="add_attendee_question_groups[' . $QSG->ID() . ']"' . $checked . ' />
-						<a href="' . $edit_link . '" title="'
+					<p id="event-question-group-' . $QSG->ID().'">
+						<input value="' . $QSG->ID().'"'
+                             . ' type="checkbox" name="add_attendee_question_groups['.$QSG->ID().']"'.$checked.' />
+						<a href="' . $edit_link.'" title="'
                              . sprintf(
                                  esc_attr__('Edit %s Group', 'event_espresso'),
                                  $QSG->get('QSG_name')
                              )
-                             . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
+                             . '" target="_blank">'.$QSG->get('QSG_name').'</a>
 					</p>';
                     if ($QSG->ID() === 2) {
                         $html .= '
@@ -199,7 +199,7 @@ 
         $current_qgs = array_keys($current_qgs); // we just want the ids
 
         // now let's get the groups selected in the editor and update (IF we have data)
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
             foreach ($question_groups as $qgid) {
                 // add to event
                 if ($qgid) {

core/db_classes/EE_Event.class.php

Spacing +10 added lines, -10 removed lines

@@ -71,7 +71,7 @@ 
      */
     public function getAvailableSpacesCalculator()
     {
-        if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
+        if ( ! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
             $this->available_spaces_calculator = new EventSpacesCalculator($this);
         }
         return $this->available_spaces_calculator;
@@ -213,7 +213,7 @@ 
      */
     public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
     {
-        if (! empty($this->_Primary_Datetime)) {
+        if ( ! empty($this->_Primary_Datetime)) {
             return $this->_Primary_Datetime;
         }
         $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
@@ -236,7 +236,7 @@ 
     {
         // first get all datetimes
         $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
+        if ( ! $datetimes) {
             return array();
         }
         $datetime_ids = array();
@@ -429,7 +429,7 @@ 
     public function short_description($num_words = 55, $more = null, $not_full_desc = false)
     {
         $short_desc = $this->get('EVT_short_desc');
-        if (! empty($short_desc) || $not_full_desc) {
+        if ( ! empty($short_desc) || $not_full_desc) {
             return $short_desc;
         }
         $full_desc = $this->get('EVT_desc');
@@ -883,7 +883,7 @@ 
         );
         $all_expired = true;
         foreach ($tickets as $ticket) {
-            if (! $ticket->is_expired()) {
+            if ( ! $ticket->is_expired()) {
                 $all_expired = false;
                 break;
             }
@@ -972,7 +972,7 @@ 
      */
     public function is_sold_out($actual = false)
     {
-        if (! $actual) {
+        if ( ! $actual) {
             return $this->status() === EEM_Event::sold_out;
         }
         return $this->perform_sold_out_status_check();
@@ -1017,11 +1017,11 @@ 
     public function get_active_status($reset = false)
     {
         // if the active status has already been set, then just use that value (unless we are resetting it)
-        if (! empty($this->_active_status) && ! $reset) {
+        if ( ! empty($this->_active_status) && ! $reset) {
             return $this->_active_status;
         }
         // first check if event id is present on this object
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return false;
         }
         $where_params_for_event = array(array('EVT_ID' => $this->ID()));
@@ -1106,7 +1106,7 @@ 
     public function get_number_of_tickets_sold()
     {
         $tkt_sold = 0;
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return 0;
         }
         $datetimes = $this->datetimes();
@@ -1290,7 +1290,7 @@ 
             ]
         );
         $field_to_update = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
-        $other_field = EEM_Event_Question_Group::instance()->fieldNameForContext(! $for_primary);
+        $other_field = EEM_Event_Question_Group::instance()->fieldNameForContext( ! $for_primary);
         if ($existing_relation->get($other_field) === false) {
             // Delete it. It's now no longer for primary or additional question groups.
             return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group');

Indentation +1384 added lines, -1384 removed lines

@@ -15,1388 +15,1388 @@
 class EE_Event extends EE_CPT_Base implements EEI_Line_Item_Object, EEI_Admin_Links, EEI_Has_Icon, EEI_Event
 {
 
-    /**
-     * cached value for the the logical active status for the event
-     *
-     * @see get_active_status()
-     * @var string
-     */
-    protected $_active_status = '';
-
-    /**
-     * This is just used for caching the Primary Datetime for the Event on initial retrieval
-     *
-     * @var EE_Datetime
-     */
-    protected $_Primary_Datetime;
-
-    /**
-     * @var EventSpacesCalculator $available_spaces_calculator
-     */
-    protected $available_spaces_calculator;
-
-
-    /**
-     * @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_Event
-     * @throws EE_Error
-     */
-    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, $date_formats);
-    }
-
-
-    /**
-     * @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_Event
-     * @throws EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @return EventSpacesCalculator
-     * @throws \EE_Error
-     */
-    public function getAvailableSpacesCalculator()
-    {
-        if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
-            $this->available_spaces_calculator = new EventSpacesCalculator($this);
-        }
-        return $this->available_spaces_calculator;
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        switch ($field_name) {
-            case 'status':
-                $this->set_status($field_value, $use_default);
-                break;
-            default:
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     *    set_status
-     * Checks if event status is being changed to SOLD OUT
-     * and updates event meta data with previous event status
-     * so that we can revert things if/when the event is no longer sold out
-     *
-     * @access public
-     * @param string $new_status
-     * @param bool   $use_default
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_status($new_status = null, $use_default = false)
-    {
-        // if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
-        if (empty($new_status) && ! $use_default) {
-            return;
-        }
-        // get current Event status
-        $old_status = $this->status();
-        // if status has changed
-        if ($old_status !== $new_status) {
-            // TO sold_out
-            if ($new_status === EEM_Event::sold_out) {
-                // save the previous event status so that we can revert if the event is no longer sold out
-                $this->add_post_meta('_previous_event_status', $old_status);
-                do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $new_status);
-                // OR FROM  sold_out
-            } elseif ($old_status === EEM_Event::sold_out) {
-                $this->delete_post_meta('_previous_event_status');
-                do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $new_status);
-            }
-            // clear out the active status so that it gets reset the next time it is requested
-            $this->_active_status = null;
-            // update status
-            parent::set('status', $new_status, $use_default);
-            do_action('AHEE__EE_Event__set_status__after_update', $this);
-            return;
-        }
-        // even though the old value matches the new value, it's still good to
-        // allow the parent set method to have a say
-        parent::set('status', $new_status, $use_default);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes($query_params = array())
-    {
-        return $this->get_many_related('Datetime', $query_params);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
-     *
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes_in_chronological_order()
-    {
-        return $this->get_many_related('Datetime', array('order_by' => array('DTT_EVT_start' => 'ASC')));
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
-     * @darren, we should probably UNSET timezone on the EEM_Datetime model
-     * after running our query, so that this timezone isn't set for EVERY query
-     * on EEM_Datetime for the rest of the request, no?
-     *
-     * @param boolean $show_expired whether or not to include expired events
-     * @param boolean $show_deleted whether or not to include deleted events
-     * @param null    $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null)
-    {
-        return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
-            $this->ID(),
-            $show_expired,
-            $show_deleted,
-            $limit
-        );
-    }
-
-
-    /**
-     * Returns one related datetime. Mostly only used by some legacy code.
-     *
-     * @return EE_Base_Class|EE_Datetime
-     * @throws EE_Error
-     */
-    public function first_datetime()
-    {
-        return $this->get_first_related('Datetime');
-    }
-
-
-    /**
-     * Returns the 'primary' datetime for the event
-     *
-     * @param bool $try_to_exclude_expired
-     * @param bool $try_to_exclude_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
-    {
-        if (! empty($this->_Primary_Datetime)) {
-            return $this->_Primary_Datetime;
-        }
-        $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
-            $this->ID(),
-            $try_to_exclude_expired,
-            $try_to_exclude_deleted
-        );
-        return $this->_Primary_Datetime;
-    }
-
-
-    /**
-     * Gets all the tickets available for purchase of this event
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function tickets($query_params = array())
-    {
-        // first get all datetimes
-        $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
-            return array();
-        }
-        $datetime_ids = array();
-        foreach ($datetimes as $datetime) {
-            $datetime_ids[] = $datetime->ID();
-        }
-        $where_params = array('Datetime.DTT_ID' => array('IN', $datetime_ids));
-        // if incoming $query_params has where conditions let's merge but not override existing.
-        if (is_array($query_params) && isset($query_params[0])) {
-            $where_params = array_merge($query_params[0], $where_params);
-            unset($query_params[0]);
-        }
-        // now add $where_params to $query_params
-        $query_params[0] = $where_params;
-        return EEM_Ticket::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * get all unexpired untrashed tickets
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function active_tickets()
-    {
-        return $this->tickets(
-            array(
-                array(
-                    'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
-                    'TKT_deleted'  => false,
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function additional_limit()
-    {
-        return $this->get('EVT_additional_limit');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function allow_overflow()
-    {
-        return $this->get('EVT_allow_overflow');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function created()
-    {
-        return $this->get('EVT_created');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function description()
-    {
-        return $this->get('EVT_desc');
-    }
-
-
-    /**
-     * Runs do_shortcode and wpautop on the description
-     *
-     * @return string of html
-     * @throws EE_Error
-     */
-    public function description_filtered()
-    {
-        return $this->get_pretty('EVT_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function display_description()
-    {
-        return $this->get('EVT_display_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function display_ticket_selector()
-    {
-        return (bool) $this->get('EVT_display_ticket_selector');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function external_url()
-    {
-        return $this->get('EVT_external_URL');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function member_only()
-    {
-        return $this->get('EVT_member_only');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function phone()
-    {
-        return $this->get('EVT_phone');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function modified()
-    {
-        return $this->get('EVT_modified');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        return $this->get('EVT_name');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function order()
-    {
-        return $this->get('EVT_order');
-    }
-
-
-    /**
-     * @return bool|string
-     * @throws EE_Error
-     */
-    public function default_registration_status()
-    {
-        $event_default_registration_status = $this->get('EVT_default_registration_status');
-        return ! empty($event_default_registration_status)
-            ? $event_default_registration_status
-            : EE_Registry::instance()->CFG->registration->default_STS_ID;
-    }
-
-
-    /**
-     * @param int  $num_words
-     * @param null $more
-     * @param bool $not_full_desc
-     * @return bool|string
-     * @throws EE_Error
-     */
-    public function short_description($num_words = 55, $more = null, $not_full_desc = false)
-    {
-        $short_desc = $this->get('EVT_short_desc');
-        if (! empty($short_desc) || $not_full_desc) {
-            return $short_desc;
-        }
-        $full_desc = $this->get('EVT_desc');
-        return wp_trim_words($full_desc, $num_words, $more);
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function slug()
-    {
-        return $this->get('EVT_slug');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function timezone_string()
-    {
-        return $this->get('EVT_timezone_string');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function visible_on()
-    {
-        return $this->get('EVT_visible_on');
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('EVT_wp_user');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function donations()
-    {
-        return $this->get('EVT_donations');
-    }
-
-
-    /**
-     * @param $limit
-     * @throws EE_Error
-     */
-    public function set_additional_limit($limit)
-    {
-        $this->set('EVT_additional_limit', $limit);
-    }
-
-
-    /**
-     * @param $created
-     * @throws EE_Error
-     */
-    public function set_created($created)
-    {
-        $this->set('EVT_created', $created);
-    }
-
-
-    /**
-     * @param $desc
-     * @throws EE_Error
-     */
-    public function set_description($desc)
-    {
-        $this->set('EVT_desc', $desc);
-    }
-
-
-    /**
-     * @param $display_desc
-     * @throws EE_Error
-     */
-    public function set_display_description($display_desc)
-    {
-        $this->set('EVT_display_desc', $display_desc);
-    }
-
-
-    /**
-     * @param $display_ticket_selector
-     * @throws EE_Error
-     */
-    public function set_display_ticket_selector($display_ticket_selector)
-    {
-        $this->set('EVT_display_ticket_selector', $display_ticket_selector);
-    }
-
-
-    /**
-     * @param $external_url
-     * @throws EE_Error
-     */
-    public function set_external_url($external_url)
-    {
-        $this->set('EVT_external_URL', $external_url);
-    }
-
-
-    /**
-     * @param $member_only
-     * @throws EE_Error
-     */
-    public function set_member_only($member_only)
-    {
-        $this->set('EVT_member_only', $member_only);
-    }
-
-
-    /**
-     * @param $event_phone
-     * @throws EE_Error
-     */
-    public function set_event_phone($event_phone)
-    {
-        $this->set('EVT_phone', $event_phone);
-    }
-
-
-    /**
-     * @param $modified
-     * @throws EE_Error
-     */
-    public function set_modified($modified)
-    {
-        $this->set('EVT_modified', $modified);
-    }
-
-
-    /**
-     * @param $name
-     * @throws EE_Error
-     */
-    public function set_name($name)
-    {
-        $this->set('EVT_name', $name);
-    }
-
-
-    /**
-     * @param $order
-     * @throws EE_Error
-     */
-    public function set_order($order)
-    {
-        $this->set('EVT_order', $order);
-    }
-
-
-    /**
-     * @param $short_desc
-     * @throws EE_Error
-     */
-    public function set_short_description($short_desc)
-    {
-        $this->set('EVT_short_desc', $short_desc);
-    }
-
-
-    /**
-     * @param $slug
-     * @throws EE_Error
-     */
-    public function set_slug($slug)
-    {
-        $this->set('EVT_slug', $slug);
-    }
-
-
-    /**
-     * @param $timezone_string
-     * @throws EE_Error
-     */
-    public function set_timezone_string($timezone_string)
-    {
-        $this->set('EVT_timezone_string', $timezone_string);
-    }
-
-
-    /**
-     * @param $visible_on
-     * @throws EE_Error
-     */
-    public function set_visible_on($visible_on)
-    {
-        $this->set('EVT_visible_on', $visible_on);
-    }
-
-
-    /**
-     * @param $wp_user
-     * @throws EE_Error
-     */
-    public function set_wp_user($wp_user)
-    {
-        $this->set('EVT_wp_user', $wp_user);
-    }
-
-
-    /**
-     * @param $default_registration_status
-     * @throws EE_Error
-     */
-    public function set_default_registration_status($default_registration_status)
-    {
-        $this->set('EVT_default_registration_status', $default_registration_status);
-    }
-
-
-    /**
-     * @param $donations
-     * @throws EE_Error
-     */
-    public function set_donations($donations)
-    {
-        $this->set('EVT_donations', $donations);
-    }
-
-
-    /**
-     * Adds a venue to this event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     */
-    public function add_venue($venue_id_or_obj)
-    {
-        return $this->_add_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Removes a venue from the event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     */
-    public function remove_venue($venue_id_or_obj)
-    {
-        return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Gets all the venues related ot the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Venue[]
-     * @throws EE_Error
-     */
-    public function venues($query_params = array())
-    {
-        return $this->get_many_related('Venue', $query_params);
-    }
-
-
-    /**
-     * check if event id is present and if event is published
-     *
-     * @access public
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     */
-    private function _has_ID_and_is_published()
-    {
-        // first check if event id is present and not NULL,
-        // then check if this event is published (or any of the equivalent "published" statuses)
-        return
-            $this->ID() && $this->ID() !== null
-            && (
-                $this->status() === 'publish'
-                || $this->status() === EEM_Event::sold_out
-                || $this->status() === EEM_Event::postponed
-                || $this->status() === EEM_Event::cancelled
-            );
-    }
-
-
-    /**
-     * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
-     *
-     * @access public
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     */
-    public function is_upcoming()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $upcoming = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is active then we return false.
-                if ($datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check upcoming status
-                $upcoming = $datetime->is_upcoming();
-            }
-        }
-        return $upcoming;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_active()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $active = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be active.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is upcoming then we return false.
-                if ($datetime->is_upcoming()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $active = $datetime->is_active();
-            }
-        }
-        return $active;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_expired()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $expired = false;
-        // first let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is upcoming or active then we return false.
-                if ($datetime->is_upcoming() || $datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $expired = $datetime->is_expired();
-            }
-        }
-        return $expired;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_inactive()
-    {
-        // check if event id is present and if this event is published
-        if ($this->_has_ID_and_is_published()) {
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * calculate spaces remaining based on "saleable" tickets
-     *
-     * @param array $tickets
-     * @param bool  $filtered
-     * @return int|float
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function spaces_remaining($tickets = array(), $filtered = true)
-    {
-        $this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
-        $spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
-        return $filtered
-            ? apply_filters(
-                'FHEE_EE_Event__spaces_remaining',
-                $spaces_remaining,
-                $this,
-                $tickets
-            )
-            : $spaces_remaining;
-    }
-
-
-    /**
-     *    perform_sold_out_status_check
-     *    checks all of this events's datetime  reg_limit - sold values to determine if ANY datetimes have spaces
-     *    available... if NOT, then the event status will get toggled to 'sold_out'
-     *
-     * @return bool    return the ACTUAL sold out state.
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function perform_sold_out_status_check()
-    {
-        // get all unexpired untrashed tickets
-        $tickets = $this->tickets(
-            array(
-                array('TKT_deleted' => false),
-                'order_by' => array('TKT_qty' => 'ASC'),
-            )
-        );
-        $all_expired = true;
-        foreach ($tickets as $ticket) {
-            if (! $ticket->is_expired()) {
-                $all_expired = false;
-                break;
-            }
-        }
-        // if all the tickets are just expired, then don't update the event status to sold out
-        if ($all_expired) {
-            return true;
-        }
-        $spaces_remaining = $this->spaces_remaining($tickets);
-        if ($spaces_remaining < 1) {
-            if ($this->status() !== EEM_Event::post_status_private) {
-                $this->set_status(EEM_Event::sold_out);
-                $this->save();
-            }
-            $sold_out = true;
-        } else {
-            $sold_out = false;
-            // was event previously marked as sold out ?
-            if ($this->status() === EEM_Event::sold_out) {
-                // revert status to previous value, if it was set
-                $previous_event_status = $this->get_post_meta('_previous_event_status', true);
-                if ($previous_event_status) {
-                    $this->set_status($previous_event_status);
-                    $this->save();
-                }
-            }
-        }
-        do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
-        return $sold_out;
-    }
-
-
-    /**
-     * This returns the total remaining spaces for sale on this event.
-     *
-     * @uses EE_Event::total_available_spaces()
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function spaces_remaining_for_sale()
-    {
-        return $this->total_available_spaces(true);
-    }
-
-
-    /**
-     * This returns the total spaces available for an event
-     * while considering all the qtys on the tickets and the reg limits
-     * on the datetimes attached to this event.
-     *
-     * @param   bool $consider_sold Whether to consider any tickets that have already sold in our calculation.
-     *                              If this is false, then we return the most tickets that could ever be sold
-     *                              for this event with the datetime and tickets setup on the event under optimal
-     *                              selling conditions.  Otherwise we return a live calculation of spaces available
-     *                              based on tickets sold.  Depending on setup and stage of sales, this
-     *                              may appear to equal remaining tickets.  However, the more tickets are
-     *                              sold out, the more accurate the "live" total is.
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function total_available_spaces($consider_sold = false)
-    {
-        $spaces_available = $consider_sold
-            ? $this->getAvailableSpacesCalculator()->spacesRemaining()
-            : $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
-        return apply_filters(
-            'FHEE_EE_Event__total_available_spaces__spaces_available',
-            $spaces_available,
-            $this,
-            $this->getAvailableSpacesCalculator()->getDatetimes(),
-            $this->getAvailableSpacesCalculator()->getActiveTickets()
-        );
-    }
-
-
-    /**
-     * Checks if the event is set to sold out
-     *
-     * @param  bool $actual whether or not to perform calculations to not only figure the
-     *                      actual status but also to flip the status if necessary to sold
-     *                      out If false, we just check the existing status of the event
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_sold_out($actual = false)
-    {
-        if (! $actual) {
-            return $this->status() === EEM_Event::sold_out;
-        }
-        return $this->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * Checks if the event is marked as postponed
-     *
-     * @return boolean
-     */
-    public function is_postponed()
-    {
-        return $this->status() === EEM_Event::postponed;
-    }
-
-
-    /**
-     * Checks if the event is marked as cancelled
-     *
-     * @return boolean
-     */
-    public function is_cancelled()
-    {
-        return $this->status() === EEM_Event::cancelled;
-    }
-
-
-    /**
-     * Get the logical active status in a hierarchical order for all the datetimes.  Note
-     * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
-     * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
-     * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
-     * the event is considered expired.
-     * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
-     * status set on the EVENT when it is not published and thus is done
-     *
-     * @param bool $reset
-     * @return bool | string - based on EE_Datetime active constants or FALSE if error.
-     * @throws EE_Error
-     */
-    public function get_active_status($reset = false)
-    {
-        // if the active status has already been set, then just use that value (unless we are resetting it)
-        if (! empty($this->_active_status) && ! $reset) {
-            return $this->_active_status;
-        }
-        // first check if event id is present on this object
-        if (! $this->ID()) {
-            return false;
-        }
-        $where_params_for_event = array(array('EVT_ID' => $this->ID()));
-        // if event is published:
-        if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::post_status_private) {
-            // active?
-            if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                EE_Datetime::active,
-                $where_params_for_event
-            ) > 0) {
-                $this->_active_status = EE_Datetime::active;
-            } else {
-                // upcoming?
-                if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                    EE_Datetime::upcoming,
-                    $where_params_for_event
-                ) > 0) {
-                    $this->_active_status = EE_Datetime::upcoming;
-                } else {
-                    // expired?
-                    if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                        EE_Datetime::expired,
-                        $where_params_for_event
-                    ) > 0
-                    ) {
-                        $this->_active_status = EE_Datetime::expired;
-                    } else {
-                        // it would be odd if things make it this far because it basically means there are no datetime's
-                        // attached to the event.  So in this case it will just be considered inactive.
-                        $this->_active_status = EE_Datetime::inactive;
-                    }
-                }
-            }
-        } else {
-            // the event is not published, so let's just set it's active status according to its' post status
-            switch ($this->status()) {
-                case EEM_Event::sold_out:
-                    $this->_active_status = EE_Datetime::sold_out;
-                    break;
-                case EEM_Event::cancelled:
-                    $this->_active_status = EE_Datetime::cancelled;
-                    break;
-                case EEM_Event::postponed:
-                    $this->_active_status = EE_Datetime::postponed;
-                    break;
-                default:
-                    $this->_active_status = EE_Datetime::inactive;
-            }
-        }
-        return $this->_active_status;
-    }
-
-
-    /**
-     *    pretty_active_status
-     *
-     * @access public
-     * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
-     * @return mixed void|string
-     * @throws EE_Error
-     */
-    public function pretty_active_status($echo = true)
-    {
-        $active_status = $this->get_active_status();
-        $status = '<span class="ee-status event-active-status-'
-                  . $active_status
-                  . '">'
-                  . EEH_Template::pretty_status($active_status, false, 'sentence')
-                  . '</span>';
-        if ($echo) {
-            echo $status;
-            return '';
-        }
-        return $status;
-    }
-
-
-    /**
-     * @return bool|int
-     * @throws EE_Error
-     */
-    public function get_number_of_tickets_sold()
-    {
-        $tkt_sold = 0;
-        if (! $this->ID()) {
-            return 0;
-        }
-        $datetimes = $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                $tkt_sold += $datetime->sold();
-            }
-        }
-        return $tkt_sold;
-    }
-
-
-    /**
-     * This just returns a count of all the registrations for this event
-     *
-     * @access  public
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_count_of_all_registrations()
-    {
-        return EEM_Event::instance()->count_related($this, 'Registration');
-    }
-
-
-    /**
-     * This returns the ticket with the earliest start time that is
-     * available for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     */
-    public function get_ticket_with_earliest_start_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params = array($where, 'order_by' => array('TKT_start_date' => 'ASC'));
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the ticket with the latest end time that is available
-     * for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     */
-    public function get_ticket_with_latest_end_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params = array($where, 'order_by' => array('TKT_end_date' => 'DESC'));
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the number of different ticket types currently on sale for this event.
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function countTicketsOnSale()
-    {
-        $where = array(
-            'Datetime.EVT_ID' => $this->ID(),
-            'TKT_start_date'  => array('<', time()),
-            'TKT_end_date'    => array('>', time()),
-        );
-        return EEM_Ticket::instance()->count(array($where));
-    }
-
-
-    /**
-     * This returns whether there are any tickets on sale for this event.
-     *
-     * @return bool true = YES tickets on sale.
-     * @throws EE_Error
-     */
-    public function tickets_on_sale()
-    {
-        return $this->countTicketsOnSale() > 0;
-    }
-
-
-    /**
-     * Gets the URL for viewing this event on the front-end. Overrides parent
-     * to check for an external URL first
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_permalink()
-    {
-        if ($this->external_url()) {
-            return $this->external_url();
-        }
-        return parent::get_permalink();
-    }
-
-
-    /**
-     * Gets the first term for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class|EE_Term|null
-     * @throws EE_Error
-     */
-    public function first_event_category($query_params = array())
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_one($query_params);
-    }
-
-
-    /**
-     * Gets all terms for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Term[]
-     * @throws EE_Error
-     */
-    public function get_all_event_categories($query_params = array())
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Adds a question group to this event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool $for_primary if true, the question group will be added for the primary
-     *                                           registrant, if false will be added for others. default: false
-     * @return EE_Base_Class|EE_Question_Group
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_question_group($question_group_id_or_obj, $for_primary = false)
-    {
-        // If the row already exists, it will be updated. If it doesn't, it will be inserted.
-        // That's in EE_HABTM_Relation::add_relation_to().
-        return $this->_add_relation_to(
-            $question_group_id_or_obj,
-            'Question_Group',
-            [
-                EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary) => true
-            ]
-        );
-    }
-
-
-    /**
-     * Removes a question group from the event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool $for_primary if true, the question group will be removed from the primary
-     *                                           registrant, if false will be removed from others. default: false
-     * @return EE_Base_Class|EE_Question_Group
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function remove_question_group($question_group_id_or_obj, $for_primary = false)
-    {
-        // If the question group is used for the other type (primary or additional)
-        // then just update it. If not, delete it outright.
-        $existing_relation = $this->get_first_related(
-            'Event_Question_Group',
-            [
-                [
-                    'QSG_ID' => EEM_Question_Group::instance()->ensure_is_ID($question_group_id_or_obj)
-                ]
-            ]
-        );
-        $field_to_update = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
-        $other_field = EEM_Event_Question_Group::instance()->fieldNameForContext(! $for_primary);
-        if ($existing_relation->get($other_field) === false) {
-            // Delete it. It's now no longer for primary or additional question groups.
-            return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group');
-        }
-        // Just update it. They'll still use this question group for the other category
-        $existing_relation->save(
-            [
-                $field_to_update => false
-            ]
-        );
-    }
-
-
-    /**
-     * Gets all the question groups, ordering them by QSG_order ascending
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Question_Group[]
-     * @throws EE_Error
-     */
-    public function question_groups($query_params = array())
-    {
-        $query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC'));
-        return $this->get_many_related('Question_Group', $query_params);
-    }
-
-
-    /**
-     * Implementation for EEI_Has_Icon interface method.
-     *
-     * @see EEI_Visual_Representation for comments
-     * @return string
-     */
-    public function get_icon()
-    {
-        return '<span class="dashicons dashicons-flag"></span>';
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_edit_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'edit',
-                'post'   => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'default_event_settings',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'default',
-            ),
-            admin_url('admin.php')
-        );
-    }
+	/**
+	 * cached value for the the logical active status for the event
+	 *
+	 * @see get_active_status()
+	 * @var string
+	 */
+	protected $_active_status = '';
+
+	/**
+	 * This is just used for caching the Primary Datetime for the Event on initial retrieval
+	 *
+	 * @var EE_Datetime
+	 */
+	protected $_Primary_Datetime;
+
+	/**
+	 * @var EventSpacesCalculator $available_spaces_calculator
+	 */
+	protected $available_spaces_calculator;
+
+
+	/**
+	 * @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_Event
+	 * @throws EE_Error
+	 */
+	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, $date_formats);
+	}
+
+
+	/**
+	 * @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_Event
+	 * @throws EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @return EventSpacesCalculator
+	 * @throws \EE_Error
+	 */
+	public function getAvailableSpacesCalculator()
+	{
+		if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
+			$this->available_spaces_calculator = new EventSpacesCalculator($this);
+		}
+		return $this->available_spaces_calculator;
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		switch ($field_name) {
+			case 'status':
+				$this->set_status($field_value, $use_default);
+				break;
+			default:
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 *    set_status
+	 * Checks if event status is being changed to SOLD OUT
+	 * and updates event meta data with previous event status
+	 * so that we can revert things if/when the event is no longer sold out
+	 *
+	 * @access public
+	 * @param string $new_status
+	 * @param bool   $use_default
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_status($new_status = null, $use_default = false)
+	{
+		// if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
+		if (empty($new_status) && ! $use_default) {
+			return;
+		}
+		// get current Event status
+		$old_status = $this->status();
+		// if status has changed
+		if ($old_status !== $new_status) {
+			// TO sold_out
+			if ($new_status === EEM_Event::sold_out) {
+				// save the previous event status so that we can revert if the event is no longer sold out
+				$this->add_post_meta('_previous_event_status', $old_status);
+				do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $new_status);
+				// OR FROM  sold_out
+			} elseif ($old_status === EEM_Event::sold_out) {
+				$this->delete_post_meta('_previous_event_status');
+				do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $new_status);
+			}
+			// clear out the active status so that it gets reset the next time it is requested
+			$this->_active_status = null;
+			// update status
+			parent::set('status', $new_status, $use_default);
+			do_action('AHEE__EE_Event__set_status__after_update', $this);
+			return;
+		}
+		// even though the old value matches the new value, it's still good to
+		// allow the parent set method to have a say
+		parent::set('status', $new_status, $use_default);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes($query_params = array())
+	{
+		return $this->get_many_related('Datetime', $query_params);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
+	 *
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes_in_chronological_order()
+	{
+		return $this->get_many_related('Datetime', array('order_by' => array('DTT_EVT_start' => 'ASC')));
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
+	 * @darren, we should probably UNSET timezone on the EEM_Datetime model
+	 * after running our query, so that this timezone isn't set for EVERY query
+	 * on EEM_Datetime for the rest of the request, no?
+	 *
+	 * @param boolean $show_expired whether or not to include expired events
+	 * @param boolean $show_deleted whether or not to include deleted events
+	 * @param null    $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null)
+	{
+		return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
+			$this->ID(),
+			$show_expired,
+			$show_deleted,
+			$limit
+		);
+	}
+
+
+	/**
+	 * Returns one related datetime. Mostly only used by some legacy code.
+	 *
+	 * @return EE_Base_Class|EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function first_datetime()
+	{
+		return $this->get_first_related('Datetime');
+	}
+
+
+	/**
+	 * Returns the 'primary' datetime for the event
+	 *
+	 * @param bool $try_to_exclude_expired
+	 * @param bool $try_to_exclude_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
+	{
+		if (! empty($this->_Primary_Datetime)) {
+			return $this->_Primary_Datetime;
+		}
+		$this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
+			$this->ID(),
+			$try_to_exclude_expired,
+			$try_to_exclude_deleted
+		);
+		return $this->_Primary_Datetime;
+	}
+
+
+	/**
+	 * Gets all the tickets available for purchase of this event
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function tickets($query_params = array())
+	{
+		// first get all datetimes
+		$datetimes = $this->datetimes_ordered();
+		if (! $datetimes) {
+			return array();
+		}
+		$datetime_ids = array();
+		foreach ($datetimes as $datetime) {
+			$datetime_ids[] = $datetime->ID();
+		}
+		$where_params = array('Datetime.DTT_ID' => array('IN', $datetime_ids));
+		// if incoming $query_params has where conditions let's merge but not override existing.
+		if (is_array($query_params) && isset($query_params[0])) {
+			$where_params = array_merge($query_params[0], $where_params);
+			unset($query_params[0]);
+		}
+		// now add $where_params to $query_params
+		$query_params[0] = $where_params;
+		return EEM_Ticket::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * get all unexpired untrashed tickets
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function active_tickets()
+	{
+		return $this->tickets(
+			array(
+				array(
+					'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
+					'TKT_deleted'  => false,
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function additional_limit()
+	{
+		return $this->get('EVT_additional_limit');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function allow_overflow()
+	{
+		return $this->get('EVT_allow_overflow');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function created()
+	{
+		return $this->get('EVT_created');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function description()
+	{
+		return $this->get('EVT_desc');
+	}
+
+
+	/**
+	 * Runs do_shortcode and wpautop on the description
+	 *
+	 * @return string of html
+	 * @throws EE_Error
+	 */
+	public function description_filtered()
+	{
+		return $this->get_pretty('EVT_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function display_description()
+	{
+		return $this->get('EVT_display_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function display_ticket_selector()
+	{
+		return (bool) $this->get('EVT_display_ticket_selector');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function external_url()
+	{
+		return $this->get('EVT_external_URL');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function member_only()
+	{
+		return $this->get('EVT_member_only');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function phone()
+	{
+		return $this->get('EVT_phone');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function modified()
+	{
+		return $this->get('EVT_modified');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		return $this->get('EVT_name');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function order()
+	{
+		return $this->get('EVT_order');
+	}
+
+
+	/**
+	 * @return bool|string
+	 * @throws EE_Error
+	 */
+	public function default_registration_status()
+	{
+		$event_default_registration_status = $this->get('EVT_default_registration_status');
+		return ! empty($event_default_registration_status)
+			? $event_default_registration_status
+			: EE_Registry::instance()->CFG->registration->default_STS_ID;
+	}
+
+
+	/**
+	 * @param int  $num_words
+	 * @param null $more
+	 * @param bool $not_full_desc
+	 * @return bool|string
+	 * @throws EE_Error
+	 */
+	public function short_description($num_words = 55, $more = null, $not_full_desc = false)
+	{
+		$short_desc = $this->get('EVT_short_desc');
+		if (! empty($short_desc) || $not_full_desc) {
+			return $short_desc;
+		}
+		$full_desc = $this->get('EVT_desc');
+		return wp_trim_words($full_desc, $num_words, $more);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function slug()
+	{
+		return $this->get('EVT_slug');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function timezone_string()
+	{
+		return $this->get('EVT_timezone_string');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function visible_on()
+	{
+		return $this->get('EVT_visible_on');
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('EVT_wp_user');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function donations()
+	{
+		return $this->get('EVT_donations');
+	}
+
+
+	/**
+	 * @param $limit
+	 * @throws EE_Error
+	 */
+	public function set_additional_limit($limit)
+	{
+		$this->set('EVT_additional_limit', $limit);
+	}
+
+
+	/**
+	 * @param $created
+	 * @throws EE_Error
+	 */
+	public function set_created($created)
+	{
+		$this->set('EVT_created', $created);
+	}
+
+
+	/**
+	 * @param $desc
+	 * @throws EE_Error
+	 */
+	public function set_description($desc)
+	{
+		$this->set('EVT_desc', $desc);
+	}
+
+
+	/**
+	 * @param $display_desc
+	 * @throws EE_Error
+	 */
+	public function set_display_description($display_desc)
+	{
+		$this->set('EVT_display_desc', $display_desc);
+	}
+
+
+	/**
+	 * @param $display_ticket_selector
+	 * @throws EE_Error
+	 */
+	public function set_display_ticket_selector($display_ticket_selector)
+	{
+		$this->set('EVT_display_ticket_selector', $display_ticket_selector);
+	}
+
+
+	/**
+	 * @param $external_url
+	 * @throws EE_Error
+	 */
+	public function set_external_url($external_url)
+	{
+		$this->set('EVT_external_URL', $external_url);
+	}
+
+
+	/**
+	 * @param $member_only
+	 * @throws EE_Error
+	 */
+	public function set_member_only($member_only)
+	{
+		$this->set('EVT_member_only', $member_only);
+	}
+
+
+	/**
+	 * @param $event_phone
+	 * @throws EE_Error
+	 */
+	public function set_event_phone($event_phone)
+	{
+		$this->set('EVT_phone', $event_phone);
+	}
+
+
+	/**
+	 * @param $modified
+	 * @throws EE_Error
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('EVT_modified', $modified);
+	}
+
+
+	/**
+	 * @param $name
+	 * @throws EE_Error
+	 */
+	public function set_name($name)
+	{
+		$this->set('EVT_name', $name);
+	}
+
+
+	/**
+	 * @param $order
+	 * @throws EE_Error
+	 */
+	public function set_order($order)
+	{
+		$this->set('EVT_order', $order);
+	}
+
+
+	/**
+	 * @param $short_desc
+	 * @throws EE_Error
+	 */
+	public function set_short_description($short_desc)
+	{
+		$this->set('EVT_short_desc', $short_desc);
+	}
+
+
+	/**
+	 * @param $slug
+	 * @throws EE_Error
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('EVT_slug', $slug);
+	}
+
+
+	/**
+	 * @param $timezone_string
+	 * @throws EE_Error
+	 */
+	public function set_timezone_string($timezone_string)
+	{
+		$this->set('EVT_timezone_string', $timezone_string);
+	}
+
+
+	/**
+	 * @param $visible_on
+	 * @throws EE_Error
+	 */
+	public function set_visible_on($visible_on)
+	{
+		$this->set('EVT_visible_on', $visible_on);
+	}
+
+
+	/**
+	 * @param $wp_user
+	 * @throws EE_Error
+	 */
+	public function set_wp_user($wp_user)
+	{
+		$this->set('EVT_wp_user', $wp_user);
+	}
+
+
+	/**
+	 * @param $default_registration_status
+	 * @throws EE_Error
+	 */
+	public function set_default_registration_status($default_registration_status)
+	{
+		$this->set('EVT_default_registration_status', $default_registration_status);
+	}
+
+
+	/**
+	 * @param $donations
+	 * @throws EE_Error
+	 */
+	public function set_donations($donations)
+	{
+		$this->set('EVT_donations', $donations);
+	}
+
+
+	/**
+	 * Adds a venue to this event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 */
+	public function add_venue($venue_id_or_obj)
+	{
+		return $this->_add_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Removes a venue from the event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 */
+	public function remove_venue($venue_id_or_obj)
+	{
+		return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Gets all the venues related ot the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Venue[]
+	 * @throws EE_Error
+	 */
+	public function venues($query_params = array())
+	{
+		return $this->get_many_related('Venue', $query_params);
+	}
+
+
+	/**
+	 * check if event id is present and if event is published
+	 *
+	 * @access public
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 */
+	private function _has_ID_and_is_published()
+	{
+		// first check if event id is present and not NULL,
+		// then check if this event is published (or any of the equivalent "published" statuses)
+		return
+			$this->ID() && $this->ID() !== null
+			&& (
+				$this->status() === 'publish'
+				|| $this->status() === EEM_Event::sold_out
+				|| $this->status() === EEM_Event::postponed
+				|| $this->status() === EEM_Event::cancelled
+			);
+	}
+
+
+	/**
+	 * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
+	 *
+	 * @access public
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 */
+	public function is_upcoming()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$upcoming = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is active then we return false.
+				if ($datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check upcoming status
+				$upcoming = $datetime->is_upcoming();
+			}
+		}
+		return $upcoming;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_active()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$active = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be active.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is upcoming then we return false.
+				if ($datetime->is_upcoming()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$active = $datetime->is_active();
+			}
+		}
+		return $active;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_expired()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$expired = false;
+		// first let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is upcoming or active then we return false.
+				if ($datetime->is_upcoming() || $datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$expired = $datetime->is_expired();
+			}
+		}
+		return $expired;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_inactive()
+	{
+		// check if event id is present and if this event is published
+		if ($this->_has_ID_and_is_published()) {
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * calculate spaces remaining based on "saleable" tickets
+	 *
+	 * @param array $tickets
+	 * @param bool  $filtered
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spaces_remaining($tickets = array(), $filtered = true)
+	{
+		$this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
+		$spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
+		return $filtered
+			? apply_filters(
+				'FHEE_EE_Event__spaces_remaining',
+				$spaces_remaining,
+				$this,
+				$tickets
+			)
+			: $spaces_remaining;
+	}
+
+
+	/**
+	 *    perform_sold_out_status_check
+	 *    checks all of this events's datetime  reg_limit - sold values to determine if ANY datetimes have spaces
+	 *    available... if NOT, then the event status will get toggled to 'sold_out'
+	 *
+	 * @return bool    return the ACTUAL sold out state.
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function perform_sold_out_status_check()
+	{
+		// get all unexpired untrashed tickets
+		$tickets = $this->tickets(
+			array(
+				array('TKT_deleted' => false),
+				'order_by' => array('TKT_qty' => 'ASC'),
+			)
+		);
+		$all_expired = true;
+		foreach ($tickets as $ticket) {
+			if (! $ticket->is_expired()) {
+				$all_expired = false;
+				break;
+			}
+		}
+		// if all the tickets are just expired, then don't update the event status to sold out
+		if ($all_expired) {
+			return true;
+		}
+		$spaces_remaining = $this->spaces_remaining($tickets);
+		if ($spaces_remaining < 1) {
+			if ($this->status() !== EEM_Event::post_status_private) {
+				$this->set_status(EEM_Event::sold_out);
+				$this->save();
+			}
+			$sold_out = true;
+		} else {
+			$sold_out = false;
+			// was event previously marked as sold out ?
+			if ($this->status() === EEM_Event::sold_out) {
+				// revert status to previous value, if it was set
+				$previous_event_status = $this->get_post_meta('_previous_event_status', true);
+				if ($previous_event_status) {
+					$this->set_status($previous_event_status);
+					$this->save();
+				}
+			}
+		}
+		do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
+		return $sold_out;
+	}
+
+
+	/**
+	 * This returns the total remaining spaces for sale on this event.
+	 *
+	 * @uses EE_Event::total_available_spaces()
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spaces_remaining_for_sale()
+	{
+		return $this->total_available_spaces(true);
+	}
+
+
+	/**
+	 * This returns the total spaces available for an event
+	 * while considering all the qtys on the tickets and the reg limits
+	 * on the datetimes attached to this event.
+	 *
+	 * @param   bool $consider_sold Whether to consider any tickets that have already sold in our calculation.
+	 *                              If this is false, then we return the most tickets that could ever be sold
+	 *                              for this event with the datetime and tickets setup on the event under optimal
+	 *                              selling conditions.  Otherwise we return a live calculation of spaces available
+	 *                              based on tickets sold.  Depending on setup and stage of sales, this
+	 *                              may appear to equal remaining tickets.  However, the more tickets are
+	 *                              sold out, the more accurate the "live" total is.
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function total_available_spaces($consider_sold = false)
+	{
+		$spaces_available = $consider_sold
+			? $this->getAvailableSpacesCalculator()->spacesRemaining()
+			: $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
+		return apply_filters(
+			'FHEE_EE_Event__total_available_spaces__spaces_available',
+			$spaces_available,
+			$this,
+			$this->getAvailableSpacesCalculator()->getDatetimes(),
+			$this->getAvailableSpacesCalculator()->getActiveTickets()
+		);
+	}
+
+
+	/**
+	 * Checks if the event is set to sold out
+	 *
+	 * @param  bool $actual whether or not to perform calculations to not only figure the
+	 *                      actual status but also to flip the status if necessary to sold
+	 *                      out If false, we just check the existing status of the event
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_sold_out($actual = false)
+	{
+		if (! $actual) {
+			return $this->status() === EEM_Event::sold_out;
+		}
+		return $this->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * Checks if the event is marked as postponed
+	 *
+	 * @return boolean
+	 */
+	public function is_postponed()
+	{
+		return $this->status() === EEM_Event::postponed;
+	}
+
+
+	/**
+	 * Checks if the event is marked as cancelled
+	 *
+	 * @return boolean
+	 */
+	public function is_cancelled()
+	{
+		return $this->status() === EEM_Event::cancelled;
+	}
+
+
+	/**
+	 * Get the logical active status in a hierarchical order for all the datetimes.  Note
+	 * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
+	 * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
+	 * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
+	 * the event is considered expired.
+	 * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
+	 * status set on the EVENT when it is not published and thus is done
+	 *
+	 * @param bool $reset
+	 * @return bool | string - based on EE_Datetime active constants or FALSE if error.
+	 * @throws EE_Error
+	 */
+	public function get_active_status($reset = false)
+	{
+		// if the active status has already been set, then just use that value (unless we are resetting it)
+		if (! empty($this->_active_status) && ! $reset) {
+			return $this->_active_status;
+		}
+		// first check if event id is present on this object
+		if (! $this->ID()) {
+			return false;
+		}
+		$where_params_for_event = array(array('EVT_ID' => $this->ID()));
+		// if event is published:
+		if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::post_status_private) {
+			// active?
+			if (EEM_Datetime::instance()->get_datetime_count_for_status(
+				EE_Datetime::active,
+				$where_params_for_event
+			) > 0) {
+				$this->_active_status = EE_Datetime::active;
+			} else {
+				// upcoming?
+				if (EEM_Datetime::instance()->get_datetime_count_for_status(
+					EE_Datetime::upcoming,
+					$where_params_for_event
+				) > 0) {
+					$this->_active_status = EE_Datetime::upcoming;
+				} else {
+					// expired?
+					if (EEM_Datetime::instance()->get_datetime_count_for_status(
+						EE_Datetime::expired,
+						$where_params_for_event
+					) > 0
+					) {
+						$this->_active_status = EE_Datetime::expired;
+					} else {
+						// it would be odd if things make it this far because it basically means there are no datetime's
+						// attached to the event.  So in this case it will just be considered inactive.
+						$this->_active_status = EE_Datetime::inactive;
+					}
+				}
+			}
+		} else {
+			// the event is not published, so let's just set it's active status according to its' post status
+			switch ($this->status()) {
+				case EEM_Event::sold_out:
+					$this->_active_status = EE_Datetime::sold_out;
+					break;
+				case EEM_Event::cancelled:
+					$this->_active_status = EE_Datetime::cancelled;
+					break;
+				case EEM_Event::postponed:
+					$this->_active_status = EE_Datetime::postponed;
+					break;
+				default:
+					$this->_active_status = EE_Datetime::inactive;
+			}
+		}
+		return $this->_active_status;
+	}
+
+
+	/**
+	 *    pretty_active_status
+	 *
+	 * @access public
+	 * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
+	 * @return mixed void|string
+	 * @throws EE_Error
+	 */
+	public function pretty_active_status($echo = true)
+	{
+		$active_status = $this->get_active_status();
+		$status = '<span class="ee-status event-active-status-'
+				  . $active_status
+				  . '">'
+				  . EEH_Template::pretty_status($active_status, false, 'sentence')
+				  . '</span>';
+		if ($echo) {
+			echo $status;
+			return '';
+		}
+		return $status;
+	}
+
+
+	/**
+	 * @return bool|int
+	 * @throws EE_Error
+	 */
+	public function get_number_of_tickets_sold()
+	{
+		$tkt_sold = 0;
+		if (! $this->ID()) {
+			return 0;
+		}
+		$datetimes = $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$tkt_sold += $datetime->sold();
+			}
+		}
+		return $tkt_sold;
+	}
+
+
+	/**
+	 * This just returns a count of all the registrations for this event
+	 *
+	 * @access  public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_count_of_all_registrations()
+	{
+		return EEM_Event::instance()->count_related($this, 'Registration');
+	}
+
+
+	/**
+	 * This returns the ticket with the earliest start time that is
+	 * available for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 */
+	public function get_ticket_with_earliest_start_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params = array($where, 'order_by' => array('TKT_start_date' => 'ASC'));
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the ticket with the latest end time that is available
+	 * for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 */
+	public function get_ticket_with_latest_end_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params = array($where, 'order_by' => array('TKT_end_date' => 'DESC'));
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the number of different ticket types currently on sale for this event.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function countTicketsOnSale()
+	{
+		$where = array(
+			'Datetime.EVT_ID' => $this->ID(),
+			'TKT_start_date'  => array('<', time()),
+			'TKT_end_date'    => array('>', time()),
+		);
+		return EEM_Ticket::instance()->count(array($where));
+	}
+
+
+	/**
+	 * This returns whether there are any tickets on sale for this event.
+	 *
+	 * @return bool true = YES tickets on sale.
+	 * @throws EE_Error
+	 */
+	public function tickets_on_sale()
+	{
+		return $this->countTicketsOnSale() > 0;
+	}
+
+
+	/**
+	 * Gets the URL for viewing this event on the front-end. Overrides parent
+	 * to check for an external URL first
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_permalink()
+	{
+		if ($this->external_url()) {
+			return $this->external_url();
+		}
+		return parent::get_permalink();
+	}
+
+
+	/**
+	 * Gets the first term for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class|EE_Term|null
+	 * @throws EE_Error
+	 */
+	public function first_event_category($query_params = array())
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_one($query_params);
+	}
+
+
+	/**
+	 * Gets all terms for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Term[]
+	 * @throws EE_Error
+	 */
+	public function get_all_event_categories($query_params = array())
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Adds a question group to this event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool $for_primary if true, the question group will be added for the primary
+	 *                                           registrant, if false will be added for others. default: false
+	 * @return EE_Base_Class|EE_Question_Group
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_question_group($question_group_id_or_obj, $for_primary = false)
+	{
+		// If the row already exists, it will be updated. If it doesn't, it will be inserted.
+		// That's in EE_HABTM_Relation::add_relation_to().
+		return $this->_add_relation_to(
+			$question_group_id_or_obj,
+			'Question_Group',
+			[
+				EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary) => true
+			]
+		);
+	}
+
+
+	/**
+	 * Removes a question group from the event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool $for_primary if true, the question group will be removed from the primary
+	 *                                           registrant, if false will be removed from others. default: false
+	 * @return EE_Base_Class|EE_Question_Group
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function remove_question_group($question_group_id_or_obj, $for_primary = false)
+	{
+		// If the question group is used for the other type (primary or additional)
+		// then just update it. If not, delete it outright.
+		$existing_relation = $this->get_first_related(
+			'Event_Question_Group',
+			[
+				[
+					'QSG_ID' => EEM_Question_Group::instance()->ensure_is_ID($question_group_id_or_obj)
+				]
+			]
+		);
+		$field_to_update = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
+		$other_field = EEM_Event_Question_Group::instance()->fieldNameForContext(! $for_primary);
+		if ($existing_relation->get($other_field) === false) {
+			// Delete it. It's now no longer for primary or additional question groups.
+			return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group');
+		}
+		// Just update it. They'll still use this question group for the other category
+		$existing_relation->save(
+			[
+				$field_to_update => false
+			]
+		);
+	}
+
+
+	/**
+	 * Gets all the question groups, ordering them by QSG_order ascending
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Question_Group[]
+	 * @throws EE_Error
+	 */
+	public function question_groups($query_params = array())
+	{
+		$query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC'));
+		return $this->get_many_related('Question_Group', $query_params);
+	}
+
+
+	/**
+	 * Implementation for EEI_Has_Icon interface method.
+	 *
+	 * @see EEI_Visual_Representation for comments
+	 * @return string
+	 */
+	public function get_icon()
+	{
+		return '<span class="dashicons dashicons-flag"></span>';
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_edit_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'edit',
+				'post'   => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'default_event_settings',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'default',
+			),
+			admin_url('admin.php')
+		);
+	}
 }

modules/single_page_checkout/reg_steps/attendee_information/EE_SPCO_Reg_Step_Attendee_Information.class.php

Indentation +1422 added lines, -1422 removed lines

@@ -18,1429 +18,1429 @@
 class EE_SPCO_Reg_Step_Attendee_Information extends EE_SPCO_Reg_Step
 {
 
-    /**
-     * @type bool $_print_copy_info
-     */
-    private $_print_copy_info = false;
-
-    /**
-     * @type array $_attendee_data
-     */
-    private $_attendee_data = array();
-
-    /**
-     * @type array $_required_questions
-     */
-    private $_required_questions = array();
-
-    /**
-     * @type array $_registration_answers
-     */
-    private $_registration_answers = array();
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param    EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->_slug = 'attendee_information';
-        $this->_name = esc_html__('Attendee Information', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
-        $this->checkout = $checkout;
-        $this->_reset_success_message();
-        $this->set_instructions(
-            esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
-        );
-    }
-
-
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['required_field'] = esc_html__(
-            ' is a required question.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['required_multi_field'] = esc_html__(
-            ' is a required question. Please enter a value for at least one of the options.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
-            'Please answer all required questions correctly before proceeding.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copied'] = sprintf(
-            esc_html_x(
-                'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
-                'The attendee information was successfully copied.(line break)Please ensure the rest of the registration form is completed before proceeding.',
-                'event_espresso'
-            ),
-            '<br/>'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copy_error'] = esc_html__(
-            'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['enter_valid_email'] = esc_html__(
-            'You must enter a valid email address.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
-            'You must enter a valid email address and answer all other required questions before you can proceed.',
-            'event_espresso'
-        );
-    }
-
-
-    public function enqueue_styles_and_scripts()
-    {
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function initialize_reg_step()
-    {
-        return true;
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function generate_reg_form()
-    {
-        $this->_print_copy_info = false;
-        $primary_registrant = null;
-        // autoload Line_Item_Display classes
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        $Line_Item_Display = new EE_Line_Item_Display();
-        // calculate taxes
-        $Line_Item_Display->display_line_item(
-            $this->checkout->cart->get_grand_total(),
-            array('set_tax_rate' => true)
-        );
-        /** @var $subsections EE_Form_Section_Proper[] */
-        $extra_inputs_section = $this->reg_step_hidden_inputs();
-        $subsections = array(
-            'default_hidden_inputs' => $extra_inputs_section,
-        );
-
-        /**
-         * @var $reg_config EE_Registration_Config
-         */
-        $reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
-        // if this isn't a revisit, and they have the privacy consent box enalbed, add it
-        if (! $this->checkout->revisit && $reg_config->isConsentCheckboxEnabled()) {
-            $extra_inputs_section->add_subsections(
-                array(
-                    'consent_box' => new EE_Form_Section_Proper(
-                        array(
-                            'layout_strategy' =>
-                                new EE_Template_Layout(
-                                    array(
-                                        'input_template_file' => SPCO_REG_STEPS_PATH . $this->_slug . DS . 'privacy_consent.template.php',
-                                    )
-                                ),
-                            'subsections'     => array(
-                                'consent' => new EE_Checkbox_Multi_Input(
-                                    array(
-                                        'consent' => $reg_config->getConsentCheckboxLabelText(),
-                                    ),
-                                    array(
-                                        'required'                          => true,
-                                        'required_validation_error_message' => esc_html__(
-                                            'You must consent to these terms in order to register.',
-                                            'event_espresso'
-                                        ),
-                                        'html_label_text'                   => '',
-                                    )
-                                ),
-                            ),
-                        )
-                    ),
-                ),
-                null,
-                false
-            );
-        }
-        $template_args = array(
-            'revisit'       => $this->checkout->revisit,
-            'registrations' => array(),
-            'ticket_count'  => array(),
-        );
-        // grab the saved registrations from the transaction
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        if ($registrations) {
-            foreach ($registrations as $registration) {
-                // can this registration be processed during this visit ?
-                if ($registration instanceof EE_Registration
-                    && $this->checkout->visit_allows_processing_of_this_registration($registration)
-                ) {
-                    $subsections[ $registration->reg_url_link() ] = $this->_registrations_reg_form($registration);
-                    if (! $this->checkout->admin_request) {
-                        $template_args['registrations'][ $registration->reg_url_link() ] = $registration;
-                        $template_args['ticket_count'][ $registration->ticket()->ID() ] = isset(
-                            $template_args['ticket_count'][ $registration->ticket()->ID() ]
-                        )
-                            ? $template_args['ticket_count'][ $registration->ticket()->ID() ] + 1
-                            : 1;
-                        $ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-                            $this->checkout->cart->get_grand_total(),
-                            'Ticket',
-                            array($registration->ticket()->ID())
-                        );
-                        $ticket_line_item = is_array($ticket_line_item)
-                            ? reset($ticket_line_item)
-                            : $ticket_line_item;
-                        $template_args['ticket_line_item'][ $registration->ticket()->ID() ] =
-                            $Line_Item_Display->display_line_item($ticket_line_item);
-                    }
-                    if ($registration->is_primary_registrant()) {
-                        $primary_registrant = $registration->reg_url_link();
-                    }
-                }
-            }
-            // print_copy_info ?
-            if ($primary_registrant && ! $this->checkout->admin_request && count($registrations) > 1) {
-                // TODO: add admin option for toggling copy attendee info,
-                // then use that value to change $this->_print_copy_info
-                $copy_options['spco_copy_attendee_chk'] = $this->_print_copy_info
-                    ? $this->_copy_attendee_info_form()
-                    : $this->_auto_copy_attendee_info();
-                // generate hidden input
-                if (isset($subsections[ $primary_registrant ])
-                    && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
-                ) {
-                    $subsections[ $primary_registrant ]->add_subsections(
-                        $copy_options,
-                        'primary_registrant',
-                        false
-                    );
-                }
-            }
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => $this->reg_form_name(),
-                'html_id'         => $this->reg_form_name(),
-                'subsections'     => $subsections,
-                'layout_strategy' => $this->checkout->admin_request
-                    ?
-                    new EE_Div_Per_Section_Layout()
-                    :
-                    new EE_Template_Layout(
-                        array(
-                            'layout_template_file' => $this->_template, // layout_template
-                            'template_args'        => $template_args,
-                        )
-                    ),
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _registrations_reg_form(EE_Registration $registration)
-    {
-        static $attendee_nmbr = 1;
-        $form_args = array();
-        // verify that registration has valid event
-        if ($registration->event() instanceof EE_Event) {
-            $field_name = 'Event_Question_Group.'
-                . EEM_Event_Question_Group::instance()->fieldNameForContext(
-                    $registration->is_primary_registrant()
-                );
-            $question_groups = $registration->event()->question_groups(
-                apply_filters(
-                    // @codingStandardsIgnoreStart
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
-                    // @codingStandardsIgnoreEnd
-                    [
-                        [
-                            'Event.EVT_ID'                     => $registration->event()->ID(),
-                            $field_name => true,
-                        ],
-                        'order_by' => ['QSG_order' => 'ASC'],
-                    ],
-                    $registration,
-                    $this
-                )
-            );
-            if ($question_groups) {
-                // array of params to pass to parent constructor
-                $form_args = array(
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
-                    'html_class'      => 'ee-reg-form-attendee-dv',
-                    'html_style'      => $this->checkout->admin_request
-                        ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
-                        : '',
-                    'subsections'     => array(),
-                    'layout_strategy' => new EE_Fieldset_Section_Layout(
-                        array(
-                            'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
-                            'legend_text'  => sprintf(
-                                esc_html_x(
-                                    'Attendee %d',
-                                    'Attendee 123',
-                                    'event_espresso'
-                                ),
-                                $attendee_nmbr
-                            ),
-                        )
-                    ),
-                );
-                foreach ($question_groups as $question_group) {
-                    if ($question_group instanceof EE_Question_Group) {
-                        $form_args['subsections'][ $question_group->identifier() ] = $this->_question_group_reg_form(
-                            $registration,
-                            $question_group
-                        );
-                    }
-                }
-                // add hidden input
-                $form_args['subsections']['additional_attendee_reg_info'] = $this->_additional_attendee_reg_info_input(
-                    $registration
-                );
-                // if we have question groups for additional attendees, then display the copy options
-                $this->_print_copy_info = $attendee_nmbr > 1 ? true : $this->_print_copy_info;
-                if ($registration->is_primary_registrant()) {
-                    // generate hidden input
-                    $form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs(
-                        $registration
-                    );
-                }
-            }
-        }
-        $attendee_nmbr++;
-        return ! empty($form_args)
-            ? new EE_Form_Section_Proper($form_args)
-            : new EE_Form_Section_HTML();
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param bool            $additional_attendee_reg_info
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    private function _additional_attendee_reg_info_input(
-        EE_Registration $registration,
-        $additional_attendee_reg_info = true
-    ) {
-        // generate hidden input
-        return new EE_Hidden_Input(
-            array(
-                'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
-                'default' => $additional_attendee_reg_info,
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _question_group_reg_form(EE_Registration $registration, EE_Question_Group $question_group)
-    {
-        // array of params to pass to parent constructor
-        $form_args = array(
-            'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-' . $registration->ID(),
-            'html_class'      => $this->checkout->admin_request
-                ? 'form-table ee-reg-form-qstn-grp-dv'
-                : 'ee-reg-form-qstn-grp-dv',
-            'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-'
-                                 . $registration->ID() . '-lbl',
-            'subsections'     => array(
-                'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
-            ),
-            'layout_strategy' => $this->checkout->admin_request
-                ? new EE_Admin_Two_Column_Layout()
-                : new EE_Div_Per_Section_Layout(),
-        );
-        // where params
-        $query_params = array('QST_deleted' => 0);
-        // don't load admin only questions on the frontend
-        if (! $this->checkout->admin_request) {
-            $query_params['QST_admin_only'] = array('!=', true);
-        }
-        $questions = $question_group->get_many_related(
-            'Question',
-            apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
-                array(
-                    $query_params,
-                    'order_by' => array(
-                        'Question_Group_Question.QGQ_order' => 'ASC',
-                    ),
-                ),
-                $question_group,
-                $registration,
-                $this
-            )
-        );
-        // filter for additional content before questions
-        $form_args['subsections']['reg_form_questions_before'] = new EE_Form_Section_HTML(
-            apply_filters(
-                'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
-                '',
-                $registration,
-                $question_group,
-                $this
-            )
-        );
-        // loop thru questions
-        foreach ($questions as $question) {
-            if ($question instanceof EE_Question) {
-                $identifier = $question->is_system_question()
-                    ? $question->system_ID()
-                    : $question->ID();
-                $form_args['subsections'][ $identifier ] = $this->reg_form_question($registration, $question);
-            }
-        }
-        $form_args['subsections'] = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
-            $form_args['subsections'],
-            $registration,
-            $question_group,
-            $this
-        );
-        // filter for additional content after questions
-        $form_args['subsections']['reg_form_questions_after'] = new EE_Form_Section_HTML(
-            apply_filters(
-                'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
-                '',
-                $registration,
-                $question_group,
-                $this
-            )
-        );
-        // d($form_args);
-        $question_group_reg_form = new EE_Form_Section_Proper($form_args);
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            $question_group_reg_form,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @param EE_Question_Group $question_group
-     * @return    EE_Form_Section_HTML
-     */
-    private function _question_group_header(EE_Question_Group $question_group)
-    {
-        $html = '';
-        // group_name
-        if ($question_group->show_group_name() && $question_group->name() !== '') {
-            if ($this->checkout->admin_request) {
-                $html .= EEH_HTML::br();
-                $html .= EEH_HTML::h3(
-                    $question_group->name(),
-                    '',
-                    'ee-reg-form-qstn-grp-title title',
-                    'font-size: 1.3em; padding-left:0;'
-                );
-            } else {
-                $html .= EEH_HTML::h4(
-                    $question_group->name(),
-                    '',
-                    'ee-reg-form-qstn-grp-title section-title'
-                );
-            }
-        }
-        // group_desc
-        if ($question_group->show_group_desc() && $question_group->desc() !== '') {
-            $html .= EEH_HTML::p(
-                $question_group->desc(),
-                '',
-                $this->checkout->admin_request
-                    ? 'ee-reg-form-qstn-grp-desc-pg'
-                    : 'ee-reg-form-qstn-grp-desc-pg small-text lt-grey-text'
-            );
-        }
-        return new EE_Form_Section_HTML($html);
-    }
-
-
-    /**
-     * @return    EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _copy_attendee_info_form()
-    {
-        // array of params to pass to parent constructor
-        return new EE_Form_Section_Proper(
-            array(
-                'subsections'     => $this->_copy_attendee_info_inputs(),
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file'     => SPCO_REG_STEPS_PATH
-                                                      . $this->_slug
-                                                      . DS
-                                                      . 'copy_attendee_info.template.php',
-                        'begin_template_file'      => null,
-                        'input_template_file'      => null,
-                        'subsection_template_file' => null,
-                        'end_template_file'        => null,
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return EE_Form_Section_HTML
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _auto_copy_attendee_info()
-    {
-        return new EE_Form_Section_HTML(
-            EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
-                    array()
-                ),
-                true,
-                true
-            )
-        );
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _copy_attendee_info_inputs()
-    {
-        $copy_attendee_info_inputs = array();
-        $prev_ticket = null;
-        // grab the saved registrations from the transaction
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        foreach ($registrations as $registration) {
-            // for all  attendees other than the primary attendee
-            if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
-                // if this is a new ticket OR if this is the very first additional attendee after the primary attendee
-                if ($registration->ticket()->ID() !== $prev_ticket) {
-                    $item_name = $registration->ticket()->name();
-                    $item_name .= $registration->ticket()->description() !== ''
-                        ? ' - ' . $registration->ticket()->description()
-                        : '';
-                    $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID(
-                    ) . ']' ] =
-                        new EE_Form_Section_HTML(
-                            '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
-                        );
-                    $prev_ticket = $registration->ticket()->ID();
-                }
-
-                $copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ] =
-                    new EE_Checkbox_Multi_Input(
-                        array(
-                            $registration->ID() => sprintf(
-                                esc_html_x('Attendee #%s', 'Attendee #123', 'event_espresso'),
-                                $registration->count()
-                            ),
-                        ),
-                        array(
-                            'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
-                            'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
-                            'display_html_label_text' => false,
-                        )
-                    );
-            }
-        }
-        return $copy_attendee_info_inputs;
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return    EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    private function _additional_primary_registrant_inputs(EE_Registration $registration)
-    {
-        // generate hidden input
-        return new EE_Hidden_Input(
-            array(
-                'html_id' => 'primary_registrant',
-                'default' => $registration->reg_url_link(),
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_form_question(EE_Registration $registration, EE_Question $question)
-    {
-
-        // if this question was for an attendee detail, then check for that answer
-        $answer_value = EEM_Answer::instance()->get_attendee_property_answer_value(
-            $registration,
-            $question->system_ID()
-        );
-        $answer = $answer_value === null
-            ? EEM_Answer::instance()->get_one(
-                array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
-            )
-            : null;
-        // if NOT returning to edit an existing registration
-        // OR if this question is for an attendee property
-        // OR we still don't have an EE_Answer object
-        if ($answer_value || ! $answer instanceof EE_Answer || ! $registration->reg_url_link()) {
-            // create an EE_Answer object for storing everything in
-            $answer = EE_Answer::new_instance(
-                array(
-                    'QST_ID' => $question->ID(),
-                    'REG_ID' => $registration->ID(),
-                )
-            );
-        }
-        // verify instance
-        if ($answer instanceof EE_Answer) {
-            if (! empty($answer_value)) {
-                $answer->set('ANS_value', $answer_value);
-            }
-            $answer->cache('Question', $question);
-            // remember system ID had a bug where sometimes it could be null
-            $answer_cache_id = $question->is_system_question()
-                ? $question->system_ID() . '-' . $registration->reg_url_link()
-                : $question->ID() . '-' . $registration->reg_url_link();
-            $registration->cache('Answer', $answer, $answer_cache_id);
-        }
-        return $this->_generate_question_input($registration, $question, $answer);
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @param                 $answer
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _generate_question_input(EE_Registration $registration, EE_Question $question, $answer)
-    {
-        $identifier = $question->is_system_question()
-            ? $question->system_ID()
-            : $question->ID();
-        $this->_required_questions[ $identifier ] = $question->required() ? true : false;
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__country_options',
-            array($this, 'use_cached_countries_for_form_input'),
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__state_options',
-            array($this, 'use_cached_states_for_form_input'),
-            10,
-            4
-        );
-        $input_constructor_args = array(
-            'html_name'        => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
-            'html_id'          => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-            'html_class'       => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
-            'html_label_id'    => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-            'html_label_class' => 'ee-reg-qstn',
-        );
-        $input_constructor_args['html_label_id'] .= '-lbl';
-        if ($answer instanceof EE_Answer && $answer->ID()) {
-            $input_constructor_args['html_name'] .= '[' . $answer->ID() . ']';
-            $input_constructor_args['html_id'] .= '-' . $answer->ID();
-            $input_constructor_args['html_label_id'] .= '-' . $answer->ID();
-        }
-        $form_input = $question->generate_form_input(
-            $registration,
-            $answer,
-            $input_constructor_args
-        );
-        remove_filter(
-            'FHEE__EE_Question__generate_form_input__country_options',
-            array($this, 'use_cached_countries_for_form_input')
-        );
-        remove_filter(
-            'FHEE__EE_Question__generate_form_input__state_options',
-            array($this, 'use_cached_states_for_form_input')
-        );
-        return $form_input;
-    }
-
-
-    /**
-     * Gets the list of countries for the form input
-     *
-     * @param array|null      $countries_list
-     * @param EE_Question     $question
-     * @param EE_Registration $registration
-     * @param EE_Answer       $answer
-     * @return array 2d keys are country IDs, values are their names
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function use_cached_countries_for_form_input(
-        $countries_list,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ) {
-        $country_options = array('' => '');
-        // get possibly cached list of countries
-        $countries = $this->checkout->action === 'process_reg_step'
-            ? EEM_Country::instance()->get_all_countries()
-            : EEM_Country::instance()->get_all_active_countries();
-        if (! empty($countries)) {
-            foreach ($countries as $country) {
-                if ($country instanceof EE_Country) {
-                    $country_options[ $country->ID() ] = $country->name();
-                }
-            }
-        }
-        if ($question instanceof EE_Question && $registration instanceof EE_Registration) {
-            $answer = EEM_Answer::instance()->get_one(
-                array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
-            );
-        } else {
-            $answer = EE_Answer::new_instance();
-        }
-        $country_options = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            $country_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-        return $country_options;
-    }
-
-
-    /**
-     * Gets the list of states for the form input
-     *
-     * @param array|null      $states_list
-     * @param EE_Question     $question
-     * @param EE_Registration $registration
-     * @param EE_Answer       $answer
-     * @return array 2d keys are state IDs, values are their names
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function use_cached_states_for_form_input(
-        $states_list,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ) {
-        $state_options = array('' => array('' => ''));
-        $states = $this->checkout->action === 'process_reg_step'
-            ? EEM_State::instance()->get_all_states()
-            : EEM_State::instance()->get_all_active_states();
-        if (! empty($states)) {
-            foreach ($states as $state) {
-                if ($state instanceof EE_State) {
-                    $state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
-                }
-            }
-        }
-        $state_options = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            $state_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-        return $state_options;
-    }
-
-
-    /********************************************************************************************************/
-    /****************************************  PROCESS REG STEP  ****************************************/
-    /********************************************************************************************************/
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_reg_step()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // grab validated data from form
-        $valid_data = $this->checkout->current_step->valid_data();
-        // EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $valid_data, '$valid_data', __FILE__, __LINE__ );
-        // if we don't have any $valid_data then something went TERRIBLY WRONG !!!
-        if (empty($valid_data)) {
-            EE_Error::add_error(
-                esc_html__('No valid question responses were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
-            EE_Error::add_error(
-                esc_html__(
-                    'A valid transaction could not be initiated for processing your registrations.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // get cached registrations
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        // verify we got the goods
-        if (empty($registrations)) {
-            // combine the old translated string with a new one, in order to not break translations
-            $error_message = esc_html__(
-                'Your form data could not be applied to any valid registrations.',
-                'event_espresso'
-            )
-            . sprintf(
-                esc_html_x(
-                    '%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.',
-                    '(line break)This can sometimes happen if too much time has been taken to complete the registration process.(line break)Please return to the (link)Event List(end link) and reselect your tickets. If the problem continues, please contact the site administrator.',
-                    'event_espresso'
-                ),
-                '<a href="' . get_post_type_archive_link('espresso_events') . '" >',
-                '</a>',
-                '<br />'
-            );
-            EE_Error::add_error(
-                $error_message,
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // extract attendee info from form data and save to model objects
-        $registrations_processed = $this->_process_registrations($registrations, $valid_data);
-        // if first pass thru SPCO,
-        // then let's check processed registrations against the total number of tickets in the cart
-        if ($registrations_processed === false) {
-            // but return immediately if the previous step exited early due to errors
-            return false;
-        }
-        if (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
-            // generate a correctly translated string for all possible singular/plural combinations
-            if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
-                $error_msg = sprintf(
-                    esc_html_x(
-                        'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
-                        'There was 1 ticket in the Event Queue, but 2 registrations were processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            } elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
-                $error_msg = sprintf(
-                    esc_html_x(
-                        'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
-                        'There was a total of 2 tickets in the Event Queue, but only 1 registration was processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            } else {
-                $error_msg = sprintf(
-                    esc_html__(
-                        'There was a total of 2 tickets in the Event Queue, but 2 registrations were processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            }
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // mark this reg step as completed
-        $this->set_completed();
-        $this->_set_success_message(
-            esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
-        );
-        // do action in case a plugin wants to do something with the data submitted in step 1.
-        // passes EE_Single_Page_Checkout, and it's posted data
-        do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
-        return true;
-    }
-
-
-    /**
-     *    _process_registrations
-     *
-     * @param EE_Registration[] $registrations
-     * @param array[][]         $valid_data
-     * @return bool|int
-     * @throws EntityNotFoundException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _process_registrations($registrations = array(), $valid_data = array())
-    {
-        // load resources and set some defaults
-        EE_Registry::instance()->load_model('Attendee');
-        // holder for primary registrant attendee object
-        $this->checkout->primary_attendee_obj = null;
-        // array for tracking reg form data for the primary registrant
-        $primary_registrant = array(
-            'line_item_id' => null,
-        );
-        $copy_primary = false;
-        // reg form sections that do not contain inputs
-        $non_input_form_sections = array(
-            'primary_registrant',
-            'additional_attendee_reg_info',
-            'spco_copy_attendee_chk',
-        );
-        // attendee counter
-        $att_nmbr = 0;
-        // grab the saved registrations from the transaction
-        foreach ($registrations as $registration) {
-            // verify EE_Registration object
-            if (! $registration instanceof EE_Registration) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid Registration object was discovered when attempting to process your registration information.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            /** @var string $reg_url_link */
-            $reg_url_link = $registration->reg_url_link();
-            // reg_url_link exists ?
-            if (! empty($reg_url_link)) {
-                // should this registration be processed during this visit ?
-                if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
-                    // if NOT revisiting, then let's save the registration now,
-                    // so that we have a REG_ID to use when generating other objects
-                    if (! $this->checkout->revisit) {
-                        $registration->save();
-                    }
-                    /**
-                     * This allows plugins to trigger a fail on processing of a
-                     * registration for any conditions they may have for it to pass.
-                     *
-                     * @var bool   if true is returned by the plugin then the
-                     *            registration processing is halted.
-                     */
-                    if (apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
-                        false,
-                        $att_nmbr,
-                        $registration,
-                        $registrations,
-                        $valid_data,
-                        $this
-                    )) {
-                        return false;
-                    }
-
-                    // Houston, we have a registration!
-                    $att_nmbr++;
-                    $this->_attendee_data[ $reg_url_link ] = array();
-                    // grab any existing related answer objects
-                    $this->_registration_answers = $registration->answers();
-                    // unset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] );
-                    if (isset($valid_data[ $reg_url_link ])) {
-                        // do we need to copy basic info from primary attendee ?
-                        $copy_primary = isset($valid_data[ $reg_url_link ]['additional_attendee_reg_info'])
-                                        && absint($valid_data[ $reg_url_link ]['additional_attendee_reg_info']) === 0;
-                        // filter form input data for this registration
-                        $valid_data[ $reg_url_link ] = (array) apply_filters(
-                            'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-                            $valid_data[ $reg_url_link ]
-                        );
-                        if (isset($valid_data['primary_attendee'])) {
-                            $primary_registrant['line_item_id'] = ! empty($valid_data['primary_attendee'])
-                                ? $valid_data['primary_attendee']
-                                : false;
-                            unset($valid_data['primary_attendee']);
-                        }
-                        // now loop through our array of valid post data && process attendee reg forms
-                        foreach ($valid_data[ $reg_url_link ] as $form_section => $form_inputs) {
-                            if (! in_array($form_section, $non_input_form_sections, true)) {
-                                foreach ($form_inputs as $form_input => $input_value) {
-                                    // \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
-                                    // check for critical inputs
-                                    if (! $this->_verify_critical_attendee_details_are_set_and_validate_email(
-                                        $form_input,
-                                        $input_value
-                                    )
-                                    ) {
-                                        return false;
-                                    }
-                                    // store a bit of data about the primary attendee
-                                    if ($att_nmbr === 1
-                                        && ! empty($input_value)
-                                        && $reg_url_link === $primary_registrant['line_item_id']
-                                    ) {
-                                        $primary_registrant[ $form_input ] = $input_value;
-                                    } elseif ($copy_primary
-                                              && $input_value === null
-                                              && isset($primary_registrant[ $form_input ])
-                                    ) {
-                                        $input_value = $primary_registrant[ $form_input ];
-                                    }
-                                    // now attempt to save the input data
-                                    if (! $this->_save_registration_form_input(
-                                        $registration,
-                                        $form_input,
-                                        $input_value
-                                    )
-                                    ) {
-                                        EE_Error::add_error(
-                                            sprintf(
-                                                esc_html_x(
-                                                    'Unable to save registration form data for the form input: "%1$s" with the submitted value: "%2$s"',
-                                                    'Unable to save registration form data for the form input: "form input name" with the submitted value: "form input value"',
-                                                    'event_espresso'
-                                                ),
-                                                $form_input,
-                                                $input_value
-                                            ),
-                                            __FILE__,
-                                            __FUNCTION__,
-                                            __LINE__
-                                        );
-                                        return false;
-                                    }
-                                }
-                            }
-                        }  // end of foreach ( $valid_data[ $reg_url_link ] as $form_section => $form_inputs )
-                    }
-                    // EEH_Debug_Tools::printr( $this->_attendee_data, '$this->_attendee_data', __FILE__, __LINE__ );
-                    // this registration does not require additional attendee information ?
-                    if ($copy_primary
-                        && $att_nmbr > 1
-                        && $this->checkout->primary_attendee_obj instanceof EE_Attendee
-                    ) {
-                        // just copy the primary registrant
-                        $attendee = $this->checkout->primary_attendee_obj;
-                    } else {
-                        // ensure critical details are set for additional attendees
-                        $this->_attendee_data[ $reg_url_link ] = $att_nmbr > 1
-                            ? $this->_copy_critical_attendee_details_from_primary_registrant(
-                                $this->_attendee_data[ $reg_url_link ]
-                            )
-                            : $this->_attendee_data[ $reg_url_link ];
-                        // execute create attendee command (which may return an existing attendee)
-                        $attendee = EE_Registry::instance()->BUS->execute(
-                            new CreateAttendeeCommand(
-                                $this->_attendee_data[ $reg_url_link ],
-                                $registration
-                            )
-                        );
-                        // who's #1 ?
-                        if ($att_nmbr === 1) {
-                            $this->checkout->primary_attendee_obj = $attendee;
-                        }
-                    }
-                    // EEH_Debug_Tools::printr( $attendee, '$attendee', __FILE__, __LINE__ );
-                    // add relation to registration, set attendee ID, and cache attendee
-                    $this->_associate_attendee_with_registration($registration, $attendee);
-                    // \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
-                    if (! $registration->attendee() instanceof EE_Attendee) {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html_x(
-                                    'Registration %s has an invalid or missing Attendee object.',
-                                    'Registration 123-456-789 has an invalid or missing Attendee object.',
-                                    'event_espresso'
-                                ),
-                                $reg_url_link
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                    /** @type EE_Registration_Processor $registration_processor */
-                    $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-                    // at this point, we should have enough details about the registrant to consider the registration
-                    // NOT incomplete
-                    $registration_processor->toggle_incomplete_registration_status_to_default(
-                        $registration,
-                        false,
-                        new Context(
-                            'spco_reg_step_attendee_information_process_registrations',
-                            esc_html__(
-                                'Finished populating registration with details from the registration form after submitting the Attendee Information Reg Step.',
-                                'event_espresso'
-                            )
-                        )
-                    );
-                    // we can also consider the TXN to not have been failed, so temporarily upgrade it's status to
-                    // abandoned
-                    $this->checkout->transaction->toggle_failed_transaction_status();
-                    // if we've gotten this far, then let's save what we have
-                    $registration->save();
-                    // add relation between TXN and registration
-                    $this->_associate_registration_with_transaction($registration);
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid or missing line item ID was encountered while attempting to process the registration form.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                // remove malformed data
-                unset($valid_data[ $reg_url_link ]);
-                return false;
-            }
-        } // end of foreach ( $this->checkout->transaction->registrations()  as $registration )
-        return $att_nmbr;
-    }
-
-
-    /**
-     *    _save_registration_form_input
-     *
-     * @param EE_Registration $registration
-     * @param string          $form_input
-     * @param string          $input_value
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _save_registration_form_input(
-        EE_Registration $registration,
-        $form_input = '',
-        $input_value = ''
-    ) {
-        // \EEH_Debug_Tools::printr( __FUNCTION__, __CLASS__, __FILE__, __LINE__, 2 );
-        // \EEH_Debug_Tools::printr( $form_input, '$form_input', __FILE__, __LINE__ );
-        // \EEH_Debug_Tools::printr( $input_value, '$input_value', __FILE__, __LINE__ );
-        // allow for plugins to hook in and do their own processing of the form input.
-        // For plugins to bypass normal processing here, they just need to return a boolean value.
-        if (apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
-            false,
-            $registration,
-            $form_input,
-            $input_value,
-            $this
-        )) {
-            return true;
-        }
-        /*
+	/**
+	 * @type bool $_print_copy_info
+	 */
+	private $_print_copy_info = false;
+
+	/**
+	 * @type array $_attendee_data
+	 */
+	private $_attendee_data = array();
+
+	/**
+	 * @type array $_required_questions
+	 */
+	private $_required_questions = array();
+
+	/**
+	 * @type array $_registration_answers
+	 */
+	private $_registration_answers = array();
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param    EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->_slug = 'attendee_information';
+		$this->_name = esc_html__('Attendee Information', 'event_espresso');
+		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
+		$this->checkout = $checkout;
+		$this->_reset_success_message();
+		$this->set_instructions(
+			esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
+		);
+	}
+
+
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['required_field'] = esc_html__(
+			' is a required question.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['required_multi_field'] = esc_html__(
+			' is a required question. Please enter a value for at least one of the options.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
+			'Please answer all required questions correctly before proceeding.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copied'] = sprintf(
+			esc_html_x(
+				'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
+				'The attendee information was successfully copied.(line break)Please ensure the rest of the registration form is completed before proceeding.',
+				'event_espresso'
+			),
+			'<br/>'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copy_error'] = esc_html__(
+			'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['enter_valid_email'] = esc_html__(
+			'You must enter a valid email address.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
+			'You must enter a valid email address and answer all other required questions before you can proceed.',
+			'event_espresso'
+		);
+	}
+
+
+	public function enqueue_styles_and_scripts()
+	{
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function initialize_reg_step()
+	{
+		return true;
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function generate_reg_form()
+	{
+		$this->_print_copy_info = false;
+		$primary_registrant = null;
+		// autoload Line_Item_Display classes
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		$Line_Item_Display = new EE_Line_Item_Display();
+		// calculate taxes
+		$Line_Item_Display->display_line_item(
+			$this->checkout->cart->get_grand_total(),
+			array('set_tax_rate' => true)
+		);
+		/** @var $subsections EE_Form_Section_Proper[] */
+		$extra_inputs_section = $this->reg_step_hidden_inputs();
+		$subsections = array(
+			'default_hidden_inputs' => $extra_inputs_section,
+		);
+
+		/**
+		 * @var $reg_config EE_Registration_Config
+		 */
+		$reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
+		// if this isn't a revisit, and they have the privacy consent box enalbed, add it
+		if (! $this->checkout->revisit && $reg_config->isConsentCheckboxEnabled()) {
+			$extra_inputs_section->add_subsections(
+				array(
+					'consent_box' => new EE_Form_Section_Proper(
+						array(
+							'layout_strategy' =>
+								new EE_Template_Layout(
+									array(
+										'input_template_file' => SPCO_REG_STEPS_PATH . $this->_slug . DS . 'privacy_consent.template.php',
+									)
+								),
+							'subsections'     => array(
+								'consent' => new EE_Checkbox_Multi_Input(
+									array(
+										'consent' => $reg_config->getConsentCheckboxLabelText(),
+									),
+									array(
+										'required'                          => true,
+										'required_validation_error_message' => esc_html__(
+											'You must consent to these terms in order to register.',
+											'event_espresso'
+										),
+										'html_label_text'                   => '',
+									)
+								),
+							),
+						)
+					),
+				),
+				null,
+				false
+			);
+		}
+		$template_args = array(
+			'revisit'       => $this->checkout->revisit,
+			'registrations' => array(),
+			'ticket_count'  => array(),
+		);
+		// grab the saved registrations from the transaction
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		if ($registrations) {
+			foreach ($registrations as $registration) {
+				// can this registration be processed during this visit ?
+				if ($registration instanceof EE_Registration
+					&& $this->checkout->visit_allows_processing_of_this_registration($registration)
+				) {
+					$subsections[ $registration->reg_url_link() ] = $this->_registrations_reg_form($registration);
+					if (! $this->checkout->admin_request) {
+						$template_args['registrations'][ $registration->reg_url_link() ] = $registration;
+						$template_args['ticket_count'][ $registration->ticket()->ID() ] = isset(
+							$template_args['ticket_count'][ $registration->ticket()->ID() ]
+						)
+							? $template_args['ticket_count'][ $registration->ticket()->ID() ] + 1
+							: 1;
+						$ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+							$this->checkout->cart->get_grand_total(),
+							'Ticket',
+							array($registration->ticket()->ID())
+						);
+						$ticket_line_item = is_array($ticket_line_item)
+							? reset($ticket_line_item)
+							: $ticket_line_item;
+						$template_args['ticket_line_item'][ $registration->ticket()->ID() ] =
+							$Line_Item_Display->display_line_item($ticket_line_item);
+					}
+					if ($registration->is_primary_registrant()) {
+						$primary_registrant = $registration->reg_url_link();
+					}
+				}
+			}
+			// print_copy_info ?
+			if ($primary_registrant && ! $this->checkout->admin_request && count($registrations) > 1) {
+				// TODO: add admin option for toggling copy attendee info,
+				// then use that value to change $this->_print_copy_info
+				$copy_options['spco_copy_attendee_chk'] = $this->_print_copy_info
+					? $this->_copy_attendee_info_form()
+					: $this->_auto_copy_attendee_info();
+				// generate hidden input
+				if (isset($subsections[ $primary_registrant ])
+					&& $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
+				) {
+					$subsections[ $primary_registrant ]->add_subsections(
+						$copy_options,
+						'primary_registrant',
+						false
+					);
+				}
+			}
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => $this->reg_form_name(),
+				'html_id'         => $this->reg_form_name(),
+				'subsections'     => $subsections,
+				'layout_strategy' => $this->checkout->admin_request
+					?
+					new EE_Div_Per_Section_Layout()
+					:
+					new EE_Template_Layout(
+						array(
+							'layout_template_file' => $this->_template, // layout_template
+							'template_args'        => $template_args,
+						)
+					),
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _registrations_reg_form(EE_Registration $registration)
+	{
+		static $attendee_nmbr = 1;
+		$form_args = array();
+		// verify that registration has valid event
+		if ($registration->event() instanceof EE_Event) {
+			$field_name = 'Event_Question_Group.'
+				. EEM_Event_Question_Group::instance()->fieldNameForContext(
+					$registration->is_primary_registrant()
+				);
+			$question_groups = $registration->event()->question_groups(
+				apply_filters(
+					// @codingStandardsIgnoreStart
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
+					// @codingStandardsIgnoreEnd
+					[
+						[
+							'Event.EVT_ID'                     => $registration->event()->ID(),
+							$field_name => true,
+						],
+						'order_by' => ['QSG_order' => 'ASC'],
+					],
+					$registration,
+					$this
+				)
+			);
+			if ($question_groups) {
+				// array of params to pass to parent constructor
+				$form_args = array(
+					'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+					'html_class'      => 'ee-reg-form-attendee-dv',
+					'html_style'      => $this->checkout->admin_request
+						? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
+						: '',
+					'subsections'     => array(),
+					'layout_strategy' => new EE_Fieldset_Section_Layout(
+						array(
+							'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
+							'legend_text'  => sprintf(
+								esc_html_x(
+									'Attendee %d',
+									'Attendee 123',
+									'event_espresso'
+								),
+								$attendee_nmbr
+							),
+						)
+					),
+				);
+				foreach ($question_groups as $question_group) {
+					if ($question_group instanceof EE_Question_Group) {
+						$form_args['subsections'][ $question_group->identifier() ] = $this->_question_group_reg_form(
+							$registration,
+							$question_group
+						);
+					}
+				}
+				// add hidden input
+				$form_args['subsections']['additional_attendee_reg_info'] = $this->_additional_attendee_reg_info_input(
+					$registration
+				);
+				// if we have question groups for additional attendees, then display the copy options
+				$this->_print_copy_info = $attendee_nmbr > 1 ? true : $this->_print_copy_info;
+				if ($registration->is_primary_registrant()) {
+					// generate hidden input
+					$form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs(
+						$registration
+					);
+				}
+			}
+		}
+		$attendee_nmbr++;
+		return ! empty($form_args)
+			? new EE_Form_Section_Proper($form_args)
+			: new EE_Form_Section_HTML();
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param bool            $additional_attendee_reg_info
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	private function _additional_attendee_reg_info_input(
+		EE_Registration $registration,
+		$additional_attendee_reg_info = true
+	) {
+		// generate hidden input
+		return new EE_Hidden_Input(
+			array(
+				'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
+				'default' => $additional_attendee_reg_info,
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _question_group_reg_form(EE_Registration $registration, EE_Question_Group $question_group)
+	{
+		// array of params to pass to parent constructor
+		$form_args = array(
+			'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-' . $registration->ID(),
+			'html_class'      => $this->checkout->admin_request
+				? 'form-table ee-reg-form-qstn-grp-dv'
+				: 'ee-reg-form-qstn-grp-dv',
+			'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-'
+								 . $registration->ID() . '-lbl',
+			'subsections'     => array(
+				'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
+			),
+			'layout_strategy' => $this->checkout->admin_request
+				? new EE_Admin_Two_Column_Layout()
+				: new EE_Div_Per_Section_Layout(),
+		);
+		// where params
+		$query_params = array('QST_deleted' => 0);
+		// don't load admin only questions on the frontend
+		if (! $this->checkout->admin_request) {
+			$query_params['QST_admin_only'] = array('!=', true);
+		}
+		$questions = $question_group->get_many_related(
+			'Question',
+			apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
+				array(
+					$query_params,
+					'order_by' => array(
+						'Question_Group_Question.QGQ_order' => 'ASC',
+					),
+				),
+				$question_group,
+				$registration,
+				$this
+			)
+		);
+		// filter for additional content before questions
+		$form_args['subsections']['reg_form_questions_before'] = new EE_Form_Section_HTML(
+			apply_filters(
+				'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
+				'',
+				$registration,
+				$question_group,
+				$this
+			)
+		);
+		// loop thru questions
+		foreach ($questions as $question) {
+			if ($question instanceof EE_Question) {
+				$identifier = $question->is_system_question()
+					? $question->system_ID()
+					: $question->ID();
+				$form_args['subsections'][ $identifier ] = $this->reg_form_question($registration, $question);
+			}
+		}
+		$form_args['subsections'] = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
+			$form_args['subsections'],
+			$registration,
+			$question_group,
+			$this
+		);
+		// filter for additional content after questions
+		$form_args['subsections']['reg_form_questions_after'] = new EE_Form_Section_HTML(
+			apply_filters(
+				'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
+				'',
+				$registration,
+				$question_group,
+				$this
+			)
+		);
+		// d($form_args);
+		$question_group_reg_form = new EE_Form_Section_Proper($form_args);
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			$question_group_reg_form,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param EE_Question_Group $question_group
+	 * @return    EE_Form_Section_HTML
+	 */
+	private function _question_group_header(EE_Question_Group $question_group)
+	{
+		$html = '';
+		// group_name
+		if ($question_group->show_group_name() && $question_group->name() !== '') {
+			if ($this->checkout->admin_request) {
+				$html .= EEH_HTML::br();
+				$html .= EEH_HTML::h3(
+					$question_group->name(),
+					'',
+					'ee-reg-form-qstn-grp-title title',
+					'font-size: 1.3em; padding-left:0;'
+				);
+			} else {
+				$html .= EEH_HTML::h4(
+					$question_group->name(),
+					'',
+					'ee-reg-form-qstn-grp-title section-title'
+				);
+			}
+		}
+		// group_desc
+		if ($question_group->show_group_desc() && $question_group->desc() !== '') {
+			$html .= EEH_HTML::p(
+				$question_group->desc(),
+				'',
+				$this->checkout->admin_request
+					? 'ee-reg-form-qstn-grp-desc-pg'
+					: 'ee-reg-form-qstn-grp-desc-pg small-text lt-grey-text'
+			);
+		}
+		return new EE_Form_Section_HTML($html);
+	}
+
+
+	/**
+	 * @return    EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _copy_attendee_info_form()
+	{
+		// array of params to pass to parent constructor
+		return new EE_Form_Section_Proper(
+			array(
+				'subsections'     => $this->_copy_attendee_info_inputs(),
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file'     => SPCO_REG_STEPS_PATH
+													  . $this->_slug
+													  . DS
+													  . 'copy_attendee_info.template.php',
+						'begin_template_file'      => null,
+						'input_template_file'      => null,
+						'subsection_template_file' => null,
+						'end_template_file'        => null,
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return EE_Form_Section_HTML
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _auto_copy_attendee_info()
+	{
+		return new EE_Form_Section_HTML(
+			EEH_Template::locate_template(
+				SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
+					array()
+				),
+				true,
+				true
+			)
+		);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _copy_attendee_info_inputs()
+	{
+		$copy_attendee_info_inputs = array();
+		$prev_ticket = null;
+		// grab the saved registrations from the transaction
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		foreach ($registrations as $registration) {
+			// for all  attendees other than the primary attendee
+			if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
+				// if this is a new ticket OR if this is the very first additional attendee after the primary attendee
+				if ($registration->ticket()->ID() !== $prev_ticket) {
+					$item_name = $registration->ticket()->name();
+					$item_name .= $registration->ticket()->description() !== ''
+						? ' - ' . $registration->ticket()->description()
+						: '';
+					$copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID(
+					) . ']' ] =
+						new EE_Form_Section_HTML(
+							'<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+						);
+					$prev_ticket = $registration->ticket()->ID();
+				}
+
+				$copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ] =
+					new EE_Checkbox_Multi_Input(
+						array(
+							$registration->ID() => sprintf(
+								esc_html_x('Attendee #%s', 'Attendee #123', 'event_espresso'),
+								$registration->count()
+							),
+						),
+						array(
+							'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+							'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
+							'display_html_label_text' => false,
+						)
+					);
+			}
+		}
+		return $copy_attendee_info_inputs;
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return    EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	private function _additional_primary_registrant_inputs(EE_Registration $registration)
+	{
+		// generate hidden input
+		return new EE_Hidden_Input(
+			array(
+				'html_id' => 'primary_registrant',
+				'default' => $registration->reg_url_link(),
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_form_question(EE_Registration $registration, EE_Question $question)
+	{
+
+		// if this question was for an attendee detail, then check for that answer
+		$answer_value = EEM_Answer::instance()->get_attendee_property_answer_value(
+			$registration,
+			$question->system_ID()
+		);
+		$answer = $answer_value === null
+			? EEM_Answer::instance()->get_one(
+				array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
+			)
+			: null;
+		// if NOT returning to edit an existing registration
+		// OR if this question is for an attendee property
+		// OR we still don't have an EE_Answer object
+		if ($answer_value || ! $answer instanceof EE_Answer || ! $registration->reg_url_link()) {
+			// create an EE_Answer object for storing everything in
+			$answer = EE_Answer::new_instance(
+				array(
+					'QST_ID' => $question->ID(),
+					'REG_ID' => $registration->ID(),
+				)
+			);
+		}
+		// verify instance
+		if ($answer instanceof EE_Answer) {
+			if (! empty($answer_value)) {
+				$answer->set('ANS_value', $answer_value);
+			}
+			$answer->cache('Question', $question);
+			// remember system ID had a bug where sometimes it could be null
+			$answer_cache_id = $question->is_system_question()
+				? $question->system_ID() . '-' . $registration->reg_url_link()
+				: $question->ID() . '-' . $registration->reg_url_link();
+			$registration->cache('Answer', $answer, $answer_cache_id);
+		}
+		return $this->_generate_question_input($registration, $question, $answer);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @param                 $answer
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _generate_question_input(EE_Registration $registration, EE_Question $question, $answer)
+	{
+		$identifier = $question->is_system_question()
+			? $question->system_ID()
+			: $question->ID();
+		$this->_required_questions[ $identifier ] = $question->required() ? true : false;
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__country_options',
+			array($this, 'use_cached_countries_for_form_input'),
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__state_options',
+			array($this, 'use_cached_states_for_form_input'),
+			10,
+			4
+		);
+		$input_constructor_args = array(
+			'html_name'        => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
+			'html_id'          => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+			'html_class'       => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
+			'html_label_id'    => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+			'html_label_class' => 'ee-reg-qstn',
+		);
+		$input_constructor_args['html_label_id'] .= '-lbl';
+		if ($answer instanceof EE_Answer && $answer->ID()) {
+			$input_constructor_args['html_name'] .= '[' . $answer->ID() . ']';
+			$input_constructor_args['html_id'] .= '-' . $answer->ID();
+			$input_constructor_args['html_label_id'] .= '-' . $answer->ID();
+		}
+		$form_input = $question->generate_form_input(
+			$registration,
+			$answer,
+			$input_constructor_args
+		);
+		remove_filter(
+			'FHEE__EE_Question__generate_form_input__country_options',
+			array($this, 'use_cached_countries_for_form_input')
+		);
+		remove_filter(
+			'FHEE__EE_Question__generate_form_input__state_options',
+			array($this, 'use_cached_states_for_form_input')
+		);
+		return $form_input;
+	}
+
+
+	/**
+	 * Gets the list of countries for the form input
+	 *
+	 * @param array|null      $countries_list
+	 * @param EE_Question     $question
+	 * @param EE_Registration $registration
+	 * @param EE_Answer       $answer
+	 * @return array 2d keys are country IDs, values are their names
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function use_cached_countries_for_form_input(
+		$countries_list,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	) {
+		$country_options = array('' => '');
+		// get possibly cached list of countries
+		$countries = $this->checkout->action === 'process_reg_step'
+			? EEM_Country::instance()->get_all_countries()
+			: EEM_Country::instance()->get_all_active_countries();
+		if (! empty($countries)) {
+			foreach ($countries as $country) {
+				if ($country instanceof EE_Country) {
+					$country_options[ $country->ID() ] = $country->name();
+				}
+			}
+		}
+		if ($question instanceof EE_Question && $registration instanceof EE_Registration) {
+			$answer = EEM_Answer::instance()->get_one(
+				array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
+			);
+		} else {
+			$answer = EE_Answer::new_instance();
+		}
+		$country_options = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			$country_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+		return $country_options;
+	}
+
+
+	/**
+	 * Gets the list of states for the form input
+	 *
+	 * @param array|null      $states_list
+	 * @param EE_Question     $question
+	 * @param EE_Registration $registration
+	 * @param EE_Answer       $answer
+	 * @return array 2d keys are state IDs, values are their names
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function use_cached_states_for_form_input(
+		$states_list,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	) {
+		$state_options = array('' => array('' => ''));
+		$states = $this->checkout->action === 'process_reg_step'
+			? EEM_State::instance()->get_all_states()
+			: EEM_State::instance()->get_all_active_states();
+		if (! empty($states)) {
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
+				}
+			}
+		}
+		$state_options = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			$state_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+		return $state_options;
+	}
+
+
+	/********************************************************************************************************/
+	/****************************************  PROCESS REG STEP  ****************************************/
+	/********************************************************************************************************/
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_reg_step()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// grab validated data from form
+		$valid_data = $this->checkout->current_step->valid_data();
+		// EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $valid_data, '$valid_data', __FILE__, __LINE__ );
+		// if we don't have any $valid_data then something went TERRIBLY WRONG !!!
+		if (empty($valid_data)) {
+			EE_Error::add_error(
+				esc_html__('No valid question responses were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
+			EE_Error::add_error(
+				esc_html__(
+					'A valid transaction could not be initiated for processing your registrations.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// get cached registrations
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		// verify we got the goods
+		if (empty($registrations)) {
+			// combine the old translated string with a new one, in order to not break translations
+			$error_message = esc_html__(
+				'Your form data could not be applied to any valid registrations.',
+				'event_espresso'
+			)
+			. sprintf(
+				esc_html_x(
+					'%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.',
+					'(line break)This can sometimes happen if too much time has been taken to complete the registration process.(line break)Please return to the (link)Event List(end link) and reselect your tickets. If the problem continues, please contact the site administrator.',
+					'event_espresso'
+				),
+				'<a href="' . get_post_type_archive_link('espresso_events') . '" >',
+				'</a>',
+				'<br />'
+			);
+			EE_Error::add_error(
+				$error_message,
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// extract attendee info from form data and save to model objects
+		$registrations_processed = $this->_process_registrations($registrations, $valid_data);
+		// if first pass thru SPCO,
+		// then let's check processed registrations against the total number of tickets in the cart
+		if ($registrations_processed === false) {
+			// but return immediately if the previous step exited early due to errors
+			return false;
+		}
+		if (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
+			// generate a correctly translated string for all possible singular/plural combinations
+			if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
+				$error_msg = sprintf(
+					esc_html_x(
+						'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
+						'There was 1 ticket in the Event Queue, but 2 registrations were processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			} elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
+				$error_msg = sprintf(
+					esc_html_x(
+						'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
+						'There was a total of 2 tickets in the Event Queue, but only 1 registration was processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			} else {
+				$error_msg = sprintf(
+					esc_html__(
+						'There was a total of 2 tickets in the Event Queue, but 2 registrations were processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			}
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// mark this reg step as completed
+		$this->set_completed();
+		$this->_set_success_message(
+			esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
+		);
+		// do action in case a plugin wants to do something with the data submitted in step 1.
+		// passes EE_Single_Page_Checkout, and it's posted data
+		do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
+		return true;
+	}
+
+
+	/**
+	 *    _process_registrations
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @param array[][]         $valid_data
+	 * @return bool|int
+	 * @throws EntityNotFoundException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _process_registrations($registrations = array(), $valid_data = array())
+	{
+		// load resources and set some defaults
+		EE_Registry::instance()->load_model('Attendee');
+		// holder for primary registrant attendee object
+		$this->checkout->primary_attendee_obj = null;
+		// array for tracking reg form data for the primary registrant
+		$primary_registrant = array(
+			'line_item_id' => null,
+		);
+		$copy_primary = false;
+		// reg form sections that do not contain inputs
+		$non_input_form_sections = array(
+			'primary_registrant',
+			'additional_attendee_reg_info',
+			'spco_copy_attendee_chk',
+		);
+		// attendee counter
+		$att_nmbr = 0;
+		// grab the saved registrations from the transaction
+		foreach ($registrations as $registration) {
+			// verify EE_Registration object
+			if (! $registration instanceof EE_Registration) {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid Registration object was discovered when attempting to process your registration information.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			/** @var string $reg_url_link */
+			$reg_url_link = $registration->reg_url_link();
+			// reg_url_link exists ?
+			if (! empty($reg_url_link)) {
+				// should this registration be processed during this visit ?
+				if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
+					// if NOT revisiting, then let's save the registration now,
+					// so that we have a REG_ID to use when generating other objects
+					if (! $this->checkout->revisit) {
+						$registration->save();
+					}
+					/**
+					 * This allows plugins to trigger a fail on processing of a
+					 * registration for any conditions they may have for it to pass.
+					 *
+					 * @var bool   if true is returned by the plugin then the
+					 *            registration processing is halted.
+					 */
+					if (apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
+						false,
+						$att_nmbr,
+						$registration,
+						$registrations,
+						$valid_data,
+						$this
+					)) {
+						return false;
+					}
+
+					// Houston, we have a registration!
+					$att_nmbr++;
+					$this->_attendee_data[ $reg_url_link ] = array();
+					// grab any existing related answer objects
+					$this->_registration_answers = $registration->answers();
+					// unset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] );
+					if (isset($valid_data[ $reg_url_link ])) {
+						// do we need to copy basic info from primary attendee ?
+						$copy_primary = isset($valid_data[ $reg_url_link ]['additional_attendee_reg_info'])
+										&& absint($valid_data[ $reg_url_link ]['additional_attendee_reg_info']) === 0;
+						// filter form input data for this registration
+						$valid_data[ $reg_url_link ] = (array) apply_filters(
+							'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+							$valid_data[ $reg_url_link ]
+						);
+						if (isset($valid_data['primary_attendee'])) {
+							$primary_registrant['line_item_id'] = ! empty($valid_data['primary_attendee'])
+								? $valid_data['primary_attendee']
+								: false;
+							unset($valid_data['primary_attendee']);
+						}
+						// now loop through our array of valid post data && process attendee reg forms
+						foreach ($valid_data[ $reg_url_link ] as $form_section => $form_inputs) {
+							if (! in_array($form_section, $non_input_form_sections, true)) {
+								foreach ($form_inputs as $form_input => $input_value) {
+									// \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
+									// check for critical inputs
+									if (! $this->_verify_critical_attendee_details_are_set_and_validate_email(
+										$form_input,
+										$input_value
+									)
+									) {
+										return false;
+									}
+									// store a bit of data about the primary attendee
+									if ($att_nmbr === 1
+										&& ! empty($input_value)
+										&& $reg_url_link === $primary_registrant['line_item_id']
+									) {
+										$primary_registrant[ $form_input ] = $input_value;
+									} elseif ($copy_primary
+											  && $input_value === null
+											  && isset($primary_registrant[ $form_input ])
+									) {
+										$input_value = $primary_registrant[ $form_input ];
+									}
+									// now attempt to save the input data
+									if (! $this->_save_registration_form_input(
+										$registration,
+										$form_input,
+										$input_value
+									)
+									) {
+										EE_Error::add_error(
+											sprintf(
+												esc_html_x(
+													'Unable to save registration form data for the form input: "%1$s" with the submitted value: "%2$s"',
+													'Unable to save registration form data for the form input: "form input name" with the submitted value: "form input value"',
+													'event_espresso'
+												),
+												$form_input,
+												$input_value
+											),
+											__FILE__,
+											__FUNCTION__,
+											__LINE__
+										);
+										return false;
+									}
+								}
+							}
+						}  // end of foreach ( $valid_data[ $reg_url_link ] as $form_section => $form_inputs )
+					}
+					// EEH_Debug_Tools::printr( $this->_attendee_data, '$this->_attendee_data', __FILE__, __LINE__ );
+					// this registration does not require additional attendee information ?
+					if ($copy_primary
+						&& $att_nmbr > 1
+						&& $this->checkout->primary_attendee_obj instanceof EE_Attendee
+					) {
+						// just copy the primary registrant
+						$attendee = $this->checkout->primary_attendee_obj;
+					} else {
+						// ensure critical details are set for additional attendees
+						$this->_attendee_data[ $reg_url_link ] = $att_nmbr > 1
+							? $this->_copy_critical_attendee_details_from_primary_registrant(
+								$this->_attendee_data[ $reg_url_link ]
+							)
+							: $this->_attendee_data[ $reg_url_link ];
+						// execute create attendee command (which may return an existing attendee)
+						$attendee = EE_Registry::instance()->BUS->execute(
+							new CreateAttendeeCommand(
+								$this->_attendee_data[ $reg_url_link ],
+								$registration
+							)
+						);
+						// who's #1 ?
+						if ($att_nmbr === 1) {
+							$this->checkout->primary_attendee_obj = $attendee;
+						}
+					}
+					// EEH_Debug_Tools::printr( $attendee, '$attendee', __FILE__, __LINE__ );
+					// add relation to registration, set attendee ID, and cache attendee
+					$this->_associate_attendee_with_registration($registration, $attendee);
+					// \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
+					if (! $registration->attendee() instanceof EE_Attendee) {
+						EE_Error::add_error(
+							sprintf(
+								esc_html_x(
+									'Registration %s has an invalid or missing Attendee object.',
+									'Registration 123-456-789 has an invalid or missing Attendee object.',
+									'event_espresso'
+								),
+								$reg_url_link
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+					/** @type EE_Registration_Processor $registration_processor */
+					$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+					// at this point, we should have enough details about the registrant to consider the registration
+					// NOT incomplete
+					$registration_processor->toggle_incomplete_registration_status_to_default(
+						$registration,
+						false,
+						new Context(
+							'spco_reg_step_attendee_information_process_registrations',
+							esc_html__(
+								'Finished populating registration with details from the registration form after submitting the Attendee Information Reg Step.',
+								'event_espresso'
+							)
+						)
+					);
+					// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to
+					// abandoned
+					$this->checkout->transaction->toggle_failed_transaction_status();
+					// if we've gotten this far, then let's save what we have
+					$registration->save();
+					// add relation between TXN and registration
+					$this->_associate_registration_with_transaction($registration);
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid or missing line item ID was encountered while attempting to process the registration form.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				// remove malformed data
+				unset($valid_data[ $reg_url_link ]);
+				return false;
+			}
+		} // end of foreach ( $this->checkout->transaction->registrations()  as $registration )
+		return $att_nmbr;
+	}
+
+
+	/**
+	 *    _save_registration_form_input
+	 *
+	 * @param EE_Registration $registration
+	 * @param string          $form_input
+	 * @param string          $input_value
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _save_registration_form_input(
+		EE_Registration $registration,
+		$form_input = '',
+		$input_value = ''
+	) {
+		// \EEH_Debug_Tools::printr( __FUNCTION__, __CLASS__, __FILE__, __LINE__, 2 );
+		// \EEH_Debug_Tools::printr( $form_input, '$form_input', __FILE__, __LINE__ );
+		// \EEH_Debug_Tools::printr( $input_value, '$input_value', __FILE__, __LINE__ );
+		// allow for plugins to hook in and do their own processing of the form input.
+		// For plugins to bypass normal processing here, they just need to return a boolean value.
+		if (apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
+			false,
+			$registration,
+			$form_input,
+			$input_value,
+			$this
+		)) {
+			return true;
+		}
+		/*
          * $answer_cache_id is the key used to find the EE_Answer we want
          * @see https://events.codebasehq.com/projects/event-espresso/tickets/10477
          */
-        $answer_cache_id = $this->checkout->reg_url_link
-            ? $form_input . '-' . $registration->reg_url_link()
-            : $form_input;
-        $answer_is_obj = isset($this->_registration_answers[ $answer_cache_id ])
-                         && $this->_registration_answers[ $answer_cache_id ] instanceof EE_Answer;
-        // rename form_inputs if they are EE_Attendee properties
-        switch ((string) $form_input) {
-            case 'state':
-            case 'STA_ID':
-                $attendee_property = true;
-                $form_input = 'STA_ID';
-                break;
-
-            case 'country':
-            case 'CNT_ISO':
-                $attendee_property = true;
-                $form_input = 'CNT_ISO';
-                break;
-
-            default:
-                $ATT_input = 'ATT_' . $form_input;
-                // EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
-                $attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
-                $form_input = $attendee_property ? 'ATT_' . $form_input : $form_input;
-        }
-        // EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $answer_is_obj, '$answer_is_obj', __FILE__, __LINE__ );
-        // if this form input has a corresponding attendee property
-        if ($attendee_property) {
-            $this->_attendee_data[ $registration->reg_url_link() ][ $form_input ] = $input_value;
-            if ($answer_is_obj) {
-                // and delete the corresponding answer since we won't be storing this data in that object
-                $registration->_remove_relation_to($this->_registration_answers[ $answer_cache_id ], 'Answer');
-                $this->_registration_answers[ $answer_cache_id ]->delete_permanently();
-            }
-            return true;
-        }
-        if ($answer_is_obj) {
-            // save this data to the answer object
-            $this->_registration_answers[ $answer_cache_id ]->set_value($input_value);
-            $result = $this->_registration_answers[ $answer_cache_id ]->save();
-            return $result !== false;
-        }
-        foreach ($this->_registration_answers as $answer) {
-            if ($answer instanceof EE_Answer && $answer->question_ID() === $answer_cache_id) {
-                $answer->set_value($input_value);
-                $result = $answer->save();
-                return $result !== false;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    _verify_critical_attendee_details_are_set
-     *
-     * @param string $form_input
-     * @param string $input_value
-     * @return boolean
-     */
-    private function _verify_critical_attendee_details_are_set_and_validate_email(
-        $form_input = '',
-        $input_value = ''
-    ) {
-        if (empty($input_value)) {
-            // if the form input isn't marked as being required, then just return
-            if (! isset($this->_required_questions[ $form_input ]) || ! $this->_required_questions[ $form_input ]) {
-                return true;
-            }
-            switch ($form_input) {
-                case 'fname':
-                    EE_Error::add_error(
-                        esc_html__('First Name is a required value.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                    break;
-                case 'lname':
-                    EE_Error::add_error(
-                        esc_html__('Last Name is a required value.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                    break;
-                case 'email':
-                    EE_Error::add_error(
-                        esc_html__('Please enter a valid email address.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                    break;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     *    _associate_attendee_with_registration
-     *
-     * @param EE_Registration $registration
-     * @param EE_Attendee     $attendee
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _associate_attendee_with_registration(EE_Registration $registration, EE_Attendee $attendee)
-    {
-        // add relation to attendee
-        $registration->_add_relation_to($attendee, 'Attendee');
-        $registration->set_attendee_id($attendee->ID());
-        $registration->update_cache_after_object_save('Attendee', $attendee);
-    }
-
-
-    /**
-     *    _associate_registration_with_transaction
-     *
-     * @param EE_Registration $registration
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _associate_registration_with_transaction(EE_Registration $registration)
-    {
-        // add relation to registration
-        $this->checkout->transaction->_add_relation_to($registration, 'Registration');
-        $this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
-    }
-
-
-    /**
-     *    _copy_critical_attendee_details_from_primary_registrant
-     *    ensures that all attendees at least have data for first name, last name, and email address
-     *
-     * @param array $attendee_data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _copy_critical_attendee_details_from_primary_registrant($attendee_data = array())
-    {
-        // bare minimum critical details include first name, last name, email address
-        $critical_attendee_details = array('ATT_fname', 'ATT_lname', 'ATT_email');
-        // add address info to critical details?
-        if (apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
-            false
-        )) {
-            $address_details = array(
-                'ATT_address',
-                'ATT_address2',
-                'ATT_city',
-                'STA_ID',
-                'CNT_ISO',
-                'ATT_zip',
-                'ATT_phone',
-            );
-            $critical_attendee_details = array_merge($critical_attendee_details, $address_details);
-        }
-        foreach ($critical_attendee_details as $critical_attendee_detail) {
-            if (! isset($attendee_data[ $critical_attendee_detail ])
-                || empty($attendee_data[ $critical_attendee_detail ])
-            ) {
-                $attendee_data[ $critical_attendee_detail ] = $this->checkout->primary_attendee_obj->get(
-                    $critical_attendee_detail
-                );
-            }
-        }
-        return $attendee_data;
-    }
-
-
-    /**
-     *    update_reg_step
-     *    this is the final step after a user  revisits the site to edit their attendee information
-     *    this gets called AFTER the process_reg_step() method above
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update_reg_step()
-    {
-        // save everything
-        if ($this->process_reg_step()) {
-            $this->checkout->redirect = true;
-            $this->checkout->redirect_url = add_query_arg(
-                array(
-                    'e_reg_url_link' => $this->checkout->reg_url_link,
-                    'revisit'        => true,
-                ),
-                $this->checkout->thank_you_page_url
-            );
-            $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-            return true;
-        }
-        return false;
-    }
+		$answer_cache_id = $this->checkout->reg_url_link
+			? $form_input . '-' . $registration->reg_url_link()
+			: $form_input;
+		$answer_is_obj = isset($this->_registration_answers[ $answer_cache_id ])
+						 && $this->_registration_answers[ $answer_cache_id ] instanceof EE_Answer;
+		// rename form_inputs if they are EE_Attendee properties
+		switch ((string) $form_input) {
+			case 'state':
+			case 'STA_ID':
+				$attendee_property = true;
+				$form_input = 'STA_ID';
+				break;
+
+			case 'country':
+			case 'CNT_ISO':
+				$attendee_property = true;
+				$form_input = 'CNT_ISO';
+				break;
+
+			default:
+				$ATT_input = 'ATT_' . $form_input;
+				// EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
+				$attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
+				$form_input = $attendee_property ? 'ATT_' . $form_input : $form_input;
+		}
+		// EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $answer_is_obj, '$answer_is_obj', __FILE__, __LINE__ );
+		// if this form input has a corresponding attendee property
+		if ($attendee_property) {
+			$this->_attendee_data[ $registration->reg_url_link() ][ $form_input ] = $input_value;
+			if ($answer_is_obj) {
+				// and delete the corresponding answer since we won't be storing this data in that object
+				$registration->_remove_relation_to($this->_registration_answers[ $answer_cache_id ], 'Answer');
+				$this->_registration_answers[ $answer_cache_id ]->delete_permanently();
+			}
+			return true;
+		}
+		if ($answer_is_obj) {
+			// save this data to the answer object
+			$this->_registration_answers[ $answer_cache_id ]->set_value($input_value);
+			$result = $this->_registration_answers[ $answer_cache_id ]->save();
+			return $result !== false;
+		}
+		foreach ($this->_registration_answers as $answer) {
+			if ($answer instanceof EE_Answer && $answer->question_ID() === $answer_cache_id) {
+				$answer->set_value($input_value);
+				$result = $answer->save();
+				return $result !== false;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    _verify_critical_attendee_details_are_set
+	 *
+	 * @param string $form_input
+	 * @param string $input_value
+	 * @return boolean
+	 */
+	private function _verify_critical_attendee_details_are_set_and_validate_email(
+		$form_input = '',
+		$input_value = ''
+	) {
+		if (empty($input_value)) {
+			// if the form input isn't marked as being required, then just return
+			if (! isset($this->_required_questions[ $form_input ]) || ! $this->_required_questions[ $form_input ]) {
+				return true;
+			}
+			switch ($form_input) {
+				case 'fname':
+					EE_Error::add_error(
+						esc_html__('First Name is a required value.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+					break;
+				case 'lname':
+					EE_Error::add_error(
+						esc_html__('Last Name is a required value.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+					break;
+				case 'email':
+					EE_Error::add_error(
+						esc_html__('Please enter a valid email address.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+					break;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 *    _associate_attendee_with_registration
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Attendee     $attendee
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _associate_attendee_with_registration(EE_Registration $registration, EE_Attendee $attendee)
+	{
+		// add relation to attendee
+		$registration->_add_relation_to($attendee, 'Attendee');
+		$registration->set_attendee_id($attendee->ID());
+		$registration->update_cache_after_object_save('Attendee', $attendee);
+	}
+
+
+	/**
+	 *    _associate_registration_with_transaction
+	 *
+	 * @param EE_Registration $registration
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _associate_registration_with_transaction(EE_Registration $registration)
+	{
+		// add relation to registration
+		$this->checkout->transaction->_add_relation_to($registration, 'Registration');
+		$this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
+	}
+
+
+	/**
+	 *    _copy_critical_attendee_details_from_primary_registrant
+	 *    ensures that all attendees at least have data for first name, last name, and email address
+	 *
+	 * @param array $attendee_data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _copy_critical_attendee_details_from_primary_registrant($attendee_data = array())
+	{
+		// bare minimum critical details include first name, last name, email address
+		$critical_attendee_details = array('ATT_fname', 'ATT_lname', 'ATT_email');
+		// add address info to critical details?
+		if (apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
+			false
+		)) {
+			$address_details = array(
+				'ATT_address',
+				'ATT_address2',
+				'ATT_city',
+				'STA_ID',
+				'CNT_ISO',
+				'ATT_zip',
+				'ATT_phone',
+			);
+			$critical_attendee_details = array_merge($critical_attendee_details, $address_details);
+		}
+		foreach ($critical_attendee_details as $critical_attendee_detail) {
+			if (! isset($attendee_data[ $critical_attendee_detail ])
+				|| empty($attendee_data[ $critical_attendee_detail ])
+			) {
+				$attendee_data[ $critical_attendee_detail ] = $this->checkout->primary_attendee_obj->get(
+					$critical_attendee_detail
+				);
+			}
+		}
+		return $attendee_data;
+	}
+
+
+	/**
+	 *    update_reg_step
+	 *    this is the final step after a user  revisits the site to edit their attendee information
+	 *    this gets called AFTER the process_reg_step() method above
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update_reg_step()
+	{
+		// save everything
+		if ($this->process_reg_step()) {
+			$this->checkout->redirect = true;
+			$this->checkout->redirect_url = add_query_arg(
+				array(
+					'e_reg_url_link' => $this->checkout->reg_url_link,
+					'revisit'        => true,
+				),
+				$this->checkout->thank_you_page_url
+			);
+			$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+			return true;
+		}
+		return false;
+	}
 }

core/domain/services/registration/CopyRegistrationService.php

Indentation +141 added lines, -141 removed lines

@@ -27,151 +27,151 @@
 {
 
 
-    /**
-     * @param EE_Registration $target_registration
-     * @param EE_Registration $registration_to_copy
-     * @return bool
-     * @throws UnexpectedEntityException
-     * @throws EntityNotFoundException
-     * @throws RuntimeException
-     * @throws EE_Error
-     */
-    public function copyRegistrationDetails(
-        EE_Registration $target_registration,
-        EE_Registration $registration_to_copy
-    ) {
-        // copy attendee
-        $target_registration->set_attendee_id($registration_to_copy->attendee_ID());
-        $target_registration->updateStatusBasedOnTotalPaid(false);
-        $target_registration->save();
-        // get answers to previous reg questions
-        $answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers());
-        // get questions to new event reg form
-        $new_event = $target_registration->event();
-        $field_name = 'Event_Question_Group.'
-            . EEM_Event_Question_Group::instance()->fieldNameForContext(
-                $registration_to_copy->is_primary_registrant()
-            );
-        $question_groups = $new_event->question_groups([
-                [
-                    'Event.EVT_ID' => $new_event->ID(),
-                    $field_name => true,
-                ],
-                'order_by' => ['QSG_order' => 'ASC'],
-            ]);
-        foreach ($question_groups as $question_group) {
-            if ($question_group instanceof \EE_Question_Group) {
-                foreach ($question_group->questions() as $question) {
-                    if ($question instanceof EE_Question) {
-                        $this->generateNewAnswer(
-                            $question,
-                            $target_registration,
-                            $answers
-                        );
-                    }
-                }
-            }
-        }
-        return true;
-    }
+	/**
+	 * @param EE_Registration $target_registration
+	 * @param EE_Registration $registration_to_copy
+	 * @return bool
+	 * @throws UnexpectedEntityException
+	 * @throws EntityNotFoundException
+	 * @throws RuntimeException
+	 * @throws EE_Error
+	 */
+	public function copyRegistrationDetails(
+		EE_Registration $target_registration,
+		EE_Registration $registration_to_copy
+	) {
+		// copy attendee
+		$target_registration->set_attendee_id($registration_to_copy->attendee_ID());
+		$target_registration->updateStatusBasedOnTotalPaid(false);
+		$target_registration->save();
+		// get answers to previous reg questions
+		$answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers());
+		// get questions to new event reg form
+		$new_event = $target_registration->event();
+		$field_name = 'Event_Question_Group.'
+			. EEM_Event_Question_Group::instance()->fieldNameForContext(
+				$registration_to_copy->is_primary_registrant()
+			);
+		$question_groups = $new_event->question_groups([
+				[
+					'Event.EVT_ID' => $new_event->ID(),
+					$field_name => true,
+				],
+				'order_by' => ['QSG_order' => 'ASC'],
+			]);
+		foreach ($question_groups as $question_group) {
+			if ($question_group instanceof \EE_Question_Group) {
+				foreach ($question_group->questions() as $question) {
+					if ($question instanceof EE_Question) {
+						$this->generateNewAnswer(
+							$question,
+							$target_registration,
+							$answers
+						);
+					}
+				}
+			}
+		}
+		return true;
+	}
 
 
-    /**
-     * @param EE_Answer[] $answers
-     * @return array
-     * @throws EE_Error
-     */
-    protected function reindexAnswersByQuestionId(array $answers)
-    {
-        $reindexed_answers = array();
-        foreach ($answers as $answer) {
-            if ($answer instanceof EE_Answer) {
-                $reindexed_answers[ $answer->question_ID() ] = $answer->value();
-            }
-        }
-        return $reindexed_answers;
-    }
+	/**
+	 * @param EE_Answer[] $answers
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function reindexAnswersByQuestionId(array $answers)
+	{
+		$reindexed_answers = array();
+		foreach ($answers as $answer) {
+			if ($answer instanceof EE_Answer) {
+				$reindexed_answers[ $answer->question_ID() ] = $answer->value();
+			}
+		}
+		return $reindexed_answers;
+	}
 
 
-    /**
-     * @param EE_Question      $question
-     * @param EE_Registration  $registration
-     * @param                  $previous_answers
-     * @return EE_Answer
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function generateNewAnswer(
-        EE_Question $question,
-        EE_Registration $registration,
-        $previous_answers
-    ) {
-        $old_answer_value = isset($previous_answers[ $question->ID() ])
-            ? $previous_answers[ $question->ID() ]
-            : '';
-        $new_answer = EE_Answer::new_instance(
-            array(
-                'QST_ID'    => $question->ID(),
-                'REG_ID'    => $registration->ID(),
-                'ANS_value' => $old_answer_value,
-            )
-        );
-        if (! $new_answer instanceof EE_Answer) {
-            throw new UnexpectedEntityException($new_answer, 'EE_Answer');
-        }
-        $new_answer->save();
-        return $new_answer;
-    }
+	/**
+	 * @param EE_Question      $question
+	 * @param EE_Registration  $registration
+	 * @param                  $previous_answers
+	 * @return EE_Answer
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function generateNewAnswer(
+		EE_Question $question,
+		EE_Registration $registration,
+		$previous_answers
+	) {
+		$old_answer_value = isset($previous_answers[ $question->ID() ])
+			? $previous_answers[ $question->ID() ]
+			: '';
+		$new_answer = EE_Answer::new_instance(
+			array(
+				'QST_ID'    => $question->ID(),
+				'REG_ID'    => $registration->ID(),
+				'ANS_value' => $old_answer_value,
+			)
+		);
+		if (! $new_answer instanceof EE_Answer) {
+			throw new UnexpectedEntityException($new_answer, 'EE_Answer');
+		}
+		$new_answer->save();
+		return $new_answer;
+	}
 
 
-    /**
-     * @param EE_Registration $target_registration
-     * @param EE_Registration $registration_to_copy
-     * @return bool
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public function copyPaymentDetails(
-        EE_Registration $target_registration,
-        EE_Registration $registration_to_copy
-    ) {
-        $save = false;
-        $previous_registration_payments = $registration_to_copy->registration_payments();
-        $new_registration_payment_total = 0;
-        $registration_to_copy_total = $registration_to_copy->paid();
-        foreach ($previous_registration_payments as $previous_registration_payment) {
-            if ($previous_registration_payment instanceof EE_Registration_Payment
-                && $previous_registration_payment->payment() instanceof EE_Payment
-                && $previous_registration_payment->payment()->is_approved()
-            ) {
-                $payment_amount = $previous_registration_payment->amount();
-                $new_registration_payment = EE_Registration_Payment::new_instance(
-                    array(
-                        'REG_ID'     => $target_registration->ID(),
-                        'PAY_ID'     => $previous_registration_payment->payment()->ID(),
-                        'RPY_amount' => $payment_amount,
-                    )
-                );
-                if (! $new_registration_payment instanceof EE_Registration_Payment) {
-                    throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
-                }
-                $new_registration_payment->save();
-                // if new reg payment is good, then set old reg payment amount to zero
-                $previous_registration_payment->set_amount(0);
-                $previous_registration_payment->save();
-                // now  increment/decrement payment amounts
-                $new_registration_payment_total += $payment_amount;
-                $registration_to_copy_total -= $payment_amount;
-                $save = true;
-            }
-        }
-        if ($save) {
-            $target_registration->set_paid($new_registration_payment_total);
-            $target_registration->save();
-            $registration_to_copy->set_paid($registration_to_copy_total);
-            $registration_to_copy->save();
-        }
-        return true;
-    }
+	/**
+	 * @param EE_Registration $target_registration
+	 * @param EE_Registration $registration_to_copy
+	 * @return bool
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public function copyPaymentDetails(
+		EE_Registration $target_registration,
+		EE_Registration $registration_to_copy
+	) {
+		$save = false;
+		$previous_registration_payments = $registration_to_copy->registration_payments();
+		$new_registration_payment_total = 0;
+		$registration_to_copy_total = $registration_to_copy->paid();
+		foreach ($previous_registration_payments as $previous_registration_payment) {
+			if ($previous_registration_payment instanceof EE_Registration_Payment
+				&& $previous_registration_payment->payment() instanceof EE_Payment
+				&& $previous_registration_payment->payment()->is_approved()
+			) {
+				$payment_amount = $previous_registration_payment->amount();
+				$new_registration_payment = EE_Registration_Payment::new_instance(
+					array(
+						'REG_ID'     => $target_registration->ID(),
+						'PAY_ID'     => $previous_registration_payment->payment()->ID(),
+						'RPY_amount' => $payment_amount,
+					)
+				);
+				if (! $new_registration_payment instanceof EE_Registration_Payment) {
+					throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
+				}
+				$new_registration_payment->save();
+				// if new reg payment is good, then set old reg payment amount to zero
+				$previous_registration_payment->set_amount(0);
+				$previous_registration_payment->save();
+				// now  increment/decrement payment amounts
+				$new_registration_payment_total += $payment_amount;
+				$registration_to_copy_total -= $payment_amount;
+				$save = true;
+			}
+		}
+		if ($save) {
+			$target_registration->set_paid($new_registration_payment_total);
+			$target_registration->save();
+			$registration_to_copy->set_paid($registration_to_copy_total);
+			$registration_to_copy->save();
+		}
+		return true;
+	}
 }

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_event_question_group.dmsstage.php

Indentation +104 added lines, -106 removed lines

@@ -16,15 +16,13 @@ 
             'EQG_primary'=>new EE_Boolean_Field('EQG_primary', __('Flag indicating question is only for primary attendees','event_espresso'), false, false)
         )
     );
-
-
  *
  */
 class EE_DMS_4_1_0_event_question_group extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_table;
-    public function _migrate_old_row($old_row)
-    {
+	private $_new_table;
+	public function _migrate_old_row($old_row)
+	{
 //      $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, $old_row['id'], $this->_new_transaction_table);
 //          if ( ! $txn_id ){
 //              $this->add_error(sprintf(__("Could not find the transaction for the 3.1 attendee %d from row %s", "event_espresso"),$old_row['id'],$this->_json_encode($old_row)));
@@ -34,8 +32,8 @@ 
 //          $new_line_items = $this->_insert_new_line_items($txn,$old_row);
 //          $this->get_migration_script()->set_mapping($this->_old_table,$old_row['id'],$this->_new_line_table,$new_line_items);
 
-            $this->_insert_new_event_question_groups($old_row);
-    }
+			$this->_insert_new_event_question_groups($old_row);
+	}
 //  function _migration_step($num_items=50){
 //      global $wpdb;
 //      $start_at_record = $this->count_records_migrated();
@@ -55,109 +53,109 @@ 
 //      $count = $wpdb->get_var("SELECT COUNT(id) FROM ".$this->_old_table);
 //      return $count;
 //  }
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->prefix."events_detail";
-        $this->_extra_where_sql = 'WHERE event_status!="D"';
-        $this->_new_table = $wpdb->prefix."esp_event_question_group";
-        $this->_pretty_name = __("Question Groups in each Event", "event_espresso");
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->prefix."events_detail";
+		$this->_extra_where_sql = 'WHERE event_status!="D"';
+		$this->_new_table = $wpdb->prefix."esp_event_question_group";
+		$this->_pretty_name = __("Question Groups in each Event", "event_espresso");
+		parent::__construct();
+	}
 
-    /**
-     * Attempts to insert a new question group inthe new format given an old one
-     * @global type $wpdb
-     * @param array $old_event
-     * @return void
-     */
-    private function _insert_new_event_question_groups($old_event)
-    {
-        $new_event_question_group_ids = array();
-        $question_groups_for_primary = maybe_unserialize($old_event['question_groups']);
-        if (is_array($question_groups_for_primary)) {
-            foreach ($question_groups_for_primary as $old_question_group_id) {
-                $new_id = $this->_insert_event_question_group($old_event, $old_question_group_id, true);
-                if ($new_id) {
-                    $new_event_question_group_ids[] = $new_id;
-                }
-            }
-        }
-        $event_meta = maybe_unserialize($old_event['event_meta']);
-        if (isset($event_meta['add_attendee_question_groups'])) {
-            if (is_array($event_meta['add_attendee_question_groups'])) {
-                foreach ($event_meta['add_attendee_question_groups'] as $old_question_group_id) {
-                    $new_id = $this->_insert_event_question_group($old_event, $old_question_group_id, false);
-                    if ($new_id) {
-                        $new_event_question_group_ids[] = $new_id;
-                    }
-                }
-            }
-        }
+	/**
+	 * Attempts to insert a new question group inthe new format given an old one
+	 * @global type $wpdb
+	 * @param array $old_event
+	 * @return void
+	 */
+	private function _insert_new_event_question_groups($old_event)
+	{
+		$new_event_question_group_ids = array();
+		$question_groups_for_primary = maybe_unserialize($old_event['question_groups']);
+		if (is_array($question_groups_for_primary)) {
+			foreach ($question_groups_for_primary as $old_question_group_id) {
+				$new_id = $this->_insert_event_question_group($old_event, $old_question_group_id, true);
+				if ($new_id) {
+					$new_event_question_group_ids[] = $new_id;
+				}
+			}
+		}
+		$event_meta = maybe_unserialize($old_event['event_meta']);
+		if (isset($event_meta['add_attendee_question_groups'])) {
+			if (is_array($event_meta['add_attendee_question_groups'])) {
+				foreach ($event_meta['add_attendee_question_groups'] as $old_question_group_id) {
+					$new_id = $this->_insert_event_question_group($old_event, $old_question_group_id, false);
+					if ($new_id) {
+						$new_event_question_group_ids[] = $new_id;
+					}
+				}
+			}
+		}
 
 
-        $this->get_migration_script()->set_mapping($this->_old_table, $old_event['id'], $this->_new_table, $new_event_question_group_ids);
-    }
+		$this->get_migration_script()->set_mapping($this->_old_table, $old_event['id'], $this->_new_table, $new_event_question_group_ids);
+	}
 
-    private function _insert_event_question_group($old_event, $old_question_group_id, $primary)
-    {
-        global $wpdb;
-        $new_question_group_id = $this->get_migration_script()->get_mapping_new_pk(
-            $wpdb->prefix . "events_qst_group",
-            intval($old_question_group_id),
-            $wpdb->prefix . "esp_question_group"
-        );
+	private function _insert_event_question_group($old_event, $old_question_group_id, $primary)
+	{
+		global $wpdb;
+		$new_question_group_id = $this->get_migration_script()->get_mapping_new_pk(
+			$wpdb->prefix . "events_qst_group",
+			intval($old_question_group_id),
+			$wpdb->prefix . "esp_question_group"
+		);
 
-        if (! $new_question_group_id) {
-            $this->add_error(
-                sprintf(
-                    // translators: %s question ID, %s event ID
-                    __("Could not find 4.1 question ID for 3.1 question id #%s on event $%s", "event_espresso"),
-                    $old_question_group_id,
-                    $old_event['id']
-                )
-            );
-            return 0;
-        }
-        $new_event_id = $this->get_migration_script()->get_mapping_new_pk(
-            $wpdb->prefix . "events_detail",
-            intval($old_event['id']),
-            $wpdb->posts
-        );
-        if (! $new_question_group_id) {
-            $this->add_error(
-                sprintf(
-                    // translators: %s event ID
-                    __("Could not find 4.1 event 3.1 event id #%s", "event_espresso"),
-                    $old_event['id']
-                )
-            );
-            return 0;
-        }
-        $cols_n_values = array(
-            'EVT_ID'=>$new_event_id,
-            'QSG_ID'=>$new_question_group_id,
-            'EQG_primary' => $primary
-        );
+		if (! $new_question_group_id) {
+			$this->add_error(
+				sprintf(
+					// translators: %s question ID, %s event ID
+					__("Could not find 4.1 question ID for 3.1 question id #%s on event $%s", "event_espresso"),
+					$old_question_group_id,
+					$old_event['id']
+				)
+			);
+			return 0;
+		}
+		$new_event_id = $this->get_migration_script()->get_mapping_new_pk(
+			$wpdb->prefix . "events_detail",
+			intval($old_event['id']),
+			$wpdb->posts
+		);
+		if (! $new_question_group_id) {
+			$this->add_error(
+				sprintf(
+					// translators: %s event ID
+					__("Could not find 4.1 event 3.1 event id #%s", "event_espresso"),
+					$old_event['id']
+				)
+			);
+			return 0;
+		}
+		$cols_n_values = array(
+			'EVT_ID'=>$new_event_id,
+			'QSG_ID'=>$new_question_group_id,
+			'EQG_primary' => $primary
+		);
 
-        $datatypes = array(
-            '%d',// EVT_ID
-            '%d',// QSG_ID
-            '%d',// EQG_primary
-        );
-        $success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error(
-                $this->get_migration_script()->_create_error_message_for_db_insertion(
-                    $this->_old_table,
-                    $old_event,
-                    $this->_new_table,
-                    $cols_n_values,
-                    $datatypes
-                )
-            );
-            return 0;
-        }
-        return $wpdb->insert_id;
-    }
+		$datatypes = array(
+			'%d',// EVT_ID
+			'%d',// QSG_ID
+			'%d',// EQG_primary
+		);
+		$success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error(
+				$this->get_migration_script()->_create_error_message_for_db_insertion(
+					$this->_old_table,
+					$old_event,
+					$this->_new_table,
+					$cols_n_values,
+					$datatypes
+				)
+			);
+			return 0;
+		}
+		return $wpdb->insert_id;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -103,12 +103,12 @@ 
     {
         global $wpdb;
         $new_question_group_id = $this->get_migration_script()->get_mapping_new_pk(
-            $wpdb->prefix . "events_qst_group",
+            $wpdb->prefix."events_qst_group",
             intval($old_question_group_id),
-            $wpdb->prefix . "esp_question_group"
+            $wpdb->prefix."esp_question_group"
         );
 
-        if (! $new_question_group_id) {
+        if ( ! $new_question_group_id) {
             $this->add_error(
                 sprintf(
                     // translators: %s question ID, %s event ID
@@ -120,11 +120,11 @@ 
             return 0;
         }
         $new_event_id = $this->get_migration_script()->get_mapping_new_pk(
-            $wpdb->prefix . "events_detail",
+            $wpdb->prefix."events_detail",
             intval($old_event['id']),
             $wpdb->posts
         );
-        if (! $new_question_group_id) {
+        if ( ! $new_question_group_id) {
             $this->add_error(
                 sprintf(
                     // translators: %s event ID
@@ -141,12 +141,12 @@ 
         );
 
         $datatypes = array(
-            '%d',// EVT_ID
-            '%d',// QSG_ID
-            '%d',// EQG_primary
+            '%d', // EVT_ID
+            '%d', // QSG_ID
+            '%d', // EQG_primary
         );
         $success = $wpdb->insert($this->_new_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error(
                 $this->get_migration_script()->_create_error_message_for_db_insertion(
                     $this->_old_table,

core/data_migration_scripts/EE_Data_Migration_Class_Base.core.php

Indentation +404 added lines, -404 removed lines

@@ -17,408 +17,408 @@
 abstract class EE_Data_Migration_Class_Base
 {
 
-    /**
-     * @var $records_to_migrate int count of all that have been migrated
-     */
-    protected $_records_to_migrate = 0;
-
-    /**
-     *
-     * @var $records_migrated int
-     */
-    protected $_records_migrated = 0;
-
-    /**
-     * Whether this migration script is done or not. This COULD be deduced by
-     * _records_to_migrate and _records_migrated, but that might nto be accurate
-     *
-     * @var string one of EE_Data_migration_Manager::status_* constants
-     */
-    protected $_status = null;
-
-    /**
-     * internationalized name of this class. Convention is to NOT restate that
-     * this class if a migration script or a migration script stage
-     *
-     * @var string (i18ned)
-     */
-    protected $_pretty_name = null;
-
-    /**
-     * @var array
-     */
-    protected $_errors = array();
-
-    /**
-     * @var \EventEspresso\core\services\database\TableManager $table_manager
-     */
-    protected $_table_manager;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-
-    /**
-     * Just initializes the status of the migration
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_table_manager = $table_manager;
-        $this->_table_analysis = $table_analysis;
-        $this->set_status(EE_Data_Migration_Manager::status_continue);
-    }
-
-
-    /**
-     * Just gets the pretty name for this migration script or stage
-     *
-     * @throws EE_Error
-     * @return string
-     */
-    public function pretty_name()
-    {
-        if ($this->_pretty_name === null) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Please give a pretty name to the migration script stage %s by assigning the property _pretty_name in the constructor",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_pretty_name;
-    }
-
-    /**
-     *
-     * @return int
-     */
-    public function count_records_to_migrate()
-    {
-        if ($this->_records_to_migrate == null) {
-            $this->_records_to_migrate = $this->_count_records_to_migrate();
-        }
-        return $this->_records_to_migrate;
-    }
-
-    /**
-     * Counts records already migrated. This should only be implemented by EE_Data_Migration_Script_base and
-     * EE_Data_migration_Script_Stage
-     *
-     * @return int
-     */
-    abstract public function count_records_migrated();
-
-    /**
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @return int
-     */
-    abstract protected function _count_records_to_migrate();
-
-    /**
-     * Returns a string indicating the migration script's status.
-     *
-     * @return string one of EE_Data_Migration_Manager::status_* constants
-     * @throws EE_Error
-     */
-    public function get_status()
-    {
-        if ($this->_status === null) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Trying to get status of Migration class %s, but it has not been initialized yet. It should be set in the constructor.",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_status;
-    }
-
-    /**
-     *
-     * @param string $status
-     * @return void
-     */
-    protected function set_status($status)
-    {
-        $this->_status = $status;
-    }
-
-    /**
-     * @return array of strings
-     */
-    abstract public function get_errors();
-
-    /**
-     * Returns the last error that occurred. If none occurred, returns null
-     *
-     * @return string
-     */
-    public function get_last_error()
-    {
-        $errors = $this->get_errors();
-        if ($errors) {
-            return end($errors);
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Adds an error to the array of errors on this class.
-     *
-     * @param string  $error a string describing the error that will be useful for debugging. Consider including all
-     *                       the data that led to the error, and a stack trace etc.
-     * @param boolean $force force the error to be added (because otherwise we have a limit). If forcing and errors are
-     *                       already at their limit, we will purposefully forget the first half
-     */
-    public function add_error($error, $force = false)
-    {
-        if (! defined('EE_DMS_ERROR_LIMIT')) {
-            $limit = 50;
-        } else {
-            $limit = EE_DMS_ERROR_LIMIT;
-        }
-        // make sure errors is an array, see ticket #8261
-        if (is_string($this->_errors)) {
-            $this->_errors = array($this->_errors);
-        }
-        if (count($this->_errors) >= $limit) {
-            if ($force) {
-                // get rid of the first half of the errors and any above the limit
-                $this->_errors = array_slice($this->_errors, $limit / 2, $limit / 2);
-                $this->_errors[] = "Limit reached; removed first half of errors to save space";
-                $this->_errors[] = $error;
-            } else {
-                $this->_errors[ $limit ] = 'More, but limit reached...';
-            }
-        } else {
-            $this->_errors[] = $error;
-        }
-    }
-
-    /**
-     * Indicates there was a fatal error and the migration cannot possibly continue
-     *
-     * @return boolean
-     */
-    public function is_broken()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_fatal_error;
-    }
-
-    /**
-     * @deprecated since 4.6.12
-     */
-    public function is_borked()
-    {
-        EE_Error::doing_it_wrong(
-            'is_borked',
-            __(
-                'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
-                'event_espresso'
-            ),
-            '4.6.12'
-        );
-        return $this->is_broken();
-    }
-
-    /**
-     * Sets the status to as having a fatal error
-     */
-    public function set_broken()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_fatal_error;
-    }
-
-    /**
-     *
-     * @deprecated since 4.6.12
-     */
-    public function set_borked()
-    {
-        EE_Error::doing_it_wrong(
-            'is_borked',
-            __(
-                'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
-                'event_espresso'
-            ),
-            '4.6.12'
-        );
-        return $this->set_broken();
-    }
-
-    /**
-     * Checks if this thing believes it is completed
-     *
-     * @return boolean
-     */
-    public function is_completed()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_completed;
-    }
-
-    /**
-     * Checks if the current script has more to do or not (ie, if it's status is CONTINUE)
-     *
-     * @return boolean
-     */
-    public function has_more_to_do()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_continue;
-    }
-
-    /**
-     * Marks that we believe this migration thing is completed
-     */
-    public function set_completed()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_completed;
-    }
-
-    /**
-     * Marks that we think this migration class can continue to migrate
-     */
-    public function reattempt()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_continue;
-        $this->add_error(__('Reattempt migration', 'event_espresso'), true);
-    }
-
-    /**
-     * A lot like "__sleep()" magic method in purpose, this is meant for persisting this class'
-     * properties to the DB. However, we don't want to use __sleep() because its quite
-     * possible that this class is defined when it goes to sleep, but NOT available when it
-     * awakes (eg, this class is part of an addon that is deactivated at some point).
-     */
-    public function properties_as_array()
-    {
-        $properties = get_object_vars($this);
-        $properties['class'] = get_class($this);
-        unset($properties['_migration_script']);
-        unset($properties['_table_manager']);
-        unset($properties['_table_analysis']);
-        return $properties;
-    }
-
-    /**
-     * Sets all of the properties of this script stage to match what's in the array, which is assumed
-     * to have been made from the properties_as_array() function.
-     *
-     * @param array $array_of_properties like what's produced from properties_as_array() method
-     */
-    abstract public function instantiate_from_array_of_properties($array_of_properties);
-
-    /**
-     * Convenience method for showing a database insertion error
-     *
-     * @param string $old_table
-     * @param array  $old_row_as_array
-     * @param string $new_table
-     * @param array  $new_row_as_array columns=>values like used in wpdb->insert
-     * @param array  $data_types       numerically indexed
-     * @return string
-     */
-    protected function _create_error_message_for_db_insertion(
-        $old_table,
-        $old_row_as_array,
-        $new_table,
-        $new_row_as_array,
-        $data_types
-    ) {
-        global $wpdb;
-        $old_columns_and_values_for_string = array();
-        foreach ($old_row_as_array as $column => $value) {
-            $old_columns_and_values_for_string[] = "$column => $value";
-        }
-        $new_columns_and_values_for_string = array();
-        $count = 0;
-        foreach ($new_row_as_array as $column => $value) {
-            $new_columns_and_values_for_string[] = " $column => $value (" . $data_types[ $count++ ] . ")";
-        }
-        return sprintf(
-            __(
-                'Received error "%6$s" inserting row %5$s %1$s %5$s into table %2$s.%5$s Data used was %5$s %3$s %5$s from table %4$s.',
-                'event_espresso'
-            ),
-            implode(", ", $new_columns_and_values_for_string),
-            $new_table,
-            implode(", ", $old_columns_and_values_for_string),
-            $old_table,
-            '<br/>',
-            $wpdb->last_error
-        );
-    }
-
-
-    /**
-     * Same as json_encode, just avoids putting
-     * serialized arrays into the http build query, as that would
-     *
-     * @param array $array_of_data
-     * @return string
-     */
-    protected function _json_encode($array_of_data)
-    {
-        // we'd rather NOT serialize the transaction details
-        $fields_to_include = array();
-        foreach ($array_of_data as $name => $value) {
-            $unserialized_data = @unserialize($value);
-            if ($unserialized_data === false) {
-                $fields_to_include[ $name ] = $value;
-            }
-        }
-        return wp_json_encode($fields_to_include);
-    }
-
-    /**
-     * Gets the table manager (or throws an exception if it cannot be retrieved)
-     *
-     * @return TableManager
-     * @throws EE_Error
-     */
-    protected function _get_table_manager()
-    {
-        if ($this->_table_manager instanceof TableManager) {
-            return $this->_table_manager;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Table manager on migration class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Table analysis class on migration class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * @var $records_to_migrate int count of all that have been migrated
+	 */
+	protected $_records_to_migrate = 0;
+
+	/**
+	 *
+	 * @var $records_migrated int
+	 */
+	protected $_records_migrated = 0;
+
+	/**
+	 * Whether this migration script is done or not. This COULD be deduced by
+	 * _records_to_migrate and _records_migrated, but that might nto be accurate
+	 *
+	 * @var string one of EE_Data_migration_Manager::status_* constants
+	 */
+	protected $_status = null;
+
+	/**
+	 * internationalized name of this class. Convention is to NOT restate that
+	 * this class if a migration script or a migration script stage
+	 *
+	 * @var string (i18ned)
+	 */
+	protected $_pretty_name = null;
+
+	/**
+	 * @var array
+	 */
+	protected $_errors = array();
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableManager $table_manager
+	 */
+	protected $_table_manager;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+
+	/**
+	 * Just initializes the status of the migration
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_table_manager = $table_manager;
+		$this->_table_analysis = $table_analysis;
+		$this->set_status(EE_Data_Migration_Manager::status_continue);
+	}
+
+
+	/**
+	 * Just gets the pretty name for this migration script or stage
+	 *
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function pretty_name()
+	{
+		if ($this->_pretty_name === null) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Please give a pretty name to the migration script stage %s by assigning the property _pretty_name in the constructor",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_pretty_name;
+	}
+
+	/**
+	 *
+	 * @return int
+	 */
+	public function count_records_to_migrate()
+	{
+		if ($this->_records_to_migrate == null) {
+			$this->_records_to_migrate = $this->_count_records_to_migrate();
+		}
+		return $this->_records_to_migrate;
+	}
+
+	/**
+	 * Counts records already migrated. This should only be implemented by EE_Data_Migration_Script_base and
+	 * EE_Data_migration_Script_Stage
+	 *
+	 * @return int
+	 */
+	abstract public function count_records_migrated();
+
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @return int
+	 */
+	abstract protected function _count_records_to_migrate();
+
+	/**
+	 * Returns a string indicating the migration script's status.
+	 *
+	 * @return string one of EE_Data_Migration_Manager::status_* constants
+	 * @throws EE_Error
+	 */
+	public function get_status()
+	{
+		if ($this->_status === null) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Trying to get status of Migration class %s, but it has not been initialized yet. It should be set in the constructor.",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_status;
+	}
+
+	/**
+	 *
+	 * @param string $status
+	 * @return void
+	 */
+	protected function set_status($status)
+	{
+		$this->_status = $status;
+	}
+
+	/**
+	 * @return array of strings
+	 */
+	abstract public function get_errors();
+
+	/**
+	 * Returns the last error that occurred. If none occurred, returns null
+	 *
+	 * @return string
+	 */
+	public function get_last_error()
+	{
+		$errors = $this->get_errors();
+		if ($errors) {
+			return end($errors);
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * Adds an error to the array of errors on this class.
+	 *
+	 * @param string  $error a string describing the error that will be useful for debugging. Consider including all
+	 *                       the data that led to the error, and a stack trace etc.
+	 * @param boolean $force force the error to be added (because otherwise we have a limit). If forcing and errors are
+	 *                       already at their limit, we will purposefully forget the first half
+	 */
+	public function add_error($error, $force = false)
+	{
+		if (! defined('EE_DMS_ERROR_LIMIT')) {
+			$limit = 50;
+		} else {
+			$limit = EE_DMS_ERROR_LIMIT;
+		}
+		// make sure errors is an array, see ticket #8261
+		if (is_string($this->_errors)) {
+			$this->_errors = array($this->_errors);
+		}
+		if (count($this->_errors) >= $limit) {
+			if ($force) {
+				// get rid of the first half of the errors and any above the limit
+				$this->_errors = array_slice($this->_errors, $limit / 2, $limit / 2);
+				$this->_errors[] = "Limit reached; removed first half of errors to save space";
+				$this->_errors[] = $error;
+			} else {
+				$this->_errors[ $limit ] = 'More, but limit reached...';
+			}
+		} else {
+			$this->_errors[] = $error;
+		}
+	}
+
+	/**
+	 * Indicates there was a fatal error and the migration cannot possibly continue
+	 *
+	 * @return boolean
+	 */
+	public function is_broken()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_fatal_error;
+	}
+
+	/**
+	 * @deprecated since 4.6.12
+	 */
+	public function is_borked()
+	{
+		EE_Error::doing_it_wrong(
+			'is_borked',
+			__(
+				'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
+				'event_espresso'
+			),
+			'4.6.12'
+		);
+		return $this->is_broken();
+	}
+
+	/**
+	 * Sets the status to as having a fatal error
+	 */
+	public function set_broken()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_fatal_error;
+	}
+
+	/**
+	 *
+	 * @deprecated since 4.6.12
+	 */
+	public function set_borked()
+	{
+		EE_Error::doing_it_wrong(
+			'is_borked',
+			__(
+				'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
+				'event_espresso'
+			),
+			'4.6.12'
+		);
+		return $this->set_broken();
+	}
+
+	/**
+	 * Checks if this thing believes it is completed
+	 *
+	 * @return boolean
+	 */
+	public function is_completed()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_completed;
+	}
+
+	/**
+	 * Checks if the current script has more to do or not (ie, if it's status is CONTINUE)
+	 *
+	 * @return boolean
+	 */
+	public function has_more_to_do()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_continue;
+	}
+
+	/**
+	 * Marks that we believe this migration thing is completed
+	 */
+	public function set_completed()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_completed;
+	}
+
+	/**
+	 * Marks that we think this migration class can continue to migrate
+	 */
+	public function reattempt()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_continue;
+		$this->add_error(__('Reattempt migration', 'event_espresso'), true);
+	}
+
+	/**
+	 * A lot like "__sleep()" magic method in purpose, this is meant for persisting this class'
+	 * properties to the DB. However, we don't want to use __sleep() because its quite
+	 * possible that this class is defined when it goes to sleep, but NOT available when it
+	 * awakes (eg, this class is part of an addon that is deactivated at some point).
+	 */
+	public function properties_as_array()
+	{
+		$properties = get_object_vars($this);
+		$properties['class'] = get_class($this);
+		unset($properties['_migration_script']);
+		unset($properties['_table_manager']);
+		unset($properties['_table_analysis']);
+		return $properties;
+	}
+
+	/**
+	 * Sets all of the properties of this script stage to match what's in the array, which is assumed
+	 * to have been made from the properties_as_array() function.
+	 *
+	 * @param array $array_of_properties like what's produced from properties_as_array() method
+	 */
+	abstract public function instantiate_from_array_of_properties($array_of_properties);
+
+	/**
+	 * Convenience method for showing a database insertion error
+	 *
+	 * @param string $old_table
+	 * @param array  $old_row_as_array
+	 * @param string $new_table
+	 * @param array  $new_row_as_array columns=>values like used in wpdb->insert
+	 * @param array  $data_types       numerically indexed
+	 * @return string
+	 */
+	protected function _create_error_message_for_db_insertion(
+		$old_table,
+		$old_row_as_array,
+		$new_table,
+		$new_row_as_array,
+		$data_types
+	) {
+		global $wpdb;
+		$old_columns_and_values_for_string = array();
+		foreach ($old_row_as_array as $column => $value) {
+			$old_columns_and_values_for_string[] = "$column => $value";
+		}
+		$new_columns_and_values_for_string = array();
+		$count = 0;
+		foreach ($new_row_as_array as $column => $value) {
+			$new_columns_and_values_for_string[] = " $column => $value (" . $data_types[ $count++ ] . ")";
+		}
+		return sprintf(
+			__(
+				'Received error "%6$s" inserting row %5$s %1$s %5$s into table %2$s.%5$s Data used was %5$s %3$s %5$s from table %4$s.',
+				'event_espresso'
+			),
+			implode(", ", $new_columns_and_values_for_string),
+			$new_table,
+			implode(", ", $old_columns_and_values_for_string),
+			$old_table,
+			'<br/>',
+			$wpdb->last_error
+		);
+	}
+
+
+	/**
+	 * Same as json_encode, just avoids putting
+	 * serialized arrays into the http build query, as that would
+	 *
+	 * @param array $array_of_data
+	 * @return string
+	 */
+	protected function _json_encode($array_of_data)
+	{
+		// we'd rather NOT serialize the transaction details
+		$fields_to_include = array();
+		foreach ($array_of_data as $name => $value) {
+			$unserialized_data = @unserialize($value);
+			if ($unserialized_data === false) {
+				$fields_to_include[ $name ] = $value;
+			}
+		}
+		return wp_json_encode($fields_to_include);
+	}
+
+	/**
+	 * Gets the table manager (or throws an exception if it cannot be retrieved)
+	 *
+	 * @return TableManager
+	 * @throws EE_Error
+	 */
+	protected function _get_table_manager()
+	{
+		if ($this->_table_manager instanceof TableManager) {
+			return $this->_table_manager;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Table manager on migration class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Table analysis class on migration class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 }

admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php

Indentation +161 added lines, -161 removed lines

@@ -18,179 +18,179 @@
  */
 class EE_Registration_Custom_Questions_Form extends EE_Form_Section_Proper
 {
-    /**
-     *
-     * @var EE_Registration
-     */
-    protected $_registration = null;
+	/**
+	 *
+	 * @var EE_Registration
+	 */
+	protected $_registration = null;
 
-    /**
-     *
-     * @param EE_Registration $reg
-     * @param array $options
-     */
-    public function __construct(EE_Registration $reg, $options = array())
-    {
-        $this->_registration = $reg;
-        if (! isset($options['layout_strategy'])) {
-            $options['layout_strategy'] = new EE_Admin_Two_Column_Layout();
-        }
-        if (! isset($options['html_id'])) {
-            $options['html_id'] = 'reg-admin-attendee-questions-frm';
-        }
-        $this->build_form_from_registration();
-        parent::__construct($options);
-    }
+	/**
+	 *
+	 * @param EE_Registration $reg
+	 * @param array $options
+	 */
+	public function __construct(EE_Registration $reg, $options = array())
+	{
+		$this->_registration = $reg;
+		if (! isset($options['layout_strategy'])) {
+			$options['layout_strategy'] = new EE_Admin_Two_Column_Layout();
+		}
+		if (! isset($options['html_id'])) {
+			$options['html_id'] = 'reg-admin-attendee-questions-frm';
+		}
+		$this->build_form_from_registration();
+		parent::__construct($options);
+	}
 
 
-    /**
-     * Gets the registration object this form is about
-     * @return EE_Registration
-     */
-    public function get_registration()
-    {
-        return $this->_registration;
-    }
+	/**
+	 * Gets the registration object this form is about
+	 * @return EE_Registration
+	 */
+	public function get_registration()
+	{
+		return $this->_registration;
+	}
 
-    /**
-     * @since $VID:$
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function build_form_from_registration()
-    {
-        $reg = $this->get_registration();
-        if (! $reg instanceof EE_Registration) {
-            throw new EE_Error(__('We cannot build the registration custom questions form because there is no registration set on it yet', 'event_espresso'));
-        }
-        // we want to get all their question groups
-        $question_groups = EEM_Question_Group::instance()->get_all(
-            [
-                [
-                    'Event_Question_Group.EVT_ID' => $reg->event_ID(),
-                    'OR' => [
-                        'Question.QST_system*blank' =>  '',
-                        'Question.QST_system*null' => ['IS_NULL']
-                    ],
-                    'Event_Question_Group.'
-                    . EEM_Event_Question_Group::instance()->fieldNameForContext(
-                        $reg->is_primary_registrant()
-                    ) => true
-                ],
-                'order_by' => ['QSG_order' => 'ASC']
-            ]
-        );
-        // get each question groups questions
-        foreach ($question_groups as $question_group) {
-            if ($question_group instanceof EE_Question_Group) {
-                $this->_subsections[ $question_group->ID() ] = $this->build_subform_from_question_group(
-                    $question_group,
-                    $reg
-                );
-            }
-        }
-    }
+	/**
+	 * @since $VID:$
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function build_form_from_registration()
+	{
+		$reg = $this->get_registration();
+		if (! $reg instanceof EE_Registration) {
+			throw new EE_Error(__('We cannot build the registration custom questions form because there is no registration set on it yet', 'event_espresso'));
+		}
+		// we want to get all their question groups
+		$question_groups = EEM_Question_Group::instance()->get_all(
+			[
+				[
+					'Event_Question_Group.EVT_ID' => $reg->event_ID(),
+					'OR' => [
+						'Question.QST_system*blank' =>  '',
+						'Question.QST_system*null' => ['IS_NULL']
+					],
+					'Event_Question_Group.'
+					. EEM_Event_Question_Group::instance()->fieldNameForContext(
+						$reg->is_primary_registrant()
+					) => true
+				],
+				'order_by' => ['QSG_order' => 'ASC']
+			]
+		);
+		// get each question groups questions
+		foreach ($question_groups as $question_group) {
+			if ($question_group instanceof EE_Question_Group) {
+				$this->_subsections[ $question_group->ID() ] = $this->build_subform_from_question_group(
+					$question_group,
+					$reg
+				);
+			}
+		}
+	}
 
 
 
-    /**
-     *
-     * @param EE_Question_Group $question_group
-     * @param EE_Registration   $registration
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    public function build_subform_from_question_group($question_group, $registration)
-    {
-        if (! $question_group instanceof EE_Question_Group ||
-            ! $registration instanceof EE_Registration) {
-            throw new EE_Error(__('A valid question group and registration must be passed to EE_Registration_Custom_Question_Form', 'event_espresso'));
-        }
-        $parts_of_subsection = array(
-            'title' => new EE_Form_Section_HTML(
-                EEH_HTML::h5(
-                    $question_group->name(),
-                    $question_group->identifier(),
-                    'espresso-question-group-title-h5 section-title'
-                )
-            )
-        );
-        $questions = $question_group->questions(
-            array(
-                array(
-                    'OR' => array(
-                        'QST_system*blank' => '',
-                        'QST_system*null' => array( 'IS_NULL' )
-                    )
-                )
-            )
-        );
-        foreach ($questions as $question) {
-            $parts_of_subsection[ $question->ID() ] = $question->generate_form_input($registration);
-        }
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_registration',
-            'edit-reg-questions-mbox',
-            $this->_registration->ID()
-        )) {
-            $parts_of_subsection['edit_link'] = new EE_Form_Section_HTML(
-                '<tr><th/><td class="reg-admin-edit-attendee-question-td"><a class="reg-admin-edit-attendee-question-lnk" href="#" aria-label="' . esc_attr__('click to edit question', 'event_espresso') . '">
+	/**
+	 *
+	 * @param EE_Question_Group $question_group
+	 * @param EE_Registration   $registration
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	public function build_subform_from_question_group($question_group, $registration)
+	{
+		if (! $question_group instanceof EE_Question_Group ||
+			! $registration instanceof EE_Registration) {
+			throw new EE_Error(__('A valid question group and registration must be passed to EE_Registration_Custom_Question_Form', 'event_espresso'));
+		}
+		$parts_of_subsection = array(
+			'title' => new EE_Form_Section_HTML(
+				EEH_HTML::h5(
+					$question_group->name(),
+					$question_group->identifier(),
+					'espresso-question-group-title-h5 section-title'
+				)
+			)
+		);
+		$questions = $question_group->questions(
+			array(
+				array(
+					'OR' => array(
+						'QST_system*blank' => '',
+						'QST_system*null' => array( 'IS_NULL' )
+					)
+				)
+			)
+		);
+		foreach ($questions as $question) {
+			$parts_of_subsection[ $question->ID() ] = $question->generate_form_input($registration);
+		}
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_registration',
+			'edit-reg-questions-mbox',
+			$this->_registration->ID()
+		)) {
+			$parts_of_subsection['edit_link'] = new EE_Form_Section_HTML(
+				'<tr><th/><td class="reg-admin-edit-attendee-question-td"><a class="reg-admin-edit-attendee-question-lnk" href="#" aria-label="' . esc_attr__('click to edit question', 'event_espresso') . '">
 		  			<span class="reg-admin-edit-question-group-spn">' . __('edit the above question group', 'event_espresso') . '</span>
 		  			<div class="dashicons dashicons-edit"></div>
 		  		</a></td></tr>'
-            );
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'subsections' => $parts_of_subsection,
-                'html_class' => 'question-group-questions',
-            )
-        );
-    }
+			);
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'subsections' => $parts_of_subsection,
+				'html_class' => 'question-group-questions',
+			)
+		);
+	}
 
-    /**
-     * Overrides parent so if inputs were disabled, we leave those with their defaults
-     * from the answers in the DB
-     * @param array $req_data like $_POST
-     * @return void
-     */
-    protected function _normalize($req_data)
-    {
-        $this->_received_submission = true;
-        $this->_validation_errors = array();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            if ($subsection->form_data_present_in($req_data)) {
-                try {
-                    $subsection->_normalize($req_data);
-                } catch (EE_Validation_Error $e) {
-                    $subsection->add_validation_error($e);
-                }
-            }
-        }
-    }
+	/**
+	 * Overrides parent so if inputs were disabled, we leave those with their defaults
+	 * from the answers in the DB
+	 * @param array $req_data like $_POST
+	 * @return void
+	 */
+	protected function _normalize($req_data)
+	{
+		$this->_received_submission = true;
+		$this->_validation_errors = array();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			if ($subsection->form_data_present_in($req_data)) {
+				try {
+					$subsection->_normalize($req_data);
+				} catch (EE_Validation_Error $e) {
+					$subsection->add_validation_error($e);
+				}
+			}
+		}
+	}
 
 
 
-    /**
-     * Performs validation on this form section and its subsections. For each subsection,
-     * calls _validate_{subsection_name} on THIS form (if the function exists) and passes it the subsection, then calls _validate on that subsection.
-     * If you need to perform validation on the form as a whole (considering multiple) you would be best to override this _validate method,
-     * calling parent::_validate() first.
-     */
-    protected function _validate()
-    {
-        foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
-            if ($subsection->form_data_present_in(array_merge($_GET, $_POST))) {
-                if (method_exists($this, '_validate_'.$subsection_name)) {
-                    call_user_func_array(array($this,'_validate_'.$subsection_name), array($subsection));
-                }
-                $subsection->_validate();
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                $subsection->_received_submission = true;
-            }
-        }
-    }
+	/**
+	 * Performs validation on this form section and its subsections. For each subsection,
+	 * calls _validate_{subsection_name} on THIS form (if the function exists) and passes it the subsection, then calls _validate on that subsection.
+	 * If you need to perform validation on the form as a whole (considering multiple) you would be best to override this _validate method,
+	 * calling parent::_validate() first.
+	 */
+	protected function _validate()
+	{
+		foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
+			if ($subsection->form_data_present_in(array_merge($_GET, $_POST))) {
+				if (method_exists($this, '_validate_'.$subsection_name)) {
+					call_user_func_array(array($this,'_validate_'.$subsection_name), array($subsection));
+				}
+				$subsection->_validate();
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				$subsection->_received_submission = true;
+			}
+		}
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -32,10 +32,10 @@ 
     public function __construct(EE_Registration $reg, $options = array())
     {
         $this->_registration = $reg;
-        if (! isset($options['layout_strategy'])) {
+        if ( ! isset($options['layout_strategy'])) {
             $options['layout_strategy'] = new EE_Admin_Two_Column_Layout();
         }
-        if (! isset($options['html_id'])) {
+        if ( ! isset($options['html_id'])) {
             $options['html_id'] = 'reg-admin-attendee-questions-frm';
         }
         $this->build_form_from_registration();
@@ -63,7 +63,7 @@ 
     public function build_form_from_registration()
     {
         $reg = $this->get_registration();
-        if (! $reg instanceof EE_Registration) {
+        if ( ! $reg instanceof EE_Registration) {
             throw new EE_Error(__('We cannot build the registration custom questions form because there is no registration set on it yet', 'event_espresso'));
         }
         // we want to get all their question groups
@@ -86,7 +86,7 @@ 
         // get each question groups questions
         foreach ($question_groups as $question_group) {
             if ($question_group instanceof EE_Question_Group) {
-                $this->_subsections[ $question_group->ID() ] = $this->build_subform_from_question_group(
+                $this->_subsections[$question_group->ID()] = $this->build_subform_from_question_group(
                     $question_group,
                     $reg
                 );
@@ -105,7 +105,7 @@ 
      */
     public function build_subform_from_question_group($question_group, $registration)
     {
-        if (! $question_group instanceof EE_Question_Group ||
+        if ( ! $question_group instanceof EE_Question_Group ||
             ! $registration instanceof EE_Registration) {
             throw new EE_Error(__('A valid question group and registration must be passed to EE_Registration_Custom_Question_Form', 'event_espresso'));
         }
@@ -123,13 +123,13 @@ 
                 array(
                     'OR' => array(
                         'QST_system*blank' => '',
-                        'QST_system*null' => array( 'IS_NULL' )
+                        'QST_system*null' => array('IS_NULL')
                     )
                 )
             )
         );
         foreach ($questions as $question) {
-            $parts_of_subsection[ $question->ID() ] = $question->generate_form_input($registration);
+            $parts_of_subsection[$question->ID()] = $question->generate_form_input($registration);
         }
         if (EE_Registry::instance()->CAP->current_user_can(
             'ee_edit_registration',
@@ -137,8 +137,8 @@ 
             $this->_registration->ID()
         )) {
             $parts_of_subsection['edit_link'] = new EE_Form_Section_HTML(
-                '<tr><th/><td class="reg-admin-edit-attendee-question-td"><a class="reg-admin-edit-attendee-question-lnk" href="#" aria-label="' . esc_attr__('click to edit question', 'event_espresso') . '">
-		  			<span class="reg-admin-edit-question-group-spn">' . __('edit the above question group', 'event_espresso') . '</span>
+                '<tr><th/><td class="reg-admin-edit-attendee-question-td"><a class="reg-admin-edit-attendee-question-lnk" href="#" aria-label="'.esc_attr__('click to edit question', 'event_espresso').'">
+		  			<span class="reg-admin-edit-question-group-spn">' . __('edit the above question group', 'event_espresso').'</span>
 		  			<div class="dashicons dashicons-edit"></div>
 		  		</a></td></tr>'
             );
@@ -185,7 +185,7 @@ 
         foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
             if ($subsection->form_data_present_in(array_merge($_GET, $_POST))) {
                 if (method_exists($this, '_validate_'.$subsection_name)) {
-                    call_user_func_array(array($this,'_validate_'.$subsection_name), array($subsection));
+                    call_user_func_array(array($this, '_validate_'.$subsection_name), array($subsection));
                 }
                 $subsection->_validate();
             } elseif ($subsection instanceof EE_Form_Section_Proper) {

core/data_migration_scripts/4_10_0_stages/EE_DMS_4_10_0_Event_Question_Group.dmsstage.php

Indentation +110 added lines, -110 removed lines

@@ -14,118 +14,118 @@
 
 
 
-    /**
-     * Just initializes the status of the migration
-     */
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __('Event-Question Group Relations', 'event_espresso');
-        $this->_old_table = $wpdb->prefix.'esp_event_question_group';
-        $this->_extra_where_sql = "WHERE EQG_primary = 0 AND EQG_additional=0";
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 */
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __('Event-Question Group Relations', 'event_espresso');
+		$this->_old_table = $wpdb->prefix.'esp_event_question_group';
+		$this->_extra_where_sql = "WHERE EQG_primary = 0 AND EQG_additional=0";
+		parent::__construct();
+	}
 
 
-    /**
-     * Removes the duplicate event_question_group rows that only had EQG_primary=0. Now we just have one row
-     * joining event-to-question-groups with two columns: EQG_primary and EQG_additional, indicating which question
-     * groups apply to which category of registrant.
-     * @param array $event_question_group an associative array where keys are column names and values are their values.
-     * @return null
-     */
-    protected function _migrate_old_row($event_question_group)
-    {
-        if (isset($event_question_group['EVT_ID'], $event_question_group['QSG_ID'])) {
-            global $wpdb;
-            // If the question group was also for primary attendees, we should just update that row.
-            // And we delete this row.
-            $success = $wpdb->update(
-                $this->_old_table,
-                ['EQG_additional' => true],  // data
-                [
-                    'EQG_primary' => true,
-                    'EVT_ID' => $event_question_group['EVT_ID'],
-                    'QSG_ID' => $event_question_group['QSG_ID']
-                ],  // where
-                array( '%d' ),   // data format
-                array( '%d', '%d', '%d' )  // where format
-            );
-            if ($success) {
-                // Ok it's confirmed: the question group WAS for the primary attendee group too. So
-                // now we just need to delete this row.
-                $successful_delete = $wpdb->delete(
-                    $this->_old_table,
-                    [
-                        'EQG_ID' => $event_question_group['EQG_ID']
-                    ],
-                    ['%d']
-                );
-                if (! $successful_delete) {
-                    $this->add_error(
-                        sprintf(
-                            __('Could not delete old event-question group relation row "%1$s" because "%2$s"', 'event_espresso'),
-                            wp_json_encode($event_question_group),
-                            $wpdb->last_error
-                        )
-                    );
-                }
-            } else {
-                // Oh, the question group actually was NOT for the primary attendee. So we just need to update this row
-                $wpdb->update(
-                    $this->_old_table,
-                    ['EQG_additional' => true],  // data
-                    [
-                        'EVT_ID' => $event_question_group['EVT_ID'],
-                        'QSG_ID' => $event_question_group['QSG_ID']
-                    ],  // where
-                    array( '%d' ),   // data format
-                    array( '%d', '%d', '%d' )  // where format
-                );
-            }
-        }
-    }
+	/**
+	 * Removes the duplicate event_question_group rows that only had EQG_primary=0. Now we just have one row
+	 * joining event-to-question-groups with two columns: EQG_primary and EQG_additional, indicating which question
+	 * groups apply to which category of registrant.
+	 * @param array $event_question_group an associative array where keys are column names and values are their values.
+	 * @return null
+	 */
+	protected function _migrate_old_row($event_question_group)
+	{
+		if (isset($event_question_group['EVT_ID'], $event_question_group['QSG_ID'])) {
+			global $wpdb;
+			// If the question group was also for primary attendees, we should just update that row.
+			// And we delete this row.
+			$success = $wpdb->update(
+				$this->_old_table,
+				['EQG_additional' => true],  // data
+				[
+					'EQG_primary' => true,
+					'EVT_ID' => $event_question_group['EVT_ID'],
+					'QSG_ID' => $event_question_group['QSG_ID']
+				],  // where
+				array( '%d' ),   // data format
+				array( '%d', '%d', '%d' )  // where format
+			);
+			if ($success) {
+				// Ok it's confirmed: the question group WAS for the primary attendee group too. So
+				// now we just need to delete this row.
+				$successful_delete = $wpdb->delete(
+					$this->_old_table,
+					[
+						'EQG_ID' => $event_question_group['EQG_ID']
+					],
+					['%d']
+				);
+				if (! $successful_delete) {
+					$this->add_error(
+						sprintf(
+							__('Could not delete old event-question group relation row "%1$s" because "%2$s"', 'event_espresso'),
+							wp_json_encode($event_question_group),
+							$wpdb->last_error
+						)
+					);
+				}
+			} else {
+				// Oh, the question group actually was NOT for the primary attendee. So we just need to update this row
+				$wpdb->update(
+					$this->_old_table,
+					['EQG_additional' => true],  // data
+					[
+						'EVT_ID' => $event_question_group['EVT_ID'],
+						'QSG_ID' => $event_question_group['QSG_ID']
+					],  // where
+					array( '%d' ),   // data format
+					array( '%d', '%d', '%d' )  // where format
+				);
+			}
+		}
+	}
 
-    /**
-     * Gets the rows for the existing table that shouldn't exist in 4.10.
-     * Specifically the rows where EQG_primary=false and EQG_additional=false.
-     * Gotcha: because the migration is REMOVING rows as it goes, we shouldn't use the offset.
-     *
-     * @global wpdb $wpdb
-     * @param int   $limit
-     * @return array of arrays like $wpdb->get_results($sql, ARRAY_A)
-     */
-    protected function _get_rows($limit)
-    {
-        global $wpdb;
-        $query = "SELECT * FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare(
-            "LIMIT %d",
-            $limit
-        );
-        return $wpdb->get_results($query, ARRAY_A);
-    }
+	/**
+	 * Gets the rows for the existing table that shouldn't exist in 4.10.
+	 * Specifically the rows where EQG_primary=false and EQG_additional=false.
+	 * Gotcha: because the migration is REMOVING rows as it goes, we shouldn't use the offset.
+	 *
+	 * @global wpdb $wpdb
+	 * @param int   $limit
+	 * @return array of arrays like $wpdb->get_results($sql, ARRAY_A)
+	 */
+	protected function _get_rows($limit)
+	{
+		global $wpdb;
+		$query = "SELECT * FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare(
+			"LIMIT %d",
+			$limit
+		);
+		return $wpdb->get_results($query, ARRAY_A);
+	}
 
-    /**
-     * Slight departure from the normal procedure here: because this removes rows from the DB, we need to ensure
-     * we count the records first, then do the migration.
-     *
-     * @param int $num_items
-     * @return int number of items ACTUALLY migrated
-     */
-    public function _migration_step($num_items = 50)
-    {
-        // Count the items right away. This migration step will be removing those rows, so we need to count them
-        // right away to get an accurate count.
-        $this->count_records_to_migrate();
-        $rows = $this->_get_rows($num_items);
-        $items_actually_migrated = 0;
-        foreach ($rows as $old_row) {
-            $this->_migrate_old_row($old_row);
-            $items_actually_migrated++;
-        }
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
+	/**
+	 * Slight departure from the normal procedure here: because this removes rows from the DB, we need to ensure
+	 * we count the records first, then do the migration.
+	 *
+	 * @param int $num_items
+	 * @return int number of items ACTUALLY migrated
+	 */
+	public function _migration_step($num_items = 50)
+	{
+		// Count the items right away. This migration step will be removing those rows, so we need to count them
+		// right away to get an accurate count.
+		$this->count_records_to_migrate();
+		$rows = $this->_get_rows($num_items);
+		$items_actually_migrated = 0;
+		foreach ($rows as $old_row) {
+			$this->_migrate_old_row($old_row);
+			$items_actually_migrated++;
+		}
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -42,14 +42,14 @@ 
             // And we delete this row.
             $success = $wpdb->update(
                 $this->_old_table,
-                ['EQG_additional' => true],  // data
+                ['EQG_additional' => true], // data
                 [
                     'EQG_primary' => true,
                     'EVT_ID' => $event_question_group['EVT_ID'],
                     'QSG_ID' => $event_question_group['QSG_ID']
-                ],  // where
-                array( '%d' ),   // data format
-                array( '%d', '%d', '%d' )  // where format
+                ], // where
+                array('%d'), // data format
+                array('%d', '%d', '%d')  // where format
             );
             if ($success) {
                 // Ok it's confirmed: the question group WAS for the primary attendee group too. So
@@ -61,7 +61,7 @@ 
                     ],
                     ['%d']
                 );
-                if (! $successful_delete) {
+                if ( ! $successful_delete) {
                     $this->add_error(
                         sprintf(
                             __('Could not delete old event-question group relation row "%1$s" because "%2$s"', 'event_espresso'),
@@ -74,13 +74,13 @@ 
                 // Oh, the question group actually was NOT for the primary attendee. So we just need to update this row
                 $wpdb->update(
                     $this->_old_table,
-                    ['EQG_additional' => true],  // data
+                    ['EQG_additional' => true], // data
                     [
                         'EVT_ID' => $event_question_group['EVT_ID'],
                         'QSG_ID' => $event_question_group['QSG_ID']
-                    ],  // where
-                    array( '%d' ),   // data format
-                    array( '%d', '%d', '%d' )  // where format
+                    ], // where
+                    array('%d'), // data format
+                    array('%d', '%d', '%d')  // where format
                 );
             }
         }
@@ -98,7 +98,7 @@ 
     protected function _get_rows($limit)
     {
         global $wpdb;
-        $query = "SELECT * FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare(
+        $query = "SELECT * FROM {$this->_old_table} {$this->_extra_where_sql} ".$wpdb->prepare(
             "LIMIT %d",
             $limit
         );

core/data_migration_scripts/EE_DMS_Core_4_10_0.dms.php

Indentation +186 added lines, -186 removed lines

@@ -15,9 +15,9 @@ 
 $stages = glob(EE_CORE . 'data_migration_scripts/4_10_0_stages/*');
 $class_to_filepath = [];
 foreach ($stages as $filepath) {
-    $matches = [];
-    preg_match('~4_10_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[ $matches[1] ] = $filepath;
+	$matches = [];
+	preg_match('~4_10_0_stages/(.*).dmsstage.php~', $filepath, $matches);
+	$class_to_filepath[ $matches[1] ] = $filepath;
 }
 // give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_4_10_0__autoloaded_stages', $class_to_filepath);
@@ -35,67 +35,67 @@ 
  */
 class EE_DMS_Core_4_10_0 extends EE_Data_Migration_Script_Base
 {
-    /**
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(
-        TableManager $table_manager = null,
-        TableAnalysis $table_analysis = null,
-        EE_DMS_Core_4_9_0 $dms_4_9
-    ) {
-        $this->previous_dms = $dms_4_9;
-        $this->_pretty_name = esc_html__("Data Update to Event Espresso 4.10.0", "event_espresso");
-        $this->_priority = 10;
-        $this->_migration_stages = array(
-            new EE_DMS_4_10_0_Event_Question_Group(),
-        );
-        parent::__construct($table_manager, $table_analysis);
-    }
+	/**
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(
+		TableManager $table_manager = null,
+		TableAnalysis $table_analysis = null,
+		EE_DMS_Core_4_9_0 $dms_4_9
+	) {
+		$this->previous_dms = $dms_4_9;
+		$this->_pretty_name = esc_html__("Data Update to Event Espresso 4.10.0", "event_espresso");
+		$this->_priority = 10;
+		$this->_migration_stages = array(
+			new EE_DMS_4_10_0_Event_Question_Group(),
+		);
+		parent::__construct($table_manager, $table_analysis);
+	}
 
 
 
-    /**
-     * Whether to migrate or not.
-     *
-     * @param array $version_array
-     * @return bool
-     */
-    public function can_migrate_from_version($version_array)
-    {
-        $version_string = $version_array['Core'];
-        if (version_compare($version_string, '4.10.0.rc.000', '<') && version_compare($version_string, '4.9.0', '>=')) {
-            //          echo "$version_string can be migrated from";
-            return true;
-        } elseif (! $version_string) {
-            //          echo "no version string provided: $version_string";
-            // no version string provided... this must be pre 4.3
-            return false;// changed mind. dont want people thinking they should migrate yet because they cant
-        }
-        return false;
-    }
+	/**
+	 * Whether to migrate or not.
+	 *
+	 * @param array $version_array
+	 * @return bool
+	 */
+	public function can_migrate_from_version($version_array)
+	{
+		$version_string = $version_array['Core'];
+		if (version_compare($version_string, '4.10.0.rc.000', '<') && version_compare($version_string, '4.9.0', '>=')) {
+			//          echo "$version_string can be migrated from";
+			return true;
+		} elseif (! $version_string) {
+			//          echo "no version string provided: $version_string";
+			// no version string provided... this must be pre 4.3
+			return false;// changed mind. dont want people thinking they should migrate yet because they cant
+		}
+		return false;
+	}
 
 
 
-    /**
-     * @return bool
-     */
-    public function schema_changes_before_migration()
-    {
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
-        $now_in_mysql = current_time('mysql', true);
-        $table_name = 'esp_answer';
-        $sql = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+	/**
+	 * @return bool
+	 */
+	public function schema_changes_before_migration()
+	{
+		require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+		$now_in_mysql = current_time('mysql', true);
+		$table_name = 'esp_answer';
+		$sql = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					REG_ID int(10) unsigned NOT NULL,
 					QST_ID int(10) unsigned NOT NULL,
 					ANS_value text NOT NULL,
 					PRIMARY KEY  (ANS_ID),
 					KEY REG_ID (REG_ID),
 					KEY QST_ID (QST_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_attendee_meta';
-        $sql = "ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_attendee_meta';
+		$sql = "ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				ATT_ID bigint(20) unsigned NOT NULL,
 				ATT_fname varchar(45) NOT NULL,
 				ATT_lname varchar(45) NOT NULL,
@@ -112,9 +112,9 @@ 
 				KEY ATT_email (ATT_email(191)),
 				KEY ATT_lname (ATT_lname),
 				KEY ATT_fname (ATT_fname)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_checkin';
-        $sql = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_checkin';
+		$sql = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				REG_ID int(10) unsigned NOT NULL,
 				DTT_ID int(10) unsigned NOT NULL,
 				CHK_in tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -122,9 +122,9 @@ 
 				PRIMARY KEY  (CHK_ID),
 				KEY REG_ID (REG_ID),
 				KEY DTT_ID (DTT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_country';
-        $sql = "CNT_ISO varchar(2) NOT NULL,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_country';
+		$sql = "CNT_ISO varchar(2) NOT NULL,
 				CNT_ISO3 varchar(3) NOT NULL,
 				RGN_ID tinyint(3) unsigned DEFAULT NULL,
 				CNT_name varchar(45) NOT NULL,
@@ -140,29 +140,29 @@ 
 				CNT_is_EU tinyint(1) DEFAULT '0',
 				CNT_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_currency';
-        $sql = "CUR_code varchar(6) NOT NULL,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_currency';
+		$sql = "CUR_code varchar(6) NOT NULL,
 				CUR_single varchar(45) DEFAULT 'dollar',
 				CUR_plural varchar(45) DEFAULT 'dollars',
 				CUR_sign varchar(45) DEFAULT '$',
 				CUR_dec_plc varchar(1) NOT NULL DEFAULT '2',
 				CUR_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CUR_code)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        // note: although this table is no longer in use,
-        // it hasn't been removed because then queries to the model will have errors.
-        // but you should expect this table and its corresponding model to be removed in
-        // the next few months
-        $table_name = 'esp_currency_payment_method';
-        $sql = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		// note: although this table is no longer in use,
+		// it hasn't been removed because then queries to the model will have errors.
+		// but you should expect this table and its corresponding model to be removed in
+		// the next few months
+		$table_name = 'esp_currency_payment_method';
+		$sql = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
 				CUR_code varchar(6) NOT NULL,
 				PMD_ID int(11) NOT NULL,
 				PRIMARY KEY  (CPM_ID),
 				KEY PMD_ID (PMD_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_datetime';
-        $sql = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_datetime';
+		$sql = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				DTT_name varchar(255) NOT NULL DEFAULT '',
 				DTT_description text NOT NULL,
@@ -179,25 +179,25 @@ 
 				KEY DTT_EVT_start (DTT_EVT_start),
 				KEY EVT_ID (EVT_ID),
 				KEY DTT_is_primary (DTT_is_primary)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_datetime_ticket";
-        $sql = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_datetime_ticket";
+		$sql = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				DTT_ID int(10) unsigned NOT NULL,
 				TKT_ID int(10) unsigned NOT NULL,
 				PRIMARY KEY  (DTK_ID),
 				KEY DTT_ID (DTT_ID),
 				KEY TKT_ID (TKT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_message_template';
-        $sql = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_message_template';
+		$sql = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 				GRP_ID int(10) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EMT_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY GRP_ID (GRP_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_meta';
-        $sql = "EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_meta';
+		$sql = "EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				EVT_display_desc tinyint(1) unsigned NOT NULL DEFAULT 1,
 				EVT_display_ticket_selector tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -212,9 +212,9 @@ 
 				EVT_donations tinyint(1) NULL,
 				PRIMARY KEY  (EVTM_ID),
 				KEY EVT_ID (EVT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_question_group';
-        $sql = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_question_group';
+		$sql = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				QSG_ID int(10) unsigned NOT NULL,
 				EQG_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
@@ -222,25 +222,25 @@ 
 				PRIMARY KEY  (EQG_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY QSG_ID (QSG_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_venue';
-        $sql = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_venue';
+		$sql = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				VNU_ID bigint(20) unsigned NOT NULL,
 				EVV_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EVV_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_meta';
-        $sql = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_meta';
+		$sql = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
 				OBJ_ID int(11) DEFAULT NULL,
 				EXM_type varchar(45) DEFAULT NULL,
 				EXM_key varchar(45) DEFAULT NULL,
 				EXM_value text,
 				PRIMARY KEY  (EXM_ID),
 				KEY EXM_type (EXM_type,OBJ_ID,EXM_key)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_join';
-        $sql = "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_join';
+		$sql = "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
 				EXJ_first_model_id varchar(6) NOT NULL,
 				EXJ_first_model_name varchar(20) NOT NULL,
 				EXJ_second_model_id varchar(6) NOT NULL,
@@ -248,9 +248,9 @@ 
 				PRIMARY KEY  (EXJ_ID),
 				KEY first_model (EXJ_first_model_name,EXJ_first_model_id),
 				KEY second_model (EXJ_second_model_name,EXJ_second_model_id)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_line_item';
-        $sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_line_item';
+		$sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
 				LIN_code varchar(245) NOT NULL DEFAULT '',
 				TXN_ID int(11) DEFAULT NULL,
 				LIN_name varchar(245) NOT NULL DEFAULT '',
@@ -271,9 +271,9 @@ 
 				KEY txn_type_timestamp (TXN_ID,LIN_type,LIN_timestamp),
 				KEY txn_obj_id_obj_type (TXN_ID,OBJ_ID,OBJ_type),
 				KEY obj_id_obj_type (OBJ_ID,OBJ_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_log';
-        $sql = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_log';
+		$sql = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
 				LOG_time datetime DEFAULT NULL,
 				OBJ_ID varchar(45) DEFAULT NULL,
 				OBJ_type varchar(45) DEFAULT NULL,
@@ -284,9 +284,9 @@ 
 				KEY LOG_time (LOG_time),
 				KEY OBJ (OBJ_type,OBJ_ID),
 				KEY LOG_type (LOG_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message';
-        $sql = "MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message';
+		$sql = "MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 				GRP_ID int(10) unsigned NULL,
 				MSG_token varchar(255) NULL,
 				TXN_ID int(10) unsigned NULL,
@@ -318,18 +318,18 @@ 
 				KEY STS_ID (STS_ID),
 				KEY MSG_created (MSG_created),
 				KEY MSG_modified (MSG_modified)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template';
-        $sql = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template';
+		$sql = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				GRP_ID int(10) unsigned NOT NULL,
 				MTP_context varchar(50) NOT NULL,
 				MTP_template_field varchar(30) NOT NULL,
 				MTP_content text NOT NULL,
 				PRIMARY KEY  (MTP_ID),
 				KEY GRP_ID (GRP_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template_group';
-        $sql = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template_group';
+		$sql = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				MTP_user_id int(10) NOT NULL DEFAULT '1',
 				MTP_name varchar(245) NOT NULL DEFAULT '',
 				MTP_description varchar(245) NOT NULL DEFAULT '',
@@ -341,9 +341,9 @@ 
 				MTP_is_active tinyint(1) NOT NULL DEFAULT '1',
 				PRIMARY KEY  (GRP_ID),
 				KEY MTP_user_id (MTP_user_id)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_payment';
-        $sql = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_payment';
+		$sql = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_ID int(10) unsigned DEFAULT NULL,
 				STS_ID varchar(3) DEFAULT NULL,
 				PAY_timestamp datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
@@ -360,9 +360,9 @@ 
 				PRIMARY KEY  (PAY_ID),
 				KEY PAY_timestamp (PAY_timestamp),
 				KEY TXN_ID (TXN_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_payment_method';
-        $sql = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_payment_method';
+		$sql = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
 				PMD_type varchar(124) DEFAULT NULL,
 				PMD_name varchar(255) DEFAULT NULL,
 				PMD_desc text,
@@ -378,24 +378,24 @@ 
 				PRIMARY KEY  (PMD_ID),
 				UNIQUE KEY PMD_slug_UNIQUE (PMD_slug),
 				KEY PMD_type (PMD_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket_price";
-        $sql = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket_price";
+		$sql = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TKT_ID int(10) unsigned NOT NULL,
 				PRC_ID int(10) unsigned NOT NULL,
 				PRIMARY KEY  (TKP_ID),
 				KEY TKT_ID (TKT_ID),
 				KEY PRC_ID (PRC_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_ticket_template";
-        $sql = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_ticket_template";
+		$sql = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TTM_name varchar(45) NOT NULL,
 				TTM_description text,
 				TTM_file varchar(45),
 				PRIMARY KEY  (TTM_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question';
-        $sql = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question';
+		$sql = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QST_display_text text NOT NULL,
 				QST_admin_label varchar(255) NOT NULL,
 				QST_system varchar(25) DEFAULT NULL,
@@ -409,18 +409,18 @@ 
 				QST_deleted tinyint(2) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QST_ID),
 				KEY QST_order (QST_order)';
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group_question';
-        $sql = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group_question';
+		$sql = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSG_ID int(10) unsigned NOT NULL,
 				QST_ID int(10) unsigned NOT NULL,
 				QGQ_order int(10) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QGQ_ID),
 				KEY QST_ID (QST_ID),
 				KEY QSG_ID_order (QSG_ID,QGQ_order)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_option';
-        $sql = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_option';
+		$sql = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSO_value varchar(255) NOT NULL,
 				QSO_desc text NOT NULL,
 				QST_ID int(10) unsigned NOT NULL,
@@ -430,9 +430,9 @@ 
 				PRIMARY KEY  (QSO_ID),
 				KEY QST_ID (QST_ID),
 				KEY QSO_order (QSO_order)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_registration';
-        $sql = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_registration';
+		$sql = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				ATT_ID bigint(20) unsigned NOT NULL,
 				TXN_ID int(10) unsigned NOT NULL,
@@ -456,18 +456,18 @@ 
 				KEY TKT_ID (TKT_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY STS_ID (STS_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_registration_payment';
-        $sql = "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_registration_payment';
+		$sql = "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  REG_ID int(10) unsigned NOT NULL,
 					  PAY_ID int(10) unsigned NULL,
 					  RPY_amount decimal(12,3) NOT NULL DEFAULT '0.00',
 					  PRIMARY KEY  (RPY_ID),
 					  KEY REG_ID (REG_ID),
 					  KEY PAY_ID (PAY_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_state';
-        $sql = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_state';
+		$sql = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
 				CNT_ISO varchar(2) NOT NULL,
 				STA_abbrev varchar(24) NOT NULL,
 				STA_name varchar(100) NOT NULL,
@@ -475,9 +475,9 @@ 
 				PRIMARY KEY  (STA_ID),
 				KEY STA_abbrev (STA_abbrev),
 				KEY CNT_ISO (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_status';
-        $sql = "STS_ID varchar(3) NOT NULL,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_status';
+		$sql = "STS_ID varchar(3) NOT NULL,
 				STS_code varchar(45) NOT NULL,
 				STS_type varchar(45) NOT NULL,
 				STS_can_edit tinyint(1) NOT NULL DEFAULT 0,
@@ -485,9 +485,9 @@ 
 				STS_open tinyint(1) NOT NULL DEFAULT 1,
 				UNIQUE KEY STS_ID_UNIQUE (STS_ID),
 				KEY STS_type (STS_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_transaction';
-        $sql = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_transaction';
+		$sql = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_timestamp datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
 				TXN_total decimal(12,3) DEFAULT '0.00',
 				TXN_paid decimal(12,3) NOT NULL DEFAULT '0.00',
@@ -499,9 +499,9 @@ 
 				PRIMARY KEY  (TXN_ID),
 				KEY TXN_timestamp (TXN_timestamp),
 				KEY STS_ID (STS_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_venue_meta';
-        $sql = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_venue_meta';
+		$sql = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
 			VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 			VNU_address varchar(255) DEFAULT NULL,
 			VNU_address2 varchar(255) DEFAULT NULL,
@@ -520,10 +520,10 @@ 
 			KEY VNU_ID (VNU_ID),
 			KEY STA_ID (STA_ID),
 			KEY CNT_ISO (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        // modified tables
-        $table_name = "esp_price";
-        $sql = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		// modified tables
+		$table_name = "esp_price";
+		$sql = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				PRT_ID tinyint(3) unsigned NOT NULL,
 				PRC_amount decimal(12,3) NOT NULL DEFAULT '0.00',
 				PRC_name varchar(245) NOT NULL,
@@ -536,9 +536,9 @@ 
 				PRC_parent int(10) unsigned DEFAULT 0,
 				PRIMARY KEY  (PRC_ID),
 				KEY PRT_ID (PRT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_price_type";
-        $sql = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_price_type";
+		$sql = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
 				PRT_name varchar(45) NOT NULL,
 				PBT_ID tinyint(3) unsigned NOT NULL DEFAULT '1',
 				PRT_is_percent tinyint(1) NOT NULL DEFAULT '0',
@@ -547,9 +547,9 @@ 
 				PRT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				UNIQUE KEY PRT_name_UNIQUE (PRT_name),
 				PRIMARY KEY  (PRT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket";
-        $sql = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket";
+		$sql = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TTM_ID int(10) unsigned NOT NULL,
 				TKT_name varchar(245) NOT NULL DEFAULT '',
 				TKT_description text NOT NULL,
@@ -572,9 +572,9 @@ 
 				TKT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				PRIMARY KEY  (TKT_ID),
 				KEY TKT_start_date (TKT_start_date)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group';
-        $sql = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group';
+		$sql = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSG_name varchar(255) NOT NULL,
 				QSG_identifier varchar(100) NOT NULL,
 				QSG_desc text NULL,
@@ -587,38 +587,38 @@ 
 				PRIMARY KEY  (QSG_ID),
 				UNIQUE KEY QSG_identifier_UNIQUE (QSG_identifier),
 				KEY QSG_order (QSG_order)';
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $this->insert_default_data();
-        return true;
-    }
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$this->insert_default_data();
+		return true;
+	}
 
-    /**
-     * Inserts default data on new installs
-     * @since $VID:$
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function insert_default_data()
-    {
-        $this->previous_dms->insert_default_data();
-    }
+	/**
+	 * Inserts default data on new installs
+	 * @since $VID:$
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function insert_default_data()
+	{
+		$this->previous_dms->insert_default_data();
+	}
 
 
 
-    /**
-     * @return boolean
-     */
-    public function schema_changes_after_migration()
-    {
-        return true;
-    }
+	/**
+	 * @return boolean
+	 */
+	public function schema_changes_after_migration()
+	{
+		return true;
+	}
 
 
 
-    public function migration_page_hooks()
-    {
-    }
+	public function migration_page_hooks()
+	{
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -12,12 +12,12 @@ 
 // unfortunately, this needs to be done upon INCLUSION of this file,
 // instead of construction, because it only gets constructed on first page load
 // (all other times it gets resurrected from a wordpress option)
-$stages = glob(EE_CORE . 'data_migration_scripts/4_10_0_stages/*');
+$stages = glob(EE_CORE.'data_migration_scripts/4_10_0_stages/*');
 $class_to_filepath = [];
 foreach ($stages as $filepath) {
     $matches = [];
     preg_match('~4_10_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[ $matches[1] ] = $filepath;
+    $class_to_filepath[$matches[1]] = $filepath;
 }
 // give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_4_10_0__autoloaded_stages', $class_to_filepath);
@@ -68,10 +68,10 @@ 
         if (version_compare($version_string, '4.10.0.rc.000', '<') && version_compare($version_string, '4.9.0', '>=')) {
             //          echo "$version_string can be migrated from";
             return true;
-        } elseif (! $version_string) {
+        } elseif ( ! $version_string) {
             //          echo "no version string provided: $version_string";
             // no version string provided... this must be pre 4.3
-            return false;// changed mind. dont want people thinking they should migrate yet because they cant
+            return false; // changed mind. dont want people thinking they should migrate yet because they cant
         }
         return false;
     }
@@ -83,7 +83,7 @@ 
      */
     public function schema_changes_before_migration()
     {
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+        require_once(EE_HELPERS.'EEH_Activation.helper.php');
         $now_in_mysql = current_time('mysql', true);
         $table_name = 'esp_answer';
         $sql = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,