eventespresso / event-espresso-core

caffeinated/admin/extend/messages/Custom_Messages_Template_List_Table.class.php

Spacing +11 added lines, -11 removed lines

@@ -98,7 +98,7 @@ 
      */
     public function column_name($item)
     {
-        return '<p>' . $item->name() . '</p>';
+        return '<p>'.$item->name().'</p>';
     }
 
 
@@ -136,7 +136,7 @@ 
     protected function _add_view_counts()
     {
         foreach ($this->_views as $view => $args) {
-            $this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
+            $this->_views[$view]['count'] = $this->get_admin_page()->get_message_templates(
                 $this->_per_page,
                 $view,
                 true,
@@ -199,10 +199,10 @@ 
             )
         ) {
             $actions['trash'] = '
-                <a href="' . $trash_lnk_url . '" 
-                   aria-label="' . esc_attr__('Move Template Group to Trash', 'event_espresso') . '"
+                <a href="' . $trash_lnk_url.'" 
+                   aria-label="' . esc_attr__('Move Template Group to Trash', 'event_espresso').'"
                 >
-                    ' . esc_html__('Move to Trash', 'event_espresso') . '
+                    ' . esc_html__('Move to Trash', 'event_espresso').'
                 </a>';
         } else {
             if (
@@ -213,10 +213,10 @@ 
                 )
             ) {
                 $actions['restore'] = '
-                    <a href="' . $restore_lnk_url . '" 
-                       aria-label="' . esc_attr__('Restore Message Template', 'event_espresso') . '"
+                    <a href="' . $restore_lnk_url.'" 
+                       aria-label="' . esc_attr__('Restore Message Template', 'event_espresso').'"
                     >
-                        ' . esc_html__('Restore', 'event_espresso') . '
+                        ' . esc_html__('Restore', 'event_espresso').'
                     </a>';
             }
 
@@ -229,10 +229,10 @@ 
                 )
             ) {
                 $actions['delete'] = '
-                    <a href="' . $delete_lnk_url . '" 
-                       aria-label="' . esc_attr__('Delete Template Group Permanently', 'event_espresso') . '"
+                    <a href="' . $delete_lnk_url.'" 
+                       aria-label="' . esc_attr__('Delete Template Group Permanently', 'event_espresso').'"
                     >
-                        ' . esc_html__('Delete Permanently', 'event_espresso') . '
+                        ' . esc_html__('Delete Permanently', 'event_espresso').'
                     </a>';
             }
         }

Indentation +215 added lines, -215 removed lines

@@ -11,257 +11,257 @@
  */
 class Custom_Messages_Template_List_Table extends Messages_Template_List_Table
 {
-    /**
-     * Setup initial data.
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->get_admin_page()->get_message_templates(
-            $this->_per_page,
-            $this->_view,
-            false,
-            false,
-            false
-        );
-        $this->_all_data_count = $this->get_admin_page()->get_message_templates(
-            $this->_per_page,
-            $this->_view,
-            true,
-            true,
-            false
-        );
-    }
+	/**
+	 * Setup initial data.
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->get_admin_page()->get_message_templates(
+			$this->_per_page,
+			$this->_view,
+			false,
+			false,
+			false
+		);
+		$this->_all_data_count = $this->get_admin_page()->get_message_templates(
+			$this->_per_page,
+			$this->_view,
+			true,
+			true,
+			false
+		);
+	}
 
 
-    /**
-     * Set initial properties
-     */
-    protected function _set_properties()
-    {
-        parent::_set_properties();
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('Message Template Group', 'event_espresso'),
-            'plural'   => esc_html__('Message Template', 'event_espresso'),
-            'ajax'     => true, // for now,
-            'screen'   => $this->get_admin_page()->get_current_screen()->id,
-        );
+	/**
+	 * Set initial properties
+	 */
+	protected function _set_properties()
+	{
+		parent::_set_properties();
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('Message Template Group', 'event_espresso'),
+			'plural'   => esc_html__('Message Template', 'event_espresso'),
+			'ajax'     => true, // for now,
+			'screen'   => $this->get_admin_page()->get_current_screen()->id,
+		);
 
-        $this->_columns = array_merge(
-            array(
-                'cb'   => '<input type="checkbox" />',
-                'name' => esc_html__('Template Name', 'event_espresso'),
-            ),
-            $this->_columns,
-            array(
-                'events'  => esc_html__('Events', 'event_espresso'),
-                'actions' => '',
-            )
-        );
-    }
+		$this->_columns = array_merge(
+			array(
+				'cb'   => '<input type="checkbox" />',
+				'name' => esc_html__('Template Name', 'event_espresso'),
+			),
+			$this->_columns,
+			array(
+				'events'  => esc_html__('Events', 'event_espresso'),
+				'actions' => '',
+			)
+		);
+	}
 
 
-    /**
-     * Custom message for when there are no items found.
-     *
-     * @since 4.3.0
-     */
-    public function no_items()
-    {
-        if ($this->_view !== 'trashed') {
-            printf(
-                esc_html__(
-                    '%sNo Custom Templates found.%s To create your first custom message template, go to the "Default Message Templates" tab and click the "Create Custom" button next to the template you want to use as a base for the new one.',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>'
-            );
-        } else {
-            parent::no_items();
-        }
-    }
+	/**
+	 * Custom message for when there are no items found.
+	 *
+	 * @since 4.3.0
+	 */
+	public function no_items()
+	{
+		if ($this->_view !== 'trashed') {
+			printf(
+				esc_html__(
+					'%sNo Custom Templates found.%s To create your first custom message template, go to the "Default Message Templates" tab and click the "Create Custom" button next to the template you want to use as a base for the new one.',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>'
+			);
+		} else {
+			parent::no_items();
+		}
+	}
 
 
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_cb($item)
-    {
-        return sprintf('<input type="checkbox" name="checkbox[%s]" value="1" />', $item->GRP_ID());
-    }
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_cb($item)
+	{
+		return sprintf('<input type="checkbox" name="checkbox[%s]" value="1" />', $item->GRP_ID());
+	}
 
 
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_name($item)
-    {
-        return '<p>' . $item->name() . '</p>';
-    }
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_name($item)
+	{
+		return '<p>' . $item->name() . '</p>';
+	}
 
 
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_actions($item)
-    {
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_messages',
-                'espresso_messages_add_new_message_template'
-            )
-        ) {
-            $create_args = array(
-                'GRP_ID'       => $item->ID(),
-                'messenger'    => $item->messenger(),
-                'message_type' => $item->message_type(),
-                'action'       => 'add_new_message_template',
-            );
-            $create_link = EE_Admin_Page::add_query_args_and_nonce($create_args, EE_MSG_ADMIN_URL);
-            return sprintf(
-                '<p><a href="%s" class="button button--secondary">%s</a></p>',
-                $create_link,
-                esc_html__('Create Custom', 'event_espresso')
-            );
-        }
-        return '';
-    }
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_actions($item)
+	{
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_messages',
+				'espresso_messages_add_new_message_template'
+			)
+		) {
+			$create_args = array(
+				'GRP_ID'       => $item->ID(),
+				'messenger'    => $item->messenger(),
+				'message_type' => $item->message_type(),
+				'action'       => 'add_new_message_template',
+			);
+			$create_link = EE_Admin_Page::add_query_args_and_nonce($create_args, EE_MSG_ADMIN_URL);
+			return sprintf(
+				'<p><a href="%s" class="button button--secondary">%s</a></p>',
+				$create_link,
+				esc_html__('Create Custom', 'event_espresso')
+			);
+		}
+		return '';
+	}
 
-    /**
-     * Set the view counts on the _views property
-     */
-    protected function _add_view_counts()
-    {
-        foreach ($this->_views as $view => $args) {
-            $this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
-                $this->_per_page,
-                $view,
-                true,
-                true,
-                false
-            );
-        }
-    }
+	/**
+	 * Set the view counts on the _views property
+	 */
+	protected function _add_view_counts()
+	{
+		foreach ($this->_views as $view => $args) {
+			$this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
+				$this->_per_page,
+				$view,
+				true,
+				true,
+				false
+			);
+		}
+	}
 
 
-    /**
-     * column_events
-     * This provides a count of events using this custom template
-     *
-     * @param  EE_Message_Template_Group $item message_template group data
-     * @return string column output
-     */
-    public function column_events($item)
-    {
-        return $item->count_events();
-    }
+	/**
+	 * column_events
+	 * This provides a count of events using this custom template
+	 *
+	 * @param  EE_Message_Template_Group $item message_template group data
+	 * @return string column output
+	 */
+	public function column_events($item)
+	{
+		return $item->count_events();
+	}
 
 
-    /**
-     * Add additional actions for custom message template list view.
-     *
-     * @param EE_Message_Template_Group $item
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_actions_for_messenger_column(EE_Message_Template_Group $item)
-    {
-        $actions = parent::_get_actions_for_messenger_column($item);
+	/**
+	 * Add additional actions for custom message template list view.
+	 *
+	 * @param EE_Message_Template_Group $item
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_actions_for_messenger_column(EE_Message_Template_Group $item)
+	{
+		$actions = parent::_get_actions_for_messenger_column($item);
 
-        // add additional actions for trash/restore etc.
-        $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action'   => 'trash_message_template',
-            'id'       => $item->GRP_ID(),
-            'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
-        // restore link
-        $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action'   => 'restore_message_template',
-            'id'       => $item->GRP_ID(),
-            'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
-        // delete price link
-        $delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action'   => 'delete_message_template',
-            'id'       => $item->GRP_ID(),
-            'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
+		// add additional actions for trash/restore etc.
+		$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action'   => 'trash_message_template',
+			'id'       => $item->GRP_ID(),
+			'noheader' => true,
+		), EE_MSG_ADMIN_URL);
+		// restore link
+		$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action'   => 'restore_message_template',
+			'id'       => $item->GRP_ID(),
+			'noheader' => true,
+		), EE_MSG_ADMIN_URL);
+		// delete price link
+		$delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action'   => 'delete_message_template',
+			'id'       => $item->GRP_ID(),
+			'noheader' => true,
+		), EE_MSG_ADMIN_URL);
 
-        if (
-            ! $item->get('MTP_deleted')
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_message',
-                'espresso_messages_trash_message_template',
-                $item->ID()
-            )
-        ) {
-            $actions['trash'] = '
+		if (
+			! $item->get('MTP_deleted')
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_message',
+				'espresso_messages_trash_message_template',
+				$item->ID()
+			)
+		) {
+			$actions['trash'] = '
                 <a href="' . $trash_lnk_url . '" 
                    aria-label="' . esc_attr__('Move Template Group to Trash', 'event_espresso') . '"
                 >
                     ' . esc_html__('Move to Trash', 'event_espresso') . '
                 </a>';
-        } else {
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_message',
-                    'espresso_messages_restore_message_template',
-                    $item->ID()
-                )
-            ) {
-                $actions['restore'] = '
+		} else {
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_message',
+					'espresso_messages_restore_message_template',
+					$item->ID()
+				)
+			) {
+				$actions['restore'] = '
                     <a href="' . $restore_lnk_url . '" 
                        aria-label="' . esc_attr__('Restore Message Template', 'event_espresso') . '"
                     >
                         ' . esc_html__('Restore', 'event_espresso') . '
                     </a>';
-            }
+			}
 
-            if (
-                $this->_view === 'trashed'
-                && EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_message',
-                    'espresso_messages_delete_message_template',
-                    $item->ID()
-                )
-            ) {
-                $actions['delete'] = '
+			if (
+				$this->_view === 'trashed'
+				&& EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_message',
+					'espresso_messages_delete_message_template',
+					$item->ID()
+				)
+			) {
+				$actions['delete'] = '
                     <a href="' . $delete_lnk_url . '" 
                        aria-label="' . esc_attr__('Delete Template Group Permanently', 'event_espresso') . '"
                     >
                         ' . esc_html__('Delete Permanently', 'event_espresso') . '
                     </a>';
-            }
-        }
-        return $actions;
-    }
+			}
+		}
+		return $actions;
+	}
 
 
-    /**
-     * Generate dropdown filter select input for messengers
-     *
-     * @param bool $global
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_messengers_dropdown_filter($global = true)
-    {
-        return parent::_get_messengers_dropdown_filter(false);
-    }
+	/**
+	 * Generate dropdown filter select input for messengers
+	 *
+	 * @param bool $global
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_messengers_dropdown_filter($global = true)
+	{
+		return parent::_get_messengers_dropdown_filter(false);
+	}
 
 
-    /**
-     * Generate dropdown filter select input for message types
-     *
-     * @param bool $global
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_message_types_dropdown_filter($global = true)
-    {
-        return parent::_get_message_types_dropdown_filter(false);
-    }
+	/**
+	 * Generate dropdown filter select input for message types
+	 *
+	 * @param bool $global
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_message_types_dropdown_filter($global = true)
+	{
+		return parent::_get_message_types_dropdown_filter(false);
+	}
 }

core/domain/services/commands/registration/CreateRegistrationCommand.php

Indentation +154 added lines, -154 removed lines

@@ -26,158 +26,158 @@
  */
 class CreateRegistrationCommand extends Command implements CommandRequiresCapCheckInterface
 {
-    /**
-     * @var EE_Transaction $transaction
-     */
-    private $transaction;
-
-    /**
-     * @var EE_Ticket $ticket
-     */
-    private $ticket;
-
-    /**
-     * @var EE_Line_Item $ticket_line_item
-     */
-    private $ticket_line_item;
-
-    /**
-     * @var int $reg_count
-     */
-    private $reg_count;
-
-    /**
-     * @var int $reg_group_size
-     */
-    private $reg_group_size;
-
-    /**
-     * @var string $reg_status
-     */
-    private $reg_status;
-
-    /**
-     * @var EE_Registration $registration
-     */
-    protected $registration;
-
-
-    /**
-     * CreateRegistrationCommand constructor.
-     *
-     * @param EE_Transaction $transaction
-     * @param EE_Line_Item   $ticket_line_item
-     * @param int            $reg_count
-     * @param int            $reg_group_size
-     * @param string         $reg_status
-     * @param EE_Ticket|null $ticket
-     * @throws InvalidEntityException
-     * @throws EE_Error
-     */
-    public function __construct(
-        EE_Transaction $transaction,
-        EE_Line_Item $ticket_line_item,
-        $reg_count = 1,
-        $reg_group_size = 0,
-        $reg_status = EEM_Registration::status_id_incomplete,
-        EE_Ticket $ticket = null
-    ) {
-        defined('EVENT_ESPRESSO_VERSION') || exit;
-        $this->transaction      = $transaction;
-        $this->ticket_line_item = $ticket_line_item;
-        $this->reg_count        = absint($reg_count);
-        $this->reg_group_size   = absint($reg_group_size);
-        $this->reg_status       = $reg_status;
-        // grab the related ticket object for this line_item if one wasn't already supplied
-        $this->ticket = $ticket instanceof EE_Ticket ? $ticket : $this->ticket_line_item->ticket();
-        if (! $this->ticket instanceof EE_Ticket) {
-            throw new InvalidEntityException(
-                is_object($this->ticket) ? get_class($this->ticket) : gettype($this->ticket),
-                'EE_Ticket',
-                sprintf(
-                    esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'),
-                    $ticket_line_item->ID()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return CapCheckInterface
-     * @throws InvalidDataTypeException
-     */
-    public function getCapCheck()
-    {
-        if (! $this->cap_check instanceof CapCheckInterface) {
-            // need cap for non-AJAX admin requests
-            $this->cap_check = ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()
-                ? new CapCheck('ee_edit_registrations', 'create_new_registration')
-                : new PublicCapabilities('', 'create_new_registration');
-        }
-        return $this->cap_check;
-    }
-
-
-    /**
-     * @return EE_Transaction
-     */
-    public function transaction()
-    {
-        return $this->transaction;
-    }
-
-
-    /**
-     * @return EE_Ticket
-     */
-    public function ticket()
-    {
-        return $this->ticket;
-    }
-
-
-    /**
-     * @return EE_Line_Item
-     */
-    public function ticketLineItem()
-    {
-        return $this->ticket_line_item;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function regCount()
-    {
-        return $this->reg_count;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function regGroupSize()
-    {
-        return $this->reg_group_size;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function regStatus()
-    {
-        return $this->reg_status;
-    }
-
-
-    /**
-     * @return EE_Registration
-     */
-    public function registration()
-    {
-        return $this->registration;
-    }
+	/**
+	 * @var EE_Transaction $transaction
+	 */
+	private $transaction;
+
+	/**
+	 * @var EE_Ticket $ticket
+	 */
+	private $ticket;
+
+	/**
+	 * @var EE_Line_Item $ticket_line_item
+	 */
+	private $ticket_line_item;
+
+	/**
+	 * @var int $reg_count
+	 */
+	private $reg_count;
+
+	/**
+	 * @var int $reg_group_size
+	 */
+	private $reg_group_size;
+
+	/**
+	 * @var string $reg_status
+	 */
+	private $reg_status;
+
+	/**
+	 * @var EE_Registration $registration
+	 */
+	protected $registration;
+
+
+	/**
+	 * CreateRegistrationCommand constructor.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param EE_Line_Item   $ticket_line_item
+	 * @param int            $reg_count
+	 * @param int            $reg_group_size
+	 * @param string         $reg_status
+	 * @param EE_Ticket|null $ticket
+	 * @throws InvalidEntityException
+	 * @throws EE_Error
+	 */
+	public function __construct(
+		EE_Transaction $transaction,
+		EE_Line_Item $ticket_line_item,
+		$reg_count = 1,
+		$reg_group_size = 0,
+		$reg_status = EEM_Registration::status_id_incomplete,
+		EE_Ticket $ticket = null
+	) {
+		defined('EVENT_ESPRESSO_VERSION') || exit;
+		$this->transaction      = $transaction;
+		$this->ticket_line_item = $ticket_line_item;
+		$this->reg_count        = absint($reg_count);
+		$this->reg_group_size   = absint($reg_group_size);
+		$this->reg_status       = $reg_status;
+		// grab the related ticket object for this line_item if one wasn't already supplied
+		$this->ticket = $ticket instanceof EE_Ticket ? $ticket : $this->ticket_line_item->ticket();
+		if (! $this->ticket instanceof EE_Ticket) {
+			throw new InvalidEntityException(
+				is_object($this->ticket) ? get_class($this->ticket) : gettype($this->ticket),
+				'EE_Ticket',
+				sprintf(
+					esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'),
+					$ticket_line_item->ID()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return CapCheckInterface
+	 * @throws InvalidDataTypeException
+	 */
+	public function getCapCheck()
+	{
+		if (! $this->cap_check instanceof CapCheckInterface) {
+			// need cap for non-AJAX admin requests
+			$this->cap_check = ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()
+				? new CapCheck('ee_edit_registrations', 'create_new_registration')
+				: new PublicCapabilities('', 'create_new_registration');
+		}
+		return $this->cap_check;
+	}
+
+
+	/**
+	 * @return EE_Transaction
+	 */
+	public function transaction()
+	{
+		return $this->transaction;
+	}
+
+
+	/**
+	 * @return EE_Ticket
+	 */
+	public function ticket()
+	{
+		return $this->ticket;
+	}
+
+
+	/**
+	 * @return EE_Line_Item
+	 */
+	public function ticketLineItem()
+	{
+		return $this->ticket_line_item;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function regCount()
+	{
+		return $this->reg_count;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function regGroupSize()
+	{
+		return $this->reg_group_size;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function regStatus()
+	{
+		return $this->reg_status;
+	}
+
+
+	/**
+	 * @return EE_Registration
+	 */
+	public function registration()
+	{
+		return $this->registration;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -90,7 +90,7 @@ 
         $this->reg_status       = $reg_status;
         // grab the related ticket object for this line_item if one wasn't already supplied
         $this->ticket = $ticket instanceof EE_Ticket ? $ticket : $this->ticket_line_item->ticket();
-        if (! $this->ticket instanceof EE_Ticket) {
+        if ( ! $this->ticket instanceof EE_Ticket) {
             throw new InvalidEntityException(
                 is_object($this->ticket) ? get_class($this->ticket) : gettype($this->ticket),
                 'EE_Ticket',
@@ -109,7 +109,7 @@ 
      */
     public function getCapCheck()
     {
-        if (! $this->cap_check instanceof CapCheckInterface) {
+        if ( ! $this->cap_check instanceof CapCheckInterface) {
             // need cap for non-AJAX admin requests
             $this->cap_check = ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()
                 ? new CapCheck('ee_edit_registrations', 'create_new_registration')

core/db_classes/EE_Venue.class.php

Indentation +562 added lines, -562 removed lines

@@ -9,566 +9,566 @@
  */
 class EE_Venue extends EE_CPT_Base implements EEI_Address
 {
-    /**
-     *
-     * @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_Attendee
-     */
-    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_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->get('VNU_name');
-    }
-
-
-    /**
-     * Gets phone
-     *
-     * @return string
-     */
-    public function phone()
-    {
-        return $this->get('VNU_phone');
-    }
-
-
-    /**
-     * venue_url
-     *
-     * @return string
-     */
-    public function venue_url()
-    {
-        return $this->get('VNU_url');
-    }
-
-
-    /**
-     * Gets desc
-     *
-     * @return string
-     */
-    public function description()
-    {
-        return $this->get('VNU_desc');
-    }
-
-
-    /**
-     * Gets short description (AKA: the excerpt)
-     *
-     * @return string
-     */
-    public function excerpt()
-    {
-        return $this->get('VNU_short_desc');
-    }
-
-
-    /**
-     * Gets identifier
-     *
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->get('VNU_identifier');
-    }
-
-
-    /**
-     * Gets address
-     *
-     * @return string
-     */
-    public function address()
-    {
-        return $this->get('VNU_address');
-    }
-
-
-    /**
-     * Gets address2
-     *
-     * @return string
-     */
-    public function address2()
-    {
-        return $this->get('VNU_address2');
-    }
-
-
-    /**
-     * Gets city
-     *
-     * @return string
-     */
-    public function city()
-    {
-        return $this->get('VNU_city');
-    }
-
-    /**
-     * Gets state
-     *
-     * @return int
-     */
-    public function state_ID()
-    {
-        return $this->get('STA_ID');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_abbrev()
-    {
-        return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_name()
-    {
-        return $this->state_obj() instanceof EE_State ? $this->state_obj()->name() : '';
-    }
-
-
-    /**
-     * Gets the state for this venue
-     *
-     * @return EE_State
-     */
-    public function state_obj()
-    {
-        return $this->get_first_related('State');
-    }
-
-
-    /**
-     * either displays the state abbreviation or the state name, as determined
-     * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     */
-    public function state()
-    {
-        if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
-            return $this->state_abbrev();
-        } else {
-            return $this->state_name();
-        }
-    }
-
-
-    /**
-     * country_ID
-     *
-     * @return string
-     */
-    public function country_ID()
-    {
-        return $this->get('CNT_ISO');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_name()
-    {
-        return $this->country_obj() instanceof EE_Country ? $this->country_obj()->name() : '';
-    }
-
-
-    /**
-     * Gets the country of this venue
-     *
-     * @return EE_Country
-     */
-    public function country_obj()
-    {
-        return $this->get_first_related('Country');
-    }
-
-
-    /**
-     * either displays the country ISO2 code or the country name, as determined
-     * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     */
-    public function country()
-    {
-        if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
-            return $this->country_ID();
-        } else {
-            return $this->country_name();
-        }
-    }
-
-
-    /**
-     * Gets zip
-     *
-     * @return string
-     */
-    public function zip()
-    {
-        return $this->get('VNU_zip');
-    }
-
-
-    /**
-     * Gets capacity
-     *
-     * @return int|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function capacity()
-    {
-        return $this->get_pretty('VNU_capacity', 'symbol');
-    }
-
-
-    /**
-     * Gets created
-     *
-     * @return string
-     */
-    public function created()
-    {
-        return $this->get('VNU_created');
-    }
-
-
-    /**
-     * Gets modified
-     *
-     * @return string
-     */
-    public function modified()
-    {
-        return $this->get('VNU_modified');
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     */
-    public function order()
-    {
-        return $this->get('VNU_order');
-    }
-
-
-    /**
-     * Gets wp_user
-     *
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('VNU_wp_user');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function virtual_phone()
-    {
-        return $this->get('VNU_virtual_phone');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function virtual_url()
-    {
-        return $this->get('VNU_virtual_url');
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function enable_for_gmap()
-    {
-        return $this->get('VNU_enable_for_gmap');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function google_map_link()
-    {
-        return $this->get('VNU_google_map_link');
-    }
-
-
-    /**
-     * Gets all events happening at this venue. Query parameters can be added to
-     * fetch a subset of those events.
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param bool  $upcoming
-     * @return EE_Event[]
-     */
-    public function events($query_params = array(), $upcoming = false)
-    {
-        if ($upcoming) {
-            $query_params = array(
-                array(
-                    'status'                 => 'publish',
-                    'Datetime.DTT_EVT_start' => array(
-                        '>',
-                        EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-                    ),
-                ),
-            );
-        }
-        return $this->get_many_related('Event', $query_params);
-    }
-
-
-    /**
-     * Sets address
-     */
-    public function set_address($address = '')
-    {
-        $this->set('VNU_address', $address);
-    }
-
-
-    /**
-     * @param string $address2
-     */
-    public function set_address2($address2 = '')
-    {
-        $this->set('VNU_address2', $address2);
-    }
-
-
-    /**
-     * @param string $city
-     */
-    public function set_city($city = '')
-    {
-        $this->set('VNU_city', $city);
-    }
-
-
-    /**
-     * @param int $state
-     */
-    public function set_state_ID($state = 0)
-    {
-        $this->set('STA_ID', $state);
-    }
-
-
-    /**
-     * Sets the state, given either a state id or state object
-     *
-     * @param EE_State /int $state_id_or_obj
-     * @return EE_State
-     */
-    public function set_state_obj($state_id_or_obj)
-    {
-        return $this->_add_relation_to($state_id_or_obj, 'State');
-    }
-
-
-    /**
-     * @param int $country_ID
-     */
-    public function set_country_ID($country_ID = 0)
-    {
-        $this->set('CNT_ISO', $country_ID);
-    }
-
-
-    /**
-     * Sets the country on the venue
-     *
-     * @param EE_Country /string $country_id_or_obj
-     * @return EE_Country
-     */
-    public function set_country_obj($country_id_or_obj)
-    {
-        return $this->_add_relation_to($country_id_or_obj, 'Country');
-    }
-
-
-    /**
-     * @param string $zip
-     */
-    public function set_zip($zip = '')
-    {
-        $this->set('VNU_zip', $zip);
-    }
-
-
-    /**
-     * @param int $capacity
-     */
-    public function set_capacity($capacity = 0)
-    {
-        $this->set('VNU_capacity', $capacity);
-    }
-
-
-    /**
-     * @param string $created
-     */
-    public function set_created($created = '')
-    {
-        $this->set('VNU_created', $created);
-    }
-
-
-    /**
-     * @param string $desc
-     */
-    public function set_description($desc = '')
-    {
-        $this->set('VNU_desc', $desc);
-    }
-
-
-    /**
-     * @param string $identifier
-     */
-    public function set_identifier($identifier = '')
-    {
-        $this->set('VNU_identifier', $identifier);
-    }
-
-
-    /**
-     * @param string $modified
-     */
-    public function set_modified($modified = '')
-    {
-        $this->set('VNU_modified', $modified);
-    }
-
-
-    /**
-     * @param string $name
-     */
-    public function set_name($name = '')
-    {
-        $this->set('VNU_name', $name);
-    }
-
-
-    /**
-     * @param int $order
-     */
-    public function set_order($order = 0)
-    {
-        $this->set('VNU_order', $order);
-    }
-
-
-    /**
-     * @param string $phone
-     */
-    public function set_phone($phone = '')
-    {
-        $this->set('VNU_phone', $phone);
-    }
-
-
-    /**
-     * @param int $wp_user
-     */
-    public function set_wp_user($wp_user = 1)
-    {
-        $this->set('VNU_wp_user', $wp_user);
-    }
-
-
-    /**
-     * @param string $url
-     */
-    public function set_venue_url($url = '')
-    {
-        $this->set('VNU_url', $url);
-    }
-
-
-    /**
-     * @param string $phone
-     */
-    public function set_virtual_phone($phone = '')
-    {
-        $this->set('VNU_virtual_phone', $phone);
-    }
-
-
-    /**
-     * @param string $url
-     */
-    public function set_virtual_url($url = '')
-    {
-        $this->set('VNU_virtual_url', $url);
-    }
-
-
-    /**
-     * @param string $enable
-     */
-    public function set_enable_for_gmap($enable = '')
-    {
-        $this->set('VNU_enable_for_gmap', $enable);
-    }
-
-
-    /**
-     * @param string $google_map_link
-     */
-    public function set_google_map_link($google_map_link = '')
-    {
-        $this->set('VNU_google_map_link', $google_map_link);
-    }
+	/**
+	 *
+	 * @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_Attendee
+	 */
+	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_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->get('VNU_name');
+	}
+
+
+	/**
+	 * Gets phone
+	 *
+	 * @return string
+	 */
+	public function phone()
+	{
+		return $this->get('VNU_phone');
+	}
+
+
+	/**
+	 * venue_url
+	 *
+	 * @return string
+	 */
+	public function venue_url()
+	{
+		return $this->get('VNU_url');
+	}
+
+
+	/**
+	 * Gets desc
+	 *
+	 * @return string
+	 */
+	public function description()
+	{
+		return $this->get('VNU_desc');
+	}
+
+
+	/**
+	 * Gets short description (AKA: the excerpt)
+	 *
+	 * @return string
+	 */
+	public function excerpt()
+	{
+		return $this->get('VNU_short_desc');
+	}
+
+
+	/**
+	 * Gets identifier
+	 *
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->get('VNU_identifier');
+	}
+
+
+	/**
+	 * Gets address
+	 *
+	 * @return string
+	 */
+	public function address()
+	{
+		return $this->get('VNU_address');
+	}
+
+
+	/**
+	 * Gets address2
+	 *
+	 * @return string
+	 */
+	public function address2()
+	{
+		return $this->get('VNU_address2');
+	}
+
+
+	/**
+	 * Gets city
+	 *
+	 * @return string
+	 */
+	public function city()
+	{
+		return $this->get('VNU_city');
+	}
+
+	/**
+	 * Gets state
+	 *
+	 * @return int
+	 */
+	public function state_ID()
+	{
+		return $this->get('STA_ID');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_abbrev()
+	{
+		return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_name()
+	{
+		return $this->state_obj() instanceof EE_State ? $this->state_obj()->name() : '';
+	}
+
+
+	/**
+	 * Gets the state for this venue
+	 *
+	 * @return EE_State
+	 */
+	public function state_obj()
+	{
+		return $this->get_first_related('State');
+	}
+
+
+	/**
+	 * either displays the state abbreviation or the state name, as determined
+	 * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 */
+	public function state()
+	{
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
+			return $this->state_abbrev();
+		} else {
+			return $this->state_name();
+		}
+	}
+
+
+	/**
+	 * country_ID
+	 *
+	 * @return string
+	 */
+	public function country_ID()
+	{
+		return $this->get('CNT_ISO');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_name()
+	{
+		return $this->country_obj() instanceof EE_Country ? $this->country_obj()->name() : '';
+	}
+
+
+	/**
+	 * Gets the country of this venue
+	 *
+	 * @return EE_Country
+	 */
+	public function country_obj()
+	{
+		return $this->get_first_related('Country');
+	}
+
+
+	/**
+	 * either displays the country ISO2 code or the country name, as determined
+	 * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 */
+	public function country()
+	{
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
+			return $this->country_ID();
+		} else {
+			return $this->country_name();
+		}
+	}
+
+
+	/**
+	 * Gets zip
+	 *
+	 * @return string
+	 */
+	public function zip()
+	{
+		return $this->get('VNU_zip');
+	}
+
+
+	/**
+	 * Gets capacity
+	 *
+	 * @return int|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function capacity()
+	{
+		return $this->get_pretty('VNU_capacity', 'symbol');
+	}
+
+
+	/**
+	 * Gets created
+	 *
+	 * @return string
+	 */
+	public function created()
+	{
+		return $this->get('VNU_created');
+	}
+
+
+	/**
+	 * Gets modified
+	 *
+	 * @return string
+	 */
+	public function modified()
+	{
+		return $this->get('VNU_modified');
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->get('VNU_order');
+	}
+
+
+	/**
+	 * Gets wp_user
+	 *
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('VNU_wp_user');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function virtual_phone()
+	{
+		return $this->get('VNU_virtual_phone');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function virtual_url()
+	{
+		return $this->get('VNU_virtual_url');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function enable_for_gmap()
+	{
+		return $this->get('VNU_enable_for_gmap');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function google_map_link()
+	{
+		return $this->get('VNU_google_map_link');
+	}
+
+
+	/**
+	 * Gets all events happening at this venue. Query parameters can be added to
+	 * fetch a subset of those events.
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param bool  $upcoming
+	 * @return EE_Event[]
+	 */
+	public function events($query_params = array(), $upcoming = false)
+	{
+		if ($upcoming) {
+			$query_params = array(
+				array(
+					'status'                 => 'publish',
+					'Datetime.DTT_EVT_start' => array(
+						'>',
+						EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+					),
+				),
+			);
+		}
+		return $this->get_many_related('Event', $query_params);
+	}
+
+
+	/**
+	 * Sets address
+	 */
+	public function set_address($address = '')
+	{
+		$this->set('VNU_address', $address);
+	}
+
+
+	/**
+	 * @param string $address2
+	 */
+	public function set_address2($address2 = '')
+	{
+		$this->set('VNU_address2', $address2);
+	}
+
+
+	/**
+	 * @param string $city
+	 */
+	public function set_city($city = '')
+	{
+		$this->set('VNU_city', $city);
+	}
+
+
+	/**
+	 * @param int $state
+	 */
+	public function set_state_ID($state = 0)
+	{
+		$this->set('STA_ID', $state);
+	}
+
+
+	/**
+	 * Sets the state, given either a state id or state object
+	 *
+	 * @param EE_State /int $state_id_or_obj
+	 * @return EE_State
+	 */
+	public function set_state_obj($state_id_or_obj)
+	{
+		return $this->_add_relation_to($state_id_or_obj, 'State');
+	}
+
+
+	/**
+	 * @param int $country_ID
+	 */
+	public function set_country_ID($country_ID = 0)
+	{
+		$this->set('CNT_ISO', $country_ID);
+	}
+
+
+	/**
+	 * Sets the country on the venue
+	 *
+	 * @param EE_Country /string $country_id_or_obj
+	 * @return EE_Country
+	 */
+	public function set_country_obj($country_id_or_obj)
+	{
+		return $this->_add_relation_to($country_id_or_obj, 'Country');
+	}
+
+
+	/**
+	 * @param string $zip
+	 */
+	public function set_zip($zip = '')
+	{
+		$this->set('VNU_zip', $zip);
+	}
+
+
+	/**
+	 * @param int $capacity
+	 */
+	public function set_capacity($capacity = 0)
+	{
+		$this->set('VNU_capacity', $capacity);
+	}
+
+
+	/**
+	 * @param string $created
+	 */
+	public function set_created($created = '')
+	{
+		$this->set('VNU_created', $created);
+	}
+
+
+	/**
+	 * @param string $desc
+	 */
+	public function set_description($desc = '')
+	{
+		$this->set('VNU_desc', $desc);
+	}
+
+
+	/**
+	 * @param string $identifier
+	 */
+	public function set_identifier($identifier = '')
+	{
+		$this->set('VNU_identifier', $identifier);
+	}
+
+
+	/**
+	 * @param string $modified
+	 */
+	public function set_modified($modified = '')
+	{
+		$this->set('VNU_modified', $modified);
+	}
+
+
+	/**
+	 * @param string $name
+	 */
+	public function set_name($name = '')
+	{
+		$this->set('VNU_name', $name);
+	}
+
+
+	/**
+	 * @param int $order
+	 */
+	public function set_order($order = 0)
+	{
+		$this->set('VNU_order', $order);
+	}
+
+
+	/**
+	 * @param string $phone
+	 */
+	public function set_phone($phone = '')
+	{
+		$this->set('VNU_phone', $phone);
+	}
+
+
+	/**
+	 * @param int $wp_user
+	 */
+	public function set_wp_user($wp_user = 1)
+	{
+		$this->set('VNU_wp_user', $wp_user);
+	}
+
+
+	/**
+	 * @param string $url
+	 */
+	public function set_venue_url($url = '')
+	{
+		$this->set('VNU_url', $url);
+	}
+
+
+	/**
+	 * @param string $phone
+	 */
+	public function set_virtual_phone($phone = '')
+	{
+		$this->set('VNU_virtual_phone', $phone);
+	}
+
+
+	/**
+	 * @param string $url
+	 */
+	public function set_virtual_url($url = '')
+	{
+		$this->set('VNU_virtual_url', $url);
+	}
+
+
+	/**
+	 * @param string $enable
+	 */
+	public function set_enable_for_gmap($enable = '')
+	{
+		$this->set('VNU_enable_for_gmap', $enable);
+	}
+
+
+	/**
+	 * @param string $google_map_link
+	 */
+	public function set_google_map_link($google_map_link = '')
+	{
+		$this->set('VNU_google_map_link', $google_map_link);
+	}
 }

core/db_models/EEM_CPT_Base.model.php

Indentation +560 added lines, -560 removed lines

@@ -14,564 +14,564 @@
  */
 abstract class EEM_CPT_Base extends EEM_Soft_Delete_Base
 {
-    const EVENT_CATEGORY_TAXONOMY = 'espresso_event_categories';
-
-    /**
-     * @var string post_status_publish - the wp post status for published cpts
-     */
-    const post_status_publish = 'publish';
-
-    /**
-     * @var string post_status_future - the wp post status for scheduled cpts
-     */
-    const post_status_future = 'future';
-
-    /**
-     * @var string post_status_draft - the wp post status for draft cpts
-     */
-    const post_status_draft = 'draft';
-
-    /**
-     * @var string post_status_pending - the wp post status for pending cpts
-     */
-    const post_status_pending = 'pending';
-
-    /**
-     * @var string post_status_private - the wp post status for private cpts
-     */
-    const post_status_private = 'private';
-
-    /**
-     * @var string post_status_trashed - the wp post status for trashed cpts
-     */
-    const post_status_trashed = 'trash';
-
-    /**
-     * This is an array of custom statuses for the given CPT model (modified by children)
-     * format:
-     * array(
-     *        'status_name' => array(
-     *            'label' => esc_html__('Status Name', 'event_espresso'),
-     *            'public' => TRUE //whether a public status or not.
-     *        )
-     * )
-     *
-     * @var array
-     */
-    protected $_custom_stati = array();
-
-
-    /**
-     * Adds a relationship to Term_Taxonomy for each CPT_Base
-     *
-     * @param string $timezone
-     * @throws \EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        // adds a relationship to Term_Taxonomy for all these models. For this to work
-        // Term_Relationship must have a relation to each model subclassing EE_CPT_Base explicitly
-        // eg, in EEM_Term_Relationship, inside the _model_relations array, there must be an entry
-        // with key equalling the subclassing model's model name (eg 'Event' or 'Venue'), and the value
-        // must also be new EE_HABTM_Relation('Term_Relationship');
-        $this->_model_relations['Term_Taxonomy'] = new EE_HABTM_Relation('Term_Relationship');
-        $primary_table_name = null;
-        // add  the common _status field to all CPT primary tables.
-        foreach ($this->_tables as $alias => $table_obj) {
-            if ($table_obj instanceof EE_Primary_Table) {
-                $primary_table_name = $alias;
-            }
-        }
-        // set default wp post statuses if child has not already set.
-        if (! isset($this->_fields[ $primary_table_name ]['status'])) {
-            $this->_fields[ $primary_table_name ]['status'] = new EE_WP_Post_Status_Field(
-                'post_status',
-                esc_html__("Event Status", "event_espresso"),
-                false,
-                'draft'
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['to_ping'])) {
-            $this->_fields[ $primary_table_name ]['to_ping'] = new EE_DB_Only_Text_Field(
-                'to_ping',
-                esc_html__('To Ping', 'event_espresso'),
-                false,
-                ''
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['pinged'])) {
-            $this->_fields[ $primary_table_name ]['pinged'] = new EE_DB_Only_Text_Field(
-                'pinged',
-                esc_html__('Pinged', 'event_espresso'),
-                false,
-                ''
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['comment_status'])) {
-            $this->_fields[ $primary_table_name ]['comment_status'] = new EE_Plain_Text_Field(
-                'comment_status',
-                esc_html__('Comment Status', 'event_espresso'),
-                false,
-                'open'
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['ping_status'])) {
-            $this->_fields[ $primary_table_name ]['ping_status'] = new EE_Plain_Text_Field(
-                'ping_status',
-                esc_html__('Ping Status', 'event_espresso'),
-                false,
-                'open'
-            );
-        }
-        if (! isset($this->_fields[ $primary_table_name ]['post_content_filtered'])) {
-            $this->_fields[ $primary_table_name ]['post_content_filtered'] = new EE_DB_Only_Text_Field(
-                'post_content_filtered',
-                esc_html__('Post Content Filtered', 'event_espresso'),
-                false,
-                ''
-            );
-        }
-        if (! isset($this->_model_relations['Post_Meta'])) {
-            // don't block deletes though because we want to maintain the current behaviour
-            $this->_model_relations['Post_Meta'] = new EE_Has_Many_Relation(false);
-        }
-        if (! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            // nothing was set during child constructor, so set default
-            $this->_minimum_where_conditions_strategy = new EE_CPT_Minimum_Where_Conditions($this->post_type());
-        }
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            // nothing was set during child constructor, so set default
-            // it's ok for child classes to specify this, but generally this is more DRY
-            $this->_default_where_conditions_strategy = new EE_CPT_Where_Conditions($this->post_type());
-        }
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function public_event_stati()
-    {
-        // @see wp-includes/post.php
-        return get_post_stati(array('public' => true));
-    }
-
-
-    /**
-     * Searches for field on this model of type 'deleted_flag'. if it is found,
-     * returns it's name. BUT That doesn't apply to CPTs. We should instead use post_status_field_name
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function deleted_field_name()
-    {
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    '%1$s should not call deleted_field_name()! It should instead use post_status_field_name',
-                    "event_espresso"
-                ),
-                get_called_class()
-            )
-        );
-    }
-
-
-    /**
-     * Gets the field's name that sets the post status
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function post_status_field_name()
-    {
-        $field = $this->get_a_field_of_type('EE_WP_Post_Status_Field');
-        if ($field) {
-            return $field->get_name();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'We are trying to find the post status flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
-                        'event_espresso'
-                    ),
-                    get_called_class(),
-                    get_called_class()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function _alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        $post_status_field_name = $this->post_status_field_name();
-        $query_params[0][ $post_status_field_name ] = self::post_status_trashed;
-        return $query_params;
-    }
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
-    {
-        $query_params['default_where_conditions'] = 'minimum';
-        return $query_params;
-    }
-
-
-    /**
-     * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
-     *
-     * @param boolean $delete       true to indicate deletion, false to indicate restoration
-     * @param array $query_params
-     * @return boolean success
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function delete_or_restore($delete = true, $query_params = array())
-    {
-        $post_status_field_name = $this->post_status_field_name();
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        $new_status = $delete ? self::post_status_trashed : 'draft';
-        return (bool) $this->update([$post_status_field_name => $new_status], $query_params);
-    }
-
-
-    /**
-     * meta_table
-     * returns first EE_Secondary_Table table name
-     *
-     * @access public
-     * @return string
-     */
-    public function meta_table()
-    {
-        $meta_table = $this->_get_other_tables();
-        $meta_table = reset($meta_table);
-        return $meta_table instanceof EE_Secondary_Table ? $meta_table->get_table_name() : null;
-    }
-
-
-    /**
-     * This simply returns an array of the meta table fields (useful for when we just need to update those fields)
-     *
-     * @param  bool $all triggers whether we include DB_Only fields or JUST non DB_Only fields.  Defaults to false (no
-     *                   db only fields)
-     * @return array
-     */
-    public function get_meta_table_fields($all = false)
-    {
-        $all_fields = $fields_to_return = array();
-        foreach ($this->_tables as $alias => $table_obj) {
-            if ($table_obj instanceof EE_Secondary_Table) {
-                $all_fields = array_merge($this->_get_fields_for_table($alias), $all_fields);
-            }
-        }
-        if (! $all) {
-            foreach ($all_fields as $name => $obj) {
-                if ($obj instanceof EE_DB_Only_Field_Base) {
-                    continue;
-                }
-                $fields_to_return[] = $name;
-            }
-        } else {
-            $fields_to_return = array_keys($all_fields);
-        }
-        return $fields_to_return;
-    }
-
-
-    /**
-     * Adds an event category with the specified name and description to the specified
-     * $cpt_model_object. Intelligently adds a term if necessary, and adds a term_taxonomy if necessary,
-     * and adds an entry in the term_relationship if necessary.
-     *
-     * @param EE_CPT_Base $cpt_model_object
-     * @param string      $category_name (used to derive the term slug too)
-     * @param string      $category_description
-     * @param int         $parent_term_taxonomy_id
-     * @return EE_Term_Taxonomy
-     */
-    public function add_event_category(
-        EE_CPT_Base $cpt_model_object,
-        $category_name,
-        $category_description = '',
-        $parent_term_taxonomy_id = null
-    ) {
-        // create term
-        require_once(EE_MODELS . 'EEM_Term.model.php');
-        // first, check for a term by the same name or slug
-        $category_slug = sanitize_title($category_name);
-        $term = EEM_Term::instance()->get_one(
-            array(
-                array(
-                    'OR' => array(
-                        'name' => $category_name,
-                        'slug' => $category_slug,
-                    ),
-                    'Term_Taxonomy.taxonomy' => self::EVENT_CATEGORY_TAXONOMY
-                ),
-            )
-        );
-        if (! $term) {
-            $term = EE_Term::new_instance(
-                array(
-                    'name' => $category_name,
-                    'slug' => $category_slug,
-                )
-            );
-            $term->save();
-        }
-        // make sure there's a term-taxonomy entry too
-        require_once(EE_MODELS . 'EEM_Term_Taxonomy.model.php');
-        $term_taxonomy = EEM_Term_Taxonomy::instance()->get_one(
-            array(
-                array(
-                    'term_id'  => $term->ID(),
-                    'taxonomy' => self::EVENT_CATEGORY_TAXONOMY,
-                ),
-            )
-        );
-        /** @var $term_taxonomy EE_Term_Taxonomy */
-        if (! $term_taxonomy) {
-            $term_taxonomy = EE_Term_Taxonomy::new_instance(
-                array(
-                    'term_id'     => $term->ID(),
-                    'taxonomy'    => self::EVENT_CATEGORY_TAXONOMY,
-                    'description' => $category_description,
-                    'term_count'       => 1,
-                    'parent'      => $parent_term_taxonomy_id,
-                )
-            );
-            $term_taxonomy->save();
-        } else {
-            $term_taxonomy->set_count($term_taxonomy->count() + 1);
-            $term_taxonomy->save();
-        }
-        return $this->add_relationship_to($cpt_model_object, $term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * Removed the category specified by name as having a relation to this event.
-     * Does not remove the term or term_taxonomy.
-     *
-     * @param EE_CPT_Base $cpt_model_object_event
-     * @param string      $category_name name of the event category (term)
-     * @return bool
-     */
-    public function remove_event_category(EE_CPT_Base $cpt_model_object_event, $category_name)
-    {
-        // find the term_taxonomy by that name
-        $term_taxonomy = $this->get_first_related(
-            $cpt_model_object_event,
-            'Term_Taxonomy',
-            array(array('Term.name' => $category_name, 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY))
-        );
-        /** @var $term_taxonomy EE_Term_Taxonomy */
-        if ($term_taxonomy) {
-            $term_taxonomy->set_count($term_taxonomy->count() - 1);
-            $term_taxonomy->save();
-        }
-        return $this->remove_relationship_to($cpt_model_object_event, $term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * This is a wrapper for the WordPress get_the_post_thumbnail() function that returns the feature image for the
-     * given CPT ID.  It accepts the same params as what get_the_post_thumbnail() accepts.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
-     * @access public
-     * @param int          $id   the ID for the cpt we want the feature image for
-     * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
-     *                           representing width and height in pixels (i.e. array(32,32) ).
-     * @param string|array $attr Optional. Query string or array of attributes.
-     * @return string HTML image element
-     */
-    public function get_feature_image($id, $size = 'thumbnail', $attr = '')
-    {
-        return get_the_post_thumbnail($id, $size, $attr);
-    }
-
-
-    /**
-     * Just a handy way to get the list of post statuses currently registered with WP.
-     *
-     * @global array $wp_post_statuses set in wp core for storing all the post stati
-     * @return array
-     */
-    public function get_post_statuses()
-    {
-        global $wp_post_statuses;
-        $statuses = array();
-        foreach ($wp_post_statuses as $post_status => $args_object) {
-            $statuses[ $post_status ] = $args_object->label;
-        }
-        return $statuses;
-    }
-
-
-    /**
-     * public method that can be used to retrieve the protected status array on the instantiated cpt model
-     *
-     * @return array array of statuses.
-     */
-    public function get_status_array()
-    {
-        $statuses = $this->get_post_statuses();
-        // first the global filter
-        $statuses = apply_filters('FHEE_EEM_CPT_Base__get_status_array', $statuses);
-        // now the class specific filter
-        $statuses = apply_filters('FHEE_EEM_' . get_class($this) . '__get_status_array', $statuses);
-        return $statuses;
-    }
-
-
-    /**
-     * this returns the post statuses that are NOT the default wordpress status
-     *
-     * @return array
-     */
-    public function get_custom_post_statuses()
-    {
-        $new_stati = array();
-        foreach ($this->_custom_stati as $status => $props) {
-            $new_stati[ $status ] = $props['label'];
-        }
-        return $new_stati;
-    }
-
-
-    /**
-     * Creates a child of EE_CPT_Base given a WP_Post or array of wpdb results which
-     * are a row from the posts table. If we're missing any fields required for the model,
-     * we just fetch the entire entry from the DB (ie, if you want to use this to save DB queries,
-     * make sure you are attaching all the model's fields onto the post)
-     *
-     * @param WP_Post|array $post
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class
-     */
-    public function instantiate_class_from_post_object_orig($post)
-    {
-        $post = (array) $post;
-        $has_all_necessary_fields_for_table = true;
-        // check if the post has fields on the meta table already
-        foreach ($this->_get_other_tables() as $table_obj) {
-            $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
-            foreach ($fields_for_that_table as $field_obj) {
-                if (
-                    ! isset($post[ $field_obj->get_table_column() ])
-                    && ! isset($post[ $field_obj->get_qualified_column() ])
-                ) {
-                    $has_all_necessary_fields_for_table = false;
-                }
-            }
-        }
-        // if we don't have all the fields we need, then just fetch the proper model from the DB
-        if (! $has_all_necessary_fields_for_table) {
-            return $this->get_one_by_ID($post['ID']);
-        } else {
-            return $this->instantiate_class_from_array_or_object($post);
-        }
-    }
-
-
-    /**
-     * @param null $post
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class
-     */
-    public function instantiate_class_from_post_object($post = null)
-    {
-        if (empty($post)) {
-            global $post;
-        }
-        $post = (array) $post;
-        $tables_needing_to_be_queried = array();
-        // check if the post has fields on the meta table already
-        foreach ($this->get_tables() as $table_obj) {
-            $fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
-            foreach ($fields_for_that_table as $field_obj) {
-                if (
-                    ! isset($post[ $field_obj->get_table_column() ])
-                    && ! isset($post[ $field_obj->get_qualified_column() ])
-                ) {
-                    $tables_needing_to_be_queried[ $table_obj->get_table_alias() ] = $table_obj;
-                }
-            }
-        }
-        // if we don't have all the fields we need, then just fetch the proper model from the DB
-        if ($tables_needing_to_be_queried) {
-            if (
-                count($tables_needing_to_be_queried) == 1
-                && reset($tables_needing_to_be_queried)
-                   instanceof
-                   EE_Secondary_Table
-            ) {
-                // so we're only missing data from a secondary table. Well that's not too hard to query for
-                $table_to_query = reset($tables_needing_to_be_queried);
-                $missing_data = $this->_do_wpdb_query(
-                    'get_row',
-                    array(
-                        'SELECT * FROM '
-                        . $table_to_query->get_table_name()
-                        . ' WHERE '
-                        . $table_to_query->get_fk_on_table()
-                        . ' = '
-                        . $post['ID'],
-                        ARRAY_A,
-                    )
-                );
-                if (! empty($missing_data)) {
-                    $post = array_merge($post, $missing_data);
-                }
-            } else {
-                return $this->get_one_by_ID($post['ID']);
-            }
-        }
-        return $this->instantiate_class_from_array_or_object($post);
-    }
-
-
-    /**
-     * Gets the post type associated with this
-     *
-     * @throws EE_Error
-     * @return string
-     */
-    public function post_type()
-    {
-        $post_type_field = null;
-        foreach ($this->field_settings(true) as $field_obj) {
-            if ($field_obj instanceof EE_WP_Post_Type_Field) {
-                $post_type_field = $field_obj;
-                break;
-            }
-        }
-        if ($post_type_field == null) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "CPT Model %s should have a field of type EE_WP_Post_Type, but doesnt",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $post_type_field->get_default_value();
-    }
+	const EVENT_CATEGORY_TAXONOMY = 'espresso_event_categories';
+
+	/**
+	 * @var string post_status_publish - the wp post status for published cpts
+	 */
+	const post_status_publish = 'publish';
+
+	/**
+	 * @var string post_status_future - the wp post status for scheduled cpts
+	 */
+	const post_status_future = 'future';
+
+	/**
+	 * @var string post_status_draft - the wp post status for draft cpts
+	 */
+	const post_status_draft = 'draft';
+
+	/**
+	 * @var string post_status_pending - the wp post status for pending cpts
+	 */
+	const post_status_pending = 'pending';
+
+	/**
+	 * @var string post_status_private - the wp post status for private cpts
+	 */
+	const post_status_private = 'private';
+
+	/**
+	 * @var string post_status_trashed - the wp post status for trashed cpts
+	 */
+	const post_status_trashed = 'trash';
+
+	/**
+	 * This is an array of custom statuses for the given CPT model (modified by children)
+	 * format:
+	 * array(
+	 *        'status_name' => array(
+	 *            'label' => esc_html__('Status Name', 'event_espresso'),
+	 *            'public' => TRUE //whether a public status or not.
+	 *        )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_custom_stati = array();
+
+
+	/**
+	 * Adds a relationship to Term_Taxonomy for each CPT_Base
+	 *
+	 * @param string $timezone
+	 * @throws \EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		// adds a relationship to Term_Taxonomy for all these models. For this to work
+		// Term_Relationship must have a relation to each model subclassing EE_CPT_Base explicitly
+		// eg, in EEM_Term_Relationship, inside the _model_relations array, there must be an entry
+		// with key equalling the subclassing model's model name (eg 'Event' or 'Venue'), and the value
+		// must also be new EE_HABTM_Relation('Term_Relationship');
+		$this->_model_relations['Term_Taxonomy'] = new EE_HABTM_Relation('Term_Relationship');
+		$primary_table_name = null;
+		// add  the common _status field to all CPT primary tables.
+		foreach ($this->_tables as $alias => $table_obj) {
+			if ($table_obj instanceof EE_Primary_Table) {
+				$primary_table_name = $alias;
+			}
+		}
+		// set default wp post statuses if child has not already set.
+		if (! isset($this->_fields[ $primary_table_name ]['status'])) {
+			$this->_fields[ $primary_table_name ]['status'] = new EE_WP_Post_Status_Field(
+				'post_status',
+				esc_html__("Event Status", "event_espresso"),
+				false,
+				'draft'
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['to_ping'])) {
+			$this->_fields[ $primary_table_name ]['to_ping'] = new EE_DB_Only_Text_Field(
+				'to_ping',
+				esc_html__('To Ping', 'event_espresso'),
+				false,
+				''
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['pinged'])) {
+			$this->_fields[ $primary_table_name ]['pinged'] = new EE_DB_Only_Text_Field(
+				'pinged',
+				esc_html__('Pinged', 'event_espresso'),
+				false,
+				''
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['comment_status'])) {
+			$this->_fields[ $primary_table_name ]['comment_status'] = new EE_Plain_Text_Field(
+				'comment_status',
+				esc_html__('Comment Status', 'event_espresso'),
+				false,
+				'open'
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['ping_status'])) {
+			$this->_fields[ $primary_table_name ]['ping_status'] = new EE_Plain_Text_Field(
+				'ping_status',
+				esc_html__('Ping Status', 'event_espresso'),
+				false,
+				'open'
+			);
+		}
+		if (! isset($this->_fields[ $primary_table_name ]['post_content_filtered'])) {
+			$this->_fields[ $primary_table_name ]['post_content_filtered'] = new EE_DB_Only_Text_Field(
+				'post_content_filtered',
+				esc_html__('Post Content Filtered', 'event_espresso'),
+				false,
+				''
+			);
+		}
+		if (! isset($this->_model_relations['Post_Meta'])) {
+			// don't block deletes though because we want to maintain the current behaviour
+			$this->_model_relations['Post_Meta'] = new EE_Has_Many_Relation(false);
+		}
+		if (! $this->_minimum_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			// nothing was set during child constructor, so set default
+			$this->_minimum_where_conditions_strategy = new EE_CPT_Minimum_Where_Conditions($this->post_type());
+		}
+		if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			// nothing was set during child constructor, so set default
+			// it's ok for child classes to specify this, but generally this is more DRY
+			$this->_default_where_conditions_strategy = new EE_CPT_Where_Conditions($this->post_type());
+		}
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function public_event_stati()
+	{
+		// @see wp-includes/post.php
+		return get_post_stati(array('public' => true));
+	}
+
+
+	/**
+	 * Searches for field on this model of type 'deleted_flag'. if it is found,
+	 * returns it's name. BUT That doesn't apply to CPTs. We should instead use post_status_field_name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function deleted_field_name()
+	{
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'%1$s should not call deleted_field_name()! It should instead use post_status_field_name',
+					"event_espresso"
+				),
+				get_called_class()
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the field's name that sets the post status
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function post_status_field_name()
+	{
+		$field = $this->get_a_field_of_type('EE_WP_Post_Status_Field');
+		if ($field) {
+			return $field->get_name();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'We are trying to find the post status flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
+						'event_espresso'
+					),
+					get_called_class(),
+					get_called_class()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function _alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		$post_status_field_name = $this->post_status_field_name();
+		$query_params[0][ $post_status_field_name ] = self::post_status_trashed;
+		return $query_params;
+	}
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
+	{
+		$query_params['default_where_conditions'] = 'minimum';
+		return $query_params;
+	}
+
+
+	/**
+	 * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
+	 *
+	 * @param boolean $delete       true to indicate deletion, false to indicate restoration
+	 * @param array $query_params
+	 * @return boolean success
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function delete_or_restore($delete = true, $query_params = array())
+	{
+		$post_status_field_name = $this->post_status_field_name();
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		$new_status = $delete ? self::post_status_trashed : 'draft';
+		return (bool) $this->update([$post_status_field_name => $new_status], $query_params);
+	}
+
+
+	/**
+	 * meta_table
+	 * returns first EE_Secondary_Table table name
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function meta_table()
+	{
+		$meta_table = $this->_get_other_tables();
+		$meta_table = reset($meta_table);
+		return $meta_table instanceof EE_Secondary_Table ? $meta_table->get_table_name() : null;
+	}
+
+
+	/**
+	 * This simply returns an array of the meta table fields (useful for when we just need to update those fields)
+	 *
+	 * @param  bool $all triggers whether we include DB_Only fields or JUST non DB_Only fields.  Defaults to false (no
+	 *                   db only fields)
+	 * @return array
+	 */
+	public function get_meta_table_fields($all = false)
+	{
+		$all_fields = $fields_to_return = array();
+		foreach ($this->_tables as $alias => $table_obj) {
+			if ($table_obj instanceof EE_Secondary_Table) {
+				$all_fields = array_merge($this->_get_fields_for_table($alias), $all_fields);
+			}
+		}
+		if (! $all) {
+			foreach ($all_fields as $name => $obj) {
+				if ($obj instanceof EE_DB_Only_Field_Base) {
+					continue;
+				}
+				$fields_to_return[] = $name;
+			}
+		} else {
+			$fields_to_return = array_keys($all_fields);
+		}
+		return $fields_to_return;
+	}
+
+
+	/**
+	 * Adds an event category with the specified name and description to the specified
+	 * $cpt_model_object. Intelligently adds a term if necessary, and adds a term_taxonomy if necessary,
+	 * and adds an entry in the term_relationship if necessary.
+	 *
+	 * @param EE_CPT_Base $cpt_model_object
+	 * @param string      $category_name (used to derive the term slug too)
+	 * @param string      $category_description
+	 * @param int         $parent_term_taxonomy_id
+	 * @return EE_Term_Taxonomy
+	 */
+	public function add_event_category(
+		EE_CPT_Base $cpt_model_object,
+		$category_name,
+		$category_description = '',
+		$parent_term_taxonomy_id = null
+	) {
+		// create term
+		require_once(EE_MODELS . 'EEM_Term.model.php');
+		// first, check for a term by the same name or slug
+		$category_slug = sanitize_title($category_name);
+		$term = EEM_Term::instance()->get_one(
+			array(
+				array(
+					'OR' => array(
+						'name' => $category_name,
+						'slug' => $category_slug,
+					),
+					'Term_Taxonomy.taxonomy' => self::EVENT_CATEGORY_TAXONOMY
+				),
+			)
+		);
+		if (! $term) {
+			$term = EE_Term::new_instance(
+				array(
+					'name' => $category_name,
+					'slug' => $category_slug,
+				)
+			);
+			$term->save();
+		}
+		// make sure there's a term-taxonomy entry too
+		require_once(EE_MODELS . 'EEM_Term_Taxonomy.model.php');
+		$term_taxonomy = EEM_Term_Taxonomy::instance()->get_one(
+			array(
+				array(
+					'term_id'  => $term->ID(),
+					'taxonomy' => self::EVENT_CATEGORY_TAXONOMY,
+				),
+			)
+		);
+		/** @var $term_taxonomy EE_Term_Taxonomy */
+		if (! $term_taxonomy) {
+			$term_taxonomy = EE_Term_Taxonomy::new_instance(
+				array(
+					'term_id'     => $term->ID(),
+					'taxonomy'    => self::EVENT_CATEGORY_TAXONOMY,
+					'description' => $category_description,
+					'term_count'       => 1,
+					'parent'      => $parent_term_taxonomy_id,
+				)
+			);
+			$term_taxonomy->save();
+		} else {
+			$term_taxonomy->set_count($term_taxonomy->count() + 1);
+			$term_taxonomy->save();
+		}
+		return $this->add_relationship_to($cpt_model_object, $term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * Removed the category specified by name as having a relation to this event.
+	 * Does not remove the term or term_taxonomy.
+	 *
+	 * @param EE_CPT_Base $cpt_model_object_event
+	 * @param string      $category_name name of the event category (term)
+	 * @return bool
+	 */
+	public function remove_event_category(EE_CPT_Base $cpt_model_object_event, $category_name)
+	{
+		// find the term_taxonomy by that name
+		$term_taxonomy = $this->get_first_related(
+			$cpt_model_object_event,
+			'Term_Taxonomy',
+			array(array('Term.name' => $category_name, 'taxonomy' => self::EVENT_CATEGORY_TAXONOMY))
+		);
+		/** @var $term_taxonomy EE_Term_Taxonomy */
+		if ($term_taxonomy) {
+			$term_taxonomy->set_count($term_taxonomy->count() - 1);
+			$term_taxonomy->save();
+		}
+		return $this->remove_relationship_to($cpt_model_object_event, $term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * This is a wrapper for the WordPress get_the_post_thumbnail() function that returns the feature image for the
+	 * given CPT ID.  It accepts the same params as what get_the_post_thumbnail() accepts.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
+	 * @access public
+	 * @param int          $id   the ID for the cpt we want the feature image for
+	 * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
+	 *                           representing width and height in pixels (i.e. array(32,32) ).
+	 * @param string|array $attr Optional. Query string or array of attributes.
+	 * @return string HTML image element
+	 */
+	public function get_feature_image($id, $size = 'thumbnail', $attr = '')
+	{
+		return get_the_post_thumbnail($id, $size, $attr);
+	}
+
+
+	/**
+	 * Just a handy way to get the list of post statuses currently registered with WP.
+	 *
+	 * @global array $wp_post_statuses set in wp core for storing all the post stati
+	 * @return array
+	 */
+	public function get_post_statuses()
+	{
+		global $wp_post_statuses;
+		$statuses = array();
+		foreach ($wp_post_statuses as $post_status => $args_object) {
+			$statuses[ $post_status ] = $args_object->label;
+		}
+		return $statuses;
+	}
+
+
+	/**
+	 * public method that can be used to retrieve the protected status array on the instantiated cpt model
+	 *
+	 * @return array array of statuses.
+	 */
+	public function get_status_array()
+	{
+		$statuses = $this->get_post_statuses();
+		// first the global filter
+		$statuses = apply_filters('FHEE_EEM_CPT_Base__get_status_array', $statuses);
+		// now the class specific filter
+		$statuses = apply_filters('FHEE_EEM_' . get_class($this) . '__get_status_array', $statuses);
+		return $statuses;
+	}
+
+
+	/**
+	 * this returns the post statuses that are NOT the default wordpress status
+	 *
+	 * @return array
+	 */
+	public function get_custom_post_statuses()
+	{
+		$new_stati = array();
+		foreach ($this->_custom_stati as $status => $props) {
+			$new_stati[ $status ] = $props['label'];
+		}
+		return $new_stati;
+	}
+
+
+	/**
+	 * Creates a child of EE_CPT_Base given a WP_Post or array of wpdb results which
+	 * are a row from the posts table. If we're missing any fields required for the model,
+	 * we just fetch the entire entry from the DB (ie, if you want to use this to save DB queries,
+	 * make sure you are attaching all the model's fields onto the post)
+	 *
+	 * @param WP_Post|array $post
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class
+	 */
+	public function instantiate_class_from_post_object_orig($post)
+	{
+		$post = (array) $post;
+		$has_all_necessary_fields_for_table = true;
+		// check if the post has fields on the meta table already
+		foreach ($this->_get_other_tables() as $table_obj) {
+			$fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
+			foreach ($fields_for_that_table as $field_obj) {
+				if (
+					! isset($post[ $field_obj->get_table_column() ])
+					&& ! isset($post[ $field_obj->get_qualified_column() ])
+				) {
+					$has_all_necessary_fields_for_table = false;
+				}
+			}
+		}
+		// if we don't have all the fields we need, then just fetch the proper model from the DB
+		if (! $has_all_necessary_fields_for_table) {
+			return $this->get_one_by_ID($post['ID']);
+		} else {
+			return $this->instantiate_class_from_array_or_object($post);
+		}
+	}
+
+
+	/**
+	 * @param null $post
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class
+	 */
+	public function instantiate_class_from_post_object($post = null)
+	{
+		if (empty($post)) {
+			global $post;
+		}
+		$post = (array) $post;
+		$tables_needing_to_be_queried = array();
+		// check if the post has fields on the meta table already
+		foreach ($this->get_tables() as $table_obj) {
+			$fields_for_that_table = $this->_get_fields_for_table($table_obj->get_table_alias());
+			foreach ($fields_for_that_table as $field_obj) {
+				if (
+					! isset($post[ $field_obj->get_table_column() ])
+					&& ! isset($post[ $field_obj->get_qualified_column() ])
+				) {
+					$tables_needing_to_be_queried[ $table_obj->get_table_alias() ] = $table_obj;
+				}
+			}
+		}
+		// if we don't have all the fields we need, then just fetch the proper model from the DB
+		if ($tables_needing_to_be_queried) {
+			if (
+				count($tables_needing_to_be_queried) == 1
+				&& reset($tables_needing_to_be_queried)
+				   instanceof
+				   EE_Secondary_Table
+			) {
+				// so we're only missing data from a secondary table. Well that's not too hard to query for
+				$table_to_query = reset($tables_needing_to_be_queried);
+				$missing_data = $this->_do_wpdb_query(
+					'get_row',
+					array(
+						'SELECT * FROM '
+						. $table_to_query->get_table_name()
+						. ' WHERE '
+						. $table_to_query->get_fk_on_table()
+						. ' = '
+						. $post['ID'],
+						ARRAY_A,
+					)
+				);
+				if (! empty($missing_data)) {
+					$post = array_merge($post, $missing_data);
+				}
+			} else {
+				return $this->get_one_by_ID($post['ID']);
+			}
+		}
+		return $this->instantiate_class_from_array_or_object($post);
+	}
+
+
+	/**
+	 * Gets the post type associated with this
+	 *
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function post_type()
+	{
+		$post_type_field = null;
+		foreach ($this->field_settings(true) as $field_obj) {
+			if ($field_obj instanceof EE_WP_Post_Type_Field) {
+				$post_type_field = $field_obj;
+				break;
+			}
+		}
+		if ($post_type_field == null) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"CPT Model %s should have a field of type EE_WP_Post_Type, but doesnt",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $post_type_field->get_default_value();
+	}
 }

core/services/request/middleware/BotDetector.php

Indentation +21 added lines, -21 removed lines

@@ -16,25 +16,25 @@
  */
 class BotDetector extends Middleware
 {
-    /**
-     * converts a Request to a Response
-     *
-     * @param RequestInterface  $request
-     * @param ResponseInterface $response
-     * @return ResponseInterface
-     */
-    public function handleRequest(RequestInterface $request, ResponseInterface $response)
-    {
-        $this->request = $request;
-        $this->response = $response;
-        /** @var CrawlerDetect $CrawlerDetect */
-        $CrawlerDetect = $this->loader->getShared('EventEspressoVendor\CrawlerDetect\CrawlerDetect');
-        if ($CrawlerDetect instanceof CrawlerDetect) {
-            // Check and record the user agent of the current 'visitor'
-            $this->request->setIsBot($CrawlerDetect->isCrawler());
-            $this->request->setUserAgent($CrawlerDetect->userAgent());
-        }
-        $this->response = $this->processRequestStack($this->request, $this->response);
-        return $this->response;
-    }
+	/**
+	 * converts a Request to a Response
+	 *
+	 * @param RequestInterface  $request
+	 * @param ResponseInterface $response
+	 * @return ResponseInterface
+	 */
+	public function handleRequest(RequestInterface $request, ResponseInterface $response)
+	{
+		$this->request = $request;
+		$this->response = $response;
+		/** @var CrawlerDetect $CrawlerDetect */
+		$CrawlerDetect = $this->loader->getShared('EventEspressoVendor\CrawlerDetect\CrawlerDetect');
+		if ($CrawlerDetect instanceof CrawlerDetect) {
+			// Check and record the user agent of the current 'visitor'
+			$this->request->setIsBot($CrawlerDetect->isCrawler());
+			$this->request->setUserAgent($CrawlerDetect->userAgent());
+		}
+		$this->response = $this->processRequestStack($this->request, $this->response);
+		return $this->response;
+	}
 }

core/helpers/EEH_Activation.helper.php

Indentation +1575 added lines, -1575 removed lines

@@ -16,238 +16,238 @@ 
  */
 class EEH_Activation implements ResettableInterface
 {
-    /**
-     * constant used to indicate a cron task is no longer in use
-     */
-    const cron_task_no_longer_in_use = 'no_longer_in_use';
-
-    /**
-     * WP_User->ID
-     *
-     * @var int
-     */
-    private static $_default_creator_id;
-
-    /**
-     * indicates whether or not we've already verified core's default data during this request,
-     * because after migrations are done, any addons activated while in maintenance mode
-     * will want to setup their own default data, and they might hook into core's default data
-     * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
-     * This prevents doing that for EVERY single addon.
-     *
-     * @var boolean
-     */
-    protected static $_initialized_db_content_already_in_this_request = false;
-
-    /**
-     * @var TableAnalysis $table_analysis
-     */
-    private static $table_analysis;
-
-    /**
-     * @var TableManager $table_manager
-     */
-    private static $table_manager;
-
-
-    /**
-     * @return TableAnalysis
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getTableAnalysis()
-    {
-        if (! self::$table_analysis instanceof TableAnalysis) {
-            self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', [], true);
-        }
-        return self::$table_analysis;
-    }
-
-
-    /**
-     * @return TableManager
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getTableManager()
-    {
-        if (! self::$table_manager instanceof TableManager) {
-            self::$table_manager = EE_Registry::instance()->create('TableManager', [], true);
-        }
-        return self::$table_manager;
-    }
-
-
-    /**
-     * @param $table_name
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated instead use TableAnalysis::ensureTableNameHasPrefix()
-     */
-    public static function ensure_table_name_has_prefix($table_name)
-    {
-        return EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-    }
-
-
-    /**
-     * ensures the EE configuration settings are loaded with at least default options set
-     * and that all critical EE pages have been generated with the appropriate shortcodes in place
-     *
-     * @return void
-     */
-    public static function system_initialization()
-    {
-        EEH_Activation::reset_and_update_config();
-        // which is fired BEFORE activation of plugin anyways
-        EEH_Activation::verify_default_pages_exist();
-    }
-
-
-    /**
-     * Sets the database schema and creates folders. This should
-     * be called on plugin activation and reactivation
-     *
-     * @return boolean success, whether the database and folders are setup properly
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function initialize_db_and_folders()
-    {
-        EEH_File::ensure_folder_exists_and_is_writable(EVENT_ESPRESSO_UPLOAD_DIR);
-        EEH_File::ensure_folder_exists_and_is_writable(EVENT_ESPRESSO_UPLOAD_DIR . 'logs');
-        return EEH_Activation::create_database_tables();
-    }
-
-
-    /**
-     * assuming we have an up-to-date database schema, this will populate it
-     * with default and initial data. This should be called
-     * upon activation of a new plugin, reactivation, and at the end
-     * of running migration scripts
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function initialize_db_content()
-    {
-        // let's avoid doing all this logic repeatedly, especially when addons are requesting it
-        if (EEH_Activation::$_initialized_db_content_already_in_this_request) {
-            return;
-        }
-        EEH_Activation::$_initialized_db_content_already_in_this_request = true;
-
-        EEH_Activation::initialize_system_questions();
-        EEH_Activation::insert_default_status_codes();
-        EEH_Activation::generate_default_message_templates();
-        EEH_Activation::removeEmailConfirmFromAddressGroup();
-
-        EEH_Activation::validate_messages_system();
-        EEH_Activation::insert_default_payment_methods();
-        // in case we've
-        EEH_Activation::remove_cron_tasks();
-        EEH_Activation::create_cron_tasks();
-        // remove all TXN locks since that is being done via extra meta now
-        delete_option('ee_locked_transactions');
-        // also, check for CAF default db content
-        do_action('AHEE__EEH_Activation__initialize_db_content');
-        // also: EEM_Gateways::load_all_gateways() outputs a lot of success messages
-        // which users really won't care about on initial activation
-        EE_Error::overwrite_success();
-    }
-
-
-    /**
-     * Returns an array of cron tasks. Array values are the actions fired by the cron tasks (the "hooks"),
-     * values are the frequency (the "recurrence"). See http://codex.wordpress.org/Function_Reference/wp_schedule_event
-     * If the cron task should NO longer be used, it should have a value of EEH_Activation::cron_task_no_longer_in_use
-     * (null)
-     *
-     * @param string $which_to_include can be 'current' (ones that are currently in use),
-     *                                 'old' (only returns ones that should no longer be used),or 'all',
-     * @return array
-     * @throws EE_Error
-     */
-    public static function get_cron_tasks($which_to_include)
-    {
-        $cron_tasks = apply_filters(
-            'FHEE__EEH_Activation__get_cron_tasks',
-            [
-                'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'      => 'hourly',
-                // 'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions' =>
-                // EEH_Activation::cron_task_no_longer_in_use, actually this is still in use
-                'AHEE__EE_Cron_Tasks__update_transaction_with_payment' => EEH_Activation::cron_task_no_longer_in_use,
-                // there may have been a bug which prevented from these cron tasks from getting unscheduled,
-                // so we might want to remove these for a few updates
-                'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs'       => 'daily',
-            ]
-        );
-        if ($which_to_include === 'old') {
-            $cron_tasks = array_filter(
-                $cron_tasks,
-                function ($value) {
-                    return $value === EEH_Activation::cron_task_no_longer_in_use;
-                }
-            );
-        } elseif ($which_to_include === 'current') {
-            $cron_tasks = array_filter($cron_tasks);
-        } elseif (WP_DEBUG && $which_to_include !== 'all') {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Invalid argument of "%1$s" passed to EEH_Activation::get_cron_tasks. Valid values are "all", "old" and "current".',
-                        'event_espresso'
-                    ),
-                    $which_to_include
-                )
-            );
-        }
-        return $cron_tasks;
-    }
-
-
-    /**
-     * Ensure cron tasks are setup (the removal of crons should be done by remove_crons())
-     *
-     * @throws EE_Error
-     */
-    public static function create_cron_tasks()
-    {
-
-        foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
-                /**
-                 * This allows client code to define the initial start timestamp for this schedule.
-                 */
-                if (
-                    is_array($frequency)
-                    && count($frequency) === 2
-                    && isset($frequency[0], $frequency[1])
-                ) {
-                    $start_timestamp = $frequency[0];
-                    $frequency       = $frequency[1];
-                } else {
-                    $start_timestamp = time();
-                }
-                wp_schedule_event($start_timestamp, $frequency, $hook_name);
-            }
-        }
-    }
-
-
-    /**
-     * Remove the currently-existing and now-removed cron tasks.
-     *
-     * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
-     * @throws EE_Error
-     */
-    public static function remove_cron_tasks($remove_all = true)
-    {
-        $cron_tasks_to_remove = $remove_all ? 'all' : 'old';
-        $crons                = _get_cron_array();
-        $crons                = is_array($crons) ? $crons : [];
-        /* reminder of what $crons look like:
+	/**
+	 * constant used to indicate a cron task is no longer in use
+	 */
+	const cron_task_no_longer_in_use = 'no_longer_in_use';
+
+	/**
+	 * WP_User->ID
+	 *
+	 * @var int
+	 */
+	private static $_default_creator_id;
+
+	/**
+	 * indicates whether or not we've already verified core's default data during this request,
+	 * because after migrations are done, any addons activated while in maintenance mode
+	 * will want to setup their own default data, and they might hook into core's default data
+	 * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
+	 * This prevents doing that for EVERY single addon.
+	 *
+	 * @var boolean
+	 */
+	protected static $_initialized_db_content_already_in_this_request = false;
+
+	/**
+	 * @var TableAnalysis $table_analysis
+	 */
+	private static $table_analysis;
+
+	/**
+	 * @var TableManager $table_manager
+	 */
+	private static $table_manager;
+
+
+	/**
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getTableAnalysis()
+	{
+		if (! self::$table_analysis instanceof TableAnalysis) {
+			self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', [], true);
+		}
+		return self::$table_analysis;
+	}
+
+
+	/**
+	 * @return TableManager
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getTableManager()
+	{
+		if (! self::$table_manager instanceof TableManager) {
+			self::$table_manager = EE_Registry::instance()->create('TableManager', [], true);
+		}
+		return self::$table_manager;
+	}
+
+
+	/**
+	 * @param $table_name
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated instead use TableAnalysis::ensureTableNameHasPrefix()
+	 */
+	public static function ensure_table_name_has_prefix($table_name)
+	{
+		return EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+	}
+
+
+	/**
+	 * ensures the EE configuration settings are loaded with at least default options set
+	 * and that all critical EE pages have been generated with the appropriate shortcodes in place
+	 *
+	 * @return void
+	 */
+	public static function system_initialization()
+	{
+		EEH_Activation::reset_and_update_config();
+		// which is fired BEFORE activation of plugin anyways
+		EEH_Activation::verify_default_pages_exist();
+	}
+
+
+	/**
+	 * Sets the database schema and creates folders. This should
+	 * be called on plugin activation and reactivation
+	 *
+	 * @return boolean success, whether the database and folders are setup properly
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function initialize_db_and_folders()
+	{
+		EEH_File::ensure_folder_exists_and_is_writable(EVENT_ESPRESSO_UPLOAD_DIR);
+		EEH_File::ensure_folder_exists_and_is_writable(EVENT_ESPRESSO_UPLOAD_DIR . 'logs');
+		return EEH_Activation::create_database_tables();
+	}
+
+
+	/**
+	 * assuming we have an up-to-date database schema, this will populate it
+	 * with default and initial data. This should be called
+	 * upon activation of a new plugin, reactivation, and at the end
+	 * of running migration scripts
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function initialize_db_content()
+	{
+		// let's avoid doing all this logic repeatedly, especially when addons are requesting it
+		if (EEH_Activation::$_initialized_db_content_already_in_this_request) {
+			return;
+		}
+		EEH_Activation::$_initialized_db_content_already_in_this_request = true;
+
+		EEH_Activation::initialize_system_questions();
+		EEH_Activation::insert_default_status_codes();
+		EEH_Activation::generate_default_message_templates();
+		EEH_Activation::removeEmailConfirmFromAddressGroup();
+
+		EEH_Activation::validate_messages_system();
+		EEH_Activation::insert_default_payment_methods();
+		// in case we've
+		EEH_Activation::remove_cron_tasks();
+		EEH_Activation::create_cron_tasks();
+		// remove all TXN locks since that is being done via extra meta now
+		delete_option('ee_locked_transactions');
+		// also, check for CAF default db content
+		do_action('AHEE__EEH_Activation__initialize_db_content');
+		// also: EEM_Gateways::load_all_gateways() outputs a lot of success messages
+		// which users really won't care about on initial activation
+		EE_Error::overwrite_success();
+	}
+
+
+	/**
+	 * Returns an array of cron tasks. Array values are the actions fired by the cron tasks (the "hooks"),
+	 * values are the frequency (the "recurrence"). See http://codex.wordpress.org/Function_Reference/wp_schedule_event
+	 * If the cron task should NO longer be used, it should have a value of EEH_Activation::cron_task_no_longer_in_use
+	 * (null)
+	 *
+	 * @param string $which_to_include can be 'current' (ones that are currently in use),
+	 *                                 'old' (only returns ones that should no longer be used),or 'all',
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function get_cron_tasks($which_to_include)
+	{
+		$cron_tasks = apply_filters(
+			'FHEE__EEH_Activation__get_cron_tasks',
+			[
+				'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'      => 'hourly',
+				// 'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions' =>
+				// EEH_Activation::cron_task_no_longer_in_use, actually this is still in use
+				'AHEE__EE_Cron_Tasks__update_transaction_with_payment' => EEH_Activation::cron_task_no_longer_in_use,
+				// there may have been a bug which prevented from these cron tasks from getting unscheduled,
+				// so we might want to remove these for a few updates
+				'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs'       => 'daily',
+			]
+		);
+		if ($which_to_include === 'old') {
+			$cron_tasks = array_filter(
+				$cron_tasks,
+				function ($value) {
+					return $value === EEH_Activation::cron_task_no_longer_in_use;
+				}
+			);
+		} elseif ($which_to_include === 'current') {
+			$cron_tasks = array_filter($cron_tasks);
+		} elseif (WP_DEBUG && $which_to_include !== 'all') {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Invalid argument of "%1$s" passed to EEH_Activation::get_cron_tasks. Valid values are "all", "old" and "current".',
+						'event_espresso'
+					),
+					$which_to_include
+				)
+			);
+		}
+		return $cron_tasks;
+	}
+
+
+	/**
+	 * Ensure cron tasks are setup (the removal of crons should be done by remove_crons())
+	 *
+	 * @throws EE_Error
+	 */
+	public static function create_cron_tasks()
+	{
+
+		foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
+			if (! wp_next_scheduled($hook_name)) {
+				/**
+				 * This allows client code to define the initial start timestamp for this schedule.
+				 */
+				if (
+					is_array($frequency)
+					&& count($frequency) === 2
+					&& isset($frequency[0], $frequency[1])
+				) {
+					$start_timestamp = $frequency[0];
+					$frequency       = $frequency[1];
+				} else {
+					$start_timestamp = time();
+				}
+				wp_schedule_event($start_timestamp, $frequency, $hook_name);
+			}
+		}
+	}
+
+
+	/**
+	 * Remove the currently-existing and now-removed cron tasks.
+	 *
+	 * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
+	 * @throws EE_Error
+	 */
+	public static function remove_cron_tasks($remove_all = true)
+	{
+		$cron_tasks_to_remove = $remove_all ? 'all' : 'old';
+		$crons                = _get_cron_array();
+		$crons                = is_array($crons) ? $crons : [];
+		/* reminder of what $crons look like:
          * Top-level keys are timestamps, and their values are arrays.
          * The 2nd level arrays have keys with each of the cron task hook names to run at that time
          * and their values are arrays.
@@ -264,893 +264,893 @@ 
          *                  ...
          *      ...
          */
-        $ee_cron_tasks_to_remove = EEH_Activation::get_cron_tasks($cron_tasks_to_remove);
-        foreach ($crons as $timestamp => $hooks_to_fire_at_time) {
-            if (is_array($hooks_to_fire_at_time)) {
-                foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
-                    if (
-                        isset($ee_cron_tasks_to_remove[ $hook_name ])
-                        && is_array($ee_cron_tasks_to_remove[ $hook_name ])
-                    ) {
-                        unset($crons[ $timestamp ][ $hook_name ]);
-                    }
-                }
-                // also take care of any empty cron timestamps.
-                if (empty($hooks_to_fire_at_time)) {
-                    unset($crons[ $timestamp ]);
-                }
-            }
-        }
-        _set_cron_array($crons);
-    }
-
-
-    /**
-     * registers all EE CPTs ( Custom Post Types ) then flushes rewrite rules so that all endpoints exist
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function CPT_initialization()
-    {
-        // register Custom Post Types
-        EE_Registry::instance()->load_core('Register_CPTs');
-        flush_rewrite_rules();
-    }
-
-
-    /**
-     * The following code was moved over from EE_Config so that it will no longer run on every request.
-     * If there is old calendar config data saved, then it will get converted on activation.
-     * This was basically a DMS before we had DMS's, and will get removed after a few more versions.
-     *
-     * @return void
-     */
-    public static function reset_and_update_config()
-    {
-        do_action('AHEE__EE_Config___load_core_config__start', ['EEH_Activation', 'load_calendar_config']);
-        add_filter(
-            'FHEE__EE_Config___load_core_config__config_settings',
-            ['EEH_Activation', 'migrate_old_config_data'],
-            10,
-            3
-        );
-        if (! EE_Config::logging_enabled()) {
-            delete_option(EE_Config::LOG_NAME);
-        }
-    }
-
-
-    /**
-     * @return    void
-     */
-    public static function load_calendar_config()
-    {
-        // grab array of all plugin folders and loop thru it
-        $plugins = glob(WP_PLUGIN_DIR . '/*', GLOB_ONLYDIR);
-        if (empty($plugins)) {
-            return;
-        }
-        foreach ($plugins as $plugin_path) {
-            // grab plugin folder name from path
-            $plugin = basename($plugin_path);
-            // drill down to Espresso plugins
-            // then to calendar related plugins
-            if (
-                strpos($plugin, 'espresso') !== false
-                || strpos($plugin, 'Espresso') !== false
-                || strpos($plugin, 'ee4') !== false
-                || strpos($plugin, 'EE4') !== false
-                || strpos($plugin, 'calendar') !== false
-            ) {
-                // this is what we are looking for
-                $calendar_config = $plugin_path . '/EE_Calendar_Config.php';
-                // does it exist in this folder ?
-                if (is_readable($calendar_config)) {
-                    // YEAH! let's load it
-                    require_once($calendar_config);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param array|stdClass $settings
-     * @param int|string         $config
-     * @param EE_Config      $EE_Config
-     * @return stdClass
-     */
-    public static function migrate_old_config_data($settings, $config, EE_Config $EE_Config)
-    {
-        $convert_from_array = ['addons'];
-        // in case old settings were saved as an array
-        if (is_array($settings) && in_array($config, $convert_from_array)) {
-            // convert existing settings to an object
-            $config_array = $settings;
-            $settings     = new stdClass();
-            foreach ($config_array as $key => $value) {
-                if ($key === 'calendar' && class_exists('EE_Calendar_Config')) {
-                    $EE_Config->set_config('addons', 'EE_Calendar', 'EE_Calendar_Config', $value);
-                } else {
-                    $settings->{$key} = $value;
-                }
-            }
-            add_filter('FHEE__EE_Config___load_core_config__update_espresso_config', '__return_true');
-        }
-        return $settings;
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function deactivate_event_espresso()
-    {
-        // check permissions
-        if (current_user_can('activate_plugins')) {
-            deactivate_plugins(EE_PLUGIN_BASENAME, true);
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidDataTypeException
-     */
-    public static function verify_default_pages_exist()
-    {
-        $critical_page_problem = false;
-        $critical_pages        = [
-            [
-                'id'   => 'reg_page_id',
-                'name' => esc_html__('Registration Checkout', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_CHECKOUT',
-            ],
-            [
-                'id'   => 'txn_page_id',
-                'name' => esc_html__('Transactions', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_TXN_PAGE',
-            ],
-            [
-                'id'   => 'thank_you_page_id',
-                'name' => esc_html__('Thank You', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_THANK_YOU',
-            ],
-            [
-                'id'   => 'cancel_page_id',
-                'name' => esc_html__('Registration Cancelled', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_CANCELLED',
-            ],
-        ];
-        $EE_Core_Config        = EE_Registry::instance()->CFG->core;
-        foreach ($critical_pages as $critical_page) {
-            // is critical page ID set in config ?
-            if ($EE_Core_Config->{$critical_page['id']} !== false) {
-                // attempt to find post by ID
-                $critical_page['post'] = get_post($EE_Core_Config->{$critical_page['id']});
-            }
-            // no dice?
-            if ($critical_page['post'] === null) {
-                // attempt to find post by title
-                $critical_page['post'] = self::get_page_by_ee_shortcode($critical_page['code']);
-                // still nothing?
-                if ($critical_page['post'] === null) {
-                    $critical_page = EEH_Activation::create_critical_page($critical_page);
-                    // REALLY? Still nothing ??!?!?
-                    if ($critical_page['post'] === null) {
-                        $msg = esc_html__(
-                            'The Event Espresso critical page configuration settings could not be updated.',
-                            'event_espresso'
-                        );
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                        break;
-                    }
-                }
-            }
-            // check that Post ID matches critical page ID in config
-            if (
-                isset($critical_page['post']->ID)
-                && $critical_page['post']->ID !== $EE_Core_Config->{$critical_page['id']}
-            ) {
-                // update Config with post ID
-                $EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
-                if (! EE_Config::instance()->update_espresso_config(false, false)) {
-                    $msg = esc_html__(
-                        'The Event Espresso critical page configuration settings could not be updated.',
-                        'event_espresso'
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            $critical_page_problem =
-                ! isset($critical_page['post']->post_status)
-                || $critical_page['post']->post_status !== 'publish'
-                || strpos($critical_page['post']->post_content, $critical_page['code']) === false
-                    ? true
-                    : $critical_page_problem;
-        }
-        if ($critical_page_problem) {
-            new PersistentAdminNotice(
-                'critical_page_problem',
-                sprintf(
-                    esc_html__(
-                        'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
-                        'event_espresso'
-                    ),
-                    '<a href="' . admin_url('admin.php?page=espresso_general_settings&action=critical_pages') . '">'
-                    . esc_html__('Event Espresso Critical Pages Settings', 'event_espresso')
-                    . '</a>'
-                )
-            );
-        }
-        if (EE_Error::has_notices()) {
-            EE_Error::get_notices(false, true);
-        }
-    }
-
-
-    /**
-     * Returns the first post which uses the specified shortcode
-     *
-     * @param string $ee_shortcode usually one of the critical pages shortcodes, eg
-     *                             ESPRESSO_THANK_YOU. So we will search fora post with the content
-     *                             "[ESPRESSO_THANK_YOU"
-     *                             (we don't search for the closing shortcode bracket because they might have added
-     *                             parameter to the shortcode
-     * @return WP_Post or NULl
-     */
-    public static function get_page_by_ee_shortcode($ee_shortcode)
-    {
-        global $wpdb;
-        $shortcode_and_opening_bracket = '[' . $ee_shortcode;
-        $post_id                       =
-            $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
-        if ($post_id) {
-            return get_post($post_id);
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * This function generates a post for critical espresso pages
-     *
-     * @param array $critical_page
-     * @return array
-     */
-    public static function create_critical_page($critical_page)
-    {
-
-        $post_args = [
-            'post_title'     => $critical_page['name'],
-            'post_status'    => 'publish',
-            'post_type'      => 'page',
-            'comment_status' => 'closed',
-            'post_content'   => '[' . $critical_page['code'] . ']',
-        ];
-
-        $post_id = wp_insert_post($post_args);
-        if (! $post_id) {
-            $msg = sprintf(
-                esc_html__('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return $critical_page;
-        }
-        // get newly created post's details
-        if (! $critical_page['post'] = get_post($post_id)) {
-            $msg = sprintf(
-                esc_html__('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-
-        return $critical_page;
-    }
-
-
-    /**
-     * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
-     * The role being used to check is filterable.
-     *
-     * @return int|null WP_user ID or NULL
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since  4.6.0
-     * @global WPDB $wpdb
-     */
-    public static function get_default_creator_id()
-    {
-        global $wpdb;
-        if (! empty(self::$_default_creator_id)) {
-            return self::$_default_creator_id;
-        }/**/
-        $role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
-        // let's allow pre_filtering for early exits by alternative methods for getting id.  We check for truthy result and if so then exit early.
-        $pre_filtered_id = apply_filters(
-            'FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id',
-            false,
-            $role_to_check
-        );
-        if ($pre_filtered_id !== false) {
-            return (int) $pre_filtered_id;
-        }
-        $capabilities_key = EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
-        $query            = $wpdb->prepare(
-            "SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
-            '%' . $role_to_check . '%'
-        );
-        $user_id          = $wpdb->get_var($query);
-        $user_id          = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
-        if ($user_id && (int) $user_id) {
-            self::$_default_creator_id = (int) $user_id;
-            return self::$_default_creator_id;
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * used by EE and EE addons during plugin activation to create tables.
-     * Its a wrapper for EventEspresso\core\services\database\TableManager::createTable,
-     * but includes extra logic regarding activations.
-     *
-     * @param string  $table_name              without the $wpdb->prefix
-     * @param string  $sql                     SQL for creating the table (contents between brackets in an SQL create
-     *                                         table query)
-     * @param string  $engine                  like 'ENGINE=MyISAM' or 'ENGINE=InnoDB'
-     * @param boolean $drop_pre_existing_table set to TRUE when you want to make SURE the table is completely empty
-     *                                         and new once this function is done (ie, you really do want to CREATE a
-     *                                         table, and expect it to be empty once you're done) leave as FALSE when
-     *                                         you just want to verify the table exists and matches this definition
-     *                                         (and if it HAS data in it you want to leave it be)
-     * @return void
-     * @throws EE_Error if there are database errors
-     * @throws ReflectionException
-     */
-    public static function create_table($table_name, $sql, $engine = 'ENGINE=MyISAM ', $drop_pre_existing_table = false)
-    {
-        if (apply_filters('FHEE__EEH_Activation__create_table__short_circuit', false, $table_name, $sql)) {
-            return;
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! function_exists('dbDelta')) {
-            require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
-        }
-        $tableAnalysis = EEH_Activation::getTableAnalysis();
-        $wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
-        // do we need to first delete an existing version of this table ?
-        if ($drop_pre_existing_table && $tableAnalysis->tableExists($wp_table_name)) {
-            // ok, delete the table... but ONLY if it's empty
-            $deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
-            // table is NOT empty, are you SURE you want to delete this table ???
-            if (! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
-                EEH_Activation::getTableManager()->dropTable($wp_table_name);
-            } elseif (! $deleted_safely) {
-                // so we should be more cautious rather than just dropping tables so easily
-                error_log(
-                    sprintf(
-                        esc_html__(
-                            'It appears that database table "%1$s" exists when it shouldn\'t, and therefore may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend: %2$s 1. create a new COMPLETE backup of your database, %2$s 2. delete ALL tables from your database, %2$s 3. restore to your previous backup. %2$s If, however, you have not restored to a backup, then somehow your "%3$s" WordPress option could not be read. You can probably ignore this message, but should investigate why that option is being removed.',
-                            'event_espresso'
-                        ),
-                        $wp_table_name,
-                        '<br/>',
-                        'espresso_db_update'
-                    )
-                );
-            }
-        }
-        $engine = str_replace('ENGINE=', '', $engine);
-        EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
-    }
-
-
-    /**
-     * Checks if this column already exists on the specified table. Handy for addons which want to add a column
-     *
-     * @param string $table_name  (without "wp_", eg "esp_attendee"
-     * @param string $column_name
-     * @param string $column_info if your SQL were 'ALTER TABLE table_name ADD price VARCHAR(10)', this would be
-     *                            'VARCHAR(10)'
-     * @return bool|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated instead use TableManager::addColumn()
-     */
-    public static function add_column_if_it_doesnt_exist(
-        $table_name,
-        $column_name,
-        $column_info = 'INT UNSIGNED NOT NULL'
-    ) {
-        return EEH_Activation::getTableManager()->addColumn($table_name, $column_name, $column_info);
-    }
-
-
-    /**
-     * Gets all the fields on the database table.
-     *
-     * @param string $table_name , without prefixed $wpdb->prefix
-     * @return array of database column names
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated instead use TableManager::getTableColumns()
-     */
-    public static function get_fields_on_table($table_name = null)
-    {
-        return EEH_Activation::getTableManager()->getTableColumns($table_name);
-    }
-
-
-    /**
-     * @param string $table_name
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated instead use TableAnalysis::tableIsEmpty()
-     */
-    public static function db_table_is_empty($table_name)
-    {
-        return EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
-    }
-
-
-    /**
-     * @param string $table_name
-     * @return bool | int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function delete_db_table_if_empty($table_name)
-    {
-        if (EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name)) {
-            return EEH_Activation::getTableManager()->dropTable($table_name);
-        }
-        return false;
-    }
-
-
-    /**
-     * @param string $table_name
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated instead use TableManager::dropTable()
-     */
-    public static function delete_unused_db_table($table_name)
-    {
-        return EEH_Activation::getTableManager()->dropTable($table_name);
-    }
-
-
-    /**
-     * @param string $table_name
-     * @param string $index_name
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated instead use TableManager::dropIndex()
-     */
-    public static function drop_index($table_name, $index_name)
-    {
-        return EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
-    }
-
-
-    /**
-     * @return boolean success (whether database is setup properly or not)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function create_database_tables()
-    {
-        EE_Registry::instance()->load_core('Data_Migration_Manager');
-        // find the migration script that sets the database to be compatible with the code
-        $dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
-        if (! $dms_name) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Could not determine most up-to-date data migration script from which to pull database schema
+		$ee_cron_tasks_to_remove = EEH_Activation::get_cron_tasks($cron_tasks_to_remove);
+		foreach ($crons as $timestamp => $hooks_to_fire_at_time) {
+			if (is_array($hooks_to_fire_at_time)) {
+				foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
+					if (
+						isset($ee_cron_tasks_to_remove[ $hook_name ])
+						&& is_array($ee_cron_tasks_to_remove[ $hook_name ])
+					) {
+						unset($crons[ $timestamp ][ $hook_name ]);
+					}
+				}
+				// also take care of any empty cron timestamps.
+				if (empty($hooks_to_fire_at_time)) {
+					unset($crons[ $timestamp ]);
+				}
+			}
+		}
+		_set_cron_array($crons);
+	}
+
+
+	/**
+	 * registers all EE CPTs ( Custom Post Types ) then flushes rewrite rules so that all endpoints exist
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function CPT_initialization()
+	{
+		// register Custom Post Types
+		EE_Registry::instance()->load_core('Register_CPTs');
+		flush_rewrite_rules();
+	}
+
+
+	/**
+	 * The following code was moved over from EE_Config so that it will no longer run on every request.
+	 * If there is old calendar config data saved, then it will get converted on activation.
+	 * This was basically a DMS before we had DMS's, and will get removed after a few more versions.
+	 *
+	 * @return void
+	 */
+	public static function reset_and_update_config()
+	{
+		do_action('AHEE__EE_Config___load_core_config__start', ['EEH_Activation', 'load_calendar_config']);
+		add_filter(
+			'FHEE__EE_Config___load_core_config__config_settings',
+			['EEH_Activation', 'migrate_old_config_data'],
+			10,
+			3
+		);
+		if (! EE_Config::logging_enabled()) {
+			delete_option(EE_Config::LOG_NAME);
+		}
+	}
+
+
+	/**
+	 * @return    void
+	 */
+	public static function load_calendar_config()
+	{
+		// grab array of all plugin folders and loop thru it
+		$plugins = glob(WP_PLUGIN_DIR . '/*', GLOB_ONLYDIR);
+		if (empty($plugins)) {
+			return;
+		}
+		foreach ($plugins as $plugin_path) {
+			// grab plugin folder name from path
+			$plugin = basename($plugin_path);
+			// drill down to Espresso plugins
+			// then to calendar related plugins
+			if (
+				strpos($plugin, 'espresso') !== false
+				|| strpos($plugin, 'Espresso') !== false
+				|| strpos($plugin, 'ee4') !== false
+				|| strpos($plugin, 'EE4') !== false
+				|| strpos($plugin, 'calendar') !== false
+			) {
+				// this is what we are looking for
+				$calendar_config = $plugin_path . '/EE_Calendar_Config.php';
+				// does it exist in this folder ?
+				if (is_readable($calendar_config)) {
+					// YEAH! let's load it
+					require_once($calendar_config);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param array|stdClass $settings
+	 * @param int|string         $config
+	 * @param EE_Config      $EE_Config
+	 * @return stdClass
+	 */
+	public static function migrate_old_config_data($settings, $config, EE_Config $EE_Config)
+	{
+		$convert_from_array = ['addons'];
+		// in case old settings were saved as an array
+		if (is_array($settings) && in_array($config, $convert_from_array)) {
+			// convert existing settings to an object
+			$config_array = $settings;
+			$settings     = new stdClass();
+			foreach ($config_array as $key => $value) {
+				if ($key === 'calendar' && class_exists('EE_Calendar_Config')) {
+					$EE_Config->set_config('addons', 'EE_Calendar', 'EE_Calendar_Config', $value);
+				} else {
+					$settings->{$key} = $value;
+				}
+			}
+			add_filter('FHEE__EE_Config___load_core_config__update_espresso_config', '__return_true');
+		}
+		return $settings;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function deactivate_event_espresso()
+	{
+		// check permissions
+		if (current_user_can('activate_plugins')) {
+			deactivate_plugins(EE_PLUGIN_BASENAME, true);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 */
+	public static function verify_default_pages_exist()
+	{
+		$critical_page_problem = false;
+		$critical_pages        = [
+			[
+				'id'   => 'reg_page_id',
+				'name' => esc_html__('Registration Checkout', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_CHECKOUT',
+			],
+			[
+				'id'   => 'txn_page_id',
+				'name' => esc_html__('Transactions', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_TXN_PAGE',
+			],
+			[
+				'id'   => 'thank_you_page_id',
+				'name' => esc_html__('Thank You', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_THANK_YOU',
+			],
+			[
+				'id'   => 'cancel_page_id',
+				'name' => esc_html__('Registration Cancelled', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_CANCELLED',
+			],
+		];
+		$EE_Core_Config        = EE_Registry::instance()->CFG->core;
+		foreach ($critical_pages as $critical_page) {
+			// is critical page ID set in config ?
+			if ($EE_Core_Config->{$critical_page['id']} !== false) {
+				// attempt to find post by ID
+				$critical_page['post'] = get_post($EE_Core_Config->{$critical_page['id']});
+			}
+			// no dice?
+			if ($critical_page['post'] === null) {
+				// attempt to find post by title
+				$critical_page['post'] = self::get_page_by_ee_shortcode($critical_page['code']);
+				// still nothing?
+				if ($critical_page['post'] === null) {
+					$critical_page = EEH_Activation::create_critical_page($critical_page);
+					// REALLY? Still nothing ??!?!?
+					if ($critical_page['post'] === null) {
+						$msg = esc_html__(
+							'The Event Espresso critical page configuration settings could not be updated.',
+							'event_espresso'
+						);
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+						break;
+					}
+				}
+			}
+			// check that Post ID matches critical page ID in config
+			if (
+				isset($critical_page['post']->ID)
+				&& $critical_page['post']->ID !== $EE_Core_Config->{$critical_page['id']}
+			) {
+				// update Config with post ID
+				$EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
+				if (! EE_Config::instance()->update_espresso_config(false, false)) {
+					$msg = esc_html__(
+						'The Event Espresso critical page configuration settings could not be updated.',
+						'event_espresso'
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			$critical_page_problem =
+				! isset($critical_page['post']->post_status)
+				|| $critical_page['post']->post_status !== 'publish'
+				|| strpos($critical_page['post']->post_content, $critical_page['code']) === false
+					? true
+					: $critical_page_problem;
+		}
+		if ($critical_page_problem) {
+			new PersistentAdminNotice(
+				'critical_page_problem',
+				sprintf(
+					esc_html__(
+						'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
+						'event_espresso'
+					),
+					'<a href="' . admin_url('admin.php?page=espresso_general_settings&action=critical_pages') . '">'
+					. esc_html__('Event Espresso Critical Pages Settings', 'event_espresso')
+					. '</a>'
+				)
+			);
+		}
+		if (EE_Error::has_notices()) {
+			EE_Error::get_notices(false, true);
+		}
+	}
+
+
+	/**
+	 * Returns the first post which uses the specified shortcode
+	 *
+	 * @param string $ee_shortcode usually one of the critical pages shortcodes, eg
+	 *                             ESPRESSO_THANK_YOU. So we will search fora post with the content
+	 *                             "[ESPRESSO_THANK_YOU"
+	 *                             (we don't search for the closing shortcode bracket because they might have added
+	 *                             parameter to the shortcode
+	 * @return WP_Post or NULl
+	 */
+	public static function get_page_by_ee_shortcode($ee_shortcode)
+	{
+		global $wpdb;
+		$shortcode_and_opening_bracket = '[' . $ee_shortcode;
+		$post_id                       =
+			$wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
+		if ($post_id) {
+			return get_post($post_id);
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * This function generates a post for critical espresso pages
+	 *
+	 * @param array $critical_page
+	 * @return array
+	 */
+	public static function create_critical_page($critical_page)
+	{
+
+		$post_args = [
+			'post_title'     => $critical_page['name'],
+			'post_status'    => 'publish',
+			'post_type'      => 'page',
+			'comment_status' => 'closed',
+			'post_content'   => '[' . $critical_page['code'] . ']',
+		];
+
+		$post_id = wp_insert_post($post_args);
+		if (! $post_id) {
+			$msg = sprintf(
+				esc_html__('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return $critical_page;
+		}
+		// get newly created post's details
+		if (! $critical_page['post'] = get_post($post_id)) {
+			$msg = sprintf(
+				esc_html__('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+
+		return $critical_page;
+	}
+
+
+	/**
+	 * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
+	 * The role being used to check is filterable.
+	 *
+	 * @return int|null WP_user ID or NULL
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since  4.6.0
+	 * @global WPDB $wpdb
+	 */
+	public static function get_default_creator_id()
+	{
+		global $wpdb;
+		if (! empty(self::$_default_creator_id)) {
+			return self::$_default_creator_id;
+		}/**/
+		$role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
+		// let's allow pre_filtering for early exits by alternative methods for getting id.  We check for truthy result and if so then exit early.
+		$pre_filtered_id = apply_filters(
+			'FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id',
+			false,
+			$role_to_check
+		);
+		if ($pre_filtered_id !== false) {
+			return (int) $pre_filtered_id;
+		}
+		$capabilities_key = EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
+		$query            = $wpdb->prepare(
+			"SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
+			'%' . $role_to_check . '%'
+		);
+		$user_id          = $wpdb->get_var($query);
+		$user_id          = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
+		if ($user_id && (int) $user_id) {
+			self::$_default_creator_id = (int) $user_id;
+			return self::$_default_creator_id;
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * used by EE and EE addons during plugin activation to create tables.
+	 * Its a wrapper for EventEspresso\core\services\database\TableManager::createTable,
+	 * but includes extra logic regarding activations.
+	 *
+	 * @param string  $table_name              without the $wpdb->prefix
+	 * @param string  $sql                     SQL for creating the table (contents between brackets in an SQL create
+	 *                                         table query)
+	 * @param string  $engine                  like 'ENGINE=MyISAM' or 'ENGINE=InnoDB'
+	 * @param boolean $drop_pre_existing_table set to TRUE when you want to make SURE the table is completely empty
+	 *                                         and new once this function is done (ie, you really do want to CREATE a
+	 *                                         table, and expect it to be empty once you're done) leave as FALSE when
+	 *                                         you just want to verify the table exists and matches this definition
+	 *                                         (and if it HAS data in it you want to leave it be)
+	 * @return void
+	 * @throws EE_Error if there are database errors
+	 * @throws ReflectionException
+	 */
+	public static function create_table($table_name, $sql, $engine = 'ENGINE=MyISAM ', $drop_pre_existing_table = false)
+	{
+		if (apply_filters('FHEE__EEH_Activation__create_table__short_circuit', false, $table_name, $sql)) {
+			return;
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if (! function_exists('dbDelta')) {
+			require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+		}
+		$tableAnalysis = EEH_Activation::getTableAnalysis();
+		$wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
+		// do we need to first delete an existing version of this table ?
+		if ($drop_pre_existing_table && $tableAnalysis->tableExists($wp_table_name)) {
+			// ok, delete the table... but ONLY if it's empty
+			$deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
+			// table is NOT empty, are you SURE you want to delete this table ???
+			if (! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
+				EEH_Activation::getTableManager()->dropTable($wp_table_name);
+			} elseif (! $deleted_safely) {
+				// so we should be more cautious rather than just dropping tables so easily
+				error_log(
+					sprintf(
+						esc_html__(
+							'It appears that database table "%1$s" exists when it shouldn\'t, and therefore may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend: %2$s 1. create a new COMPLETE backup of your database, %2$s 2. delete ALL tables from your database, %2$s 3. restore to your previous backup. %2$s If, however, you have not restored to a backup, then somehow your "%3$s" WordPress option could not be read. You can probably ignore this message, but should investigate why that option is being removed.',
+							'event_espresso'
+						),
+						$wp_table_name,
+						'<br/>',
+						'espresso_db_update'
+					)
+				);
+			}
+		}
+		$engine = str_replace('ENGINE=', '', $engine);
+		EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
+	}
+
+
+	/**
+	 * Checks if this column already exists on the specified table. Handy for addons which want to add a column
+	 *
+	 * @param string $table_name  (without "wp_", eg "esp_attendee"
+	 * @param string $column_name
+	 * @param string $column_info if your SQL were 'ALTER TABLE table_name ADD price VARCHAR(10)', this would be
+	 *                            'VARCHAR(10)'
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated instead use TableManager::addColumn()
+	 */
+	public static function add_column_if_it_doesnt_exist(
+		$table_name,
+		$column_name,
+		$column_info = 'INT UNSIGNED NOT NULL'
+	) {
+		return EEH_Activation::getTableManager()->addColumn($table_name, $column_name, $column_info);
+	}
+
+
+	/**
+	 * Gets all the fields on the database table.
+	 *
+	 * @param string $table_name , without prefixed $wpdb->prefix
+	 * @return array of database column names
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated instead use TableManager::getTableColumns()
+	 */
+	public static function get_fields_on_table($table_name = null)
+	{
+		return EEH_Activation::getTableManager()->getTableColumns($table_name);
+	}
+
+
+	/**
+	 * @param string $table_name
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated instead use TableAnalysis::tableIsEmpty()
+	 */
+	public static function db_table_is_empty($table_name)
+	{
+		return EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
+	}
+
+
+	/**
+	 * @param string $table_name
+	 * @return bool | int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function delete_db_table_if_empty($table_name)
+	{
+		if (EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name)) {
+			return EEH_Activation::getTableManager()->dropTable($table_name);
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param string $table_name
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated instead use TableManager::dropTable()
+	 */
+	public static function delete_unused_db_table($table_name)
+	{
+		return EEH_Activation::getTableManager()->dropTable($table_name);
+	}
+
+
+	/**
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated instead use TableManager::dropIndex()
+	 */
+	public static function drop_index($table_name, $index_name)
+	{
+		return EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
+	}
+
+
+	/**
+	 * @return boolean success (whether database is setup properly or not)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function create_database_tables()
+	{
+		EE_Registry::instance()->load_core('Data_Migration_Manager');
+		// find the migration script that sets the database to be compatible with the code
+		$dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
+		if (! $dms_name) {
+			EE_Error::add_error(
+				esc_html__(
+					'Could not determine most up-to-date data migration script from which to pull database schema
                      structure. So database is probably not setup properly',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $current_data_migration_script = EE_Registry::instance()->load_dms($dms_name);
-        $current_data_migration_script->set_migrating(false);
-        $current_data_migration_script->schema_changes_before_migration();
-        $current_data_migration_script->schema_changes_after_migration();
-        if ($current_data_migration_script->get_errors()) {
-            if (WP_DEBUG) {
-                foreach ($current_data_migration_script->get_errors() as $error) {
-                    EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'There were errors creating the Event Espresso database tables and Event Espresso has been
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$current_data_migration_script = EE_Registry::instance()->load_dms($dms_name);
+		$current_data_migration_script->set_migrating(false);
+		$current_data_migration_script->schema_changes_before_migration();
+		$current_data_migration_script->schema_changes_after_migration();
+		if ($current_data_migration_script->get_errors()) {
+			if (WP_DEBUG) {
+				foreach ($current_data_migration_script->get_errors() as $error) {
+					EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'There were errors creating the Event Espresso database tables and Event Espresso has been
                             deactivated. To view the errors, please enable WP_DEBUG in your wp-config.php file.',
-                        'event_espresso'
-                    )
-                );
-            }
-            return false;
-        }
-        EE_Data_Migration_Manager::instance()->update_current_database_state_to();
-        return true;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function initialize_system_questions()
-    {
-        // QUESTION GROUPS
-        global $wpdb;
-        $table_name = EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group');
-        $SQL        = "SELECT QSG_system FROM $table_name WHERE QSG_system != 0";
-        // what we have
-        $question_groups = $wpdb->get_col($SQL);
-        // check the response
-        $question_groups = is_array($question_groups) ? $question_groups : [];
-        // what we should have
-        $QSG_systems = [1, 2];
-        // loop thru what we should have and compare to what we have
-        foreach ($QSG_systems as $QSG_system) {
-            // reset values array
-            $QSG_values = [];
-            // if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
-            if (! in_array("$QSG_system", $question_groups)) {
-                // add it
-                switch ($QSG_system) {
-                    case 1:
-                        $QSG_values = [
-                            'QSG_name'            => esc_html__('Personal Information', 'event_espresso'),
-                            'QSG_identifier'      => 'personal-information-' . time(),
-                            'QSG_desc'            => '',
-                            'QSG_order'           => 1,
-                            'QSG_show_group_name' => 1,
-                            'QSG_show_group_desc' => 1,
-                            'QSG_system'          => EEM_Question_Group::system_personal,
-                            'QSG_deleted'         => 0,
-                        ];
-                        break;
-                    case 2:
-                        $QSG_values = [
-                            'QSG_name'            => esc_html__('Address Information', 'event_espresso'),
-                            'QSG_identifier'      => 'address-information-' . time(),
-                            'QSG_desc'            => '',
-                            'QSG_order'           => 2,
-                            'QSG_show_group_name' => 1,
-                            'QSG_show_group_desc' => 1,
-                            'QSG_system'          => EEM_Question_Group::system_address,
-                            'QSG_deleted'         => 0,
-                        ];
-                        break;
-                }
-                // make sure we have some values before inserting them
-                if (! empty($QSG_values)) {
-                    // insert system question
-                    $wpdb->insert(
-                        $table_name,
-                        $QSG_values,
-                        ['%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d']
-                    );
-                    $QSG_IDs[ $QSG_system ] = $wpdb->insert_id;
-                }
-            }
-        }
-        // QUESTIONS
-        global $wpdb;
-        $table_name = EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question');
-        $SQL        = "SELECT QST_system FROM $table_name WHERE QST_system != ''";
-        // what we have
-        $questions = $wpdb->get_col($SQL);
-        // all system questions
-        $personal_system_group_questions = ['fname', 'lname', 'email'];
-        $address_system_group_questions  = ['address', 'address2', 'city', 'country', 'state', 'zip', 'phone'];
-        $system_questions_not_in_group   = ['email_confirm'];
-        // merge all of the system questions we should have
-        $QST_systems       = array_merge(
-            $personal_system_group_questions,
-            $address_system_group_questions,
-            $system_questions_not_in_group
-        );
-        $order_for_group_1 = 1;
-        $order_for_group_2 = 1;
-        // loop thru what we should have and compare to what we have
-        foreach ($QST_systems as $QST_system) {
-            // reset values array
-            $QST_values = [];
-            // if we don't have what we should have
-            if (! in_array($QST_system, $questions)) {
-                // add it
-                switch ($QST_system) {
-                    case 'fname':
-                        $QST_values = [
-                            'QST_display_text'  => esc_html__('First Name', 'event_espresso'),
-                            'QST_admin_label'   => esc_html__('First Name - System Question', 'event_espresso'),
-                            'QST_system'        => 'fname',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 1,
-                            'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
-                            'QST_order'         => 1,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        ];
-                        break;
-                    case 'lname':
-                        $QST_values = [
-                            'QST_display_text'  => esc_html__('Last Name', 'event_espresso'),
-                            'QST_admin_label'   => esc_html__('Last Name - System Question', 'event_espresso'),
-                            'QST_system'        => 'lname',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 1,
-                            'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
-                            'QST_order'         => 2,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        ];
-                        break;
-                    case 'email':
-                        $QST_values = [
-                            'QST_display_text'  => esc_html__('Email Address', 'event_espresso'),
-                            'QST_admin_label'   => esc_html__('Email Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'email',
-                            'QST_type'          => 'EMAIL',
-                            'QST_required'      => 1,
-                            'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
-                            'QST_order'         => 3,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        ];
-                        break;
-                    case 'email_confirm':
-                        $QST_values = [
-                            'QST_display_text'  => esc_html__('Confirm Email Address', 'event_espresso'),
-                            'QST_admin_label'   => esc_html__('Confirm Email Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'email_confirm',
-                            'QST_type'          => 'EMAIL_CONFIRM',
-                            'QST_required'      => 1,
-                            'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
-                            'QST_order'         => 4,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        ];
-                        break;
-                    case 'address':
-                        $QST_values = [
-                            'QST_display_text'  => esc_html__('Address', 'event_espresso'),
-                            'QST_admin_label'   => esc_html__('Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'address',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
-                            'QST_order'         => 5,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        ];
-                        break;
-                    case 'address2':
-                        $QST_values = [
-                            'QST_display_text'  => esc_html__('Address2', 'event_espresso'),
-                            'QST_admin_label'   => esc_html__('Address2 - System Question', 'event_espresso'),
-                            'QST_system'        => 'address2',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
-                            'QST_order'         => 6,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        ];
-                        break;
-                    case 'city':
-                        $QST_values = [
-                            'QST_display_text'  => esc_html__('City', 'event_espresso'),
-                            'QST_admin_label'   => esc_html__('City - System Question', 'event_espresso'),
-                            'QST_system'        => 'city',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
-                            'QST_order'         => 7,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        ];
-                        break;
-                    case 'country':
-                        $QST_values = [
-                            'QST_display_text'  => esc_html__('Country', 'event_espresso'),
-                            'QST_admin_label'   => esc_html__('Country - System Question', 'event_espresso'),
-                            'QST_system'        => 'country',
-                            'QST_type'          => 'COUNTRY',
-                            'QST_required'      => 0,
-                            'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
-                            'QST_order'         => 8,
-                            'QST_admin_only'    => 0,
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        ];
-                        break;
-                    case 'state':
-                        $QST_values = [
-                            'QST_display_text'  => esc_html__('State/Province', 'event_espresso'),
-                            'QST_admin_label'   => esc_html__('State/Province - System Question', 'event_espresso'),
-                            'QST_system'        => 'state',
-                            'QST_type'          => 'STATE',
-                            'QST_required'      => 0,
-                            'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
-                            'QST_order'         => 9,
-                            'QST_admin_only'    => 0,
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        ];
-                        break;
-                    case 'zip':
-                        $QST_values = [
-                            'QST_display_text'  => esc_html__('Zip/Postal Code', 'event_espresso'),
-                            'QST_admin_label'   => esc_html__('Zip/Postal Code - System Question', 'event_espresso'),
-                            'QST_system'        => 'zip',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
-                            'QST_order'         => 10,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        ];
-                        break;
-                    case 'phone':
-                        $QST_values = [
-                            'QST_display_text'  => esc_html__('Phone Number', 'event_espresso'),
-                            'QST_admin_label'   => esc_html__('Phone Number - System Question', 'event_espresso'),
-                            'QST_system'        => 'phone',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
-                            'QST_order'         => 11,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        ];
-                        break;
-                }
-                if (! empty($QST_values)) {
-                    // insert system question
-                    $wpdb->insert(
-                        $table_name,
-                        $QST_values,
-                        ['%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d']
-                    );
-                    $QST_ID = $wpdb->insert_id;
-
-                    // QUESTION GROUP QUESTIONS
-                    if (in_array($QST_system, $personal_system_group_questions)) {
-                        $system_question_we_want = EEM_Question_Group::system_personal;
-                    } elseif (in_array($QST_system, $address_system_group_questions)) {
-                        $system_question_we_want = EEM_Question_Group::system_address;
-                    } else {
-                        // QST_system should not be assigned to any group
-                        continue;
-                    }
-                    if (isset($QSG_IDs[ $system_question_we_want ])) {
-                        $QSG_ID = $QSG_IDs[ $system_question_we_want ];
-                    } else {
-                        $id_col = EEM_Question_Group::instance()
-                                                    ->get_col([['QSG_system' => $system_question_we_want]]);
-                        if (is_array($id_col)) {
-                            $QSG_ID = reset($id_col);
-                        } else {
-                            // ok so we didn't find it in the db either?? that's weird because we should have inserted it at the start of this method
-                            EE_Log::instance()->log(
-                                __FILE__,
-                                __FUNCTION__,
-                                sprintf(
-                                    esc_html__(
-                                        'Could not associate question %1$s to a question group because no system question
+						'event_espresso'
+					)
+				);
+			}
+			return false;
+		}
+		EE_Data_Migration_Manager::instance()->update_current_database_state_to();
+		return true;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function initialize_system_questions()
+	{
+		// QUESTION GROUPS
+		global $wpdb;
+		$table_name = EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group');
+		$SQL        = "SELECT QSG_system FROM $table_name WHERE QSG_system != 0";
+		// what we have
+		$question_groups = $wpdb->get_col($SQL);
+		// check the response
+		$question_groups = is_array($question_groups) ? $question_groups : [];
+		// what we should have
+		$QSG_systems = [1, 2];
+		// loop thru what we should have and compare to what we have
+		foreach ($QSG_systems as $QSG_system) {
+			// reset values array
+			$QSG_values = [];
+			// if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
+			if (! in_array("$QSG_system", $question_groups)) {
+				// add it
+				switch ($QSG_system) {
+					case 1:
+						$QSG_values = [
+							'QSG_name'            => esc_html__('Personal Information', 'event_espresso'),
+							'QSG_identifier'      => 'personal-information-' . time(),
+							'QSG_desc'            => '',
+							'QSG_order'           => 1,
+							'QSG_show_group_name' => 1,
+							'QSG_show_group_desc' => 1,
+							'QSG_system'          => EEM_Question_Group::system_personal,
+							'QSG_deleted'         => 0,
+						];
+						break;
+					case 2:
+						$QSG_values = [
+							'QSG_name'            => esc_html__('Address Information', 'event_espresso'),
+							'QSG_identifier'      => 'address-information-' . time(),
+							'QSG_desc'            => '',
+							'QSG_order'           => 2,
+							'QSG_show_group_name' => 1,
+							'QSG_show_group_desc' => 1,
+							'QSG_system'          => EEM_Question_Group::system_address,
+							'QSG_deleted'         => 0,
+						];
+						break;
+				}
+				// make sure we have some values before inserting them
+				if (! empty($QSG_values)) {
+					// insert system question
+					$wpdb->insert(
+						$table_name,
+						$QSG_values,
+						['%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d']
+					);
+					$QSG_IDs[ $QSG_system ] = $wpdb->insert_id;
+				}
+			}
+		}
+		// QUESTIONS
+		global $wpdb;
+		$table_name = EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question');
+		$SQL        = "SELECT QST_system FROM $table_name WHERE QST_system != ''";
+		// what we have
+		$questions = $wpdb->get_col($SQL);
+		// all system questions
+		$personal_system_group_questions = ['fname', 'lname', 'email'];
+		$address_system_group_questions  = ['address', 'address2', 'city', 'country', 'state', 'zip', 'phone'];
+		$system_questions_not_in_group   = ['email_confirm'];
+		// merge all of the system questions we should have
+		$QST_systems       = array_merge(
+			$personal_system_group_questions,
+			$address_system_group_questions,
+			$system_questions_not_in_group
+		);
+		$order_for_group_1 = 1;
+		$order_for_group_2 = 1;
+		// loop thru what we should have and compare to what we have
+		foreach ($QST_systems as $QST_system) {
+			// reset values array
+			$QST_values = [];
+			// if we don't have what we should have
+			if (! in_array($QST_system, $questions)) {
+				// add it
+				switch ($QST_system) {
+					case 'fname':
+						$QST_values = [
+							'QST_display_text'  => esc_html__('First Name', 'event_espresso'),
+							'QST_admin_label'   => esc_html__('First Name - System Question', 'event_espresso'),
+							'QST_system'        => 'fname',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 1,
+							'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
+							'QST_order'         => 1,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						];
+						break;
+					case 'lname':
+						$QST_values = [
+							'QST_display_text'  => esc_html__('Last Name', 'event_espresso'),
+							'QST_admin_label'   => esc_html__('Last Name - System Question', 'event_espresso'),
+							'QST_system'        => 'lname',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 1,
+							'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
+							'QST_order'         => 2,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						];
+						break;
+					case 'email':
+						$QST_values = [
+							'QST_display_text'  => esc_html__('Email Address', 'event_espresso'),
+							'QST_admin_label'   => esc_html__('Email Address - System Question', 'event_espresso'),
+							'QST_system'        => 'email',
+							'QST_type'          => 'EMAIL',
+							'QST_required'      => 1,
+							'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
+							'QST_order'         => 3,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						];
+						break;
+					case 'email_confirm':
+						$QST_values = [
+							'QST_display_text'  => esc_html__('Confirm Email Address', 'event_espresso'),
+							'QST_admin_label'   => esc_html__('Confirm Email Address - System Question', 'event_espresso'),
+							'QST_system'        => 'email_confirm',
+							'QST_type'          => 'EMAIL_CONFIRM',
+							'QST_required'      => 1,
+							'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
+							'QST_order'         => 4,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						];
+						break;
+					case 'address':
+						$QST_values = [
+							'QST_display_text'  => esc_html__('Address', 'event_espresso'),
+							'QST_admin_label'   => esc_html__('Address - System Question', 'event_espresso'),
+							'QST_system'        => 'address',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
+							'QST_order'         => 5,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						];
+						break;
+					case 'address2':
+						$QST_values = [
+							'QST_display_text'  => esc_html__('Address2', 'event_espresso'),
+							'QST_admin_label'   => esc_html__('Address2 - System Question', 'event_espresso'),
+							'QST_system'        => 'address2',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
+							'QST_order'         => 6,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						];
+						break;
+					case 'city':
+						$QST_values = [
+							'QST_display_text'  => esc_html__('City', 'event_espresso'),
+							'QST_admin_label'   => esc_html__('City - System Question', 'event_espresso'),
+							'QST_system'        => 'city',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
+							'QST_order'         => 7,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						];
+						break;
+					case 'country':
+						$QST_values = [
+							'QST_display_text'  => esc_html__('Country', 'event_espresso'),
+							'QST_admin_label'   => esc_html__('Country - System Question', 'event_espresso'),
+							'QST_system'        => 'country',
+							'QST_type'          => 'COUNTRY',
+							'QST_required'      => 0,
+							'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
+							'QST_order'         => 8,
+							'QST_admin_only'    => 0,
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						];
+						break;
+					case 'state':
+						$QST_values = [
+							'QST_display_text'  => esc_html__('State/Province', 'event_espresso'),
+							'QST_admin_label'   => esc_html__('State/Province - System Question', 'event_espresso'),
+							'QST_system'        => 'state',
+							'QST_type'          => 'STATE',
+							'QST_required'      => 0,
+							'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
+							'QST_order'         => 9,
+							'QST_admin_only'    => 0,
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						];
+						break;
+					case 'zip':
+						$QST_values = [
+							'QST_display_text'  => esc_html__('Zip/Postal Code', 'event_espresso'),
+							'QST_admin_label'   => esc_html__('Zip/Postal Code - System Question', 'event_espresso'),
+							'QST_system'        => 'zip',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
+							'QST_order'         => 10,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						];
+						break;
+					case 'phone':
+						$QST_values = [
+							'QST_display_text'  => esc_html__('Phone Number', 'event_espresso'),
+							'QST_admin_label'   => esc_html__('Phone Number - System Question', 'event_espresso'),
+							'QST_system'        => 'phone',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => esc_html__('This field is required', 'event_espresso'),
+							'QST_order'         => 11,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						];
+						break;
+				}
+				if (! empty($QST_values)) {
+					// insert system question
+					$wpdb->insert(
+						$table_name,
+						$QST_values,
+						['%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d']
+					);
+					$QST_ID = $wpdb->insert_id;
+
+					// QUESTION GROUP QUESTIONS
+					if (in_array($QST_system, $personal_system_group_questions)) {
+						$system_question_we_want = EEM_Question_Group::system_personal;
+					} elseif (in_array($QST_system, $address_system_group_questions)) {
+						$system_question_we_want = EEM_Question_Group::system_address;
+					} else {
+						// QST_system should not be assigned to any group
+						continue;
+					}
+					if (isset($QSG_IDs[ $system_question_we_want ])) {
+						$QSG_ID = $QSG_IDs[ $system_question_we_want ];
+					} else {
+						$id_col = EEM_Question_Group::instance()
+													->get_col([['QSG_system' => $system_question_we_want]]);
+						if (is_array($id_col)) {
+							$QSG_ID = reset($id_col);
+						} else {
+							// ok so we didn't find it in the db either?? that's weird because we should have inserted it at the start of this method
+							EE_Log::instance()->log(
+								__FILE__,
+								__FUNCTION__,
+								sprintf(
+									esc_html__(
+										'Could not associate question %1$s to a question group because no system question
                                          group existed',
-                                        'event_espresso'
-                                    ),
-                                    $QST_ID
-                                ),
-                                'error'
-                            );
-                            continue;
-                        }
-                    }
-                    // add system questions to groups
-                    $wpdb->insert(
-                        EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
-                        [
-                            'QSG_ID'    => $QSG_ID,
-                            'QST_ID'    => $QST_ID,
-                            'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
-                        ],
-                        ['%d', '%d', '%d']
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Makes sure the default payment method (Invoice) is active.
-     * This used to be done automatically as part of constructing the old gateways config
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function insert_default_payment_methods()
-    {
-        if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
-        } else {
-            EEM_Payment_Method::instance()->verify_button_urls();
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function insert_default_status_codes()
-    {
-
-        global $wpdb;
-
-        if (EEH_Activation::getTableAnalysis()->tableExists(EEM_Status::instance()->table())) {
-            $table_name = EEM_Status::instance()->table();
-
-            $SQL =
-                "DELETE FROM $table_name WHERE STS_ID IN ( 'ACT', 'NAC', 'NOP', 'OPN', 'CLS', 'PND', 'ONG', 'SEC', 'DRF', 'DEL', 'DEN', 'EXP', 'RPP', 'RCN', 'RDC', 'RAP', 'RNA', 'RWL', 'TAB', 'TIN', 'TFL', 'TCM', 'TOP', 'PAP', 'PCN', 'PFL', 'PDC', 'EDR', 'ESN', 'PPN', 'RIC', 'MSN', 'MFL', 'MID', 'MRS', 'MIC', 'MDO', 'MEX' );";
-            $wpdb->query($SQL);
-
-            $SQL = "INSERT INTO $table_name
+										'event_espresso'
+									),
+									$QST_ID
+								),
+								'error'
+							);
+							continue;
+						}
+					}
+					// add system questions to groups
+					$wpdb->insert(
+						EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
+						[
+							'QSG_ID'    => $QSG_ID,
+							'QST_ID'    => $QST_ID,
+							'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
+						],
+						['%d', '%d', '%d']
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Makes sure the default payment method (Invoice) is active.
+	 * This used to be done automatically as part of constructing the old gateways config
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function insert_default_payment_methods()
+	{
+		if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
+		} else {
+			EEM_Payment_Method::instance()->verify_button_urls();
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function insert_default_status_codes()
+	{
+
+		global $wpdb;
+
+		if (EEH_Activation::getTableAnalysis()->tableExists(EEM_Status::instance()->table())) {
+			$table_name = EEM_Status::instance()->table();
+
+			$SQL =
+				"DELETE FROM $table_name WHERE STS_ID IN ( 'ACT', 'NAC', 'NOP', 'OPN', 'CLS', 'PND', 'ONG', 'SEC', 'DRF', 'DEL', 'DEN', 'EXP', 'RPP', 'RCN', 'RDC', 'RAP', 'RNA', 'RWL', 'TAB', 'TIN', 'TFL', 'TCM', 'TOP', 'PAP', 'PCN', 'PFL', 'PDC', 'EDR', 'ESN', 'PPN', 'RIC', 'MSN', 'MFL', 'MID', 'MRS', 'MIC', 'MDO', 'MEX' );";
+			$wpdb->query($SQL);
+
+			$SQL = "INSERT INTO $table_name
 					(STS_ID, STS_code, STS_type, STS_can_edit, STS_desc, STS_open) VALUES
 					('ACT', 'ACTIVE', 'event', 0, NULL, 1),
 					('NAC', 'NOT_ACTIVE', 'event', 0, NULL, 0),
@@ -1190,466 +1190,466 @@ 
 					('MID', 'IDLE', 'message', 0, NULL, 1),
 					('MRS', 'RESEND', 'message', 0, NULL, 1),
 					('MIC', 'INCOMPLETE', 'message', 0, NULL, 0);";
-            $wpdb->query($SQL);
-        }
-    }
-
-
-    /**
-     * @return bool     true means new templates were created.
-     *                  false means no templates were created.
-     *                  This is NOT an error flag. To check for errors you will want
-     *                  to use either EE_Error or a try catch for an EE_Error exception.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_default_message_templates()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        /*
+			$wpdb->query($SQL);
+		}
+	}
+
+
+	/**
+	 * @return bool     true means new templates were created.
+	 *                  false means no templates were created.
+	 *                  This is NOT an error flag. To check for errors you will want
+	 *                  to use either EE_Error or a try catch for an EE_Error exception.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_default_message_templates()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		/*
          * This first method is taking care of ensuring any default messengers
          * that should be made active and have templates generated are done.
          */
-        $new_templates_created_for_messenger = self::_activate_and_generate_default_messengers_and_message_templates(
-            $message_resource_manager
-        );
-        /**
-         * This method is verifying there are no NEW default message types
-         * for ACTIVE messengers that need activated (and corresponding templates setup).
-         */
-        $new_templates_created_for_message_type =
-            self::_activate_new_message_types_for_active_messengers_and_generate_default_templates(
-                $message_resource_manager
-            );
-        // after all is done, let's persist these changes to the db.
-        $message_resource_manager->update_has_activated_messengers_option();
-        $message_resource_manager->update_active_messengers_option();
-        // will return true if either of these are true.  Otherwise will return false.
-        return $new_templates_created_for_message_type || $new_templates_created_for_messenger;
-    }
-
-
-    /**
-     * @param EE_Message_Resource_Manager $message_resource_manager
-     * @return array|bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        $active_messengers       = $message_resource_manager->active_messengers();
-        $installed_message_types = $message_resource_manager->installed_message_types();
-        $templates_created       = false;
-        foreach ($active_messengers as $active_messenger) {
-            $default_message_type_names_for_messenger = $active_messenger->get_default_message_types();
-            $default_message_type_names_to_activate   = [];
-            // looping through each default message type reported by the messenger
-            // and setup the actual message types to activate.
-            foreach ($default_message_type_names_for_messenger as $default_message_type_name_for_messenger) {
-                // if already active or has already been activated before we skip
-                // (otherwise we might reactivate something user's intentionally deactivated.)
-                // we also skip if the message type is not installed.
-                if (
-                    $message_resource_manager->has_message_type_been_activated_for_messenger(
-                        $default_message_type_name_for_messenger,
-                        $active_messenger->name
-                    )
-                    || $message_resource_manager->is_message_type_active_for_messenger(
-                        $active_messenger->name,
-                        $default_message_type_name_for_messenger
-                    )
-                    || ! isset($installed_message_types[ $default_message_type_name_for_messenger ])
-                ) {
-                    continue;
-                }
-                $default_message_type_names_to_activate[] = $default_message_type_name_for_messenger;
-            }
-            // let's activate!
-            $message_resource_manager->ensure_message_types_are_active(
-                $default_message_type_names_to_activate,
-                $active_messenger->name,
-                false
-            );
-            // activate the templates for these message types
-            if (! empty($default_message_type_names_to_activate)) {
-                $templates_created = EEH_MSG_Template::generate_new_templates(
-                    $active_messenger->name,
-                    $default_message_type_names_for_messenger,
-                    '',
-                    true
-                );
-            }
-        }
-        return $templates_created;
-    }
-
-
-    /**
-     * This will activate and generate default messengers and default message types for those messengers.
-     *
-     * @param EE_message_Resource_Manager $message_resource_manager
-     * @return array|bool  True means there were default messengers and message type templates generated.
-     *                     False means that there were no templates generated
-     *                     (which could simply mean there are no default message types for a messenger).
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function _activate_and_generate_default_messengers_and_message_templates(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        $messengers_to_generate  = self::_get_default_messengers_to_generate_on_activation($message_resource_manager);
-        $installed_message_types = $message_resource_manager->installed_message_types();
-        $templates_generated     = false;
-        foreach ($messengers_to_generate as $messenger_to_generate) {
-            $default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
-            // verify the default message types match an installed message type.
-            foreach ($default_message_type_names_for_messenger as $key => $name) {
-                if (
-                    ! isset($installed_message_types[ $name ])
-                    || $message_resource_manager->has_message_type_been_activated_for_messenger(
-                        $name,
-                        $messenger_to_generate->name
-                    )
-                ) {
-                    unset($default_message_type_names_for_messenger[ $key ]);
-                }
-            }
-            // in previous iterations, the active_messengers option in the db
-            // needed updated before calling create templates. however with the changes this may not be necessary.
-            // This comment is left here just in case we discover that we _do_ need to update before
-            // passing off to create templates (after the refactor is done).
-            // @todo remove this comment when determined not necessary.
-            $message_resource_manager->activate_messenger(
-                $messenger_to_generate,
-                $default_message_type_names_for_messenger,
-                false
-            );
-            // create any templates needing created (or will reactivate templates already generated as necessary).
-            if (! empty($default_message_type_names_for_messenger)) {
-                $templates_generated = EEH_MSG_Template::generate_new_templates(
-                    $messenger_to_generate->name,
-                    $default_message_type_names_for_messenger,
-                    '',
-                    true
-                );
-            }
-        }
-        return $templates_generated;
-    }
-
-
-    /**
-     * This returns the default messengers to generate templates for on activation of EE.
-     * It considers:
-     * - whether a messenger is already active in the db.
-     * - whether a messenger has been made active at any time in the past.
-     *
-     * @param EE_Message_Resource_Manager $message_resource_manager
-     * @return EE_messenger[]
-     */
-    protected static function _get_default_messengers_to_generate_on_activation(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        $active_messengers    = $message_resource_manager->active_messengers();
-        $installed_messengers = $message_resource_manager->installed_messengers();
-        $has_activated        = $message_resource_manager->get_has_activated_messengers_option();
-
-        $messengers_to_generate = [];
-        foreach ($installed_messengers as $installed_messenger) {
-            // if installed messenger is a messenger that should be activated on install
-            // and is not already active
-            // and has never been activated
-            if (
-                ! $installed_messenger->activate_on_install
-                || isset($active_messengers[ $installed_messenger->name ])
-                || isset($has_activated[ $installed_messenger->name ])
-            ) {
-                continue;
-            }
-            $messengers_to_generate[ $installed_messenger->name ] = $installed_messenger;
-        }
-        return $messengers_to_generate;
-    }
-
-
-    /**
-     * This simply validates active message types to ensure they actually match installed
-     * message types.  If there's a mismatch then we deactivate the message type and ensure all related db
-     * rows are set inactive.
-     * Note: Messengers are no longer validated here as of 4.9.0 because they get validated automatically whenever
-     * EE_Messenger_Resource_Manager is constructed.  Message Types are a bit more resource heavy for validation so they
-     * are still handled in here.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.3.1
-     */
-    public static function validate_messages_system()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $message_resource_manager->validate_active_message_types_are_installed();
-        do_action('AHEE__EEH_Activation__validate_messages_system');
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function plugin_deactivation()
-    {
-    }
-
-
-    /**
-     * Finds all our EE4 custom post types, and deletes them and their associated data
-     * (like post meta or term relations)
-     *
-     * @throws EE_Error
-     * @global wpdb $wpdb
-     */
-    public static function delete_all_espresso_cpt_data()
-    {
-        global $wpdb;
-        // get all the CPT post_types
-        $ee_post_types = [];
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func([$model_name, 'instance']);
-                if ($model_obj instanceof EEM_CPT_Base) {
-                    $ee_post_types[] = $wpdb->prepare("%s", $model_obj->post_type());
-                }
-            }
-        }
-        // get all our CPTs
-        $query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
-        $cpt_ids = $wpdb->get_col($query);
-        // delete each post meta and term relations too
-        foreach ($cpt_ids as $post_id) {
-            wp_delete_post($post_id, true);
-        }
-    }
-
-
-    /**
-     * Deletes all EE custom tables
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function drop_espresso_tables()
-    {
-        $tables = [];
-        // load registry
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func([$model_name, 'instance']);
-                if ($model_obj instanceof EEM_Base) {
-                    foreach ($model_obj->get_tables() as $table) {
-                        if (
-                            strpos($table->get_table_name(), 'esp_')
-                            && (
-                                is_main_site()// main site? nuke them all
-                                || ! $table->is_global()// not main site,but not global either. nuke it
-                            )
-                        ) {
-                            $tables[ $table->get_table_name() ] = $table->get_table_name();
-                        }
-                    }
-                }
-            }
-        }
-
-        // there are some tables whose models were removed.
-        // they should be removed when removing all EE core's data
-        $tables_without_models = [
-            'esp_promotion',
-            'esp_promotion_applied',
-            'esp_promotion_object',
-            'esp_promotion_rule',
-            'esp_rule',
-        ];
-        foreach ($tables_without_models as $table) {
-            $tables[ $table ] = $table;
-        }
-        return EEH_Activation::getTableManager()->dropTables($tables);
-    }
-
-
-    /**
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
-     * each table name provided has a wpdb prefix attached, and that it exists.
-     * Returns the list actually deleted
-     *
-     * @param array $table_names
-     * @return array of table names which we deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated in 4.9.13. Instead use TableManager::dropTables()
-     * @global WPDB $wpdb
-     */
-    public static function drop_tables($table_names)
-    {
-        return EEH_Activation::getTableManager()->dropTables($table_names);
-    }
-
-
-    /**
-     * plugin_uninstall
-     *
-     * @param bool $remove_all
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function delete_all_espresso_tables_and_data($remove_all = true)
-    {
-        global $wpdb;
-        self::drop_espresso_tables();
-        $wp_options_to_delete = [
-            'ee_no_ticket_prices'                        => true,
-            'ee_active_messengers'                       => true,
-            'ee_has_activated_messenger'                 => true,
-            RewriteRules::OPTION_KEY_FLUSH_REWRITE_RULES => true,
-            'ee_config'                                  => false,
-            'ee_data_migration_current_db_state'         => true,
-            'ee_data_migration_mapping_'                 => false,
-            'ee_data_migration_script_'                  => false,
-            'ee_data_migrations'                         => true,
-            'ee_dms_map'                                 => false,
-            'ee_notices'                                 => true,
-            'lang_file_check_'                           => false,
-            'ee_maintenance_mode'                        => true,
-            'ee_ueip_optin'                              => true,
-            'ee_ueip_has_notified'                       => true,
-            'ee_plugin_activation_errors'                => true,
-            'ee_id_mapping_from'                         => false,
-            'espresso_persistent_admin_notices'          => true,
-            'ee_encryption_key'                          => true,
-            'pue_force_upgrade_'                         => false,
-            'pue_json_error_'                            => false,
-            'pue_install_key_'                           => false,
-            'pue_verification_error_'                    => false,
-            'pu_dismissed_upgrade_'                      => false,
-            'external_updates-'                          => false,
-            'ee_extra_data'                              => true,
-            'ee_ssn_'                                    => false,
-            'ee_rss_'                                    => false,
-            'ee_rte_n_tx_'                               => false,
-            'ee_pers_admin_notices'                      => true,
-            'ee_job_parameters_'                         => false,
-            'ee_upload_directories_incomplete'           => true,
-            'ee_verified_db_collations'                  => true,
-        ];
-        if (is_main_site()) {
-            $wp_options_to_delete['ee_network_config'] = true;
-        }
-        $undeleted_options = [];
-        foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
-            if ($no_wildcard) {
-                if (! delete_option($option_name)) {
-                    $undeleted_options[] = $option_name;
-                }
-            } else {
-                $option_names_to_delete_from_wildcard =
-                    $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
-                foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
-                    if (! delete_option($option_name_from_wildcard)) {
-                        $undeleted_options[] = $option_name_from_wildcard;
-                    }
-                }
-            }
-        }
-        // also, let's make sure the "ee_config_option_names" wp option stays out by removing the action that adds it
-        remove_action('shutdown', [EE_Config::instance(), 'shutdown']);
-        if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
-            $db_update_sans_ee4 = [];
-            foreach ($espresso_db_update as $version => $times_activated) {
-                if ((string) $version[0] === '3') {// if its NON EE4
-                    $db_update_sans_ee4[ $version ] = $times_activated;
-                }
-            }
-            update_option('espresso_db_update', $db_update_sans_ee4);
-        }
-        $errors = '';
-        if (! empty($undeleted_options)) {
-            $errors .= sprintf(
-                esc_html__('The following wp-options could not be deleted: %s%s', 'event_espresso'),
-                '<br/>',
-                implode(',<br/>', $undeleted_options)
-            );
-        }
-        if (! empty($errors)) {
-            EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-    /**
-     * Gets the mysql error code from the last used query by wpdb
-     *
-     * @return int mysql error code, see https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
-     */
-    public static function last_wpdb_error_code()
-    {
-        // phpcs:disable PHPCompatibility.Extensions.RemovedExtensions.mysql_DeprecatedRemoved
-        global $wpdb;
-        return $wpdb->use_mysqli ? mysqli_errno($wpdb->dbh) : 0;
-        // phpcs:enable
-    }
-
-
-    /**
-     * Checks that the database table exists. Also works on temporary tables (for unit tests mostly).
-     *
-     * @param string $table_name with or without $wpdb->prefix
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @global wpdb  $wpdb
-     * @deprecated instead use TableAnalysis::tableExists()
-     */
-    public static function table_exists($table_name)
-    {
-        return EEH_Activation::getTableAnalysis()->tableExists($table_name);
-    }
-
-
-    /**
-     * Resets the cache on EEH_Activation
-     */
-    public static function reset()
-    {
-        self::$_default_creator_id                             = null;
-        self::$_initialized_db_content_already_in_this_request = false;
-    }
-
-
-    /**
-     * Removes 'email_confirm' from the Address info question group on activation
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public static function removeEmailConfirmFromAddressGroup()
-    {
-
-        // Pull the email_confirm question ID.
-        $email_confirm_question_id = EEM_Question::instance()->get_Question_ID_from_system_string(
-            EEM_Attendee::system_question_email_confirm
-        );
-        // Remove the email_confirm question group from the address group questions.
-        EEM_Question_Group_Question::instance()->delete(
-            [
-                [
-                    'QST_ID'                    => $email_confirm_question_id,
-                    'Question_Group.QSG_system' => EEM_Question_Group::system_address,
-                ],
-            ]
-        );
-    }
+		$new_templates_created_for_messenger = self::_activate_and_generate_default_messengers_and_message_templates(
+			$message_resource_manager
+		);
+		/**
+		 * This method is verifying there are no NEW default message types
+		 * for ACTIVE messengers that need activated (and corresponding templates setup).
+		 */
+		$new_templates_created_for_message_type =
+			self::_activate_new_message_types_for_active_messengers_and_generate_default_templates(
+				$message_resource_manager
+			);
+		// after all is done, let's persist these changes to the db.
+		$message_resource_manager->update_has_activated_messengers_option();
+		$message_resource_manager->update_active_messengers_option();
+		// will return true if either of these are true.  Otherwise will return false.
+		return $new_templates_created_for_message_type || $new_templates_created_for_messenger;
+	}
+
+
+	/**
+	 * @param EE_Message_Resource_Manager $message_resource_manager
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		$active_messengers       = $message_resource_manager->active_messengers();
+		$installed_message_types = $message_resource_manager->installed_message_types();
+		$templates_created       = false;
+		foreach ($active_messengers as $active_messenger) {
+			$default_message_type_names_for_messenger = $active_messenger->get_default_message_types();
+			$default_message_type_names_to_activate   = [];
+			// looping through each default message type reported by the messenger
+			// and setup the actual message types to activate.
+			foreach ($default_message_type_names_for_messenger as $default_message_type_name_for_messenger) {
+				// if already active or has already been activated before we skip
+				// (otherwise we might reactivate something user's intentionally deactivated.)
+				// we also skip if the message type is not installed.
+				if (
+					$message_resource_manager->has_message_type_been_activated_for_messenger(
+						$default_message_type_name_for_messenger,
+						$active_messenger->name
+					)
+					|| $message_resource_manager->is_message_type_active_for_messenger(
+						$active_messenger->name,
+						$default_message_type_name_for_messenger
+					)
+					|| ! isset($installed_message_types[ $default_message_type_name_for_messenger ])
+				) {
+					continue;
+				}
+				$default_message_type_names_to_activate[] = $default_message_type_name_for_messenger;
+			}
+			// let's activate!
+			$message_resource_manager->ensure_message_types_are_active(
+				$default_message_type_names_to_activate,
+				$active_messenger->name,
+				false
+			);
+			// activate the templates for these message types
+			if (! empty($default_message_type_names_to_activate)) {
+				$templates_created = EEH_MSG_Template::generate_new_templates(
+					$active_messenger->name,
+					$default_message_type_names_for_messenger,
+					'',
+					true
+				);
+			}
+		}
+		return $templates_created;
+	}
+
+
+	/**
+	 * This will activate and generate default messengers and default message types for those messengers.
+	 *
+	 * @param EE_message_Resource_Manager $message_resource_manager
+	 * @return array|bool  True means there were default messengers and message type templates generated.
+	 *                     False means that there were no templates generated
+	 *                     (which could simply mean there are no default message types for a messenger).
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function _activate_and_generate_default_messengers_and_message_templates(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		$messengers_to_generate  = self::_get_default_messengers_to_generate_on_activation($message_resource_manager);
+		$installed_message_types = $message_resource_manager->installed_message_types();
+		$templates_generated     = false;
+		foreach ($messengers_to_generate as $messenger_to_generate) {
+			$default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
+			// verify the default message types match an installed message type.
+			foreach ($default_message_type_names_for_messenger as $key => $name) {
+				if (
+					! isset($installed_message_types[ $name ])
+					|| $message_resource_manager->has_message_type_been_activated_for_messenger(
+						$name,
+						$messenger_to_generate->name
+					)
+				) {
+					unset($default_message_type_names_for_messenger[ $key ]);
+				}
+			}
+			// in previous iterations, the active_messengers option in the db
+			// needed updated before calling create templates. however with the changes this may not be necessary.
+			// This comment is left here just in case we discover that we _do_ need to update before
+			// passing off to create templates (after the refactor is done).
+			// @todo remove this comment when determined not necessary.
+			$message_resource_manager->activate_messenger(
+				$messenger_to_generate,
+				$default_message_type_names_for_messenger,
+				false
+			);
+			// create any templates needing created (or will reactivate templates already generated as necessary).
+			if (! empty($default_message_type_names_for_messenger)) {
+				$templates_generated = EEH_MSG_Template::generate_new_templates(
+					$messenger_to_generate->name,
+					$default_message_type_names_for_messenger,
+					'',
+					true
+				);
+			}
+		}
+		return $templates_generated;
+	}
+
+
+	/**
+	 * This returns the default messengers to generate templates for on activation of EE.
+	 * It considers:
+	 * - whether a messenger is already active in the db.
+	 * - whether a messenger has been made active at any time in the past.
+	 *
+	 * @param EE_Message_Resource_Manager $message_resource_manager
+	 * @return EE_messenger[]
+	 */
+	protected static function _get_default_messengers_to_generate_on_activation(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		$active_messengers    = $message_resource_manager->active_messengers();
+		$installed_messengers = $message_resource_manager->installed_messengers();
+		$has_activated        = $message_resource_manager->get_has_activated_messengers_option();
+
+		$messengers_to_generate = [];
+		foreach ($installed_messengers as $installed_messenger) {
+			// if installed messenger is a messenger that should be activated on install
+			// and is not already active
+			// and has never been activated
+			if (
+				! $installed_messenger->activate_on_install
+				|| isset($active_messengers[ $installed_messenger->name ])
+				|| isset($has_activated[ $installed_messenger->name ])
+			) {
+				continue;
+			}
+			$messengers_to_generate[ $installed_messenger->name ] = $installed_messenger;
+		}
+		return $messengers_to_generate;
+	}
+
+
+	/**
+	 * This simply validates active message types to ensure they actually match installed
+	 * message types.  If there's a mismatch then we deactivate the message type and ensure all related db
+	 * rows are set inactive.
+	 * Note: Messengers are no longer validated here as of 4.9.0 because they get validated automatically whenever
+	 * EE_Messenger_Resource_Manager is constructed.  Message Types are a bit more resource heavy for validation so they
+	 * are still handled in here.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.3.1
+	 */
+	public static function validate_messages_system()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$message_resource_manager->validate_active_message_types_are_installed();
+		do_action('AHEE__EEH_Activation__validate_messages_system');
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function plugin_deactivation()
+	{
+	}
+
+
+	/**
+	 * Finds all our EE4 custom post types, and deletes them and their associated data
+	 * (like post meta or term relations)
+	 *
+	 * @throws EE_Error
+	 * @global wpdb $wpdb
+	 */
+	public static function delete_all_espresso_cpt_data()
+	{
+		global $wpdb;
+		// get all the CPT post_types
+		$ee_post_types = [];
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func([$model_name, 'instance']);
+				if ($model_obj instanceof EEM_CPT_Base) {
+					$ee_post_types[] = $wpdb->prepare("%s", $model_obj->post_type());
+				}
+			}
+		}
+		// get all our CPTs
+		$query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
+		$cpt_ids = $wpdb->get_col($query);
+		// delete each post meta and term relations too
+		foreach ($cpt_ids as $post_id) {
+			wp_delete_post($post_id, true);
+		}
+	}
+
+
+	/**
+	 * Deletes all EE custom tables
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function drop_espresso_tables()
+	{
+		$tables = [];
+		// load registry
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func([$model_name, 'instance']);
+				if ($model_obj instanceof EEM_Base) {
+					foreach ($model_obj->get_tables() as $table) {
+						if (
+							strpos($table->get_table_name(), 'esp_')
+							&& (
+								is_main_site()// main site? nuke them all
+								|| ! $table->is_global()// not main site,but not global either. nuke it
+							)
+						) {
+							$tables[ $table->get_table_name() ] = $table->get_table_name();
+						}
+					}
+				}
+			}
+		}
+
+		// there are some tables whose models were removed.
+		// they should be removed when removing all EE core's data
+		$tables_without_models = [
+			'esp_promotion',
+			'esp_promotion_applied',
+			'esp_promotion_object',
+			'esp_promotion_rule',
+			'esp_rule',
+		];
+		foreach ($tables_without_models as $table) {
+			$tables[ $table ] = $table;
+		}
+		return EEH_Activation::getTableManager()->dropTables($tables);
+	}
+
+
+	/**
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
+	 * each table name provided has a wpdb prefix attached, and that it exists.
+	 * Returns the list actually deleted
+	 *
+	 * @param array $table_names
+	 * @return array of table names which we deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated in 4.9.13. Instead use TableManager::dropTables()
+	 * @global WPDB $wpdb
+	 */
+	public static function drop_tables($table_names)
+	{
+		return EEH_Activation::getTableManager()->dropTables($table_names);
+	}
+
+
+	/**
+	 * plugin_uninstall
+	 *
+	 * @param bool $remove_all
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function delete_all_espresso_tables_and_data($remove_all = true)
+	{
+		global $wpdb;
+		self::drop_espresso_tables();
+		$wp_options_to_delete = [
+			'ee_no_ticket_prices'                        => true,
+			'ee_active_messengers'                       => true,
+			'ee_has_activated_messenger'                 => true,
+			RewriteRules::OPTION_KEY_FLUSH_REWRITE_RULES => true,
+			'ee_config'                                  => false,
+			'ee_data_migration_current_db_state'         => true,
+			'ee_data_migration_mapping_'                 => false,
+			'ee_data_migration_script_'                  => false,
+			'ee_data_migrations'                         => true,
+			'ee_dms_map'                                 => false,
+			'ee_notices'                                 => true,
+			'lang_file_check_'                           => false,
+			'ee_maintenance_mode'                        => true,
+			'ee_ueip_optin'                              => true,
+			'ee_ueip_has_notified'                       => true,
+			'ee_plugin_activation_errors'                => true,
+			'ee_id_mapping_from'                         => false,
+			'espresso_persistent_admin_notices'          => true,
+			'ee_encryption_key'                          => true,
+			'pue_force_upgrade_'                         => false,
+			'pue_json_error_'                            => false,
+			'pue_install_key_'                           => false,
+			'pue_verification_error_'                    => false,
+			'pu_dismissed_upgrade_'                      => false,
+			'external_updates-'                          => false,
+			'ee_extra_data'                              => true,
+			'ee_ssn_'                                    => false,
+			'ee_rss_'                                    => false,
+			'ee_rte_n_tx_'                               => false,
+			'ee_pers_admin_notices'                      => true,
+			'ee_job_parameters_'                         => false,
+			'ee_upload_directories_incomplete'           => true,
+			'ee_verified_db_collations'                  => true,
+		];
+		if (is_main_site()) {
+			$wp_options_to_delete['ee_network_config'] = true;
+		}
+		$undeleted_options = [];
+		foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
+			if ($no_wildcard) {
+				if (! delete_option($option_name)) {
+					$undeleted_options[] = $option_name;
+				}
+			} else {
+				$option_names_to_delete_from_wildcard =
+					$wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
+				foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
+					if (! delete_option($option_name_from_wildcard)) {
+						$undeleted_options[] = $option_name_from_wildcard;
+					}
+				}
+			}
+		}
+		// also, let's make sure the "ee_config_option_names" wp option stays out by removing the action that adds it
+		remove_action('shutdown', [EE_Config::instance(), 'shutdown']);
+		if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
+			$db_update_sans_ee4 = [];
+			foreach ($espresso_db_update as $version => $times_activated) {
+				if ((string) $version[0] === '3') {// if its NON EE4
+					$db_update_sans_ee4[ $version ] = $times_activated;
+				}
+			}
+			update_option('espresso_db_update', $db_update_sans_ee4);
+		}
+		$errors = '';
+		if (! empty($undeleted_options)) {
+			$errors .= sprintf(
+				esc_html__('The following wp-options could not be deleted: %s%s', 'event_espresso'),
+				'<br/>',
+				implode(',<br/>', $undeleted_options)
+			);
+		}
+		if (! empty($errors)) {
+			EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+	/**
+	 * Gets the mysql error code from the last used query by wpdb
+	 *
+	 * @return int mysql error code, see https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
+	 */
+	public static function last_wpdb_error_code()
+	{
+		// phpcs:disable PHPCompatibility.Extensions.RemovedExtensions.mysql_DeprecatedRemoved
+		global $wpdb;
+		return $wpdb->use_mysqli ? mysqli_errno($wpdb->dbh) : 0;
+		// phpcs:enable
+	}
+
+
+	/**
+	 * Checks that the database table exists. Also works on temporary tables (for unit tests mostly).
+	 *
+	 * @param string $table_name with or without $wpdb->prefix
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @global wpdb  $wpdb
+	 * @deprecated instead use TableAnalysis::tableExists()
+	 */
+	public static function table_exists($table_name)
+	{
+		return EEH_Activation::getTableAnalysis()->tableExists($table_name);
+	}
+
+
+	/**
+	 * Resets the cache on EEH_Activation
+	 */
+	public static function reset()
+	{
+		self::$_default_creator_id                             = null;
+		self::$_initialized_db_content_already_in_this_request = false;
+	}
+
+
+	/**
+	 * Removes 'email_confirm' from the Address info question group on activation
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function removeEmailConfirmFromAddressGroup()
+	{
+
+		// Pull the email_confirm question ID.
+		$email_confirm_question_id = EEM_Question::instance()->get_Question_ID_from_system_string(
+			EEM_Attendee::system_question_email_confirm
+		);
+		// Remove the email_confirm question group from the address group questions.
+		EEM_Question_Group_Question::instance()->delete(
+			[
+				[
+					'QST_ID'                    => $email_confirm_question_id,
+					'Question_Group.QSG_system' => EEM_Question_Group::system_address,
+				],
+			]
+		);
+	}
 }

Spacing +53 added lines, -53 removed lines

@@ -57,7 +57,7 @@ 
      */
     public static function getTableAnalysis()
     {
-        if (! self::$table_analysis instanceof TableAnalysis) {
+        if ( ! self::$table_analysis instanceof TableAnalysis) {
             self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', [], true);
         }
         return self::$table_analysis;
@@ -71,7 +71,7 @@ 
      */
     public static function getTableManager()
     {
-        if (! self::$table_manager instanceof TableManager) {
+        if ( ! self::$table_manager instanceof TableManager) {
             self::$table_manager = EE_Registry::instance()->create('TableManager', [], true);
         }
         return self::$table_manager;
@@ -116,7 +116,7 @@ 
     public static function initialize_db_and_folders()
     {
         EEH_File::ensure_folder_exists_and_is_writable(EVENT_ESPRESSO_UPLOAD_DIR);
-        EEH_File::ensure_folder_exists_and_is_writable(EVENT_ESPRESSO_UPLOAD_DIR . 'logs');
+        EEH_File::ensure_folder_exists_and_is_writable(EVENT_ESPRESSO_UPLOAD_DIR.'logs');
         return EEH_Activation::create_database_tables();
     }
 
@@ -186,7 +186,7 @@ 
         if ($which_to_include === 'old') {
             $cron_tasks = array_filter(
                 $cron_tasks,
-                function ($value) {
+                function($value) {
                     return $value === EEH_Activation::cron_task_no_longer_in_use;
                 }
             );
@@ -216,7 +216,7 @@ 
     {
 
         foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
+            if ( ! wp_next_scheduled($hook_name)) {
                 /**
                  * This allows client code to define the initial start timestamp for this schedule.
                  */
@@ -269,15 +269,15 @@ 
             if (is_array($hooks_to_fire_at_time)) {
                 foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
                     if (
-                        isset($ee_cron_tasks_to_remove[ $hook_name ])
-                        && is_array($ee_cron_tasks_to_remove[ $hook_name ])
+                        isset($ee_cron_tasks_to_remove[$hook_name])
+                        && is_array($ee_cron_tasks_to_remove[$hook_name])
                     ) {
-                        unset($crons[ $timestamp ][ $hook_name ]);
+                        unset($crons[$timestamp][$hook_name]);
                     }
                 }
                 // also take care of any empty cron timestamps.
                 if (empty($hooks_to_fire_at_time)) {
-                    unset($crons[ $timestamp ]);
+                    unset($crons[$timestamp]);
                 }
             }
         }
@@ -316,7 +316,7 @@ 
             10,
             3
         );
-        if (! EE_Config::logging_enabled()) {
+        if ( ! EE_Config::logging_enabled()) {
             delete_option(EE_Config::LOG_NAME);
         }
     }
@@ -328,7 +328,7 @@ 
     public static function load_calendar_config()
     {
         // grab array of all plugin folders and loop thru it
-        $plugins = glob(WP_PLUGIN_DIR . '/*', GLOB_ONLYDIR);
+        $plugins = glob(WP_PLUGIN_DIR.'/*', GLOB_ONLYDIR);
         if (empty($plugins)) {
             return;
         }
@@ -345,7 +345,7 @@ 
                 || strpos($plugin, 'calendar') !== false
             ) {
                 // this is what we are looking for
-                $calendar_config = $plugin_path . '/EE_Calendar_Config.php';
+                $calendar_config = $plugin_path.'/EE_Calendar_Config.php';
                 // does it exist in this folder ?
                 if (is_readable($calendar_config)) {
                     // YEAH! let's load it
@@ -428,7 +428,7 @@ 
                 'code' => 'ESPRESSO_CANCELLED',
             ],
         ];
-        $EE_Core_Config        = EE_Registry::instance()->CFG->core;
+        $EE_Core_Config = EE_Registry::instance()->CFG->core;
         foreach ($critical_pages as $critical_page) {
             // is critical page ID set in config ?
             if ($EE_Core_Config->{$critical_page['id']} !== false) {
@@ -460,7 +460,7 @@ 
             ) {
                 // update Config with post ID
                 $EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
-                if (! EE_Config::instance()->update_espresso_config(false, false)) {
+                if ( ! EE_Config::instance()->update_espresso_config(false, false)) {
                     $msg = esc_html__(
                         'The Event Espresso critical page configuration settings could not be updated.',
                         'event_espresso'
@@ -483,7 +483,7 @@ 
                         'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
                         'event_espresso'
                     ),
-                    '<a href="' . admin_url('admin.php?page=espresso_general_settings&action=critical_pages') . '">'
+                    '<a href="'.admin_url('admin.php?page=espresso_general_settings&action=critical_pages').'">'
                     . esc_html__('Event Espresso Critical Pages Settings', 'event_espresso')
                     . '</a>'
                 )
@@ -508,7 +508,7 @@ 
     public static function get_page_by_ee_shortcode($ee_shortcode)
     {
         global $wpdb;
-        $shortcode_and_opening_bracket = '[' . $ee_shortcode;
+        $shortcode_and_opening_bracket = '['.$ee_shortcode;
         $post_id                       =
             $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
         if ($post_id) {
@@ -533,11 +533,11 @@ 
             'post_status'    => 'publish',
             'post_type'      => 'page',
             'comment_status' => 'closed',
-            'post_content'   => '[' . $critical_page['code'] . ']',
+            'post_content'   => '['.$critical_page['code'].']',
         ];
 
         $post_id = wp_insert_post($post_args);
-        if (! $post_id) {
+        if ( ! $post_id) {
             $msg = sprintf(
                 esc_html__('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
                 $critical_page['name']
@@ -546,7 +546,7 @@ 
             return $critical_page;
         }
         // get newly created post's details
-        if (! $critical_page['post'] = get_post($post_id)) {
+        if ( ! $critical_page['post'] = get_post($post_id)) {
             $msg = sprintf(
                 esc_html__('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
                 $critical_page['name']
@@ -571,7 +571,7 @@ 
     public static function get_default_creator_id()
     {
         global $wpdb;
-        if (! empty(self::$_default_creator_id)) {
+        if ( ! empty(self::$_default_creator_id)) {
             return self::$_default_creator_id;
         }/**/
         $role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
@@ -587,7 +587,7 @@ 
         $capabilities_key = EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
         $query            = $wpdb->prepare(
             "SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
-            '%' . $role_to_check . '%'
+            '%'.$role_to_check.'%'
         );
         $user_id          = $wpdb->get_var($query);
         $user_id          = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
@@ -624,8 +624,8 @@ 
             return;
         }
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! function_exists('dbDelta')) {
-            require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+        if ( ! function_exists('dbDelta')) {
+            require_once(ABSPATH.'wp-admin/includes/upgrade.php');
         }
         $tableAnalysis = EEH_Activation::getTableAnalysis();
         $wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
@@ -634,9 +634,9 @@ 
             // ok, delete the table... but ONLY if it's empty
             $deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
             // table is NOT empty, are you SURE you want to delete this table ???
-            if (! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
+            if ( ! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
                 EEH_Activation::getTableManager()->dropTable($wp_table_name);
-            } elseif (! $deleted_safely) {
+            } elseif ( ! $deleted_safely) {
                 // so we should be more cautious rather than just dropping tables so easily
                 error_log(
                     sprintf(
@@ -757,7 +757,7 @@ 
         EE_Registry::instance()->load_core('Data_Migration_Manager');
         // find the migration script that sets the database to be compatible with the code
         $dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
-        if (! $dms_name) {
+        if ( ! $dms_name) {
             EE_Error::add_error(
                 esc_html__(
                     'Could not determine most up-to-date data migration script from which to pull database schema
@@ -817,13 +817,13 @@ 
             // reset values array
             $QSG_values = [];
             // if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
-            if (! in_array("$QSG_system", $question_groups)) {
+            if ( ! in_array("$QSG_system", $question_groups)) {
                 // add it
                 switch ($QSG_system) {
                     case 1:
                         $QSG_values = [
                             'QSG_name'            => esc_html__('Personal Information', 'event_espresso'),
-                            'QSG_identifier'      => 'personal-information-' . time(),
+                            'QSG_identifier'      => 'personal-information-'.time(),
                             'QSG_desc'            => '',
                             'QSG_order'           => 1,
                             'QSG_show_group_name' => 1,
@@ -835,7 +835,7 @@ 
                     case 2:
                         $QSG_values = [
                             'QSG_name'            => esc_html__('Address Information', 'event_espresso'),
-                            'QSG_identifier'      => 'address-information-' . time(),
+                            'QSG_identifier'      => 'address-information-'.time(),
                             'QSG_desc'            => '',
                             'QSG_order'           => 2,
                             'QSG_show_group_name' => 1,
@@ -846,14 +846,14 @@ 
                         break;
                 }
                 // make sure we have some values before inserting them
-                if (! empty($QSG_values)) {
+                if ( ! empty($QSG_values)) {
                     // insert system question
                     $wpdb->insert(
                         $table_name,
                         $QSG_values,
                         ['%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d']
                     );
-                    $QSG_IDs[ $QSG_system ] = $wpdb->insert_id;
+                    $QSG_IDs[$QSG_system] = $wpdb->insert_id;
                 }
             }
         }
@@ -868,7 +868,7 @@ 
         $address_system_group_questions  = ['address', 'address2', 'city', 'country', 'state', 'zip', 'phone'];
         $system_questions_not_in_group   = ['email_confirm'];
         // merge all of the system questions we should have
-        $QST_systems       = array_merge(
+        $QST_systems = array_merge(
             $personal_system_group_questions,
             $address_system_group_questions,
             $system_questions_not_in_group
@@ -880,7 +880,7 @@ 
             // reset values array
             $QST_values = [];
             // if we don't have what we should have
-            if (! in_array($QST_system, $questions)) {
+            if ( ! in_array($QST_system, $questions)) {
                 // add it
                 switch ($QST_system) {
                     case 'fname':
@@ -1056,7 +1056,7 @@ 
                         ];
                         break;
                 }
-                if (! empty($QST_values)) {
+                if ( ! empty($QST_values)) {
                     // insert system question
                     $wpdb->insert(
                         $table_name,
@@ -1074,8 +1074,8 @@ 
                         // QST_system should not be assigned to any group
                         continue;
                     }
-                    if (isset($QSG_IDs[ $system_question_we_want ])) {
-                        $QSG_ID = $QSG_IDs[ $system_question_we_want ];
+                    if (isset($QSG_IDs[$system_question_we_want])) {
+                        $QSG_ID = $QSG_IDs[$system_question_we_want];
                     } else {
                         $id_col = EEM_Question_Group::instance()
                                                     ->get_col([['QSG_system' => $system_question_we_want]]);
@@ -1124,7 +1124,7 @@ 
      */
     public static function insert_default_payment_methods()
     {
-        if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
+        if ( ! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
             EE_Registry::instance()->load_lib('Payment_Method_Manager');
             EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
         } else {
@@ -1260,7 +1260,7 @@ 
                         $active_messenger->name,
                         $default_message_type_name_for_messenger
                     )
-                    || ! isset($installed_message_types[ $default_message_type_name_for_messenger ])
+                    || ! isset($installed_message_types[$default_message_type_name_for_messenger])
                 ) {
                     continue;
                 }
@@ -1273,7 +1273,7 @@ 
                 false
             );
             // activate the templates for these message types
-            if (! empty($default_message_type_names_to_activate)) {
+            if ( ! empty($default_message_type_names_to_activate)) {
                 $templates_created = EEH_MSG_Template::generate_new_templates(
                     $active_messenger->name,
                     $default_message_type_names_for_messenger,
@@ -1307,13 +1307,13 @@ 
             // verify the default message types match an installed message type.
             foreach ($default_message_type_names_for_messenger as $key => $name) {
                 if (
-                    ! isset($installed_message_types[ $name ])
+                    ! isset($installed_message_types[$name])
                     || $message_resource_manager->has_message_type_been_activated_for_messenger(
                         $name,
                         $messenger_to_generate->name
                     )
                 ) {
-                    unset($default_message_type_names_for_messenger[ $key ]);
+                    unset($default_message_type_names_for_messenger[$key]);
                 }
             }
             // in previous iterations, the active_messengers option in the db
@@ -1327,7 +1327,7 @@ 
                 false
             );
             // create any templates needing created (or will reactivate templates already generated as necessary).
-            if (! empty($default_message_type_names_for_messenger)) {
+            if ( ! empty($default_message_type_names_for_messenger)) {
                 $templates_generated = EEH_MSG_Template::generate_new_templates(
                     $messenger_to_generate->name,
                     $default_message_type_names_for_messenger,
@@ -1363,12 +1363,12 @@ 
             // and has never been activated
             if (
                 ! $installed_messenger->activate_on_install
-                || isset($active_messengers[ $installed_messenger->name ])
-                || isset($has_activated[ $installed_messenger->name ])
+                || isset($active_messengers[$installed_messenger->name])
+                || isset($has_activated[$installed_messenger->name])
             ) {
                 continue;
             }
-            $messengers_to_generate[ $installed_messenger->name ] = $installed_messenger;
+            $messengers_to_generate[$installed_messenger->name] = $installed_messenger;
         }
         return $messengers_to_generate;
     }
@@ -1425,7 +1425,7 @@ 
             }
         }
         // get all our CPTs
-        $query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
+        $query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (".implode(",", $ee_post_types).")";
         $cpt_ids = $wpdb->get_col($query);
         // delete each post meta and term relations too
         foreach ($cpt_ids as $post_id) {
@@ -1457,7 +1457,7 @@ 
                                 || ! $table->is_global()// not main site,but not global either. nuke it
                             )
                         ) {
-                            $tables[ $table->get_table_name() ] = $table->get_table_name();
+                            $tables[$table->get_table_name()] = $table->get_table_name();
                         }
                     }
                 }
@@ -1474,7 +1474,7 @@ 
             'esp_rule',
         ];
         foreach ($tables_without_models as $table) {
-            $tables[ $table ] = $table;
+            $tables[$table] = $table;
         }
         return EEH_Activation::getTableManager()->dropTables($tables);
     }
@@ -1551,14 +1551,14 @@ 
         $undeleted_options = [];
         foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
             if ($no_wildcard) {
-                if (! delete_option($option_name)) {
+                if ( ! delete_option($option_name)) {
                     $undeleted_options[] = $option_name;
                 }
             } else {
                 $option_names_to_delete_from_wildcard =
                     $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
                 foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
-                    if (! delete_option($option_name_from_wildcard)) {
+                    if ( ! delete_option($option_name_from_wildcard)) {
                         $undeleted_options[] = $option_name_from_wildcard;
                     }
                 }
@@ -1570,20 +1570,20 @@ 
             $db_update_sans_ee4 = [];
             foreach ($espresso_db_update as $version => $times_activated) {
                 if ((string) $version[0] === '3') {// if its NON EE4
-                    $db_update_sans_ee4[ $version ] = $times_activated;
+                    $db_update_sans_ee4[$version] = $times_activated;
                 }
             }
             update_option('espresso_db_update', $db_update_sans_ee4);
         }
         $errors = '';
-        if (! empty($undeleted_options)) {
+        if ( ! empty($undeleted_options)) {
             $errors .= sprintf(
                 esc_html__('The following wp-options could not be deleted: %s%s', 'event_espresso'),
                 '<br/>',
                 implode(',<br/>', $undeleted_options)
             );
         }
-        if (! empty($errors)) {
+        if ( ! empty($errors)) {
             EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
         }
     }

core/helpers/EEH_MSG_Template.helper.php

Indentation +1249 added lines, -1249 removed lines

@@ -13,1256 +13,1256 @@
  */
 class EEH_MSG_Template
 {
-    /**
-     * Holds a collection of EE_Message_Template_Pack objects.
-     * @type EE_Messages_Template_Pack_Collection
-     */
-    protected static $_template_pack_collection;
-
-
-    /**
-     * @throws EE_Error
-     */
-    private static function _set_autoloader()
-    {
-        EED_Messages::set_autoloaders();
-    }
-
-
-    /**
-     * generate_new_templates
-     * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
-     * automatically create the defaults for the event.  The user would then be redirected to edit the default context
-     * for the event.
-     *
-     * @access protected
-     * @param string $messenger     the messenger we are generating templates for
-     * @param array  $message_types array of message types that the templates are generated for.
-     * @param int    $GRP_ID        If a non global template is being generated then it is expected we'll have a GRP_ID
-     *                              to use as the base for the new generated template.
-     * @param bool   $global        true indicates generating templates on messenger activation. false requires GRP_ID
-     *                              for event specific template generation.
-     * @return array  @see EEH_MSG_Template::_create_new_templates for the return value of each element in the array
-     *                for templates that are generated.  If this is an empty array then it means no templates were
-     *                generated which usually means there was an error.  Anything in the array with an empty value for
-     *                `MTP_context` means that it was not a new generated template but just reactivated (which only
-     *                happens for global templates that already exist in the database.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
-    {
-        // make sure message_type is an array.
-        $message_types = (array) $message_types;
-        $templates = array();
-
-        if (empty($messenger)) {
-            throw new EE_Error(esc_html__('We need a messenger to generate templates!', 'event_espresso'));
-        }
-
-        // if we STILL have empty $message_types then we need to generate an error message b/c we NEED message types to do the template files.
-        if (empty($message_types)) {
-            throw new EE_Error(esc_html__('We need at least one message type to generate templates!', 'event_espresso'));
-        }
-
-        EEH_MSG_Template::_set_autoloader();
-        foreach ($message_types as $message_type) {
-            // if this is global template generation.
-            if ($global) {
-                // let's attempt to get the GRP_ID for this combo IF GRP_ID is empty.
-                if (empty($GRP_ID)) {
-                    $GRP_ID = EEM_Message_Template_Group::instance()->get_one(
-                        array(
-                            array(
-                                'MTP_messenger'    => $messenger,
-                                'MTP_message_type' => $message_type,
-                                'MTP_is_global'    => true,
-                            ),
-                        )
-                    );
-                    $GRP_ID = $GRP_ID instanceof EE_Message_Template_Group ? $GRP_ID->ID() : 0;
-                }
-                // First let's determine if we already HAVE global templates for this messenger and message_type combination.
-                //  If we do then NO generation!!
-                if (EEH_MSG_Template::already_generated($messenger, $message_type, $GRP_ID)) {
-                    $templates[] = array(
-                        'GRP_ID' => $GRP_ID,
-                        'MTP_context' => '',
-                    );
-                    // we already have generated templates for this so let's go to the next message type.
-                    continue;
-                }
-            }
-            $new_message_template_group = EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $global);
-
-            if (! $new_message_template_group) {
-                continue;
-            }
-            $templates[] = $new_message_template_group;
-        }
-
-        return $templates;
-    }
-
-
-    /**
-     * The purpose of this method is to determine if there are already generated templates in the database for the
-     * given variables.
-     *
-     * @param string $messenger    messenger
-     * @param string $message_type message type
-     * @param int    $GRP_ID       GRP ID ( if a custom template) (if not provided then we're just doing global
-     *                             template check)
-     * @return bool                true = generated, false = hasn't been generated.
-     * @throws EE_Error
-     */
-    public static function already_generated($messenger, $message_type, $GRP_ID = 0)
-    {
-        EEH_MSG_Template::_set_autoloader();
-        // what method we use depends on whether we have an GRP_ID or not
-        $count = empty($GRP_ID)
-            ? EEM_Message_Template::instance()->count(
-                array(
-                    array(
-                        'Message_Template_Group.MTP_messenger'    => $messenger,
-                        'Message_Template_Group.MTP_message_type' => $message_type,
-                        'Message_Template_Group.MTP_is_global'    => true
-                    )
-                )
-            )
-            : EEM_Message_Template::instance()->count(array( array( 'GRP_ID' => $GRP_ID ) ));
-
-        return $count > 0;
-    }
-
-
-    /**
-     * Updates all message templates matching the incoming messengers and message types to active status.
-     *
-     * @static
-     * @param array $messenger_names    Messenger slug
-     * @param array $message_type_names Message type slug
-     * @return  int                         count of updated records.
-     * @throws EE_Error
-     */
-    public static function update_to_active($messenger_names, $message_type_names)
-    {
-        $messenger_names = is_array($messenger_names) ? $messenger_names : array( $messenger_names );
-        $message_type_names = is_array($message_type_names) ? $message_type_names : array( $message_type_names );
-        return EEM_Message_Template_Group::instance()->update(
-            array( 'MTP_is_active' => 1 ),
-            array(
-                array(
-                    'MTP_messenger'     => array( 'IN', $messenger_names ),
-                    'MTP_message_type'  => array( 'IN', $message_type_names )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * Updates all message template groups matching the incoming arguments to inactive status.
-     *
-     * @static
-     * @param array $messenger_names    The messenger slugs.
-     *                                  If empty then all templates matching the message types are marked inactive.
-     *                                  Otherwise only templates matching the messengers and message types.
-     * @param array $message_type_names The message type slugs.
-     *                                  If empty then all templates matching the messengers are marked inactive.
-     *                                  Otherwise only templates matching the messengers and message types.
-     *
-     * @return int  count of updated records.
-     * @throws EE_Error
-     */
-    public static function update_to_inactive($messenger_names = array(), $message_type_names = array())
-    {
-        return EEM_Message_Template_Group::instance()->deactivate_message_template_groups_for(
-            $messenger_names,
-            $message_type_names
-        );
-    }
-
-
-    /**
-     * The purpose of this function is to return all installed message objects
-     * (messengers and message type regardless of whether they are ACTIVE or not)
-     *
-     * @param string $type
-     * @return array array consisting of installed messenger objects and installed message type objects.
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated 4.9.0
-     * @static
-     */
-    public static function get_installed_message_objects($type = 'all')
-    {
-        self::_set_autoloader();
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return array(
-            'messenger' => $message_resource_manager->installed_messengers(),
-            'message_type' => $message_resource_manager->installed_message_types()
-        );
-    }
-
-
-    /**
-     * This will return an array of shortcodes => labels from the
-     * messenger and message_type objects associated with this
-     * template.
-     *
-     * @param string $message_type
-     * @param string $messenger
-     * @param array  $fields                        What fields we're returning valid shortcodes for.
-     *                                              If empty then we assume all fields are to be returned. Optional.
-     * @param string $context                       What context we're going to return shortcodes for. Optional.
-     * @param bool   $merged                        If TRUE then we don't return shortcodes indexed by field,
-     *                                              but instead an array of the unique shortcodes for all the given (
-     *                                              or all) fields. Optional.
-     * @return array                                an array of shortcodes in the format
-     *                                              array( '[shortcode] => 'label')
-     *                                              OR
-     *                                              FALSE if no shortcodes found.
-     * @throws ReflectionException
-     * @throws EE_Error*@since 4.3.0
-     *
-     */
-    public static function get_shortcodes(
-        $message_type,
-        $messenger,
-        $fields = array(),
-        $context = 'admin',
-        $merged = false
-    ) {
-        $messenger_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $messenger)));
-        $mt_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $message_type)));
-        /** @var EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        // convert slug to object
-        $messenger = $message_resource_manager->get_messenger($messenger);
-
-        // if messenger isn't a EE_messenger resource then bail.
-        if (! $messenger instanceof EE_messenger) {
-            return array();
-        }
-
-        // validate class for getting our list of shortcodes
-        $classname = 'EE_Messages_' . $messenger_name . '_' . $mt_name . '_Validator';
-        if (! class_exists($classname)) {
-            $msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
-            $msg[] = sprintf(
-                esc_html__('The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class', 'event_espresso'),
-                $classname
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-
-        /** @type EE_Messages_Validator $_VLD */
-        $_VLD = new $classname(array(), $context);
-        $valid_shortcodes = $_VLD->get_validators();
-
-        // let's make sure we're only getting the shortcode part of the validators
-        $shortcodes = array();
-        foreach ($valid_shortcodes as $field => $validators) {
-            $shortcodes[ $field ] = $validators['shortcodes'];
-        }
-        $valid_shortcodes = $shortcodes;
-
-        // if not all fields let's make sure we ONLY include the shortcodes for the specified fields.
-        if (! empty($fields)) {
-            $specified_shortcodes = array();
-            foreach ($fields as $field) {
-                if (isset($valid_shortcodes[ $field ])) {
-                    $specified_shortcodes[ $field ] = $valid_shortcodes[ $field ];
-                }
-            }
-            $valid_shortcodes = $specified_shortcodes;
-        }
-
-        // if not merged then let's replace the fields with the localized fields
-        if (! $merged) {
-            // let's get all the fields for the set messenger so that we can get the localized label and use that in the returned array.
-            $field_settings = $messenger->get_template_fields();
-            $localized = array();
-            foreach ($valid_shortcodes as $field => $shortcodes) {
-                // get localized field label
-                if (isset($field_settings[ $field ])) {
-                    // possible that this is used as a main field.
-                    if (empty($field_settings[ $field ])) {
-                        if (isset($field_settings['extra'][ $field ])) {
-                            $_field = $field_settings['extra'][ $field ]['main']['label'];
-                        } else {
-                            $_field = $field;
-                        }
-                    } else {
-                        $_field = $field_settings[ $field ]['label'];
-                    }
-                } elseif (isset($field_settings['extra'])) {
-                    // loop through extra "main fields" and see if any of their children have our field
-                    foreach ($field_settings['extra'] as $fields) {
-                        if (isset($fields[ $field ])) {
-                            $_field = $fields[ $field ]['label'];
-                        } else {
-                            $_field = $field;
-                        }
-                    }
-                } else {
-                    $_field = $field;
-                }
-                if (isset($_field)) {
-                    $localized[ (string) $_field ] = $shortcodes;
-                }
-            }
-            $valid_shortcodes = $localized;
-        }
-
-        // if $merged then let's merge all the shortcodes into one list NOT indexed by field.
-        if ($merged) {
-            $merged_codes = array();
-            foreach ($valid_shortcodes as $shortcode) {
-                foreach ($shortcode as $code => $label) {
-                    if (isset($merged_codes[ $code ])) {
-                        continue;
-                    } else {
-                        $merged_codes[ $code ] = $label;
-                    }
-                }
-            }
-            $valid_shortcodes = $merged_codes;
-        }
-
-        return $valid_shortcodes;
-    }
-
-
-    /**
-     * Get Messenger object.
-     *
-     * @param string $messenger messenger slug for the messenger object we want to retrieve.
-     * @return EE_messenger
-     * @throws ReflectionException
-     * @throws EE_Error*@since 4.3.0
-     * @deprecated 4.9.0
-     */
-    public static function messenger_obj($messenger)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->get_messenger($messenger);
-    }
-
-
-    /**
-     * get Message type object
-     *
-     * @param string $message_type the slug for the message type object to retrieve
-     * @return EE_message_type
-     * @throws ReflectionException
-     * @throws EE_Error*@since 4.3.0
-     * @deprecated 4.9.0
-     */
-    public static function message_type_obj($message_type)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->get_message_type($message_type);
-    }
-
-
-    /**
-     * Given a message_type slug, will return whether that message type is active in the system or not.
-     *
-     * @since    4.3.0
-     * @param string $message_type message type to check for.
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function is_mt_active($message_type)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_mts = $Message_Resource_Manager->list_of_active_message_types();
-        return in_array($message_type, $active_mts);
-    }
-
-
-    /**
-     * Given a messenger slug, will return whether that messenger is active in the system or not.
-     *
-     * @since    4.3.0
-     *
-     * @param string $messenger slug for messenger to check.
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function is_messenger_active($messenger)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_messenger = $Message_Resource_Manager->get_active_messenger($messenger);
-        return $active_messenger instanceof EE_messenger;
-    }
-
-
-    /**
-     * Used to return active messengers array stored in the wp options table.
-     * If no value is present in the option then an empty array is returned.
-     *
-     * @deprecated 4.9
-     * @since      4.3.1
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_active_messengers_in_db()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Please use EE_Message_Resource_Manager::get_active_messengers_option() instead.', 'event_espresso'),
-            '4.9.0'
-        );
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->get_active_messengers_option();
-    }
-
-
-    /**
-     * Used to update the active messengers array stored in the wp options table.
-     *
-     * @since      4.3.1
-     * @deprecated 4.9.0
-     *
-     * @param array $data_to_save Incoming data to save.
-     *
-     * @return bool FALSE if not updated, TRUE if updated.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function update_active_messengers_in_db($data_to_save)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Please use EE_Message_Resource_Manager::update_active_messengers_option() instead.', 'event_espresso'),
-            '4.9.0'
-        );
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->update_active_messengers_option($data_to_save);
-    }
-
-
-    /**
-     * This does some validation of incoming params, determines what type of url is being prepped and returns the
-     * appropriate url trigger
-     *
-     * @param EE_message_type $message_type
-     * @param EE_Message $message
-     * @param EE_Registration | null $registration  The registration object must be included if this
-     *                                              is going to be a registration trigger url.
-     * @param string $sending_messenger             The (optional) sending messenger for the url.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public static function get_url_trigger(
-        EE_message_type $message_type,
-        EE_Message $message,
-        $registration = null,
-        $sending_messenger = ''
-    ) {
-        // first determine if the url can be to the EE_Message object.
-        if (! $message_type->always_generate()) {
-            return EEH_MSG_Template::generate_browser_trigger($message);
-        }
-
-        // if $registration object is not valid then exit early because there's nothing that can be generated.
-        if (! $registration instanceof EE_Registration) {
-            throw new EE_Error(
-                esc_html__('Incoming value for registration is not a valid EE_Registration object.', 'event_espresso')
-            );
-        }
-
-        // validate given context
-        $contexts = $message_type->get_contexts();
-        if ($message->context() !== '' && ! isset($contexts[ $message->context() ])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('The context %s is not a valid context for %s.', 'event_espresso'),
-                    $message->context(),
-                    get_class($message_type)
-                )
-            );
-        }
-
-        // valid sending messenger but only if sending messenger set.  Otherwise generating messenger is used.
-        if (! empty($sending_messenger)) {
-            $with_messengers = $message_type->with_messengers();
-            if (
-                ! isset($with_messengers[ $message->messenger() ])
-                 || ! in_array($sending_messenger, $with_messengers[ $message->messenger() ])
-            ) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The given sending messenger string (%1$s) does not match a valid sending messenger with the %2$s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
-                            'event_espresso'
-                        ),
-                        $sending_messenger,
-                        get_class($message_type)
-                    )
-                );
-            }
-        } else {
-            $sending_messenger = $message->messenger();
-        }
-        return EEH_MSG_Template::generate_url_trigger(
-            $sending_messenger,
-            $message->messenger(),
-            $message->context(),
-            $message->message_type(),
-            $registration,
-            $message->GRP_ID()
-        );
-    }
-
-
-    /**
-     * This returns the url for triggering a in browser view of a specific EE_Message object.
-     * @param EE_Message $message
-     * @return string.
-     */
-    public static function generate_browser_trigger(EE_Message $message)
-    {
-        $query_args = array(
-            'ee' => 'msg_browser_trigger',
-            'token' => $message->MSG_token()
-        );
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__generate_browser_trigger',
-            add_query_arg($query_args, site_url()),
-            $message
-        );
-    }
-
-
-
-
-
-
-    /**
-     * This returns the url for triggering an in browser view of the error saved on the incoming message object.
-     * @param EE_Message $message
-     * @return string
-     */
-    public static function generate_error_display_trigger(EE_Message $message)
-    {
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__generate_error_display_trigger',
-            add_query_arg(
-                array(
-                    'ee' => 'msg_browser_error_trigger',
-                    'token' => $message->MSG_token()
-                ),
-                site_url()
-            ),
-            $message
-        );
-    }
-
-
-    /**
-     * This generates a url trigger for the msg_url_trigger route using the given arguments
-     *
-     * @param string          $sending_messenger      The sending messenger slug.
-     * @param string          $generating_messenger   The generating messenger slug.
-     * @param string          $context                The context for the template.
-     * @param string          $message_type           The message type slug
-     * @param EE_Registration $registration
-     * @param integer         $message_template_group id   The EE_Message_Template_Group ID for the template.
-     * @param integer         $data_id                The id to the EE_Base_Class for getting the data used by the
-     *                                                trigger.
-     * @return string          The generated url.
-     * @throws EE_Error
-     */
-    public static function generate_url_trigger(
-        $sending_messenger,
-        $generating_messenger,
-        $context,
-        $message_type,
-        EE_Registration $registration,
-        $message_template_group,
-        $data_id = 0
-    ) {
-        $query_args = array(
-            'ee' => 'msg_url_trigger',
-            'snd_msgr' => $sending_messenger,
-            'gen_msgr' => $generating_messenger,
-            'message_type' => $message_type,
-            'context' => $context,
-            'token' => $registration->reg_url_link(),
-            'GRP_ID' => $message_template_group,
-            'id' => $data_id
-            );
-        $url = add_query_arg($query_args, get_home_url());
-
-        // made it here so now we can just get the url and filter it.  Filtered globally and by message type.
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__generate_url_trigger',
-            $url,
-            $sending_messenger,
-            $generating_messenger,
-            $context,
-            $message_type,
-            $registration,
-            $message_template_group,
-            $data_id
-        );
-    }
-
-
-
-
-    /**
-     * Return the specific css for the action icon given.
-     *
-     * @param string $type  What action to return.
-     * @return string[]
-     * @since 4.9.0
-     */
-    public static function get_message_action_icon($type)
-    {
-        $action_icons = self::get_message_action_icons();
-        return isset($action_icons[ $type ]) ? $action_icons[ $type ] : [];
-    }
-
-
-    /**
-     * This is used for retrieving the css classes used for the icons representing message actions.
-     *
-     * @since 4.9.0
-     *
-     * @return array
-     */
-    public static function get_message_action_icons()
-    {
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__message_action_icons',
-            array(
-                'view' => array(
-                    'label' => esc_html__('View Message', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-visibility',
-                ),
-                'error' => array(
-                    'label' => esc_html__('View Error Message', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-info',
-                ),
-                'see_notifications_for' => array(
-                    'label' => esc_html__('View Related Messages', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-megaphone',
-                ),
-                'generate_now' => array(
-                    'label' => esc_html__('Generate the message now.', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-admin-tools',
-                ),
-                'send_now' => array(
-                    'label' => esc_html__('Send Immediately', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-controls-forward',
-                ),
-                'queue_for_resending' => array(
-                    'label' => esc_html__('Queue for Resending', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-controls-repeat',
-                ),
-                'view_transaction' => array(
-                    'label' => esc_html__('View related Transaction', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-cart',
-                )
-            )
-        );
-    }
-
-
-    /**
-     * This returns the url for a given action related to EE_Message.
-     *
-     * @param string     $type         What type of action to return the url for.
-     * @param EE_Message $message      Required for generating the correct url for some types.
-     * @param array      $query_params Any additional query params to be included with the generated url.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.9.0
-     *
-     */
-    public static function get_message_action_url($type, EE_Message $message = null, $query_params = array())
-    {
-        $action_urls = self::get_message_action_urls($message, $query_params);
-        return isset($action_urls[ $type ])  ? $action_urls[ $type ] : '';
-    }
-
-
-    /**
-     * This returns all the current urls for EE_Message actions.
-     *
-     * @since 4.9.0
-     *
-     * @param EE_Message $message      The EE_Message object required to generate correct urls for some types.
-     * @param array      $query_params Any additional query_params to be included with the generated url.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_message_action_urls(EE_Message $message = null, $query_params = array())
-    {
-        EE_Registry::instance()->load_helper('URL');
-        // if $message is not an instance of EE_Message then let's just do a dummy.
-        $message = empty($message) ? EE_Message_Factory::create() : $message;
-        $action_urls =  apply_filters(
-            'FHEE__EEH_MSG_Template__get_message_action_url',
-            array(
-                'view' => EEH_MSG_Template::generate_browser_trigger($message),
-                'error' => EEH_MSG_Template::generate_error_display_trigger($message),
-                'see_notifications_for' => EEH_URL::add_query_args_and_nonce(
-                    array_merge(
-                        array(
-                            'page' => 'espresso_messages',
-                            'action' => 'default',
-                            'filterby' => 1,
-                        ),
-                        $query_params
-                    ),
-                    admin_url('admin.php')
-                ),
-                'generate_now' => EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'page' => 'espresso_messages',
-                        'action' => 'generate_now',
-                        'MSG_ID' => $message->ID()
-                    ),
-                    admin_url('admin.php')
-                ),
-                'send_now' => EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'page' => 'espresso_messages',
-                        'action' => 'send_now',
-                        'MSG_ID' => $message->ID()
-                    ),
-                    admin_url('admin.php')
-                ),
-                'queue_for_resending' => EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'page' => 'espresso_messages',
-                        'action' => 'queue_for_resending',
-                        'MSG_ID' => $message->ID()
-                    ),
-                    admin_url('admin.php')
-                ),
-            )
-        );
-        if (
-            $message->TXN_ID() > 0
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_transaction',
-                'espresso_transactions_default',
-                $message->TXN_ID()
-            )
-        ) {
-            $action_urls['view_transaction'] = EEH_URL::add_query_args_and_nonce(
-                array(
-                    'page' => 'espresso_transactions',
-                    'action' => 'view_transaction',
-                    'TXN_ID' => $message->TXN_ID()
-                ),
-                admin_url('admin.php')
-            );
-        } else {
-            $action_urls['view_transaction'] = '';
-        }
-        return $action_urls;
-    }
-
-
-    /**
-     * This returns a generated link html including the icon used for the action link for EE_Message actions.
-     *
-     * @param string          $type         What type of action the link is for (if invalid type is passed in then an
-     *                                      empty string is returned)
-     * @param EE_Message|null $message      The EE_Message object (required for some actions to generate correctly)
-     * @param array           $query_params Any extra query params to include in the generated link.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.9.0
-     *
-     */
-    public static function get_message_action_link($type, EE_Message $message = null, $query_params = array())
-    {
-        $url = EEH_MSG_Template::get_message_action_url($type, $message, $query_params);
-        $icon_css = EEH_MSG_Template::get_message_action_icon($type);
-        $label = $icon_css['label'] ?? null;
-        $label = $label ? 'aria-label="' . $label . '"' : '';
-        $class = $label ? ' ee-aria-tooltip' : '';
-
-        if (empty($url) || empty($icon_css) || ! isset($icon_css['css_class'])) {
-            return '';
-        }
-
-        $icon_css_class = $icon_css['css_class'] . apply_filters(
-            'FHEE__EEH_MSG_Template__get_message_action_link__icon_css_class',
-            ' js-ee-message-action-link ee-message-action-link-' . $type,
-            $type,
-            $message,
-            $query_params
-        );
-
-        return '
+	/**
+	 * Holds a collection of EE_Message_Template_Pack objects.
+	 * @type EE_Messages_Template_Pack_Collection
+	 */
+	protected static $_template_pack_collection;
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	private static function _set_autoloader()
+	{
+		EED_Messages::set_autoloaders();
+	}
+
+
+	/**
+	 * generate_new_templates
+	 * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
+	 * automatically create the defaults for the event.  The user would then be redirected to edit the default context
+	 * for the event.
+	 *
+	 * @access protected
+	 * @param string $messenger     the messenger we are generating templates for
+	 * @param array  $message_types array of message types that the templates are generated for.
+	 * @param int    $GRP_ID        If a non global template is being generated then it is expected we'll have a GRP_ID
+	 *                              to use as the base for the new generated template.
+	 * @param bool   $global        true indicates generating templates on messenger activation. false requires GRP_ID
+	 *                              for event specific template generation.
+	 * @return array  @see EEH_MSG_Template::_create_new_templates for the return value of each element in the array
+	 *                for templates that are generated.  If this is an empty array then it means no templates were
+	 *                generated which usually means there was an error.  Anything in the array with an empty value for
+	 *                `MTP_context` means that it was not a new generated template but just reactivated (which only
+	 *                happens for global templates that already exist in the database.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
+	{
+		// make sure message_type is an array.
+		$message_types = (array) $message_types;
+		$templates = array();
+
+		if (empty($messenger)) {
+			throw new EE_Error(esc_html__('We need a messenger to generate templates!', 'event_espresso'));
+		}
+
+		// if we STILL have empty $message_types then we need to generate an error message b/c we NEED message types to do the template files.
+		if (empty($message_types)) {
+			throw new EE_Error(esc_html__('We need at least one message type to generate templates!', 'event_espresso'));
+		}
+
+		EEH_MSG_Template::_set_autoloader();
+		foreach ($message_types as $message_type) {
+			// if this is global template generation.
+			if ($global) {
+				// let's attempt to get the GRP_ID for this combo IF GRP_ID is empty.
+				if (empty($GRP_ID)) {
+					$GRP_ID = EEM_Message_Template_Group::instance()->get_one(
+						array(
+							array(
+								'MTP_messenger'    => $messenger,
+								'MTP_message_type' => $message_type,
+								'MTP_is_global'    => true,
+							),
+						)
+					);
+					$GRP_ID = $GRP_ID instanceof EE_Message_Template_Group ? $GRP_ID->ID() : 0;
+				}
+				// First let's determine if we already HAVE global templates for this messenger and message_type combination.
+				//  If we do then NO generation!!
+				if (EEH_MSG_Template::already_generated($messenger, $message_type, $GRP_ID)) {
+					$templates[] = array(
+						'GRP_ID' => $GRP_ID,
+						'MTP_context' => '',
+					);
+					// we already have generated templates for this so let's go to the next message type.
+					continue;
+				}
+			}
+			$new_message_template_group = EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $global);
+
+			if (! $new_message_template_group) {
+				continue;
+			}
+			$templates[] = $new_message_template_group;
+		}
+
+		return $templates;
+	}
+
+
+	/**
+	 * The purpose of this method is to determine if there are already generated templates in the database for the
+	 * given variables.
+	 *
+	 * @param string $messenger    messenger
+	 * @param string $message_type message type
+	 * @param int    $GRP_ID       GRP ID ( if a custom template) (if not provided then we're just doing global
+	 *                             template check)
+	 * @return bool                true = generated, false = hasn't been generated.
+	 * @throws EE_Error
+	 */
+	public static function already_generated($messenger, $message_type, $GRP_ID = 0)
+	{
+		EEH_MSG_Template::_set_autoloader();
+		// what method we use depends on whether we have an GRP_ID or not
+		$count = empty($GRP_ID)
+			? EEM_Message_Template::instance()->count(
+				array(
+					array(
+						'Message_Template_Group.MTP_messenger'    => $messenger,
+						'Message_Template_Group.MTP_message_type' => $message_type,
+						'Message_Template_Group.MTP_is_global'    => true
+					)
+				)
+			)
+			: EEM_Message_Template::instance()->count(array( array( 'GRP_ID' => $GRP_ID ) ));
+
+		return $count > 0;
+	}
+
+
+	/**
+	 * Updates all message templates matching the incoming messengers and message types to active status.
+	 *
+	 * @static
+	 * @param array $messenger_names    Messenger slug
+	 * @param array $message_type_names Message type slug
+	 * @return  int                         count of updated records.
+	 * @throws EE_Error
+	 */
+	public static function update_to_active($messenger_names, $message_type_names)
+	{
+		$messenger_names = is_array($messenger_names) ? $messenger_names : array( $messenger_names );
+		$message_type_names = is_array($message_type_names) ? $message_type_names : array( $message_type_names );
+		return EEM_Message_Template_Group::instance()->update(
+			array( 'MTP_is_active' => 1 ),
+			array(
+				array(
+					'MTP_messenger'     => array( 'IN', $messenger_names ),
+					'MTP_message_type'  => array( 'IN', $message_type_names )
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * Updates all message template groups matching the incoming arguments to inactive status.
+	 *
+	 * @static
+	 * @param array $messenger_names    The messenger slugs.
+	 *                                  If empty then all templates matching the message types are marked inactive.
+	 *                                  Otherwise only templates matching the messengers and message types.
+	 * @param array $message_type_names The message type slugs.
+	 *                                  If empty then all templates matching the messengers are marked inactive.
+	 *                                  Otherwise only templates matching the messengers and message types.
+	 *
+	 * @return int  count of updated records.
+	 * @throws EE_Error
+	 */
+	public static function update_to_inactive($messenger_names = array(), $message_type_names = array())
+	{
+		return EEM_Message_Template_Group::instance()->deactivate_message_template_groups_for(
+			$messenger_names,
+			$message_type_names
+		);
+	}
+
+
+	/**
+	 * The purpose of this function is to return all installed message objects
+	 * (messengers and message type regardless of whether they are ACTIVE or not)
+	 *
+	 * @param string $type
+	 * @return array array consisting of installed messenger objects and installed message type objects.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated 4.9.0
+	 * @static
+	 */
+	public static function get_installed_message_objects($type = 'all')
+	{
+		self::_set_autoloader();
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return array(
+			'messenger' => $message_resource_manager->installed_messengers(),
+			'message_type' => $message_resource_manager->installed_message_types()
+		);
+	}
+
+
+	/**
+	 * This will return an array of shortcodes => labels from the
+	 * messenger and message_type objects associated with this
+	 * template.
+	 *
+	 * @param string $message_type
+	 * @param string $messenger
+	 * @param array  $fields                        What fields we're returning valid shortcodes for.
+	 *                                              If empty then we assume all fields are to be returned. Optional.
+	 * @param string $context                       What context we're going to return shortcodes for. Optional.
+	 * @param bool   $merged                        If TRUE then we don't return shortcodes indexed by field,
+	 *                                              but instead an array of the unique shortcodes for all the given (
+	 *                                              or all) fields. Optional.
+	 * @return array                                an array of shortcodes in the format
+	 *                                              array( '[shortcode] => 'label')
+	 *                                              OR
+	 *                                              FALSE if no shortcodes found.
+	 * @throws ReflectionException
+	 * @throws EE_Error*@since 4.3.0
+	 *
+	 */
+	public static function get_shortcodes(
+		$message_type,
+		$messenger,
+		$fields = array(),
+		$context = 'admin',
+		$merged = false
+	) {
+		$messenger_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $messenger)));
+		$mt_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $message_type)));
+		/** @var EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		// convert slug to object
+		$messenger = $message_resource_manager->get_messenger($messenger);
+
+		// if messenger isn't a EE_messenger resource then bail.
+		if (! $messenger instanceof EE_messenger) {
+			return array();
+		}
+
+		// validate class for getting our list of shortcodes
+		$classname = 'EE_Messages_' . $messenger_name . '_' . $mt_name . '_Validator';
+		if (! class_exists($classname)) {
+			$msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
+			$msg[] = sprintf(
+				esc_html__('The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class', 'event_espresso'),
+				$classname
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+
+		/** @type EE_Messages_Validator $_VLD */
+		$_VLD = new $classname(array(), $context);
+		$valid_shortcodes = $_VLD->get_validators();
+
+		// let's make sure we're only getting the shortcode part of the validators
+		$shortcodes = array();
+		foreach ($valid_shortcodes as $field => $validators) {
+			$shortcodes[ $field ] = $validators['shortcodes'];
+		}
+		$valid_shortcodes = $shortcodes;
+
+		// if not all fields let's make sure we ONLY include the shortcodes for the specified fields.
+		if (! empty($fields)) {
+			$specified_shortcodes = array();
+			foreach ($fields as $field) {
+				if (isset($valid_shortcodes[ $field ])) {
+					$specified_shortcodes[ $field ] = $valid_shortcodes[ $field ];
+				}
+			}
+			$valid_shortcodes = $specified_shortcodes;
+		}
+
+		// if not merged then let's replace the fields with the localized fields
+		if (! $merged) {
+			// let's get all the fields for the set messenger so that we can get the localized label and use that in the returned array.
+			$field_settings = $messenger->get_template_fields();
+			$localized = array();
+			foreach ($valid_shortcodes as $field => $shortcodes) {
+				// get localized field label
+				if (isset($field_settings[ $field ])) {
+					// possible that this is used as a main field.
+					if (empty($field_settings[ $field ])) {
+						if (isset($field_settings['extra'][ $field ])) {
+							$_field = $field_settings['extra'][ $field ]['main']['label'];
+						} else {
+							$_field = $field;
+						}
+					} else {
+						$_field = $field_settings[ $field ]['label'];
+					}
+				} elseif (isset($field_settings['extra'])) {
+					// loop through extra "main fields" and see if any of their children have our field
+					foreach ($field_settings['extra'] as $fields) {
+						if (isset($fields[ $field ])) {
+							$_field = $fields[ $field ]['label'];
+						} else {
+							$_field = $field;
+						}
+					}
+				} else {
+					$_field = $field;
+				}
+				if (isset($_field)) {
+					$localized[ (string) $_field ] = $shortcodes;
+				}
+			}
+			$valid_shortcodes = $localized;
+		}
+
+		// if $merged then let's merge all the shortcodes into one list NOT indexed by field.
+		if ($merged) {
+			$merged_codes = array();
+			foreach ($valid_shortcodes as $shortcode) {
+				foreach ($shortcode as $code => $label) {
+					if (isset($merged_codes[ $code ])) {
+						continue;
+					} else {
+						$merged_codes[ $code ] = $label;
+					}
+				}
+			}
+			$valid_shortcodes = $merged_codes;
+		}
+
+		return $valid_shortcodes;
+	}
+
+
+	/**
+	 * Get Messenger object.
+	 *
+	 * @param string $messenger messenger slug for the messenger object we want to retrieve.
+	 * @return EE_messenger
+	 * @throws ReflectionException
+	 * @throws EE_Error*@since 4.3.0
+	 * @deprecated 4.9.0
+	 */
+	public static function messenger_obj($messenger)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_messenger($messenger);
+	}
+
+
+	/**
+	 * get Message type object
+	 *
+	 * @param string $message_type the slug for the message type object to retrieve
+	 * @return EE_message_type
+	 * @throws ReflectionException
+	 * @throws EE_Error*@since 4.3.0
+	 * @deprecated 4.9.0
+	 */
+	public static function message_type_obj($message_type)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_message_type($message_type);
+	}
+
+
+	/**
+	 * Given a message_type slug, will return whether that message type is active in the system or not.
+	 *
+	 * @since    4.3.0
+	 * @param string $message_type message type to check for.
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function is_mt_active($message_type)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_mts = $Message_Resource_Manager->list_of_active_message_types();
+		return in_array($message_type, $active_mts);
+	}
+
+
+	/**
+	 * Given a messenger slug, will return whether that messenger is active in the system or not.
+	 *
+	 * @since    4.3.0
+	 *
+	 * @param string $messenger slug for messenger to check.
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function is_messenger_active($messenger)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messenger = $Message_Resource_Manager->get_active_messenger($messenger);
+		return $active_messenger instanceof EE_messenger;
+	}
+
+
+	/**
+	 * Used to return active messengers array stored in the wp options table.
+	 * If no value is present in the option then an empty array is returned.
+	 *
+	 * @deprecated 4.9
+	 * @since      4.3.1
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_active_messengers_in_db()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Please use EE_Message_Resource_Manager::get_active_messengers_option() instead.', 'event_espresso'),
+			'4.9.0'
+		);
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_active_messengers_option();
+	}
+
+
+	/**
+	 * Used to update the active messengers array stored in the wp options table.
+	 *
+	 * @since      4.3.1
+	 * @deprecated 4.9.0
+	 *
+	 * @param array $data_to_save Incoming data to save.
+	 *
+	 * @return bool FALSE if not updated, TRUE if updated.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function update_active_messengers_in_db($data_to_save)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Please use EE_Message_Resource_Manager::update_active_messengers_option() instead.', 'event_espresso'),
+			'4.9.0'
+		);
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->update_active_messengers_option($data_to_save);
+	}
+
+
+	/**
+	 * This does some validation of incoming params, determines what type of url is being prepped and returns the
+	 * appropriate url trigger
+	 *
+	 * @param EE_message_type $message_type
+	 * @param EE_Message $message
+	 * @param EE_Registration | null $registration  The registration object must be included if this
+	 *                                              is going to be a registration trigger url.
+	 * @param string $sending_messenger             The (optional) sending messenger for the url.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function get_url_trigger(
+		EE_message_type $message_type,
+		EE_Message $message,
+		$registration = null,
+		$sending_messenger = ''
+	) {
+		// first determine if the url can be to the EE_Message object.
+		if (! $message_type->always_generate()) {
+			return EEH_MSG_Template::generate_browser_trigger($message);
+		}
+
+		// if $registration object is not valid then exit early because there's nothing that can be generated.
+		if (! $registration instanceof EE_Registration) {
+			throw new EE_Error(
+				esc_html__('Incoming value for registration is not a valid EE_Registration object.', 'event_espresso')
+			);
+		}
+
+		// validate given context
+		$contexts = $message_type->get_contexts();
+		if ($message->context() !== '' && ! isset($contexts[ $message->context() ])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('The context %s is not a valid context for %s.', 'event_espresso'),
+					$message->context(),
+					get_class($message_type)
+				)
+			);
+		}
+
+		// valid sending messenger but only if sending messenger set.  Otherwise generating messenger is used.
+		if (! empty($sending_messenger)) {
+			$with_messengers = $message_type->with_messengers();
+			if (
+				! isset($with_messengers[ $message->messenger() ])
+				 || ! in_array($sending_messenger, $with_messengers[ $message->messenger() ])
+			) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The given sending messenger string (%1$s) does not match a valid sending messenger with the %2$s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
+							'event_espresso'
+						),
+						$sending_messenger,
+						get_class($message_type)
+					)
+				);
+			}
+		} else {
+			$sending_messenger = $message->messenger();
+		}
+		return EEH_MSG_Template::generate_url_trigger(
+			$sending_messenger,
+			$message->messenger(),
+			$message->context(),
+			$message->message_type(),
+			$registration,
+			$message->GRP_ID()
+		);
+	}
+
+
+	/**
+	 * This returns the url for triggering a in browser view of a specific EE_Message object.
+	 * @param EE_Message $message
+	 * @return string.
+	 */
+	public static function generate_browser_trigger(EE_Message $message)
+	{
+		$query_args = array(
+			'ee' => 'msg_browser_trigger',
+			'token' => $message->MSG_token()
+		);
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__generate_browser_trigger',
+			add_query_arg($query_args, site_url()),
+			$message
+		);
+	}
+
+
+
+
+
+
+	/**
+	 * This returns the url for triggering an in browser view of the error saved on the incoming message object.
+	 * @param EE_Message $message
+	 * @return string
+	 */
+	public static function generate_error_display_trigger(EE_Message $message)
+	{
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__generate_error_display_trigger',
+			add_query_arg(
+				array(
+					'ee' => 'msg_browser_error_trigger',
+					'token' => $message->MSG_token()
+				),
+				site_url()
+			),
+			$message
+		);
+	}
+
+
+	/**
+	 * This generates a url trigger for the msg_url_trigger route using the given arguments
+	 *
+	 * @param string          $sending_messenger      The sending messenger slug.
+	 * @param string          $generating_messenger   The generating messenger slug.
+	 * @param string          $context                The context for the template.
+	 * @param string          $message_type           The message type slug
+	 * @param EE_Registration $registration
+	 * @param integer         $message_template_group id   The EE_Message_Template_Group ID for the template.
+	 * @param integer         $data_id                The id to the EE_Base_Class for getting the data used by the
+	 *                                                trigger.
+	 * @return string          The generated url.
+	 * @throws EE_Error
+	 */
+	public static function generate_url_trigger(
+		$sending_messenger,
+		$generating_messenger,
+		$context,
+		$message_type,
+		EE_Registration $registration,
+		$message_template_group,
+		$data_id = 0
+	) {
+		$query_args = array(
+			'ee' => 'msg_url_trigger',
+			'snd_msgr' => $sending_messenger,
+			'gen_msgr' => $generating_messenger,
+			'message_type' => $message_type,
+			'context' => $context,
+			'token' => $registration->reg_url_link(),
+			'GRP_ID' => $message_template_group,
+			'id' => $data_id
+			);
+		$url = add_query_arg($query_args, get_home_url());
+
+		// made it here so now we can just get the url and filter it.  Filtered globally and by message type.
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__generate_url_trigger',
+			$url,
+			$sending_messenger,
+			$generating_messenger,
+			$context,
+			$message_type,
+			$registration,
+			$message_template_group,
+			$data_id
+		);
+	}
+
+
+
+
+	/**
+	 * Return the specific css for the action icon given.
+	 *
+	 * @param string $type  What action to return.
+	 * @return string[]
+	 * @since 4.9.0
+	 */
+	public static function get_message_action_icon($type)
+	{
+		$action_icons = self::get_message_action_icons();
+		return isset($action_icons[ $type ]) ? $action_icons[ $type ] : [];
+	}
+
+
+	/**
+	 * This is used for retrieving the css classes used for the icons representing message actions.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @return array
+	 */
+	public static function get_message_action_icons()
+	{
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__message_action_icons',
+			array(
+				'view' => array(
+					'label' => esc_html__('View Message', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-visibility',
+				),
+				'error' => array(
+					'label' => esc_html__('View Error Message', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-info',
+				),
+				'see_notifications_for' => array(
+					'label' => esc_html__('View Related Messages', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-megaphone',
+				),
+				'generate_now' => array(
+					'label' => esc_html__('Generate the message now.', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-admin-tools',
+				),
+				'send_now' => array(
+					'label' => esc_html__('Send Immediately', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-controls-forward',
+				),
+				'queue_for_resending' => array(
+					'label' => esc_html__('Queue for Resending', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-controls-repeat',
+				),
+				'view_transaction' => array(
+					'label' => esc_html__('View related Transaction', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-cart',
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * This returns the url for a given action related to EE_Message.
+	 *
+	 * @param string     $type         What type of action to return the url for.
+	 * @param EE_Message $message      Required for generating the correct url for some types.
+	 * @param array      $query_params Any additional query params to be included with the generated url.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.9.0
+	 *
+	 */
+	public static function get_message_action_url($type, EE_Message $message = null, $query_params = array())
+	{
+		$action_urls = self::get_message_action_urls($message, $query_params);
+		return isset($action_urls[ $type ])  ? $action_urls[ $type ] : '';
+	}
+
+
+	/**
+	 * This returns all the current urls for EE_Message actions.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @param EE_Message $message      The EE_Message object required to generate correct urls for some types.
+	 * @param array      $query_params Any additional query_params to be included with the generated url.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_message_action_urls(EE_Message $message = null, $query_params = array())
+	{
+		EE_Registry::instance()->load_helper('URL');
+		// if $message is not an instance of EE_Message then let's just do a dummy.
+		$message = empty($message) ? EE_Message_Factory::create() : $message;
+		$action_urls =  apply_filters(
+			'FHEE__EEH_MSG_Template__get_message_action_url',
+			array(
+				'view' => EEH_MSG_Template::generate_browser_trigger($message),
+				'error' => EEH_MSG_Template::generate_error_display_trigger($message),
+				'see_notifications_for' => EEH_URL::add_query_args_and_nonce(
+					array_merge(
+						array(
+							'page' => 'espresso_messages',
+							'action' => 'default',
+							'filterby' => 1,
+						),
+						$query_params
+					),
+					admin_url('admin.php')
+				),
+				'generate_now' => EEH_URL::add_query_args_and_nonce(
+					array(
+						'page' => 'espresso_messages',
+						'action' => 'generate_now',
+						'MSG_ID' => $message->ID()
+					),
+					admin_url('admin.php')
+				),
+				'send_now' => EEH_URL::add_query_args_and_nonce(
+					array(
+						'page' => 'espresso_messages',
+						'action' => 'send_now',
+						'MSG_ID' => $message->ID()
+					),
+					admin_url('admin.php')
+				),
+				'queue_for_resending' => EEH_URL::add_query_args_and_nonce(
+					array(
+						'page' => 'espresso_messages',
+						'action' => 'queue_for_resending',
+						'MSG_ID' => $message->ID()
+					),
+					admin_url('admin.php')
+				),
+			)
+		);
+		if (
+			$message->TXN_ID() > 0
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_transaction',
+				'espresso_transactions_default',
+				$message->TXN_ID()
+			)
+		) {
+			$action_urls['view_transaction'] = EEH_URL::add_query_args_and_nonce(
+				array(
+					'page' => 'espresso_transactions',
+					'action' => 'view_transaction',
+					'TXN_ID' => $message->TXN_ID()
+				),
+				admin_url('admin.php')
+			);
+		} else {
+			$action_urls['view_transaction'] = '';
+		}
+		return $action_urls;
+	}
+
+
+	/**
+	 * This returns a generated link html including the icon used for the action link for EE_Message actions.
+	 *
+	 * @param string          $type         What type of action the link is for (if invalid type is passed in then an
+	 *                                      empty string is returned)
+	 * @param EE_Message|null $message      The EE_Message object (required for some actions to generate correctly)
+	 * @param array           $query_params Any extra query params to include in the generated link.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.9.0
+	 *
+	 */
+	public static function get_message_action_link($type, EE_Message $message = null, $query_params = array())
+	{
+		$url = EEH_MSG_Template::get_message_action_url($type, $message, $query_params);
+		$icon_css = EEH_MSG_Template::get_message_action_icon($type);
+		$label = $icon_css['label'] ?? null;
+		$label = $label ? 'aria-label="' . $label . '"' : '';
+		$class = $label ? ' ee-aria-tooltip' : '';
+
+		if (empty($url) || empty($icon_css) || ! isset($icon_css['css_class'])) {
+			return '';
+		}
+
+		$icon_css_class = $icon_css['css_class'] . apply_filters(
+			'FHEE__EEH_MSG_Template__get_message_action_link__icon_css_class',
+			' js-ee-message-action-link ee-message-action-link-' . $type,
+			$type,
+			$message,
+			$query_params
+		);
+
+		return '
             <a href="' . $url . '" ' . $label . ' class="button button--icon-only' . $class . '">
                 <span class="' .  esc_attr($icon_css_class) . '"></span>
             </a>';
-    }
-
-
-
-
-
-    /**
-     * This returns an array with keys as reg statuses and values as the corresponding message type slug (filtered).
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    public static function reg_status_to_message_type_array()
-    {
-        return (array) apply_filters(
-            'FHEE__EEH_MSG_Template__reg_status_to_message_type_array',
-            array(
-                EEM_Registration::status_id_approved => 'registration',
-                EEM_Registration::status_id_pending_payment => 'pending_approval',
-                EEM_Registration::status_id_not_approved => 'not_approved_registration',
-                EEM_Registration::status_id_cancelled => 'cancelled_registration',
-                EEM_Registration::status_id_declined => 'declined_registration'
-            )
-        );
-    }
-
-
-
-
-    /**
-     * This returns the corresponding registration message type slug to the given reg status. If there isn't a
-     * match, then returns an empty string.
-     *
-     * @since 4.9.0
-     * @param $reg_status
-     * @return string
-     */
-    public static function convert_reg_status_to_message_type($reg_status)
-    {
-        $reg_status_array = self::reg_status_to_message_type_array();
-        return isset($reg_status_array[ $reg_status ]) ? $reg_status_array[ $reg_status ] : '';
-    }
-
-
-    /**
-     * This returns an array with keys as payment stati and values as the corresponding message type slug (filtered).
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    public static function payment_status_to_message_type_array()
-    {
-        return (array) apply_filters(
-            'FHEE__EEH_MSG_Template__payment_status_to_message_type_array',
-            array(
-                EEM_Payment::status_id_approved => 'payment',
-                EEM_Payment::status_id_pending => 'payment_pending',
-                EEM_Payment::status_id_cancelled => 'payment_cancelled',
-                EEM_Payment::status_id_declined => 'payment_declined',
-                EEM_Payment::status_id_failed => 'payment_failed'
-            )
-        );
-    }
-
-
-
-
-    /**
-     * This returns the corresponding payment message type slug to the given payment status. If there isn't a match then
-     * an empty string is returned
-     *
-     * @since 4.9.0
-     * @param $payment_status
-     * @return string
-     */
-    public static function convert_payment_status_to_message_type($payment_status)
-    {
-        $payment_status_array = self::payment_status_to_message_type_array();
-        return isset($payment_status_array[ $payment_status ]) ? $payment_status_array[ $payment_status ] : '';
-    }
-
-
-    /**
-     * This is used to retrieve the template pack for the given name.
-     *
-     * @param string $template_pack_name  should match the set `dbref` property value on the EE_Messages_Template_Pack.
-     *
-     * @return EE_Messages_Template_Pack
-     */
-    public static function get_template_pack($template_pack_name)
-    {
-        if (! self::$_template_pack_collection instanceof EE_Object_Collection) {
-            self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
-        }
-
-        // first see if in collection already
-        $template_pack = self::$_template_pack_collection->get_by_name($template_pack_name);
-
-        if ($template_pack instanceof EE_Messages_Template_Pack) {
-            return $template_pack;
-        }
-
-        // nope...let's get it.
-        // not set yet so let's attempt to get it.
-        $pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
-            ' ',
-            '_',
-            ucwords(
-                str_replace('_', ' ', $template_pack_name)
-            )
-        );
-        if (! class_exists($pack_class_name) && $template_pack_name !== 'default') {
-            return self::get_template_pack('default');
-        } else {
-            $template_pack = new $pack_class_name();
-            self::$_template_pack_collection->add($template_pack);
-            return $template_pack;
-        }
-    }
-
-
-
-
-    /**
-     * Globs template packs installed in core and returns the template pack collection with all installed template packs
-     * in it.
-     *
-     * @since 4.9.0
-     *
-     * @return EE_Messages_Template_Pack_Collection
-     */
-    public static function get_template_pack_collection()
-    {
-        $new_collection = false;
-        if (! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection) {
-            self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
-            $new_collection = true;
-        }
-
-        // glob the defaults directory for messages
-        $templates = glob(EE_LIBRARIES . 'messages/defaults/*', GLOB_ONLYDIR);
-        foreach ($templates as $template_path) {
-            // grab folder name
-            $template = basename($template_path);
-
-            if (! $new_collection) {
-                // already have it?
-                if (self::$_template_pack_collection->get_by_name($template) instanceof EE_Messages_Template_Pack) {
-                    continue;
-                }
-            }
-
-            // setup classname.
-            $template_pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
-                ' ',
-                '_',
-                ucwords(
-                    str_replace(
-                        '_',
-                        ' ',
-                        $template
-                    )
-                )
-            );
-            if (! class_exists($template_pack_class_name)) {
-                continue;
-            }
-            self::$_template_pack_collection->add(new $template_pack_class_name());
-        }
-
-        /**
-         * Filter for plugins to add in any additional template packs
-         * Note the filter name here is for backward compat, this used to be found in EED_Messages.
-         */
-        $additional_template_packs = apply_filters('FHEE__EED_Messages__get_template_packs__template_packs', array());
-        foreach ((array) $additional_template_packs as $template_pack) {
-            if (
-                self::$_template_pack_collection->get_by_name(
-                    $template_pack->dbref
-                ) instanceof EE_Messages_Template_Pack
-            ) {
-                continue;
-            }
-            self::$_template_pack_collection->add($template_pack);
-        }
-        return self::$_template_pack_collection;
-    }
-
-
-    /**
-     * This is a wrapper for the protected _create_new_templates function
-     *
-     * @param string $messenger_name
-     * @param string $message_type_name message type that the templates are being created for
-     * @param int    $GRP_ID
-     * @param bool   $global
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function create_new_templates($messenger_name, $message_type_name, $GRP_ID = 0, $global = false)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
-        $message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
-        if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type, $global)) {
-            return array();
-        }
-        // whew made it this far!  Okay, let's go ahead and create the templates then
-        return EEH_MSG_Template::_create_new_templates($messenger, $message_type, $GRP_ID, $global);
-    }
-
-
-    /**
-     * @param EE_messenger     $messenger
-     * @param EE_message_type  $message_type
-     * @param                  $GRP_ID
-     * @param                  $global
-     * @return array|mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function _create_new_templates(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global)
-    {
-        // if we're creating a custom template then we don't need to use the defaults class
-        if (! $global) {
-            return EEH_MSG_Template::_create_custom_template_group($messenger, $message_type, $GRP_ID);
-        }
-        /** @type EE_Messages_Template_Defaults $Message_Template_Defaults */
-        $Message_Template_Defaults = EE_Registry::factory(
-            'EE_Messages_Template_Defaults',
-            array( $messenger, $message_type, $GRP_ID )
-        );
-        // generate templates
-        $success = $Message_Template_Defaults->create_new_templates();
-
-        // if creating the template failed.  Then we should deactivate the related message_type for the messenger because
-        // its not active if it doesn't have a template.  Note this is only happening for GLOBAL template creation
-        // attempts.
-        if (! $success) {
-            /** @var EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            $message_resource_manager->deactivate_message_type_for_messenger($message_type->name, $messenger->name);
-        }
-
-        /**
-         * $success is in an array in the following format
-         * array(
-         *    'GRP_ID' => $new_grp_id,
-         *    'MTP_context' => $first_context_in_new_templates,
-         * )
-         */
-        return $success;
-    }
-
-
-    /**
-     * This creates a custom template using the incoming GRP_ID
-     *
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @param int             $GRP_ID           GRP_ID for the template_group being used as the base
-     * @return  array $success              This will be an array in the format:
-     *                                          array(
-     *                                          'GRP_ID' => $new_grp_id,
-     *                                          'MTP_context' => $first_context_in_created_template
-     *                                          )
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @access private
-     */
-    private static function _create_custom_template_group(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID)
-    {
-        // defaults
-        $success = array( 'GRP_ID' => null, 'MTP_context' => '' );
-        // get the template group to use as a template from the db.  If $GRP_ID is empty then we'll assume the base will be the global template matching the messenger and message type.
-        $Message_Template_Group = empty($GRP_ID)
-            ? EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $messenger->name,
-                        'MTP_message_type' => $message_type->name,
-                        'MTP_is_global'    => true
-                    )
-                )
-            )
-            : EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
-        // if we don't have a mtg at this point then we need to bail.
-        if (! $Message_Template_Group instanceof EE_Message_Template_Group) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Something went wrong with generating the custom template from this group id: %s.  This usually happens when there is no matching message template group in the db.',
-                        'event_espresso'
-                    ),
-                    $GRP_ID
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return $success;
-        }
-        // let's get all the related message_template objects for this group.
-        $message_templates = $Message_Template_Group->message_templates();
-        // now we have what we need to setup the new template
-        $new_mtg = clone $Message_Template_Group;
-        $new_mtg->set('GRP_ID', 0);
-        $new_mtg->set('MTP_is_global', false);
-
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $template_name = $request->isAjax() && $request->requestParamIsSet('templateName')
-            ? $request->getRequestParam('templateName')
-            : esc_html__('New Custom Template', 'event_espresso');
-        $template_description = $request->isAjax() && $request->requestParamIsSet('templateDescription')
-            ? $request->getRequestParam('templateDescription')
-            : sprintf(
-                esc_html__(
-                    'This is a custom template that was created for the %s messenger and %s message type.',
-                    'event_espresso'
-                ),
-                $new_mtg->messenger_obj()->label['singular'],
-                $new_mtg->message_type_obj()->label['singular']
-            );
-        $new_mtg->set('MTP_name', $template_name);
-        $new_mtg->set('MTP_description', $template_description);
-        // remove ALL relations on this template group so they don't get saved!
-        $new_mtg->_remove_relations('Message_Template');
-        $new_mtg->save();
-        $success['GRP_ID'] = $new_mtg->ID();
-        $success['template_name'] = $template_name;
-        // add new message templates and add relation to.
-        foreach ($message_templates as $message_template) {
-            if (! $message_template instanceof EE_Message_Template) {
-                continue;
-            }
-            $new_message_template = clone $message_template;
-            $new_message_template->set('MTP_ID', 0);
-            $new_message_template->set('GRP_ID', $new_mtg->ID()); // relation
-            $new_message_template->save();
-            if (empty($success['MTP_context']) && $new_message_template->get('MTP_context') !== 'admin') {
-                $success['MTP_context'] = $new_message_template->get('MTP_context');
-            }
-        }
-        return $success;
-    }
-
-
-    /**
-     * message_type_has_active_templates_for_messenger
-     *
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @param bool            $global
-     * @return bool
-     * @throws EE_Error
-     */
-    public static function message_type_has_active_templates_for_messenger(
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $global = false
-    ) {
-        // is given message_type valid for given messenger (if this is not a global save)
-        if ($global) {
-            return true;
-        }
-        $active_templates = EEM_Message_Template_Group::instance()->count(
-            array(
-                array(
-                    'MTP_is_active'    => true,
-                    'MTP_messenger'    => $messenger->name,
-                    'MTP_message_type' => $message_type->name
-                )
-            )
-        );
-        if ($active_templates > 0) {
-            return true;
-        }
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'The %1$s message type is not registered with the %2$s messenger. Please visit the Messenger activation page to assign this message type first if you want to use it.',
-                    'event_espresso'
-                ),
-                $message_type->name,
-                $messenger->name
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
-
-
-    /**
-     * get_fields
-     * This takes a given messenger and message type and returns all the template fields indexed by context (and with field type).
-     *
-     * @param string $messenger_name    name of EE_messenger
-     * @param string $message_type_name name of EE_message_type
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_fields($messenger_name, $message_type_name)
-    {
-        $template_fields = array();
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
-        $message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
-        if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type)) {
-            return array();
-        }
-
-        $excluded_fields_for_messenger = $message_type->excludedFieldsForMessenger($messenger_name);
-
-        // okay now let's assemble an array with the messenger template fields added to the message_type contexts.
-        foreach ($message_type->get_contexts() as $context => $details) {
-            foreach ($messenger->get_template_fields() as $field => $value) {
-                if (in_array($field, $excluded_fields_for_messenger, true)) {
-                    continue;
-                }
-                $template_fields[ $context ][ $field ] = $value;
-            }
-        }
-        if (empty($template_fields)) {
-            EE_Error::add_error(
-                esc_html__('Something went wrong and we couldn\'t get any templates assembled', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return array();
-        }
-        return $template_fields;
-    }
+	}
+
+
+
+
+
+	/**
+	 * This returns an array with keys as reg statuses and values as the corresponding message type slug (filtered).
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public static function reg_status_to_message_type_array()
+	{
+		return (array) apply_filters(
+			'FHEE__EEH_MSG_Template__reg_status_to_message_type_array',
+			array(
+				EEM_Registration::status_id_approved => 'registration',
+				EEM_Registration::status_id_pending_payment => 'pending_approval',
+				EEM_Registration::status_id_not_approved => 'not_approved_registration',
+				EEM_Registration::status_id_cancelled => 'cancelled_registration',
+				EEM_Registration::status_id_declined => 'declined_registration'
+			)
+		);
+	}
+
+
+
+
+	/**
+	 * This returns the corresponding registration message type slug to the given reg status. If there isn't a
+	 * match, then returns an empty string.
+	 *
+	 * @since 4.9.0
+	 * @param $reg_status
+	 * @return string
+	 */
+	public static function convert_reg_status_to_message_type($reg_status)
+	{
+		$reg_status_array = self::reg_status_to_message_type_array();
+		return isset($reg_status_array[ $reg_status ]) ? $reg_status_array[ $reg_status ] : '';
+	}
+
+
+	/**
+	 * This returns an array with keys as payment stati and values as the corresponding message type slug (filtered).
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public static function payment_status_to_message_type_array()
+	{
+		return (array) apply_filters(
+			'FHEE__EEH_MSG_Template__payment_status_to_message_type_array',
+			array(
+				EEM_Payment::status_id_approved => 'payment',
+				EEM_Payment::status_id_pending => 'payment_pending',
+				EEM_Payment::status_id_cancelled => 'payment_cancelled',
+				EEM_Payment::status_id_declined => 'payment_declined',
+				EEM_Payment::status_id_failed => 'payment_failed'
+			)
+		);
+	}
+
+
+
+
+	/**
+	 * This returns the corresponding payment message type slug to the given payment status. If there isn't a match then
+	 * an empty string is returned
+	 *
+	 * @since 4.9.0
+	 * @param $payment_status
+	 * @return string
+	 */
+	public static function convert_payment_status_to_message_type($payment_status)
+	{
+		$payment_status_array = self::payment_status_to_message_type_array();
+		return isset($payment_status_array[ $payment_status ]) ? $payment_status_array[ $payment_status ] : '';
+	}
+
+
+	/**
+	 * This is used to retrieve the template pack for the given name.
+	 *
+	 * @param string $template_pack_name  should match the set `dbref` property value on the EE_Messages_Template_Pack.
+	 *
+	 * @return EE_Messages_Template_Pack
+	 */
+	public static function get_template_pack($template_pack_name)
+	{
+		if (! self::$_template_pack_collection instanceof EE_Object_Collection) {
+			self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
+		}
+
+		// first see if in collection already
+		$template_pack = self::$_template_pack_collection->get_by_name($template_pack_name);
+
+		if ($template_pack instanceof EE_Messages_Template_Pack) {
+			return $template_pack;
+		}
+
+		// nope...let's get it.
+		// not set yet so let's attempt to get it.
+		$pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+			' ',
+			'_',
+			ucwords(
+				str_replace('_', ' ', $template_pack_name)
+			)
+		);
+		if (! class_exists($pack_class_name) && $template_pack_name !== 'default') {
+			return self::get_template_pack('default');
+		} else {
+			$template_pack = new $pack_class_name();
+			self::$_template_pack_collection->add($template_pack);
+			return $template_pack;
+		}
+	}
+
+
+
+
+	/**
+	 * Globs template packs installed in core and returns the template pack collection with all installed template packs
+	 * in it.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @return EE_Messages_Template_Pack_Collection
+	 */
+	public static function get_template_pack_collection()
+	{
+		$new_collection = false;
+		if (! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection) {
+			self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
+			$new_collection = true;
+		}
+
+		// glob the defaults directory for messages
+		$templates = glob(EE_LIBRARIES . 'messages/defaults/*', GLOB_ONLYDIR);
+		foreach ($templates as $template_path) {
+			// grab folder name
+			$template = basename($template_path);
+
+			if (! $new_collection) {
+				// already have it?
+				if (self::$_template_pack_collection->get_by_name($template) instanceof EE_Messages_Template_Pack) {
+					continue;
+				}
+			}
+
+			// setup classname.
+			$template_pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+				' ',
+				'_',
+				ucwords(
+					str_replace(
+						'_',
+						' ',
+						$template
+					)
+				)
+			);
+			if (! class_exists($template_pack_class_name)) {
+				continue;
+			}
+			self::$_template_pack_collection->add(new $template_pack_class_name());
+		}
+
+		/**
+		 * Filter for plugins to add in any additional template packs
+		 * Note the filter name here is for backward compat, this used to be found in EED_Messages.
+		 */
+		$additional_template_packs = apply_filters('FHEE__EED_Messages__get_template_packs__template_packs', array());
+		foreach ((array) $additional_template_packs as $template_pack) {
+			if (
+				self::$_template_pack_collection->get_by_name(
+					$template_pack->dbref
+				) instanceof EE_Messages_Template_Pack
+			) {
+				continue;
+			}
+			self::$_template_pack_collection->add($template_pack);
+		}
+		return self::$_template_pack_collection;
+	}
+
+
+	/**
+	 * This is a wrapper for the protected _create_new_templates function
+	 *
+	 * @param string $messenger_name
+	 * @param string $message_type_name message type that the templates are being created for
+	 * @param int    $GRP_ID
+	 * @param bool   $global
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function create_new_templates($messenger_name, $message_type_name, $GRP_ID = 0, $global = false)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
+		$message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
+		if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type, $global)) {
+			return array();
+		}
+		// whew made it this far!  Okay, let's go ahead and create the templates then
+		return EEH_MSG_Template::_create_new_templates($messenger, $message_type, $GRP_ID, $global);
+	}
+
+
+	/**
+	 * @param EE_messenger     $messenger
+	 * @param EE_message_type  $message_type
+	 * @param                  $GRP_ID
+	 * @param                  $global
+	 * @return array|mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function _create_new_templates(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global)
+	{
+		// if we're creating a custom template then we don't need to use the defaults class
+		if (! $global) {
+			return EEH_MSG_Template::_create_custom_template_group($messenger, $message_type, $GRP_ID);
+		}
+		/** @type EE_Messages_Template_Defaults $Message_Template_Defaults */
+		$Message_Template_Defaults = EE_Registry::factory(
+			'EE_Messages_Template_Defaults',
+			array( $messenger, $message_type, $GRP_ID )
+		);
+		// generate templates
+		$success = $Message_Template_Defaults->create_new_templates();
+
+		// if creating the template failed.  Then we should deactivate the related message_type for the messenger because
+		// its not active if it doesn't have a template.  Note this is only happening for GLOBAL template creation
+		// attempts.
+		if (! $success) {
+			/** @var EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$message_resource_manager->deactivate_message_type_for_messenger($message_type->name, $messenger->name);
+		}
+
+		/**
+		 * $success is in an array in the following format
+		 * array(
+		 *    'GRP_ID' => $new_grp_id,
+		 *    'MTP_context' => $first_context_in_new_templates,
+		 * )
+		 */
+		return $success;
+	}
+
+
+	/**
+	 * This creates a custom template using the incoming GRP_ID
+	 *
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @param int             $GRP_ID           GRP_ID for the template_group being used as the base
+	 * @return  array $success              This will be an array in the format:
+	 *                                          array(
+	 *                                          'GRP_ID' => $new_grp_id,
+	 *                                          'MTP_context' => $first_context_in_created_template
+	 *                                          )
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @access private
+	 */
+	private static function _create_custom_template_group(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID)
+	{
+		// defaults
+		$success = array( 'GRP_ID' => null, 'MTP_context' => '' );
+		// get the template group to use as a template from the db.  If $GRP_ID is empty then we'll assume the base will be the global template matching the messenger and message type.
+		$Message_Template_Group = empty($GRP_ID)
+			? EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $messenger->name,
+						'MTP_message_type' => $message_type->name,
+						'MTP_is_global'    => true
+					)
+				)
+			)
+			: EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+		// if we don't have a mtg at this point then we need to bail.
+		if (! $Message_Template_Group instanceof EE_Message_Template_Group) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Something went wrong with generating the custom template from this group id: %s.  This usually happens when there is no matching message template group in the db.',
+						'event_espresso'
+					),
+					$GRP_ID
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return $success;
+		}
+		// let's get all the related message_template objects for this group.
+		$message_templates = $Message_Template_Group->message_templates();
+		// now we have what we need to setup the new template
+		$new_mtg = clone $Message_Template_Group;
+		$new_mtg->set('GRP_ID', 0);
+		$new_mtg->set('MTP_is_global', false);
+
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$template_name = $request->isAjax() && $request->requestParamIsSet('templateName')
+			? $request->getRequestParam('templateName')
+			: esc_html__('New Custom Template', 'event_espresso');
+		$template_description = $request->isAjax() && $request->requestParamIsSet('templateDescription')
+			? $request->getRequestParam('templateDescription')
+			: sprintf(
+				esc_html__(
+					'This is a custom template that was created for the %s messenger and %s message type.',
+					'event_espresso'
+				),
+				$new_mtg->messenger_obj()->label['singular'],
+				$new_mtg->message_type_obj()->label['singular']
+			);
+		$new_mtg->set('MTP_name', $template_name);
+		$new_mtg->set('MTP_description', $template_description);
+		// remove ALL relations on this template group so they don't get saved!
+		$new_mtg->_remove_relations('Message_Template');
+		$new_mtg->save();
+		$success['GRP_ID'] = $new_mtg->ID();
+		$success['template_name'] = $template_name;
+		// add new message templates and add relation to.
+		foreach ($message_templates as $message_template) {
+			if (! $message_template instanceof EE_Message_Template) {
+				continue;
+			}
+			$new_message_template = clone $message_template;
+			$new_message_template->set('MTP_ID', 0);
+			$new_message_template->set('GRP_ID', $new_mtg->ID()); // relation
+			$new_message_template->save();
+			if (empty($success['MTP_context']) && $new_message_template->get('MTP_context') !== 'admin') {
+				$success['MTP_context'] = $new_message_template->get('MTP_context');
+			}
+		}
+		return $success;
+	}
+
+
+	/**
+	 * message_type_has_active_templates_for_messenger
+	 *
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @param bool            $global
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public static function message_type_has_active_templates_for_messenger(
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$global = false
+	) {
+		// is given message_type valid for given messenger (if this is not a global save)
+		if ($global) {
+			return true;
+		}
+		$active_templates = EEM_Message_Template_Group::instance()->count(
+			array(
+				array(
+					'MTP_is_active'    => true,
+					'MTP_messenger'    => $messenger->name,
+					'MTP_message_type' => $message_type->name
+				)
+			)
+		);
+		if ($active_templates > 0) {
+			return true;
+		}
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'The %1$s message type is not registered with the %2$s messenger. Please visit the Messenger activation page to assign this message type first if you want to use it.',
+					'event_espresso'
+				),
+				$message_type->name,
+				$messenger->name
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
+
+
+	/**
+	 * get_fields
+	 * This takes a given messenger and message type and returns all the template fields indexed by context (and with field type).
+	 *
+	 * @param string $messenger_name    name of EE_messenger
+	 * @param string $message_type_name name of EE_message_type
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_fields($messenger_name, $message_type_name)
+	{
+		$template_fields = array();
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
+		$message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
+		if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type)) {
+			return array();
+		}
+
+		$excluded_fields_for_messenger = $message_type->excludedFieldsForMessenger($messenger_name);
+
+		// okay now let's assemble an array with the messenger template fields added to the message_type contexts.
+		foreach ($message_type->get_contexts() as $context => $details) {
+			foreach ($messenger->get_template_fields() as $field => $value) {
+				if (in_array($field, $excluded_fields_for_messenger, true)) {
+					continue;
+				}
+				$template_fields[ $context ][ $field ] = $value;
+			}
+		}
+		if (empty($template_fields)) {
+			EE_Error::add_error(
+				esc_html__('Something went wrong and we couldn\'t get any templates assembled', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return array();
+		}
+		return $template_fields;
+	}
 }

Spacing +58 added lines, -58 removed lines

@@ -95,7 +95,7 @@ 
             }
             $new_message_template_group = EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $global);
 
-            if (! $new_message_template_group) {
+            if ( ! $new_message_template_group) {
                 continue;
             }
             $templates[] = $new_message_template_group;
@@ -130,7 +130,7 @@ 
                     )
                 )
             )
-            : EEM_Message_Template::instance()->count(array( array( 'GRP_ID' => $GRP_ID ) ));
+            : EEM_Message_Template::instance()->count(array(array('GRP_ID' => $GRP_ID)));
 
         return $count > 0;
     }
@@ -147,14 +147,14 @@ 
      */
     public static function update_to_active($messenger_names, $message_type_names)
     {
-        $messenger_names = is_array($messenger_names) ? $messenger_names : array( $messenger_names );
-        $message_type_names = is_array($message_type_names) ? $message_type_names : array( $message_type_names );
+        $messenger_names = is_array($messenger_names) ? $messenger_names : array($messenger_names);
+        $message_type_names = is_array($message_type_names) ? $message_type_names : array($message_type_names);
         return EEM_Message_Template_Group::instance()->update(
-            array( 'MTP_is_active' => 1 ),
+            array('MTP_is_active' => 1),
             array(
                 array(
-                    'MTP_messenger'     => array( 'IN', $messenger_names ),
-                    'MTP_message_type'  => array( 'IN', $message_type_names )
+                    'MTP_messenger'     => array('IN', $messenger_names),
+                    'MTP_message_type'  => array('IN', $message_type_names)
                 )
             )
         );
@@ -242,13 +242,13 @@ 
         $messenger = $message_resource_manager->get_messenger($messenger);
 
         // if messenger isn't a EE_messenger resource then bail.
-        if (! $messenger instanceof EE_messenger) {
+        if ( ! $messenger instanceof EE_messenger) {
             return array();
         }
 
         // validate class for getting our list of shortcodes
-        $classname = 'EE_Messages_' . $messenger_name . '_' . $mt_name . '_Validator';
-        if (! class_exists($classname)) {
+        $classname = 'EE_Messages_'.$messenger_name.'_'.$mt_name.'_Validator';
+        if ( ! class_exists($classname)) {
             $msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
             $msg[] = sprintf(
                 esc_html__('The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class', 'event_espresso'),
@@ -264,44 +264,44 @@ 
         // let's make sure we're only getting the shortcode part of the validators
         $shortcodes = array();
         foreach ($valid_shortcodes as $field => $validators) {
-            $shortcodes[ $field ] = $validators['shortcodes'];
+            $shortcodes[$field] = $validators['shortcodes'];
         }
         $valid_shortcodes = $shortcodes;
 
         // if not all fields let's make sure we ONLY include the shortcodes for the specified fields.
-        if (! empty($fields)) {
+        if ( ! empty($fields)) {
             $specified_shortcodes = array();
             foreach ($fields as $field) {
-                if (isset($valid_shortcodes[ $field ])) {
-                    $specified_shortcodes[ $field ] = $valid_shortcodes[ $field ];
+                if (isset($valid_shortcodes[$field])) {
+                    $specified_shortcodes[$field] = $valid_shortcodes[$field];
                 }
             }
             $valid_shortcodes = $specified_shortcodes;
         }
 
         // if not merged then let's replace the fields with the localized fields
-        if (! $merged) {
+        if ( ! $merged) {
             // let's get all the fields for the set messenger so that we can get the localized label and use that in the returned array.
             $field_settings = $messenger->get_template_fields();
             $localized = array();
             foreach ($valid_shortcodes as $field => $shortcodes) {
                 // get localized field label
-                if (isset($field_settings[ $field ])) {
+                if (isset($field_settings[$field])) {
                     // possible that this is used as a main field.
-                    if (empty($field_settings[ $field ])) {
-                        if (isset($field_settings['extra'][ $field ])) {
-                            $_field = $field_settings['extra'][ $field ]['main']['label'];
+                    if (empty($field_settings[$field])) {
+                        if (isset($field_settings['extra'][$field])) {
+                            $_field = $field_settings['extra'][$field]['main']['label'];
                         } else {
                             $_field = $field;
                         }
                     } else {
-                        $_field = $field_settings[ $field ]['label'];
+                        $_field = $field_settings[$field]['label'];
                     }
                 } elseif (isset($field_settings['extra'])) {
                     // loop through extra "main fields" and see if any of their children have our field
                     foreach ($field_settings['extra'] as $fields) {
-                        if (isset($fields[ $field ])) {
-                            $_field = $fields[ $field ]['label'];
+                        if (isset($fields[$field])) {
+                            $_field = $fields[$field]['label'];
                         } else {
                             $_field = $field;
                         }
@@ -310,7 +310,7 @@ 
                     $_field = $field;
                 }
                 if (isset($_field)) {
-                    $localized[ (string) $_field ] = $shortcodes;
+                    $localized[(string) $_field] = $shortcodes;
                 }
             }
             $valid_shortcodes = $localized;
@@ -321,10 +321,10 @@ 
             $merged_codes = array();
             foreach ($valid_shortcodes as $shortcode) {
                 foreach ($shortcode as $code => $label) {
-                    if (isset($merged_codes[ $code ])) {
+                    if (isset($merged_codes[$code])) {
                         continue;
                     } else {
-                        $merged_codes[ $code ] = $label;
+                        $merged_codes[$code] = $label;
                     }
                 }
             }
@@ -475,12 +475,12 @@ 
         $sending_messenger = ''
     ) {
         // first determine if the url can be to the EE_Message object.
-        if (! $message_type->always_generate()) {
+        if ( ! $message_type->always_generate()) {
             return EEH_MSG_Template::generate_browser_trigger($message);
         }
 
         // if $registration object is not valid then exit early because there's nothing that can be generated.
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             throw new EE_Error(
                 esc_html__('Incoming value for registration is not a valid EE_Registration object.', 'event_espresso')
             );
@@ -488,7 +488,7 @@ 
 
         // validate given context
         $contexts = $message_type->get_contexts();
-        if ($message->context() !== '' && ! isset($contexts[ $message->context() ])) {
+        if ($message->context() !== '' && ! isset($contexts[$message->context()])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('The context %s is not a valid context for %s.', 'event_espresso'),
@@ -499,11 +499,11 @@ 
         }
 
         // valid sending messenger but only if sending messenger set.  Otherwise generating messenger is used.
-        if (! empty($sending_messenger)) {
+        if ( ! empty($sending_messenger)) {
             $with_messengers = $message_type->with_messengers();
             if (
-                ! isset($with_messengers[ $message->messenger() ])
-                 || ! in_array($sending_messenger, $with_messengers[ $message->messenger() ])
+                ! isset($with_messengers[$message->messenger()])
+                 || ! in_array($sending_messenger, $with_messengers[$message->messenger()])
             ) {
                 throw new EE_Error(
                     sprintf(
@@ -636,7 +636,7 @@ 
     public static function get_message_action_icon($type)
     {
         $action_icons = self::get_message_action_icons();
-        return isset($action_icons[ $type ]) ? $action_icons[ $type ] : [];
+        return isset($action_icons[$type]) ? $action_icons[$type] : [];
     }
 
 
@@ -701,7 +701,7 @@ 
     public static function get_message_action_url($type, EE_Message $message = null, $query_params = array())
     {
         $action_urls = self::get_message_action_urls($message, $query_params);
-        return isset($action_urls[ $type ])  ? $action_urls[ $type ] : '';
+        return isset($action_urls[$type]) ? $action_urls[$type] : '';
     }
 
 
@@ -722,7 +722,7 @@ 
         EE_Registry::instance()->load_helper('URL');
         // if $message is not an instance of EE_Message then let's just do a dummy.
         $message = empty($message) ? EE_Message_Factory::create() : $message;
-        $action_urls =  apply_filters(
+        $action_urls = apply_filters(
             'FHEE__EEH_MSG_Template__get_message_action_url',
             array(
                 'view' => EEH_MSG_Template::generate_browser_trigger($message),
@@ -806,24 +806,24 @@ 
         $url = EEH_MSG_Template::get_message_action_url($type, $message, $query_params);
         $icon_css = EEH_MSG_Template::get_message_action_icon($type);
         $label = $icon_css['label'] ?? null;
-        $label = $label ? 'aria-label="' . $label . '"' : '';
+        $label = $label ? 'aria-label="'.$label.'"' : '';
         $class = $label ? ' ee-aria-tooltip' : '';
 
         if (empty($url) || empty($icon_css) || ! isset($icon_css['css_class'])) {
             return '';
         }
 
-        $icon_css_class = $icon_css['css_class'] . apply_filters(
+        $icon_css_class = $icon_css['css_class'].apply_filters(
             'FHEE__EEH_MSG_Template__get_message_action_link__icon_css_class',
-            ' js-ee-message-action-link ee-message-action-link-' . $type,
+            ' js-ee-message-action-link ee-message-action-link-'.$type,
             $type,
             $message,
             $query_params
         );
 
         return '
-            <a href="' . $url . '" ' . $label . ' class="button button--icon-only' . $class . '">
-                <span class="' .  esc_attr($icon_css_class) . '"></span>
+            <a href="' . $url.'" '.$label.' class="button button--icon-only'.$class.'">
+                <span class="' .  esc_attr($icon_css_class).'"></span>
             </a>';
     }
 
@@ -865,7 +865,7 @@ 
     public static function convert_reg_status_to_message_type($reg_status)
     {
         $reg_status_array = self::reg_status_to_message_type_array();
-        return isset($reg_status_array[ $reg_status ]) ? $reg_status_array[ $reg_status ] : '';
+        return isset($reg_status_array[$reg_status]) ? $reg_status_array[$reg_status] : '';
     }
 
 
@@ -903,7 +903,7 @@ 
     public static function convert_payment_status_to_message_type($payment_status)
     {
         $payment_status_array = self::payment_status_to_message_type_array();
-        return isset($payment_status_array[ $payment_status ]) ? $payment_status_array[ $payment_status ] : '';
+        return isset($payment_status_array[$payment_status]) ? $payment_status_array[$payment_status] : '';
     }
 
 
@@ -916,7 +916,7 @@ 
      */
     public static function get_template_pack($template_pack_name)
     {
-        if (! self::$_template_pack_collection instanceof EE_Object_Collection) {
+        if ( ! self::$_template_pack_collection instanceof EE_Object_Collection) {
             self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
         }
 
@@ -929,14 +929,14 @@ 
 
         // nope...let's get it.
         // not set yet so let's attempt to get it.
-        $pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+        $pack_class_name = 'EE_Messages_Template_Pack_'.str_replace(
             ' ',
             '_',
             ucwords(
                 str_replace('_', ' ', $template_pack_name)
             )
         );
-        if (! class_exists($pack_class_name) && $template_pack_name !== 'default') {
+        if ( ! class_exists($pack_class_name) && $template_pack_name !== 'default') {
             return self::get_template_pack('default');
         } else {
             $template_pack = new $pack_class_name();
@@ -959,18 +959,18 @@ 
     public static function get_template_pack_collection()
     {
         $new_collection = false;
-        if (! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection) {
+        if ( ! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection) {
             self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
             $new_collection = true;
         }
 
         // glob the defaults directory for messages
-        $templates = glob(EE_LIBRARIES . 'messages/defaults/*', GLOB_ONLYDIR);
+        $templates = glob(EE_LIBRARIES.'messages/defaults/*', GLOB_ONLYDIR);
         foreach ($templates as $template_path) {
             // grab folder name
             $template = basename($template_path);
 
-            if (! $new_collection) {
+            if ( ! $new_collection) {
                 // already have it?
                 if (self::$_template_pack_collection->get_by_name($template) instanceof EE_Messages_Template_Pack) {
                     continue;
@@ -978,7 +978,7 @@ 
             }
 
             // setup classname.
-            $template_pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+            $template_pack_class_name = 'EE_Messages_Template_Pack_'.str_replace(
                 ' ',
                 '_',
                 ucwords(
@@ -989,7 +989,7 @@ 
                     )
                 )
             );
-            if (! class_exists($template_pack_class_name)) {
+            if ( ! class_exists($template_pack_class_name)) {
                 continue;
             }
             self::$_template_pack_collection->add(new $template_pack_class_name());
@@ -1031,7 +1031,7 @@ 
         $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
         $message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
-        if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type, $global)) {
+        if ( ! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type, $global)) {
             return array();
         }
         // whew made it this far!  Okay, let's go ahead and create the templates then
@@ -1051,13 +1051,13 @@ 
     protected static function _create_new_templates(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global)
     {
         // if we're creating a custom template then we don't need to use the defaults class
-        if (! $global) {
+        if ( ! $global) {
             return EEH_MSG_Template::_create_custom_template_group($messenger, $message_type, $GRP_ID);
         }
         /** @type EE_Messages_Template_Defaults $Message_Template_Defaults */
         $Message_Template_Defaults = EE_Registry::factory(
             'EE_Messages_Template_Defaults',
-            array( $messenger, $message_type, $GRP_ID )
+            array($messenger, $message_type, $GRP_ID)
         );
         // generate templates
         $success = $Message_Template_Defaults->create_new_templates();
@@ -1065,7 +1065,7 @@ 
         // if creating the template failed.  Then we should deactivate the related message_type for the messenger because
         // its not active if it doesn't have a template.  Note this is only happening for GLOBAL template creation
         // attempts.
-        if (! $success) {
+        if ( ! $success) {
             /** @var EE_Message_Resource_Manager $message_resource_manager */
             $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
             $message_resource_manager->deactivate_message_type_for_messenger($message_type->name, $messenger->name);
@@ -1100,7 +1100,7 @@ 
     private static function _create_custom_template_group(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID)
     {
         // defaults
-        $success = array( 'GRP_ID' => null, 'MTP_context' => '' );
+        $success = array('GRP_ID' => null, 'MTP_context' => '');
         // get the template group to use as a template from the db.  If $GRP_ID is empty then we'll assume the base will be the global template matching the messenger and message type.
         $Message_Template_Group = empty($GRP_ID)
             ? EEM_Message_Template_Group::instance()->get_one(
@@ -1114,7 +1114,7 @@ 
             )
             : EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
         // if we don't have a mtg at this point then we need to bail.
-        if (! $Message_Template_Group instanceof EE_Message_Template_Group) {
+        if ( ! $Message_Template_Group instanceof EE_Message_Template_Group) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -1160,7 +1160,7 @@ 
         $success['template_name'] = $template_name;
         // add new message templates and add relation to.
         foreach ($message_templates as $message_template) {
-            if (! $message_template instanceof EE_Message_Template) {
+            if ( ! $message_template instanceof EE_Message_Template) {
                 continue;
             }
             $new_message_template = clone $message_template;
@@ -1239,7 +1239,7 @@ 
         $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
         $message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
-        if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type)) {
+        if ( ! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type)) {
             return array();
         }
 
@@ -1251,7 +1251,7 @@ 
                 if (in_array($field, $excluded_fields_for_messenger, true)) {
                     continue;
                 }
-                $template_fields[ $context ][ $field ] = $value;
+                $template_fields[$context][$field] = $value;
             }
         }
         if (empty($template_fields)) {

core/db_models/EEM_Ticket.model.php

Indentation +479 added lines, -479 removed lines

@@ -13,483 +13,483 @@
  */
 class EEM_Ticket extends EEM_Soft_Delete_Base
 {
-    /**
-     * the following constants define where tickets can be viewed throughout the UI
-     *
-     *  TICKET_VISIBILITY_NONE          - will not be displayed anywhere
-     *  TICKET_VISIBILITY_PUBLIC        - displayed basically anywhere
-     *  TICKET_VISIBILITY_MEMBERS_ONLY  - displayed to any logged in user
-     *  TICKET_VISIBILITY_ADMINS_ONLY   - displayed to any logged in user that is an admin
-     *  TICKET_VISIBILITY_ADMIN_UI_ONLY - only displayed in the admin, never publicly
-     */
-    public const TICKET_VISIBILITY_NONE_KEY            = 'NONE';
-
-    public const TICKET_VISIBILITY_NONE_VALUE          = 0;
-
-    public const TICKET_VISIBILITY_PUBLIC_KEY          = 'PUBLIC';
-
-    public const TICKET_VISIBILITY_PUBLIC_VALUE        = 100;
-
-    public const TICKET_VISIBILITY_MEMBERS_ONLY_KEY    = 'MEMBERS_ONLY';
-
-    public const TICKET_VISIBILITY_MEMBERS_ONLY_VALUE  = 200;
-
-    public const TICKET_VISIBILITY_ADMINS_ONLY_KEY     = 'ADMINS_ONLY';
-
-    public const TICKET_VISIBILITY_ADMINS_ONLY_VALUE   = 300;
-
-    public const TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY   = 'ADMIN_UI_ONLY';
-
-    public const TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE = 400;
-
-
-    /**
-     * defines where tickets can be viewed throughout the UI
-     *
-     * @var array
-     */
-    private $ticket_visibility;
-
-    /**
-     * private instance of the EEM_Ticket object
-     *
-     * @var EEM_Ticket $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings
-     *                         (and any incoming timezone data that gets saved).
-     *                         Note this just sends the timezone info to the date time model field objects.
-     *                         Default is NULL
-     *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = esc_html__('Ticket', 'event_espresso');
-        $this->plural_item   = esc_html__('Tickets', 'event_espresso');
-        $this->_tables       = [
-            'Ticket' => new EE_Primary_Table('esp_ticket', 'TKT_ID'),
-        ];
-        $this->parseTicketVisibilityOptions();
-        $this->_fields          = [
-            'Ticket' => [
-                'TKT_ID'                => new EE_Primary_Key_Int_Field(
-                    'TKT_ID',
-                    esc_html__('Ticket ID', 'event_espresso')
-                ),
-                'TTM_ID'                => new EE_Foreign_Key_Int_Field(
-                    'TTM_ID',
-                    esc_html__('Ticket Template ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Ticket_Template'
-                ),
-                'TKT_name'              => new EE_Plain_Text_Field(
-                    'TKT_name',
-                    esc_html__('Ticket Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'TKT_description'       => new EE_Post_Content_Field(
-                    'TKT_description',
-                    esc_html__('Description of Ticket', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'TKT_start_date'        => new EE_Datetime_Field(
-                    'TKT_start_date',
-                    esc_html__('Start time/date of Ticket', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'TKT_end_date'          => new EE_Datetime_Field(
-                    'TKT_end_date',
-                    esc_html__('End time/date of Ticket', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'TKT_min'               => new EE_Integer_Field(
-                    'TKT_min',
-                    esc_html__('Minimum quantity of this ticket that must be purchased', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_max'               => new EE_Infinite_Integer_Field(
-                    'TKT_max',
-                    esc_html__(
-                        'Maximum quantity of this ticket that can be purchased in one transaction',
-                        'event_espresso'
-                    ),
-                    false,
-                    EE_INF
-                ),
-                'TKT_price'             => new EE_Money_Field(
-                    'TKT_price',
-                    esc_html__('Final calculated price for ticket', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_sold'              => new EE_Integer_Field(
-                    'TKT_sold',
-                    esc_html__('Number of this ticket sold', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_qty'               => new EE_Infinite_Integer_Field(
-                    'TKT_qty',
-                    esc_html__('Quantity of this ticket that is available', 'event_espresso'),
-                    false,
-                    EE_INF
-                ),
-                'TKT_reserved'          => new EE_Integer_Field(
-                    'TKT_reserved',
-                    esc_html__(
-                        'Quantity of this ticket that is reserved, but not yet fully purchased',
-                        'event_espresso'
-                    ),
-                    false,
-                    0
-                ),
-                'TKT_uses'              => new EE_Infinite_Integer_Field(
-                    'TKT_uses',
-                    esc_html__('Number of datetimes this ticket can be used at', 'event_espresso'),
-                    false,
-                    EE_INF
-                ),
-                'TKT_required'          => new EE_Boolean_Field(
-                    'TKT_required',
-                    esc_html__(
-                        'Flag indicating whether this ticket must be purchased with a transaction',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'TKT_taxable'           => new EE_Boolean_Field(
-                    'TKT_taxable',
-                    esc_html__(
-                        'Flag indicating whether there is tax applied on this ticket',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'TKT_is_default'        => new EE_Boolean_Field(
-                    'TKT_is_default',
-                    esc_html__('Flag indicating that this ticket is a default ticket', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'TKT_order'             => new EE_Integer_Field(
-                    'TKT_order',
-                    esc_html__(
-                        'The order in which the Ticket is displayed in the editor (used for autosaves when the form doesn\'t have the ticket ID yet)',
-                        'event_espresso'
-                    ),
-                    false,
-                    0
-                ),
-                'TKT_row'               => new EE_Integer_Field(
-                    'TKT_row',
-                    esc_html__('How tickets are displayed in the ui', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_deleted'           => new EE_Trashed_Flag_Field(
-                    'TKT_deleted',
-                    esc_html__('Flag indicating if this has been archived or not', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'TKT_wp_user'           => new EE_WP_User_Field(
-                    'TKT_wp_user',
-                    esc_html__('Ticket Creator ID', 'event_espresso'),
-                    false
-                ),
-                'TKT_parent'            => new EE_Integer_Field(
-                    'TKT_parent',
-                    esc_html__(
-                        'Indicates what TKT_ID is the parent of this TKT_ID (used in autosaves/revisions)',
-                        'event_espresso'
-                    ),
-                    true,
-                    0
-                ),
-                'TKT_reverse_calculate' => new EE_Boolean_Field(
-                    'TKT_reverse_calculate',
-                    esc_html__(
-                        'Flag indicating whether ticket calculations should run in reverse and calculate the base ticket price from the provided ticket total.',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'TKT_visibility'        => new EE_Enum_Integer_Field(
-                    'TKT_visibility',
-                    esc_html__('Defines where the ticket can be viewed throughout the UI.', 'event_espresso'),
-                    false,
-                    EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
-                    $this->getTicketVisibilityEnumOptions()
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Datetime'        => new EE_HABTM_Relation('Datetime_Ticket'),
-            'Datetime_Ticket' => new EE_Has_Many_Relation(),
-            'Price'           => new EE_HABTM_Relation('Ticket_Price'),
-            'Ticket_Template' => new EE_Belongs_To_Relation(),
-            'Registration'    => new EE_Has_Many_Relation(),
-            'WP_User'         => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $path_to_event                                                                                       = 'Datetime.Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public(
-            'TKT_is_default',
-            $path_to_event
-        );
-
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
-            = new EE_Restriction_Generator_Default_Protected(
-                'TKT_is_default',
-                $path_to_event
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = new EE_Restriction_Generator_Default_Protected(
-            'TKT_is_default',
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected(
-            'TKT_is_default',
-            $path_to_event
-        );
-        $this->model_chain_to_password                              = $path_to_event;
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * This returns all tickets that are defaults from the db
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_default_tickets(): array
-    {
-        /** @type EE_Ticket[] $tickets */
-        $tickets = $this->get_all(
-            [
-                [
-                    'TKT_is_default' => 1,
-                    'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
-                ],
-                'order_by' => ['TKT_ID' => 'ASC'],
-            ]
-        );
-        // we need to set the start date and end date to today's date and the start of the default dtt
-        return $this->_set_default_dates($tickets);
-    }
-
-
-    /**
-     * sets up relevant start and end date for EE_Ticket (s)
-     *
-     * @param EE_Ticket[] $tickets
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _set_default_dates(array $tickets): array
-    {
-        foreach ($tickets as $ticket) {
-            $ticket->set(
-                'TKT_start_date',
-                (int) $this->current_time_for_query('TKT_start_date', true)
-            );
-            $ticket->set(
-                'TKT_end_date',
-                (int) $this->current_time_for_query('TKT_end_date', true) + MONTH_IN_SECONDS
-            );
-            $ticket->set_end_time(
-                $this->convert_datetime_for_query(
-                    'TKT_end_date',
-                    '11:59 pm',
-                    'g:i a',
-                    $this->_timezone
-                )
-            );
-        }
-        return $tickets;
-    }
-
-
-    /**
-     * Gets the total number of tickets available at a particular datetime (does
-     * NOT take int account the datetime's spaces available)
-     *
-     * @param int   $DTT_ID
-     * @param array $query_params
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function sum_tickets_currently_available_at_datetime(int $DTT_ID, array $query_params = []): int
-    {
-        $query_params += [['TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE]]];
-        return EEM_Datetime::instance()->sum_tickets_currently_available_at_datetime($DTT_ID, $query_params);
-    }
-
-
-    /**
-     * Updates the TKT_sold quantity on all the tickets matching $query_params
-     *
-     * @param EE_Ticket[] $tickets
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_tickets_sold(array $tickets)
-    {
-        foreach ($tickets as $ticket) {
-            $ticket->update_tickets_sold();
-        }
-    }
-
-
-    /**
-     * returns an array of EE_Ticket objects with a non-zero value for TKT_reserved
-     *
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function get_tickets_with_reservations()
-    {
-        return $this->get_all(
-            [
-                [
-                    'TKT_reserved'   => ['>', 0],
-                    'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * returns an array of EE_Ticket objects matching the supplied list of IDs
-     *
-     * @param array $ticket_IDs
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function get_tickets_with_IDs(array $ticket_IDs)
-    {
-        return $this->get_all(
-            [
-                [
-                    'TKT_ID' => ['IN', $ticket_IDs],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    private function parseTicketVisibilityOptions()
-    {
-        $this->ticket_visibility = (array) apply_filters(
-            'FHEE__EEM_Ticket__construct__ticket_visibility',
-            [
-                EEM_Ticket::TICKET_VISIBILITY_PUBLIC_KEY        => [
-                    'label' => esc_html__('Public', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_KEY  => [
-                    'label' => esc_html__('Members only', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_KEY   => [
-                    'label' => esc_html__('Admins only', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY => [
-                    'label' => esc_html__('Admin UI only', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_NONE_KEY          => [
-                    'label' => esc_html__('None', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getTicketVisibilityEnumOptions(): array
-    {
-        $ticket_visibility = [];
-        foreach ($this->ticket_visibility as $visibility) {
-            if (isset($visibility['value'], $visibility['label'])) {
-                $ticket_visibility[ $visibility['value'] ] = $visibility['label'];
-            }
-        }
-        return $ticket_visibility;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getTicketVisibilityValues(): array
-    {
-        // copy ticket_visibility array
-        $ticket_visibility_options = $this->ticket_visibility;
-        foreach ($ticket_visibility_options as $ticket_visibility_option) {
-            // remove labels because we only want the values
-            unset($ticket_visibility_option['label']);
-        }
-        return $ticket_visibility_options;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getTicketVisibilityLabels(): array
-    {
-        $ticket_visibility_options = [];
-        foreach ($this->ticket_visibility as $key => $ticket_visibility_option) {
-            if (isset($ticket_visibility_option['label'])) {
-                // change because we only want the labels tied to the keys
-                $ticket_visibility_options[] = [
-                    'value' => $key,
-                    'label' => $ticket_visibility_option['label']
-                ];
-            }
-        }
-        return $ticket_visibility_options;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function ticketVisibilityOptions(): array
-    {
-        return $this->ticket_visibility;
-    }
+	/**
+	 * the following constants define where tickets can be viewed throughout the UI
+	 *
+	 *  TICKET_VISIBILITY_NONE          - will not be displayed anywhere
+	 *  TICKET_VISIBILITY_PUBLIC        - displayed basically anywhere
+	 *  TICKET_VISIBILITY_MEMBERS_ONLY  - displayed to any logged in user
+	 *  TICKET_VISIBILITY_ADMINS_ONLY   - displayed to any logged in user that is an admin
+	 *  TICKET_VISIBILITY_ADMIN_UI_ONLY - only displayed in the admin, never publicly
+	 */
+	public const TICKET_VISIBILITY_NONE_KEY            = 'NONE';
+
+	public const TICKET_VISIBILITY_NONE_VALUE          = 0;
+
+	public const TICKET_VISIBILITY_PUBLIC_KEY          = 'PUBLIC';
+
+	public const TICKET_VISIBILITY_PUBLIC_VALUE        = 100;
+
+	public const TICKET_VISIBILITY_MEMBERS_ONLY_KEY    = 'MEMBERS_ONLY';
+
+	public const TICKET_VISIBILITY_MEMBERS_ONLY_VALUE  = 200;
+
+	public const TICKET_VISIBILITY_ADMINS_ONLY_KEY     = 'ADMINS_ONLY';
+
+	public const TICKET_VISIBILITY_ADMINS_ONLY_VALUE   = 300;
+
+	public const TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY   = 'ADMIN_UI_ONLY';
+
+	public const TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE = 400;
+
+
+	/**
+	 * defines where tickets can be viewed throughout the UI
+	 *
+	 * @var array
+	 */
+	private $ticket_visibility;
+
+	/**
+	 * private instance of the EEM_Ticket object
+	 *
+	 * @var EEM_Ticket $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings
+	 *                         (and any incoming timezone data that gets saved).
+	 *                         Note this just sends the timezone info to the date time model field objects.
+	 *                         Default is NULL
+	 *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = esc_html__('Ticket', 'event_espresso');
+		$this->plural_item   = esc_html__('Tickets', 'event_espresso');
+		$this->_tables       = [
+			'Ticket' => new EE_Primary_Table('esp_ticket', 'TKT_ID'),
+		];
+		$this->parseTicketVisibilityOptions();
+		$this->_fields          = [
+			'Ticket' => [
+				'TKT_ID'                => new EE_Primary_Key_Int_Field(
+					'TKT_ID',
+					esc_html__('Ticket ID', 'event_espresso')
+				),
+				'TTM_ID'                => new EE_Foreign_Key_Int_Field(
+					'TTM_ID',
+					esc_html__('Ticket Template ID', 'event_espresso'),
+					false,
+					0,
+					'Ticket_Template'
+				),
+				'TKT_name'              => new EE_Plain_Text_Field(
+					'TKT_name',
+					esc_html__('Ticket Name', 'event_espresso'),
+					false,
+					''
+				),
+				'TKT_description'       => new EE_Post_Content_Field(
+					'TKT_description',
+					esc_html__('Description of Ticket', 'event_espresso'),
+					false,
+					''
+				),
+				'TKT_start_date'        => new EE_Datetime_Field(
+					'TKT_start_date',
+					esc_html__('Start time/date of Ticket', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'TKT_end_date'          => new EE_Datetime_Field(
+					'TKT_end_date',
+					esc_html__('End time/date of Ticket', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'TKT_min'               => new EE_Integer_Field(
+					'TKT_min',
+					esc_html__('Minimum quantity of this ticket that must be purchased', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_max'               => new EE_Infinite_Integer_Field(
+					'TKT_max',
+					esc_html__(
+						'Maximum quantity of this ticket that can be purchased in one transaction',
+						'event_espresso'
+					),
+					false,
+					EE_INF
+				),
+				'TKT_price'             => new EE_Money_Field(
+					'TKT_price',
+					esc_html__('Final calculated price for ticket', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_sold'              => new EE_Integer_Field(
+					'TKT_sold',
+					esc_html__('Number of this ticket sold', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_qty'               => new EE_Infinite_Integer_Field(
+					'TKT_qty',
+					esc_html__('Quantity of this ticket that is available', 'event_espresso'),
+					false,
+					EE_INF
+				),
+				'TKT_reserved'          => new EE_Integer_Field(
+					'TKT_reserved',
+					esc_html__(
+						'Quantity of this ticket that is reserved, but not yet fully purchased',
+						'event_espresso'
+					),
+					false,
+					0
+				),
+				'TKT_uses'              => new EE_Infinite_Integer_Field(
+					'TKT_uses',
+					esc_html__('Number of datetimes this ticket can be used at', 'event_espresso'),
+					false,
+					EE_INF
+				),
+				'TKT_required'          => new EE_Boolean_Field(
+					'TKT_required',
+					esc_html__(
+						'Flag indicating whether this ticket must be purchased with a transaction',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'TKT_taxable'           => new EE_Boolean_Field(
+					'TKT_taxable',
+					esc_html__(
+						'Flag indicating whether there is tax applied on this ticket',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'TKT_is_default'        => new EE_Boolean_Field(
+					'TKT_is_default',
+					esc_html__('Flag indicating that this ticket is a default ticket', 'event_espresso'),
+					false,
+					false
+				),
+				'TKT_order'             => new EE_Integer_Field(
+					'TKT_order',
+					esc_html__(
+						'The order in which the Ticket is displayed in the editor (used for autosaves when the form doesn\'t have the ticket ID yet)',
+						'event_espresso'
+					),
+					false,
+					0
+				),
+				'TKT_row'               => new EE_Integer_Field(
+					'TKT_row',
+					esc_html__('How tickets are displayed in the ui', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_deleted'           => new EE_Trashed_Flag_Field(
+					'TKT_deleted',
+					esc_html__('Flag indicating if this has been archived or not', 'event_espresso'),
+					false,
+					false
+				),
+				'TKT_wp_user'           => new EE_WP_User_Field(
+					'TKT_wp_user',
+					esc_html__('Ticket Creator ID', 'event_espresso'),
+					false
+				),
+				'TKT_parent'            => new EE_Integer_Field(
+					'TKT_parent',
+					esc_html__(
+						'Indicates what TKT_ID is the parent of this TKT_ID (used in autosaves/revisions)',
+						'event_espresso'
+					),
+					true,
+					0
+				),
+				'TKT_reverse_calculate' => new EE_Boolean_Field(
+					'TKT_reverse_calculate',
+					esc_html__(
+						'Flag indicating whether ticket calculations should run in reverse and calculate the base ticket price from the provided ticket total.',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'TKT_visibility'        => new EE_Enum_Integer_Field(
+					'TKT_visibility',
+					esc_html__('Defines where the ticket can be viewed throughout the UI.', 'event_espresso'),
+					false,
+					EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
+					$this->getTicketVisibilityEnumOptions()
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Datetime'        => new EE_HABTM_Relation('Datetime_Ticket'),
+			'Datetime_Ticket' => new EE_Has_Many_Relation(),
+			'Price'           => new EE_HABTM_Relation('Ticket_Price'),
+			'Ticket_Template' => new EE_Belongs_To_Relation(),
+			'Registration'    => new EE_Has_Many_Relation(),
+			'WP_User'         => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$path_to_event                                                                                       = 'Datetime.Event';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public(
+			'TKT_is_default',
+			$path_to_event
+		);
+
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
+			= new EE_Restriction_Generator_Default_Protected(
+				'TKT_is_default',
+				$path_to_event
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = new EE_Restriction_Generator_Default_Protected(
+			'TKT_is_default',
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected(
+			'TKT_is_default',
+			$path_to_event
+		);
+		$this->model_chain_to_password                              = $path_to_event;
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * This returns all tickets that are defaults from the db
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_default_tickets(): array
+	{
+		/** @type EE_Ticket[] $tickets */
+		$tickets = $this->get_all(
+			[
+				[
+					'TKT_is_default' => 1,
+					'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
+				],
+				'order_by' => ['TKT_ID' => 'ASC'],
+			]
+		);
+		// we need to set the start date and end date to today's date and the start of the default dtt
+		return $this->_set_default_dates($tickets);
+	}
+
+
+	/**
+	 * sets up relevant start and end date for EE_Ticket (s)
+	 *
+	 * @param EE_Ticket[] $tickets
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _set_default_dates(array $tickets): array
+	{
+		foreach ($tickets as $ticket) {
+			$ticket->set(
+				'TKT_start_date',
+				(int) $this->current_time_for_query('TKT_start_date', true)
+			);
+			$ticket->set(
+				'TKT_end_date',
+				(int) $this->current_time_for_query('TKT_end_date', true) + MONTH_IN_SECONDS
+			);
+			$ticket->set_end_time(
+				$this->convert_datetime_for_query(
+					'TKT_end_date',
+					'11:59 pm',
+					'g:i a',
+					$this->_timezone
+				)
+			);
+		}
+		return $tickets;
+	}
+
+
+	/**
+	 * Gets the total number of tickets available at a particular datetime (does
+	 * NOT take int account the datetime's spaces available)
+	 *
+	 * @param int   $DTT_ID
+	 * @param array $query_params
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function sum_tickets_currently_available_at_datetime(int $DTT_ID, array $query_params = []): int
+	{
+		$query_params += [['TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE]]];
+		return EEM_Datetime::instance()->sum_tickets_currently_available_at_datetime($DTT_ID, $query_params);
+	}
+
+
+	/**
+	 * Updates the TKT_sold quantity on all the tickets matching $query_params
+	 *
+	 * @param EE_Ticket[] $tickets
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_tickets_sold(array $tickets)
+	{
+		foreach ($tickets as $ticket) {
+			$ticket->update_tickets_sold();
+		}
+	}
+
+
+	/**
+	 * returns an array of EE_Ticket objects with a non-zero value for TKT_reserved
+	 *
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function get_tickets_with_reservations()
+	{
+		return $this->get_all(
+			[
+				[
+					'TKT_reserved'   => ['>', 0],
+					'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * returns an array of EE_Ticket objects matching the supplied list of IDs
+	 *
+	 * @param array $ticket_IDs
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function get_tickets_with_IDs(array $ticket_IDs)
+	{
+		return $this->get_all(
+			[
+				[
+					'TKT_ID' => ['IN', $ticket_IDs],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function parseTicketVisibilityOptions()
+	{
+		$this->ticket_visibility = (array) apply_filters(
+			'FHEE__EEM_Ticket__construct__ticket_visibility',
+			[
+				EEM_Ticket::TICKET_VISIBILITY_PUBLIC_KEY        => [
+					'label' => esc_html__('Public', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_KEY  => [
+					'label' => esc_html__('Members only', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_KEY   => [
+					'label' => esc_html__('Admins only', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY => [
+					'label' => esc_html__('Admin UI only', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_NONE_KEY          => [
+					'label' => esc_html__('None', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getTicketVisibilityEnumOptions(): array
+	{
+		$ticket_visibility = [];
+		foreach ($this->ticket_visibility as $visibility) {
+			if (isset($visibility['value'], $visibility['label'])) {
+				$ticket_visibility[ $visibility['value'] ] = $visibility['label'];
+			}
+		}
+		return $ticket_visibility;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getTicketVisibilityValues(): array
+	{
+		// copy ticket_visibility array
+		$ticket_visibility_options = $this->ticket_visibility;
+		foreach ($ticket_visibility_options as $ticket_visibility_option) {
+			// remove labels because we only want the values
+			unset($ticket_visibility_option['label']);
+		}
+		return $ticket_visibility_options;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getTicketVisibilityLabels(): array
+	{
+		$ticket_visibility_options = [];
+		foreach ($this->ticket_visibility as $key => $ticket_visibility_option) {
+			if (isset($ticket_visibility_option['label'])) {
+				// change because we only want the labels tied to the keys
+				$ticket_visibility_options[] = [
+					'value' => $key,
+					'label' => $ticket_visibility_option['label']
+				];
+			}
+		}
+		return $ticket_visibility_options;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function ticketVisibilityOptions(): array
+	{
+		return $this->ticket_visibility;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -78,7 +78,7 @@ 
             'Ticket' => new EE_Primary_Table('esp_ticket', 'TKT_ID'),
         ];
         $this->parseTicketVisibilityOptions();
-        $this->_fields          = [
+        $this->_fields = [
             'Ticket' => [
                 'TKT_ID'                => new EE_Primary_Key_Int_Field(
                     'TKT_ID',
@@ -251,27 +251,27 @@ 
             'WP_User'         => new EE_Belongs_To_Relation(),
         ];
         // this model is generally available for reading
-        $path_to_event                                                                                       = 'Datetime.Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public(
+        $path_to_event = 'Datetime.Event';
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Default_Public(
             'TKT_is_default',
             $path_to_event
         );
 
         // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin]
             = new EE_Restriction_Generator_Default_Protected(
                 'TKT_is_default',
                 $path_to_event
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = new EE_Restriction_Generator_Default_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Default_Protected(
             'TKT_is_default',
             $path_to_event
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Default_Protected(
             'TKT_is_default',
             $path_to_event
         );
-        $this->model_chain_to_password                              = $path_to_event;
+        $this->model_chain_to_password = $path_to_event;
         parent::__construct($timezone);
     }
 
@@ -444,7 +444,7 @@ 
         $ticket_visibility = [];
         foreach ($this->ticket_visibility as $visibility) {
             if (isset($visibility['value'], $visibility['label'])) {
-                $ticket_visibility[ $visibility['value'] ] = $visibility['label'];
+                $ticket_visibility[$visibility['value']] = $visibility['label'];
             }
         }
         return $ticket_visibility;

core/db_models/EEM_Base.model.php

Indentation +6591 added lines, -6591 removed lines

@@ -37,6597 +37,6597 @@
  */
 abstract class EEM_Base extends EE_Base implements ResettableInterface
 {
-    /**
-     * Flag to indicate whether the values provided to EEM_Base have already been prepared
-     * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
-     * They almost always WILL NOT, but it's not necessarily a requirement.
-     * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
-     *
-     * @var boolean
-     */
-    private $_values_already_prepared_by_model_object = 0;
-
-    /**
-     * when $_values_already_prepared_by_model_object equals this, we assume
-     * the data is just like form input that needs to have the model fields'
-     * prepare_for_set and prepare_for_use_in_db called on it
-     */
-    const not_prepared_by_model_object = 0;
-
-    /**
-     * when $_values_already_prepared_by_model_object equals this, we
-     * assume this value is coming from a model object and doesn't need to have
-     * prepare_for_set called on it, just prepare_for_use_in_db is used
-     */
-    const prepared_by_model_object = 1;
-
-    /**
-     * when $_values_already_prepared_by_model_object equals this, we assume
-     * the values are already to be used in the database (ie no processing is done
-     * on them by the model's fields)
-     */
-    const prepared_for_use_in_db = 2;
-
-
-    protected $singular_item = 'Item';
-
-    protected $plural_item   = 'Items';
-
-    /**
-     * @type EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
-     */
-    protected $_tables;
-
-    /**
-     * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
-     * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
-     * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
-     *
-     * @var EE_Model_Field_Base[][] $_fields
-     */
-    protected $_fields;
-
-    /**
-     * array of different kinds of relations
-     *
-     * @var EE_Model_Relation_Base[] $_model_relations
-     */
-    protected $_model_relations = [];
-
-    /**
-     * @var EE_Index[] $_indexes
-     */
-    protected $_indexes = [];
-
-    /**
-     * Default strategy for getting where conditions on this model. This strategy is used to get default
-     * where conditions which are added to get_all, update, and delete queries. They can be overridden
-     * by setting the same columns as used in these queries in the query yourself.
-     *
-     * @var EE_Default_Where_Conditions
-     */
-    protected $_default_where_conditions_strategy;
-
-    /**
-     * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
-     * This is particularly useful when you want something between 'none' and 'default'
-     *
-     * @var EE_Default_Where_Conditions
-     */
-    protected $_minimum_where_conditions_strategy;
-
-    /**
-     * String describing how to find the "owner" of this model's objects.
-     * When there is a foreign key on this model to the wp_users table, this isn't needed.
-     * But when there isn't, this indicates which related model, or transiently-related model,
-     * has the foreign key to the wp_users table.
-     * Eg, for EEM_Registration this would be 'Event' because registrations are directly
-     * related to events, and events have a foreign key to wp_users.
-     * On EEM_Transaction, this would be 'Transaction.Event'
-     *
-     * @var string
-     */
-    protected $_model_chain_to_wp_user = '';
-
-    /**
-     * String describing how to find the model with a password controlling access to this model. This property has the
-     * same format as $_model_chain_to_wp_user. This is primarily used by the query param "exclude_protected".
-     * This value is the path of models to follow to arrive at the model with the password field.
-     * If it is an empty string, it means this model has the password field. If it is null, it means there is no
-     * model with a password that should affect reading this on the front-end.
-     * Eg this is an empty string for the Event model because it has a password.
-     * This is null for the Registration model, because its event's password has no bearing on whether
-     * you can read the registration or not on the front-end (it just depends on your capabilities.)
-     * This is 'Datetime.Event' on the Ticket model, because model queries for tickets that set "exclude_protected"
-     * should hide tickets for datetimes for events that have a password set.
-     *
-     * @var string |null
-     */
-    protected $model_chain_to_password = null;
-
-    /**
-     * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
-     * don't need it (particularly CPT models)
-     *
-     * @var bool
-     */
-    protected $_ignore_where_strategy = false;
-
-    /**
-     * String used in caps relating to this model. Eg, if the caps relating to this
-     * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
-     *
-     * @var string. If null it hasn't been initialized yet. If false then we
-     * have indicated capabilities don't apply to this
-     */
-    protected $_caps_slug = null;
-
-    /**
-     * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
-     * and next-level keys are capability names, and each's value is a
-     * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
-     * they specify which context to use (ie, frontend, backend, edit or delete)
-     * and then each capability in the corresponding sub-array that they're missing
-     * adds the where conditions onto the query.
-     *
-     * @var array
-     */
-    protected $_cap_restrictions = [
-        self::caps_read       => [],
-        self::caps_read_admin => [],
-        self::caps_edit       => [],
-        self::caps_delete     => [],
-    ];
-
-    /**
-     * Array defining which cap restriction generators to use to create default
-     * cap restrictions to put in EEM_Base::_cap_restrictions.
-     * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
-     * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
-     * automatically set this to false (not just null).
-     *
-     * @var EE_Restriction_Generator_Base[]
-     */
-    protected $_cap_restriction_generators = [];
-
-    /**
-     * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
-     */
-    const caps_read       = 'read';
-
-    const caps_read_admin = 'read_admin';
-
-    const caps_edit       = 'edit';
-
-    const caps_delete     = 'delete';
-
-    /**
-     * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
-     * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
-     * maps to 'read' because when looking for relevant permissions we're going to use
-     * 'read' in teh capabilities names like 'ee_read_events' etc.
-     *
-     * @var array
-     */
-    protected $_cap_contexts_to_cap_action_map = [
-        self::caps_read       => 'read',
-        self::caps_read_admin => 'read',
-        self::caps_edit       => 'edit',
-        self::caps_delete     => 'delete',
-    ];
-
-    /**
-     * Timezone
-     * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
-     * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
-     * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
-     * EE_Datetime_Field data type will have access to it.
-     *
-     * @var string
-     */
-    protected $_timezone;
-
-
-    /**
-     * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
-     * multisite.
-     *
-     * @var int
-     */
-    protected static $_model_query_blog_id;
-
-    /**
-     * A copy of _fields, except the array keys are the model names pointed to by
-     * the field
-     *
-     * @var EE_Model_Field_Base[]
-     */
-    private $_cache_foreign_key_to_fields = [];
-
-    /**
-     * Cached list of all the fields on the model, indexed by their name
-     *
-     * @var EE_Model_Field_Base[]
-     */
-    private $_cached_fields = null;
-
-    /**
-     * Cached list of all the fields on the model, except those that are
-     * marked as only pertinent to the database
-     *
-     * @var EE_Model_Field_Base[]
-     */
-    private $_cached_fields_non_db_only = null;
-
-    /**
-     * A cached reference to the primary key for quick lookup
-     *
-     * @var EE_Model_Field_Base
-     */
-    private $_primary_key_field = null;
-
-    /**
-     * Flag indicating whether this model has a primary key or not
-     *
-     * @var boolean
-     */
-    protected $_has_primary_key_field = null;
-
-    /**
-     * array in the format:  [ FK alias => full PK ]
-     * where keys are local column name aliases for foreign keys
-     * and values are the fully qualified column name for the primary key they represent
-     *  ex:
-     *      [ 'Event.EVT_wp_user' => 'WP_User.ID' ]
-     *
-     * @var array $foreign_key_aliases
-     */
-    protected $foreign_key_aliases = [];
-
-    /**
-     * Whether or not this model is based off a table in WP core only (CPTs should set
-     * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
-     * This should be true for models that deal with data that should exist independent of EE.
-     * For example, if the model can read and insert data that isn't used by EE, this should be true.
-     * It would be false, however, if you could guarantee the model would only interact with EE data,
-     * even if it uses a WP core table (eg event and venue models set this to false for that reason:
-     * they can only read and insert events and venues custom post types, not arbitrary post types)
-     *
-     * @var boolean
-     */
-    protected $_wp_core_model = false;
-
-    /**
-     * @var bool stores whether this model has a password field or not.
-     * null until initialized by hasPasswordField()
-     */
-    protected $has_password_field;
-
-    /**
-     * @var EE_Password_Field|null Automatically set when calling getPasswordField()
-     */
-    protected $password_field;
-
-    /**
-     *    List of valid operators that can be used for querying.
-     * The keys are all operators we'll accept, the values are the real SQL
-     * operators used
-     *
-     * @var array
-     */
-    protected $_valid_operators = [
-        '='           => '=',
-        '<='          => '<=',
-        '<'           => '<',
-        '>='          => '>=',
-        '>'           => '>',
-        '!='          => '!=',
-        'LIKE'        => 'LIKE',
-        'like'        => 'LIKE',
-        'NOT_LIKE'    => 'NOT LIKE',
-        'not_like'    => 'NOT LIKE',
-        'NOT LIKE'    => 'NOT LIKE',
-        'not like'    => 'NOT LIKE',
-        'IN'          => 'IN',
-        'in'          => 'IN',
-        'NOT_IN'      => 'NOT IN',
-        'not_in'      => 'NOT IN',
-        'NOT IN'      => 'NOT IN',
-        'not in'      => 'NOT IN',
-        'between'     => 'BETWEEN',
-        'BETWEEN'     => 'BETWEEN',
-        'IS_NOT_NULL' => 'IS NOT NULL',
-        'is_not_null' => 'IS NOT NULL',
-        'IS NOT NULL' => 'IS NOT NULL',
-        'is not null' => 'IS NOT NULL',
-        'IS_NULL'     => 'IS NULL',
-        'is_null'     => 'IS NULL',
-        'IS NULL'     => 'IS NULL',
-        'is null'     => 'IS NULL',
-        'REGEXP'      => 'REGEXP',
-        'regexp'      => 'REGEXP',
-        'NOT_REGEXP'  => 'NOT REGEXP',
-        'not_regexp'  => 'NOT REGEXP',
-        'NOT REGEXP'  => 'NOT REGEXP',
-        'not regexp'  => 'NOT REGEXP',
-    ];
-
-    /**
-     * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
-     *
-     * @var array
-     */
-    protected $_in_style_operators = ['IN', 'NOT IN'];
-
-    /**
-     * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
-     * '12-31-2012'"
-     *
-     * @var array
-     */
-    protected $_between_style_operators = ['BETWEEN'];
-
-    /**
-     * Operators that work like SQL's like: input should be assumed to be a string, already prepared for a LIKE query.
-     *
-     * @var array
-     */
-    protected $_like_style_operators = ['LIKE', 'NOT LIKE'];
-
-    /**
-     * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
-     * on a join table.
-     *
-     * @var array
-     */
-    protected $_null_style_operators = ['IS NOT NULL', 'IS NULL'];
-
-    /**
-     * Allowed values for $query_params['order'] for ordering in queries
-     *
-     * @var array
-     */
-    protected $_allowed_order_values = ['asc', 'desc', 'ASC', 'DESC'];
-
-    /**
-     * When these are keys in a WHERE or HAVING clause, they are handled much differently
-     * than regular field names. It is assumed that their values are an array of WHERE conditions
-     *
-     * @var array
-     */
-    private $_logic_query_param_keys = ['not', 'and', 'or', 'NOT', 'AND', 'OR'];
-
-    /**
-     * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
-     * 'where', but 'where' clauses are so common that we thought we'd omit it
-     *
-     * @var array
-     */
-    private $_allowed_query_params = [
-        0,
-        'limit',
-        'order_by',
-        'group_by',
-        'having',
-        'force_join',
-        'order',
-        'on_join_limit',
-        'default_where_conditions',
-        'caps',
-        'extra_selects',
-        'exclude_protected',
-    ];
-
-    /**
-     * All the data types that can be used in $wpdb->prepare statements.
-     *
-     * @var array
-     */
-    private $_valid_wpdb_data_types = ['%d', '%s', '%f'];
-
-    /**
-     * @var EE_Registry $EE
-     */
-    protected $EE = null;
-
-
-    /**
-     * Property which, when set, will have this model echo out the next X queries to the page for debugging.
-     *
-     * @var int
-     */
-    protected $_show_next_x_db_queries = 0;
-
-    /**
-     * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
-     * it gets saved on this property as an instance of CustomSelects so those selections can be used in
-     * WHERE, GROUP_BY, etc.
-     *
-     * @var CustomSelects
-     */
-    protected $_custom_selections = [];
-
-    /**
-     * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
-     * caches every model object we've fetched from the DB on this request
-     *
-     * @var array
-     */
-    protected $_entity_map;
-
-    /**
-     * @var LoaderInterface
-     */
-    protected static $loader;
-
-    /**
-     * @var Mirror
-     */
-    private static $mirror;
-
-
-    /**
-     * constant used to show EEM_Base has not yet verified the db on this http request
-     */
-    const db_verified_none = 0;
-
-    /**
-     * constant used to show EEM_Base has verified the EE core db on this http request,
-     * but not the addons' dbs
-     */
-    const db_verified_core = 1;
-
-    /**
-     * constant used to show EEM_Base has verified the addons' dbs (and implicitly
-     * the EE core db too)
-     */
-    const db_verified_addons = 2;
-
-    /**
-     * indicates whether an EEM_Base child has already re-verified the DB
-     * is ok (we don't want to do it repetitively). Should be set to one the constants
-     * looking like EEM_Base::db_verified_*
-     *
-     * @var int - 0 = none, 1 = core, 2 = addons
-     */
-    protected static $_db_verification_level = EEM_Base::db_verified_none;
-
-    /**
-     * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
-     *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
-     *        registrations for non-trashed tickets for non-trashed datetimes)
-     */
-    const default_where_conditions_all = 'all';
-
-    /**
-     * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
-     *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
-     *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
-     *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
-     *        models which share tables with other models, this can return data for the wrong model.
-     */
-    const default_where_conditions_this_only = 'this_model_only';
-
-    /**
-     * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
-     *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
-     *        return all registrations related to non-trashed tickets and non-trashed datetimes)
-     */
-    const default_where_conditions_others_only = 'other_models_only';
-
-    /**
-     * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
-     *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
-     *        their table with other models, like the Event and Venue models. For example, when querying for events
-     *        ordered by their venues' name, this will be sure to only return real events with associated real venues
-     *        (regardless of whether those events and venues are trashed)
-     *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
-     *        events.
-     */
-    const default_where_conditions_minimum_all = 'minimum';
-
-    /**
-     * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
-     *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
-     *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
-     *        not)
-     */
-    const default_where_conditions_minimum_others = 'full_this_minimum_others';
-
-    /**
-     * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
-     *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
-     *        it's possible it will return table entries for other models. You should use
-     *        EEM_Base::default_where_conditions_minimum_all instead.
-     */
-    const default_where_conditions_none = 'none';
-
-
-    /**
-     * About all child constructors:
-     * they should define the _tables, _fields and _model_relations arrays.
-     * Should ALWAYS be called after child constructor.
-     * In order to make the child constructors to be as simple as possible, this parent constructor
-     * finalizes constructing all the object's attributes.
-     * Generally, rather than requiring a child to code
-     * $this->_tables = array(
-     *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
-     *        ...);
-     *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
-     * each EE_Table has a function to set the table's alias after the constructor, using
-     * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
-     * do something similar.
-     *
-     * @param null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        // check that the model has not been loaded too soon
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The %1$s model can not be loaded before the "AHEE__EE_System__load_espresso_addons" hook has been called. This gives other addons a chance to extend this model.',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        /**
-         * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
-         */
-        if (empty(EEM_Base::$_model_query_blog_id)) {
-            EEM_Base::set_model_query_blog_id();
-        }
-        /**
-         * Filters the list of tables on a model. It is best to NOT use this directly and instead
-         * just use EE_Register_Model_Extension
-         *
-         * @var EE_Table_Base[] $_tables
-         */
-        $this->_tables = (array) apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
-        foreach ($this->_tables as $table_alias => $table_obj) {
-            /** @var $table_obj EE_Table_Base */
-            $table_obj->_construct_finalize_with_alias($table_alias);
-            if ($table_obj instanceof EE_Secondary_Table) {
-                $table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
-            }
-        }
-        /**
-         * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
-         * EE_Register_Model_Extension
-         *
-         * @param EE_Model_Field_Base[] $_fields
-         */
-        $this->_fields = (array) apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
-        $this->_invalidate_field_caches();
-        foreach ($this->_fields as $table_alias => $fields_for_table) {
-            if (! array_key_exists($table_alias, $this->_tables)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
-                            'event_espresso'
-                        ),
-                        $table_alias,
-                        implode(",", $this->_fields)
-                    )
-                );
-            }
-            foreach ($fields_for_table as $field_name => $field_obj) {
-                /** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
-                // primary key field base has a slightly different _construct_finalize
-                /** @var $field_obj EE_Model_Field_Base */
-                $field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
-            }
-        }
-        // everything is related to Extra_Meta
-        if (get_class($this) !== 'EEM_Extra_Meta') {
-            // make extra meta related to everything, but don't block deleting things just
-            // because they have related extra meta info. For now just orphan those extra meta
-            // in the future we should automatically delete them
-            $this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
-        }
-        // and change logs
-        if (get_class($this) !== 'EEM_Change_Log') {
-            $this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
-        }
-        /**
-         * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
-         * EE_Register_Model_Extension
-         *
-         * @param EE_Model_Relation_Base[] $_model_relations
-         */
-        $this->_model_relations = (array) apply_filters(
-            'FHEE__' . get_class($this) . '__construct__model_relations',
-            $this->_model_relations
-        );
-        foreach ($this->_model_relations as $model_name => $relation_obj) {
-            /** @var $relation_obj EE_Model_Relation_Base */
-            $relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
-        }
-        foreach ($this->_indexes as $index_name => $index_obj) {
-            $index_obj->_construct_finalize($index_name, $this->get_this_model_name());
-        }
-        $this->set_timezone($timezone);
-        // finalize default where condition strategy, or set default
-        if (! $this->_default_where_conditions_strategy) {
-            // nothing was set during child constructor, so set default
-            $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
-        }
-        $this->_default_where_conditions_strategy->_finalize_construct($this);
-        if (! $this->_minimum_where_conditions_strategy) {
-            // nothing was set during child constructor, so set default
-            $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
-        }
-        $this->_minimum_where_conditions_strategy->_finalize_construct($this);
-        // if the cap slug hasn't been set, and we haven't set it to false on purpose
-        // to indicate to NOT set it, set it to the logical default
-        if ($this->_caps_slug === null) {
-            $this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
-        }
-        // initialize the standard cap restriction generators if none were specified by the child constructor
-        if (is_array($this->_cap_restriction_generators)) {
-            foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-                if (! isset($this->_cap_restriction_generators[ $cap_context ])) {
-                    $this->_cap_restriction_generators[ $cap_context ] = apply_filters(
-                        'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
-                        new EE_Restriction_Generator_Protected(),
-                        $cap_context,
-                        $this
-                    );
-                }
-            }
-        }
-        // if there are cap restriction generators, use them to make the default cap restrictions
-        if (is_array($this->_cap_restriction_generators)) {
-            foreach ($this->_cap_restriction_generators as $context => $generator_object) {
-                if (! $generator_object) {
-                    continue;
-                }
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'Index "%1$s" in the model %2$s\'s _cap_restriction_generators is not a child of EE_Restriction_Generator_Base. It should be that or NULL.',
-                                'event_espresso'
-                            ),
-                            $context,
-                            $this->get_this_model_name()
-                        )
-                    );
-                }
-                $action = $this->cap_action_for_context($context);
-                if (! $generator_object->construction_finalized()) {
-                    $generator_object->_construct_finalize($this, $action);
-                }
-            }
-        }
-        do_action('AHEE__' . get_class($this) . '__construct__end');
-    }
-
-
-    /**
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function getLoader(): LoaderInterface
-    {
-        if (! EEM_Base::$loader instanceof LoaderInterface) {
-            EEM_Base::$loader = LoaderFactory::getLoader();
-        }
-        return EEM_Base::$loader;
-    }
-
-
-    /**
-     * @return Mirror
-     * @since   $VID:$
-     */
-    private static function getMirror(): Mirror
-    {
-        if (! EEM_Base::$mirror instanceof Mirror) {
-            EEM_Base::$mirror = EEM_Base::getLoader()->getShared(Mirror::class);
-        }
-        return EEM_Base::$mirror;
-    }
-
-
-    /**
-     * @param string $model_class_Name
-     * @param string $timezone
-     * @return array
-     * @throws ReflectionException
-     * @since   $VID:$
-     */
-    private static function getModelArguments(string $model_class_Name, string $timezone): array
-    {
-        $arguments = [$timezone];
-        $params    = EEM_Base::getMirror()->getParameters($model_class_Name);
-        if (count($params) > 1) {
-            if ($params[1]->getName() === 'model_field_factory') {
-                $arguments = [
-                    $timezone,
-                    EEM_Base::getLoader()->getShared(ModelFieldFactory::class),
-                ];
-            } elseif ($model_class_Name === 'EEM_Form_Section') {
-                $arguments = [
-                    EEM_Base::getLoader()->getShared('EventEspresso\core\services\form\meta\FormStatus'),
-                    $timezone,
-                ];
-            } elseif ($model_class_Name === 'EEM_Form_Element') {
-                $arguments = [
-                    EEM_Base::getLoader()->getShared('EventEspresso\core\services\form\meta\FormStatus'),
-                    EEM_Base::getLoader()->getShared('EventEspresso\core\services\form\meta\InputTypes'),
-                    $timezone,
-                ];
-            }
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * This function is a singleton method used to instantiate the Espresso_model object
-     *
-     * @param string|null $timezone   string representing the timezone we want to set for returned Date Time Strings
-     *                                (and any incoming timezone data that gets saved).
-     *                                Note this just sends the timezone info to the date time model field objects.
-     *                                Default is NULL
-     *                                (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @return static (as in the concrete child class)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance($timezone = null)
-    {
-        // check if instance of Espresso_model already exists
-        if (! static::$_instance instanceof static) {
-            $arguments = EEM_Base::getModelArguments(static::class, (string) $timezone);
-            $model     = new static(...$arguments);
-            EEM_Base::getLoader()->share(static::class, $model, $arguments);
-            static::$_instance = $model;
-        }
-        // we might have a timezone set, let set_timezone decide what to do with it
-        if ($timezone) {
-            static::$_instance->set_timezone($timezone);
-        }
-        // Espresso_model object
-        return static::$_instance;
-    }
-
-
-    /**
-     * resets the model and returns it
-     *
-     * @param string|null $timezone
-     * @return EEM_Base|null (if the model was already instantiated, returns it, with
-     * all its properties reset; if it wasn't instantiated, returns null)
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function reset($timezone = null)
-    {
-        if (! static::$_instance instanceof EEM_Base) {
-            return null;
-        }
-        // Let's NOT swap out the current instance for a new one
-        // because if someone has a reference to it, we can't remove their reference.
-        // It's best to keep using the same reference but change the original object instead,
-        // so reset all its properties to their original values as defined in the class.
-        $static_properties = EEM_Base::getMirror()->getStaticProperties(static::class);
-        foreach (EEM_Base::getMirror()->getDefaultProperties(static::class) as $property => $value) {
-            // don't set instance to null like it was originally,
-            // but it's static anyways, and we're ignoring static properties (for now at least)
-            if (! isset($static_properties[ $property ])) {
-                static::$_instance->{$property} = $value;
-            }
-        }
-        // and then directly call its constructor again, like we would if we were creating a new one
-        $arguments = EEM_Base::getModelArguments(static::class, (string) $timezone);
-        static::$_instance->__construct(...$arguments);
-        return self::instance();
-    }
-
-
-    /**
-     * Used to set the $_model_query_blog_id static property.
-     *
-     * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
-     *                      value for get_current_blog_id() will be used.
-     */
-    public static function set_model_query_blog_id($blog_id = 0)
-    {
-        EEM_Base::$_model_query_blog_id = $blog_id > 0
-            ? (int) $blog_id
-            : get_current_blog_id();
-    }
-
-
-    /**
-     * Returns whatever is set as the internal $model_query_blog_id.
-     *
-     * @return int
-     */
-    public static function get_model_query_blog_id()
-    {
-        return EEM_Base::$_model_query_blog_id;
-    }
-
-
-    /**
-     * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
-     *
-     * @param boolean $translated return localized strings or JUST the array.
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function status_array($translated = false)
-    {
-        if (! array_key_exists('Status', $this->_model_relations)) {
-            return [];
-        }
-        $model_name   = $this->get_this_model_name();
-        $status_type  = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
-        $stati        = EEM_Status::instance()->get_all([['STS_type' => $status_type]]);
-        $status_array = [];
-        foreach ($stati as $status) {
-            $status_array[ $status->ID() ] = $status->get('STS_code');
-        }
-        return $translated
-            ? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
-            : $status_array;
-    }
-
-
-    /**
-     * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
-     *
-     * @param array $query_params             @see
-     *                                        https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     *                                        or if you have the development copy of EE you can view this at the path:
-     *                                        /docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
-     *                                        from EE_Base_Class[], use get_all_wpdb_results(). Array keys are object
-     *                                        IDs (if there is a primary key on the model. if not, numerically indexed)
-     *                                        Some full examples: get 10 transactions which have Scottish attendees:
-     *                                        EEM_Transaction::instance()->get_all( array( array(
-     *                                        'OR'=>array(
-     *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
-     *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
-     *                                        )
-     *                                        ),
-     *                                        'limit'=>10,
-     *                                        'group_by'=>'TXN_ID'
-     *                                        ));
-     *                                        get all the answers to the question titled "shirt size" for event with id
-     *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
-     *                                        'Question.QST_display_text'=>'shirt size',
-     *                                        'Registration.Event.EVT_ID'=>12
-     *                                        ),
-     *                                        'order_by'=>array('ANS_value'=>'ASC')
-     *                                        ));
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all($query_params = [])
-    {
-        if (
-            isset($query_params['limit'])
-            && ! isset($query_params['group_by'])
-        ) {
-            $query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
-        }
-        return $this->_create_objects($this->_get_all_wpdb_results($query_params));
-    }
-
-
-    /**
-     * Modifies the query parameters so we only get back model objects
-     * that "belong" to the current user
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws ReflectionException
-     * @throws ReflectionException
-     */
-    public function alter_query_params_to_only_include_mine($query_params = [])
-    {
-        $wp_user_field_name = $this->wp_user_field_name();
-        if ($wp_user_field_name) {
-            $query_params[0][ $wp_user_field_name ] = get_current_user_id();
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * Returns the name of the field's name that points to the WP_User table
-     *  on this model (or follows the _model_chain_to_wp_user and uses that model's
-     * foreign key to the WP_User table)
-     *
-     * @return string|boolean string on success, boolean false when there is no
-     * foreign key to the WP_User table
-     * @throws ReflectionException
-     * @throws ReflectionException
-     */
-    public function wp_user_field_name()
-    {
-        try {
-            if (! empty($this->_model_chain_to_wp_user)) {
-                $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
-                $last_model_name              = end($models_to_follow_to_wp_users);
-                $model_with_fk_to_wp_users    = EE_Registry::instance()->load_model($last_model_name);
-                $model_chain_to_wp_user       = $this->_model_chain_to_wp_user . '.';
-            } else {
-                $model_with_fk_to_wp_users = $this;
-                $model_chain_to_wp_user    = '';
-            }
-            $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
-        } catch (EE_Error $e) {
-            return false;
-        }
-    }
-
-
-    /**
-     * Returns the _model_chain_to_wp_user string, which indicates which related model
-     * (or transiently-related model) has a foreign key to the wp_users table;
-     * useful for finding if model objects of this type are 'owned' by the current user.
-     * This is an empty string when the foreign key is on this model and when it isn't,
-     * but is only non-empty when this model's ownership is indicated by a RELATED model
-     * (or transiently-related model)
-     *
-     * @return string
-     */
-    public function model_chain_to_wp_user()
-    {
-        return $this->_model_chain_to_wp_user;
-    }
-
-
-    /**
-     * Whether this model is 'owned' by a specific wordpress user (even indirectly,
-     * like how registrations don't have a foreign key to wp_users, but the
-     * events they are for are), or is unrelated to wp users.
-     * generally available
-     *
-     * @return boolean
-     */
-    public function is_owned()
-    {
-        if ($this->model_chain_to_wp_user()) {
-            return true;
-        }
-        try {
-            $this->get_foreign_key_to('WP_User');
-            return true;
-        } catch (EE_Error $e) {
-            return false;
-        }
-    }
-
-
-    /**
-     * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
-     * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
-     * the model)
-     *
-     * @param array  $query_params      @see
-     *                                  https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
-     *                                  fields on the model, and the models we joined to in the query. However, you can
-     *                                  override this and set the select to "*", or a specific column name, like
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
-     *                                  the aliases used to refer to this selection, and values are to be
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
-     * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    protected function _get_all_wpdb_results($query_params = [], $output = ARRAY_A, $columns_to_select = null)
-    {
-        $this->_custom_selections = $this->getCustomSelection($query_params, $columns_to_select);
-        $model_query_info         = $this->_create_model_query_info_carrier($query_params);
-        $select_expressions       = $columns_to_select === null
-            ? $this->_construct_default_select_sql($model_query_info)
-            : '';
-        if ($this->_custom_selections instanceof CustomSelects) {
-            $custom_expressions = $this->_custom_selections->columnsToSelectExpression();
-            $select_expressions .= $select_expressions
-                ? ', ' . $custom_expressions
-                : $custom_expressions;
-        }
-
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
-        return $this->_do_wpdb_query('get_results', [$SQL, $output]);
-    }
-
-
-    /**
-     * Get a CustomSelects object if the $query_params or $columns_to_select allows for it.
-     * Note: $query_params['extra_selects'] will always override any $columns_to_select values. It is the preferred
-     * method of including extra select information.
-     *
-     * @param array             $query_params
-     * @param null|array|string $columns_to_select
-     * @return null|CustomSelects
-     * @throws InvalidArgumentException
-     */
-    protected function getCustomSelection(array $query_params, $columns_to_select = null)
-    {
-        if (! isset($query_params['extra_selects']) && $columns_to_select === null) {
-            return null;
-        }
-        $selects = isset($query_params['extra_selects']) ? $query_params['extra_selects'] : $columns_to_select;
-        $selects = is_string($selects) ? explode(',', $selects) : $selects;
-        return new CustomSelects($selects);
-    }
-
-
-    /**
-     * Gets an array of rows from the database just like $wpdb->get_results would,
-     * but you can use the model query params to more easily
-     * take care of joins, field preparation etc.
-     *
-     * @param array  $query_params      @see
-     *                                  https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
-     * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
-     *                                  fields on the model, and the models we joined to in the query. However, you can
-     *                                  override this and set the select to "*", or a specific column name, like
-     *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
-     *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
-     *                                  the aliases used to refer to this selection, and values are to be
-     *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
-     *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
-     * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
-     * @throws EE_Error
-     */
-    public function get_all_wpdb_results($query_params = [], $output = ARRAY_A, $columns_to_select = null)
-    {
-        return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
-    }
-
-
-    /**
-     * For creating a custom select statement
-     *
-     * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
-     *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
-     *                                 SQL, and 1=>is the datatype
-     * @return string
-     * @throws EE_Error
-     */
-    private function _construct_select_from_input($columns_to_select)
-    {
-        if (is_array($columns_to_select)) {
-            $select_sql_array = [];
-            foreach ($columns_to_select as $alias => $selection_and_datatype) {
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                "Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
-                                'event_espresso'
-                            ),
-                            $selection_and_datatype,
-                            $alias
-                        )
-                    );
-                }
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types, true)) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                "Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
-                                'event_espresso'
-                            ),
-                            $selection_and_datatype[1],
-                            $selection_and_datatype[0],
-                            $alias,
-                            implode(', ', $this->_valid_wpdb_data_types)
-                        )
-                    );
-                }
-                $select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
-            }
-            $columns_to_select_string = implode(', ', $select_sql_array);
-        } else {
-            $columns_to_select_string = $columns_to_select;
-        }
-        return $columns_to_select_string;
-    }
-
-
-    /**
-     * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function primary_key_name()
-    {
-        return $this->get_primary_key_field()->get_name();
-    }
-
-
-    /**
-     * Gets a single item for this model from the DB, given only its ID (or null if none is found).
-     * If there is no primary key on this model, $id is treated as primary key string
-     *
-     * @param mixed $id int or string, depending on the type of the model's primary key
-     * @return EE_Base_Class|mixed|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_one_by_ID($id)
-    {
-        if ($this->get_from_entity_map($id)) {
-            return $this->get_from_entity_map($id);
-        }
-        $model_object = $this->get_one(
-            $this->alter_query_params_to_restrict_by_ID(
-                $id,
-                ['default_where_conditions' => EEM_Base::default_where_conditions_minimum_all]
-            )
-        );
-        $className    = $this->_get_class_name();
-        if ($model_object instanceof $className) {
-            // make sure valid objects get added to the entity map
-            // so that the next call to this method doesn't trigger another trip to the db
-            $this->add_to_entity_map($model_object);
-        }
-        return $model_object;
-    }
-
-
-    /**
-     * Alters query parameters to only get items with this ID are returned.
-     * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
-     * or could just be a simple primary key ID
-     *
-     * @param int   $id
-     * @param array $query_params
-     * @return array of normal query params, @see
-     *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     */
-    public function alter_query_params_to_restrict_by_ID($id, $query_params = [])
-    {
-        if (! isset($query_params[0])) {
-            $query_params[0] = [];
-        }
-        $conditions_from_id = $this->parse_index_primary_key_string($id);
-        if ($conditions_from_id === null) {
-            $query_params[0][ $this->primary_key_name() ] = $id;
-        } else {
-            // no primary key, so the $id must be from the get_index_primary_key_string()
-            $query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
-     * array. If no item is found, null is returned.
-     *
-     * @param array $query_params like EEM_Base's $query_params variable.
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one($query_params = [])
-    {
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong(
-                'EEM_Base::get_one',
-                sprintf(
-                    esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)
-                ),
-                '4.6.0'
-            );
-            $query_params = [];
-        }
-        $query_params['limit'] = 1;
-        $items                 = $this->get_all($query_params);
-        if (empty($items)) {
-            return null;
-        }
-        return array_shift($items);
-    }
-
-
-    /**
-     * Returns the next x number of items in sequence from the given value as
-     * found in the database matching the given query conditions.
-     *
-     * @param mixed $current_field_value    Value used for the reference point.
-     * @param null  $field_to_order_by      What field is used for the
-     *                                      reference point.
-     * @param int   $limit                  How many to return.
-     * @param array $query_params           Extra conditions on the query.
-     * @param null  $columns_to_select      If left null, then an array of
-     *                                      EE_Base_Class objects is returned,
-     *                                      otherwise you can indicate just the
-     *                                      columns you want returned.
-     * @return EE_Base_Class[]|array
-     * @throws EE_Error
-     */
-    public function next_x(
-        $current_field_value,
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = [],
-        $columns_to_select = null
-    ) {
-        return $this->_get_consecutive(
-            $current_field_value,
-            '>',
-            $field_to_order_by,
-            $limit,
-            $query_params,
-            $columns_to_select
-        );
-    }
-
-
-    /**
-     * Returns the previous x number of items in sequence from the given value
-     * as found in the database matching the given query conditions.
-     *
-     * @param mixed $current_field_value    Value used for the reference point.
-     * @param null  $field_to_order_by      What field is used for the
-     *                                      reference point.
-     * @param int   $limit                  How many to return.
-     * @param array $query_params           Extra conditions on the query.
-     * @param null  $columns_to_select      If left null, then an array of
-     *                                      EE_Base_Class objects is returned,
-     *                                      otherwise you can indicate just the
-     *                                      columns you want returned.
-     * @return EE_Base_Class[]|array
-     * @throws EE_Error
-     */
-    public function previous_x(
-        $current_field_value,
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = [],
-        $columns_to_select = null
-    ) {
-        return $this->_get_consecutive(
-            $current_field_value,
-            '<',
-            $field_to_order_by,
-            $limit,
-            $query_params,
-            $columns_to_select
-        );
-    }
-
-
-    /**
-     * Returns the next item in sequence from the given value as found in the
-     * database matching the given query conditions.
-     *
-     * @param mixed $current_field_value    Value used for the reference point.
-     * @param null  $field_to_order_by      What field is used for the
-     *                                      reference point.
-     * @param array $query_params           Extra conditions on the query.
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
-     *                                      object is returned, otherwise you
-     *                                      can indicate just the columns you
-     *                                      want and a single array indexed by
-     *                                      the columns will be returned.
-     * @return EE_Base_Class|null|array()
-     * @throws EE_Error
-     */
-    public function next(
-        $current_field_value,
-        $field_to_order_by = null,
-        $query_params = [],
-        $columns_to_select = null
-    ) {
-        $results = $this->_get_consecutive(
-            $current_field_value,
-            '>',
-            $field_to_order_by,
-            1,
-            $query_params,
-            $columns_to_select
-        );
-        return empty($results) ? null : reset($results);
-    }
-
-
-    /**
-     * Returns the previous item in sequence from the given value as found in
-     * the database matching the given query conditions.
-     *
-     * @param mixed $current_field_value    Value used for the reference point.
-     * @param null  $field_to_order_by      What field is used for the
-     *                                      reference point.
-     * @param array $query_params           Extra conditions on the query.
-     * @param null  $columns_to_select      If left null, then an EE_Base_Class
-     *                                      object is returned, otherwise you
-     *                                      can indicate just the columns you
-     *                                      want and a single array indexed by
-     *                                      the columns will be returned.
-     * @return EE_Base_Class|null|array()
-     * @throws EE_Error
-     */
-    public function previous(
-        $current_field_value,
-        $field_to_order_by = null,
-        $query_params = [],
-        $columns_to_select = null
-    ) {
-        $results = $this->_get_consecutive(
-            $current_field_value,
-            '<',
-            $field_to_order_by,
-            1,
-            $query_params,
-            $columns_to_select
-        );
-        return empty($results) ? null : reset($results);
-    }
-
-
-    /**
-     * Returns the a consecutive number of items in sequence from the given
-     * value as found in the database matching the given query conditions.
-     *
-     * @param mixed  $current_field_value   Value used for the reference point.
-     * @param string $operand               What operand is used for the sequence.
-     * @param string $field_to_order_by     What field is used for the reference point.
-     * @param int    $limit                 How many to return.
-     * @param array  $query_params          Extra conditions on the query.
-     * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
-     *                                      otherwise you can indicate just the columns you want returned.
-     * @return EE_Base_Class[]|array
-     * @throws EE_Error
-     */
-    protected function _get_consecutive(
-        $current_field_value,
-        $operand = '>',
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = [],
-        $columns_to_select = null
-    ) {
-        // if $field_to_order_by is empty then let's assume we're ordering by the primary key.
-        if (empty($field_to_order_by)) {
-            if ($this->has_primary_key_field()) {
-                $field_to_order_by = $this->get_primary_key_field()->get_name();
-            } else {
-                if (WP_DEBUG) {
-                    throw new EE_Error(
-                        esc_html__(
-                            'EEM_Base::_get_consecutive() has been called with no $field_to_order_by argument and there is no primary key on the field.  Please provide the field you would like to use as the base for retrieving the next item(s).',
-                            'event_espresso'
-                        )
-                    );
-                }
-                EE_Error::add_error(
-                    esc_html__('There was an error with the query.', 'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                return [];
-            }
-        }
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong(
-                'EEM_Base::_get_consecutive',
-                sprintf(
-                    esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)
-                ),
-                '4.6.0'
-            );
-            $query_params = [];
-        }
-        // let's add the where query param for consecutive look up.
-        $query_params[0][ $field_to_order_by ] = [$operand, $current_field_value];
-        $query_params['limit']                 = $limit;
-        // set direction
-        $incoming_orderby         = isset($query_params['order_by']) ? (array) $query_params['order_by'] : [];
-        $query_params['order_by'] = $operand === '>'
-            ? [$field_to_order_by => 'ASC'] + $incoming_orderby
-            : [$field_to_order_by => 'DESC'] + $incoming_orderby;
-        // if $columns_to_select is empty then that means we're returning EE_Base_Class objects
-        if (empty($columns_to_select)) {
-            return $this->get_all($query_params);
-        }
-        // getting just the fields
-        return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
-    }
-
-
-    /**
-     * This sets the _timezone property after model object has been instantiated.
-     *
-     * @param null | string $timezone valid PHP DateTimeZone timezone string
-     */
-    public function set_timezone($timezone)
-    {
-        if ($timezone !== null) {
-            $this->_timezone = $timezone;
-        }
-        // note we need to loop through relations and set the timezone on those objects as well.
-        foreach ($this->_model_relations as $relation) {
-            $relation->set_timezone($timezone);
-        }
-        // and finally we do the same for any datetime fields
-        foreach ($this->_fields as $field) {
-            if ($field instanceof EE_Datetime_Field) {
-                $field->set_timezone($timezone);
-            }
-        }
-    }
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @access public
-     * @return string
-     */
-    public function get_timezone()
-    {
-        // first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
-        if (empty($this->_timezone)) {
-            foreach ($this->_fields as $field) {
-                if ($field instanceof EE_Datetime_Field) {
-                    $this->set_timezone($field->get_timezone());
-                    break;
-                }
-            }
-        }
-        // if timezone STILL empty then return the default timezone for the site.
-        if (empty($this->_timezone)) {
-            $this->set_timezone(EEH_DTT_Helper::get_timezone());
-        }
-        return $this->_timezone;
-    }
-
-
-    /**
-     * This returns the date formats set for the given field name and also ensures that
-     * $this->_timezone property is set correctly.
-     *
-     * @param string $field_name The name of the field the formats are being retrieved for.
-     * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
-     * @return array formats in an array with the date format first, and the time format last.
-     * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
-     * @since 4.6.x
-     */
-    public function get_formats_for($field_name, $pretty = false)
-    {
-        $field_settings = $this->field_settings_for($field_name);
-        // if not a valid EE_Datetime_Field then throw error
-        if (! $field_settings instanceof EE_Datetime_Field) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The field sent into EEM_Base::get_formats_for (%s) is not registered as a EE_Datetime_Field. Please check the spelling and make sure you are submitting the right field name to retrieve date_formats for.',
-                        'event_espresso'
-                    ),
-                    $field_name
-                )
-            );
-        }
-        // while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
-        // the field.
-        $this->_timezone = $field_settings->get_timezone();
-        return [$field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty)];
-    }
-
-
-    /**
-     * This returns the current time in a format setup for a query on this model.
-     * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
-     * it will return:
-     *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
-     *  NOW
-     *  - or a unix timestamp (equivalent to time())
-     * Note: When requesting a formatted string, if the date or time format doesn't include seconds, for example,
-     * the time returned, because it uses that format, will also NOT include seconds. For this reason, if you want
-     * the time returned to be the current time down to the exact second, set $timestamp to true.
-     *
-     * @param string $field_name       The field the current time is needed for.
-     * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
-     *                                 formatted string matching the set format for the field in the set timezone will
-     *                                 be returned.
-     * @param string $what             Whether to return the string in just the time format, the date format, or both.
-     * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
-     *                                 exception is triggered.
-     * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
-     * @throws Exception
-     * @since 4.6.x
-     */
-    public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
-    {
-        $formats  = $this->get_formats_for($field_name);
-        $DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
-        if ($timestamp) {
-            return $DateTime->format('U');
-        }
-        // not returning timestamp, so return formatted string in timezone.
-        switch ($what) {
-            case 'time':
-                return $DateTime->format($formats[1]);
-            case 'date':
-                return $DateTime->format($formats[0]);
-            default:
-                return $DateTime->format(implode(' ', $formats));
-        }
-    }
-
-
-    /**
-     * This receives a time string for a given field and ensures that it is setup to match what the internal settings
-     * for the model are.  Returns a DateTime object.
-     * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
-     * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
-     * ignored.
-     *
-     * @param string $field_name      The field being setup.
-     * @param string $timestring      The date time string being used.
-     * @param string $incoming_format The format for the time string.
-     * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
-     *                                the blog.  If this is not the case, then it can be specified here.  If incoming
-     *                                format is
-     *                                'U', this is ignored.
-     * @return DateTime
-     * @throws EE_Error
-     */
-    public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
-    {
-        // just using this to ensure the timezone is set correctly internally
-        $this->get_formats_for($field_name);
-        // load EEH_DTT_Helper
-        $set_timezone     = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
-        $incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
-        EEH_DTT_Helper::setTimezone($incomingDateTime, new DateTimeZone($this->_timezone));
-        return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime($incomingDateTime);
-    }
-
-
-    /**
-     * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
-     *
-     * @return EE_Table_Base[]
-     */
-    public function get_tables()
-    {
-        return $this->_tables;
-    }
-
-
-    /**
-     * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
-     * also updates all the model objects, where the criteria expressed in $query_params are met..
-     * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
-     * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
-     * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
-     * model object with EVT_ID = 1
-     * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
-     * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
-     * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
-     * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
-     * are not specified)
-     *
-     * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
-     *                                         columns!), values are strings, ints, floats, and maybe arrays if they
-     *                                         are to be serialized. Basically, the values are what you'd expect to be
-     *                                         values on the model, NOT necessarily what's in the DB. For example, if
-     *                                         we wanted to update only the TXN_details on any Transactions where its
-     *                                         ID=34, we'd use this method as follows:
-     *                                         EEM_Transaction::instance()->update(
-     *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
-     *                                         array(array('TXN_ID'=>34)));
-     * @param array   $query_params            @see
-     *                                         https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     *                                         Eg, consider updating Question's QST_admin_label field is of type
-     *                                         Simple_HTML. If you use this function to update that field to $new_value
-     *                                         = (note replace 8's with appropriate opening and closing tags in the
-     *                                         following example)"8script8alert('I hack all');8/script88b8boom
-     *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
-     *                                         TRUE, it is assumed that you've already called
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
-     *                                         malicious javascript. However, if
-     *                                         $values_already_prepared_by_model_object is left as FALSE, then
-     *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
-     *                                         and every other field, before insertion. We provide this parameter
-     *                                         because model objects perform their prepare_for_set function on all
-     *                                         their values, and so don't need to be called again (and in many cases,
-     *                                         shouldn't be called again. Eg: if we escape HTML characters in the
-     *                                         prepare_for_set method...)
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
-     *                                         in this model's entity map according to $fields_n_values that match
-     *                                         $query_params. This obviously has some overhead, so you can disable it
-     *                                         by setting this to FALSE, but be aware that model objects being used
-     *                                         could get out-of-sync with the database
-     * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
-     *                                         rows affected which *could* include 0 which DOES NOT mean the query was
-     *                                         bad)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
-    {
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong(
-                'EEM_Base::update',
-                sprintf(
-                    esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)
-                ),
-                '4.6.0'
-            );
-            $query_params = [];
-        }
-        /**
-         * Action called before a model update call has been made.
-         *
-         * @param EEM_Base $model
-         * @param array    $fields_n_values the updated fields and their new values
-         * @param array    $query_params    @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-         */
-        do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
-        /**
-         * Filters the fields about to be updated given the query parameters. You can provide the
-         * $query_params to $this->get_all() to find exactly which records will be updated
-         *
-         * @param array    $fields_n_values fields and their new values
-         * @param EEM_Base $model           the model being queried
-         * @param array    $query_params    @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-         */
-        $fields_n_values = (array) apply_filters(
-            'FHEE__EEM_Base__update__fields_n_values',
-            $fields_n_values,
-            $this,
-            $query_params
-        );
-        // need to verify that, for any entry we want to update, there are entries in each secondary table.
-        // to do that, for each table, verify that it's PK isn't null.
-        $tables = $this->get_tables();
-        // and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
-        // NOTE: we should make this code more efficient by NOT querying twice
-        // before the real update, but that needs to first go through ALPHA testing
-        // as it's dangerous. says Mike August 8 2014
-        // we want to make sure the default_where strategy is ignored
-        $this->_ignore_where_strategy = true;
-        $wpdb_select_results          = $this->_get_all_wpdb_results($query_params);
-        foreach ($wpdb_select_results as $wpdb_result) {
-            // type cast stdClass as array
-            $wpdb_result = (array) $wpdb_result;
-            // get the model object's PK, as we'll want this if we need to insert a row into secondary tables
-            if ($this->has_primary_key_field()) {
-                $main_table_pk_value = $wpdb_result[ $this->get_primary_key_field()->get_qualified_column() ];
-            } else {
-                // if there's no primary key, we basically can't support having a 2nd table on the model (we could but it would be lots of work)
-                $main_table_pk_value = null;
-            }
-            // if there are more than 1 tables, we'll want to verify that each table for this model has an entry in the other tables
-            // and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
-            if (count($tables) > 1) {
-                // foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
-                // in that table, and so we'll want to insert one
-                foreach ($tables as $table_obj) {
-                    $this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
-                    // if there is no private key for this table on the results, it means there's no entry
-                    // in this table, right? so insert a row in the current table, using any fields available
-                    if (
-                        ! (array_key_exists($this_table_pk_column, $wpdb_result)
-                           && $wpdb_result[ $this_table_pk_column ])
-                    ) {
-                        $success = $this->_insert_into_specific_table(
-                            $table_obj,
-                            $fields_n_values,
-                            $main_table_pk_value
-                        );
-                        // if we died here, report the error
-                        if (! $success) {
-                            return false;
-                        }
-                    }
-                }
-            }
-            //              //and now check that if we have cached any models by that ID on the model, that
-            //              //they also get updated properly
-            //              $model_object = $this->get_from_entity_map( $main_table_pk_value );
-            //              if( $model_object ){
-            //                  foreach( $fields_n_values as $field => $value ){
-            //                      $model_object->set($field, $value);
-            // let's make sure default_where strategy is followed now
-            $this->_ignore_where_strategy = false;
-        }
-        // if we want to keep model objects in sync, AND
-        // if this wasn't called from a model object (to update itself)
-        // then we want to make sure we keep all the existing
-        // model objects in sync with the db
-        if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
-            if ($this->has_primary_key_field()) {
-                $model_objs_affected_ids = $this->get_col($query_params);
-            } else {
-                // we need to select a bunch of columns and then combine them into the the "index primary key string"s
-                $models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
-                $model_objs_affected_ids     = [];
-                foreach ($models_affected_key_columns as $row) {
-                    $combined_index_key                             = $this->get_index_primary_key_string($row);
-                    $model_objs_affected_ids[ $combined_index_key ] = $combined_index_key;
-                }
-            }
-            if (! $model_objs_affected_ids) {
-                // wait wait wait- if nothing was affected let's stop here
-                return 0;
-            }
-            foreach ($model_objs_affected_ids as $id) {
-                $model_obj_in_entity_map = $this->get_from_entity_map($id);
-                if ($model_obj_in_entity_map) {
-                    foreach ($fields_n_values as $field => $new_value) {
-                        $model_obj_in_entity_map->set($field, $new_value);
-                    }
-                }
-            }
-            // if there is a primary key on this model, we can now do a slight optimization
-            if ($this->has_primary_key_field()) {
-                // we already know what we want to update. So let's make the query simpler so it's a little more efficient
-                $query_params = [
-                    [$this->primary_key_name() => ['IN', $model_objs_affected_ids]],
-                    'limit'                    => count($model_objs_affected_ids),
-                    'default_where_conditions' => EEM_Base::default_where_conditions_none,
-                ];
-            }
-        }
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
-        $SQL              = "UPDATE "
-                            . $model_query_info->get_full_join_sql()
-                            . " SET "
-                            . $this->_construct_update_sql($fields_n_values)
-                            . $model_query_info->get_where_sql(
-            );// note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
-        $rows_affected    = $this->_do_wpdb_query('query', [$SQL]);
-        /**
-         * Action called after a model update call has been made.
-         *
-         * @param EEM_Base $model
-         * @param array    $fields_n_values the updated fields and their new values
-         * @param array    $query_params    @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-         * @param int      $rows_affected
-         */
-        do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
-        return $rows_affected;// how many supposedly got updated
-    }
-
-
-    /**
-     * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
-     * are teh values of the field specified (or by default the primary key field)
-     * that matched the query params. Note that you should pass the name of the
-     * model FIELD, not the database table's column name.
-     *
-     * @param array  $query_params @see
-     *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_select
-     * @return array just like $wpdb->get_col()
-     * @throws EE_Error
-     */
-    public function get_col($query_params = [], $field_to_select = null)
-    {
-        if ($field_to_select) {
-            $field = $this->field_settings_for($field_to_select);
-        } elseif ($this->has_primary_key_field()) {
-            $field = $this->get_primary_key_field();
-        } else {
-            $field_settings = $this->field_settings();
-            // no primary key, just grab the first column
-            $field = reset($field_settings);
-            // don't need this array now
-            unset($field_settings);
-        }
-        $model_query_info   = $this->_create_model_query_info_carrier($query_params);
-        $select_expressions = $field->get_qualified_column();
-        $SQL                =
-            "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
-        return $this->_do_wpdb_query('get_col', [$SQL]);
-    }
-
-
-    /**
-     * Returns a single column value for a single row from the database
-     *
-     * @param array  $query_params    @see
-     *                                https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_select @see EEM_Base::get_col()
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_var($query_params = [], $field_to_select = null)
-    {
-        $query_params['limit'] = 1;
-        $col                   = $this->get_col($query_params, $field_to_select);
-        if (! empty($col)) {
-            return reset($col);
-        }
-        return null;
-    }
-
-
-    /**
-     * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
-     * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
-     * injection, but currently no further filtering is done
-     *
-     * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
-     *                               be updated to in the DB
-     * @return string of SQL
-     * @throws EE_Error
-     * @global      $wpdb
-     */
-    public function _construct_update_sql($fields_n_values)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $cols_n_values = [];
-        foreach ($fields_n_values as $field_name => $value) {
-            $field_obj = $this->field_settings_for($field_name);
-            // if the value is NULL, we want to assign the value to that.
-            // wpdb->prepare doesn't really handle that properly
-            $prepared_value  = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
-            $value_sql       = $prepared_value === null ? 'NULL'
-                : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
-        }
-        return implode(",", $cols_n_values);
-    }
-
-
-    /**
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
-     * Performs a HARD delete, meaning the database row should always be removed,
-     * not just have a flag field on it switched
-     * Wrapper for EEM_Base::delete_permanently()
-     *
-     * @param mixed   $id
-     * @param boolean $allow_blocking
-     * @return int the number of rows deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_permanently_by_ID($id, $allow_blocking = true)
-    {
-        return $this->delete_permanently(
-            [
-                [$this->get_primary_key_field()->get_name() => $id],
-                'limit' => 1,
-            ],
-            $allow_blocking
-        );
-    }
-
-
-    /**
-     * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
-     * Wrapper for EEM_Base::delete()
-     *
-     * @param mixed   $id
-     * @param boolean $allow_blocking
-     * @return int the number of rows deleted
-     * @throws EE_Error
-     */
-    public function delete_by_ID($id, $allow_blocking = true)
-    {
-        return $this->delete(
-            [
-                [$this->get_primary_key_field()->get_name() => $id],
-                'limit' => 1,
-            ],
-            $allow_blocking
-        );
-    }
-
-
-    /**
-     * Identical to delete_permanently, but does a "soft" delete if possible,
-     * meaning if the model has a field that indicates its been "trashed" or
-     * "soft deleted", we will just set that instead of actually deleting the rows.
-     *
-     * @param array   $query_params
-     * @param boolean $allow_blocking
-     * @return int how many rows got deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see EEM_Base::delete_permanently
-     */
-    public function delete($query_params, $allow_blocking = true)
-    {
-        return $this->delete_permanently($query_params, $allow_blocking);
-    }
-
-
-    /**
-     * Deletes the model objects that meet the query params. Note: this method is overridden
-     * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
-     * as archived, not actually deleted
-     *
-     * @param array   $query_params   @see
-     *                                https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
-     *                                that blocks it (ie, there' sno other data that depends on this data); if false,
-     *                                deletes regardless of other objects which may depend on it. Its generally
-     *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
-     *                                DB
-     * @return int how many rows got deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_permanently($query_params, $allow_blocking = true)
-    {
-        /**
-         * Action called just before performing a real deletion query. You can use the
-         * model and its $query_params to find exactly which items will be deleted
-         *
-         * @param EEM_Base $model
-         * @param array    $query_params   @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-         * @param boolean  $allow_blocking whether or not to allow related model objects
-         *                                 to block (prevent) this deletion
-         */
-        do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
-        // some MySQL databases may be running safe mode, which may restrict
-        // deletion if there is no KEY column used in the WHERE statement of a deletion.
-        // to get around this, we first do a SELECT, get all the IDs, and then run another query
-        // to delete them
-        $items_for_deletion           = $this->_get_all_wpdb_results($query_params);
-        $columns_and_ids_for_deleting = $this->_get_ids_for_delete($items_for_deletion, $allow_blocking);
-        $deletion_where_query_part    = $this->_build_query_part_for_deleting_from_columns_and_values(
-            $columns_and_ids_for_deleting
-        );
-        /**
-         * Allows client code to act on the items being deleted before the query is actually executed.
-         *
-         * @param EEM_Base $this                            The model instance being acted on.
-         * @param array    $query_params                    The incoming array of query parameters influencing what gets deleted.
-         * @param bool     $allow_blocking                  @see param description in method phpdoc block.
-         * @param array    $columns_and_ids_for_deleting    An array indicating what entities will get removed as
-         *                                                  derived from the incoming query parameters.
-         * @see details on the structure of this array in the phpdocs
-         *                                                  for the `_get_ids_for_delete_method`
-         *
-         */
-        do_action(
-            'AHEE__EEM_Base__delete__before_query',
-            $this,
-            $query_params,
-            $allow_blocking,
-            $columns_and_ids_for_deleting
-        );
-        if ($deletion_where_query_part) {
-            $model_query_info = $this->_create_model_query_info_carrier($query_params);
-            $table_aliases    = array_keys($this->_tables);
-            $SQL              = "DELETE "
-                                . implode(", ", $table_aliases)
-                                . " FROM "
-                                . $model_query_info->get_full_join_sql()
-                                . " WHERE "
-                                . $deletion_where_query_part;
-            $rows_deleted     = $this->_do_wpdb_query('query', [$SQL]);
-        } else {
-            $rows_deleted = 0;
-        }
-
-        // Next, make sure those items are removed from the entity map; if they could be put into it at all; and if
-        // there was no error with the delete query.
-        if (
-            $this->has_primary_key_field()
-            && $rows_deleted !== false
-            && isset($columns_and_ids_for_deleting[ $this->get_primary_key_field()->get_qualified_column() ])
-        ) {
-            $ids_for_removal = $columns_and_ids_for_deleting[ $this->get_primary_key_field()->get_qualified_column() ];
-            foreach ($ids_for_removal as $id) {
-                if (isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])) {
-                    unset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]);
-                }
-            }
-
-            // delete any extra meta attached to the deleted entities but ONLY if this model is not an instance of
-            // `EEM_Extra_Meta`.  In other words we want to prevent recursion on EEM_Extra_Meta::delete_permanently calls
-            // unnecessarily.  It's very unlikely that users will have assigned Extra Meta to Extra Meta
-            // (although it is possible).
-            // Note this can be skipped by using the provided filter and returning false.
-            if (
-                apply_filters(
-                    'FHEE__EEM_Base__delete_permanently__dont_delete_extra_meta_for_extra_meta',
-                    ! $this instanceof EEM_Extra_Meta,
-                    $this
-                )
-            ) {
-                EEM_Extra_Meta::instance()->delete_permanently([
-                                                                   0 => [
-                                                                       'EXM_type' => $this->get_this_model_name(),
-                                                                       'OBJ_ID'   => [
-                                                                           'IN',
-                                                                           $ids_for_removal,
-                                                                       ],
-                                                                   ],
-                                                               ]);
-            }
-        }
-
-        /**
-         * Action called just after performing a real deletion query. Although at this point the
-         * items should have been deleted
-         *
-         * @param EEM_Base $model
-         * @param array    $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-         * @param int      $rows_deleted
-         */
-        do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted, $columns_and_ids_for_deleting);
-        return $rows_deleted;// how many supposedly got deleted
-    }
-
-
-    /**
-     * Checks all the relations that throw error messages when there are blocking related objects
-     * for related model objects. If there are any related model objects on those relations,
-     * adds an EE_Error, and return true
-     *
-     * @param EE_Base_Class|int $this_model_obj_or_id
-     * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
-     *                                                 should be ignored when determining whether there are related
-     *                                                 model objects which block this model object's deletion. Useful
-     *                                                 if you know A is related to B and are considering deleting A,
-     *                                                 but want to see if A has any other objects blocking its deletion
-     *                                                 before removing the relation between A and B
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
-    {
-        // first, if $ignore_this_model_obj was supplied, get its model
-        if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
-            $ignored_model = $ignore_this_model_obj->get_model();
-        } else {
-            $ignored_model = null;
-        }
-        // now check all the relations of $this_model_obj_or_id and see if there
-        // are any related model objects blocking it?
-        $is_blocked = false;
-        foreach ($this->_model_relations as $relation_name => $relation_obj) {
-            if ($relation_obj->block_delete_if_related_models_exist()) {
-                // if $ignore_this_model_obj was supplied, then for the query
-                // on that model needs to be told to ignore $ignore_this_model_obj
-                if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, [
-                        [
-                            $ignored_model->get_primary_key_field()->get_name() => [
-                                '!=',
-                                $ignore_this_model_obj->ID(),
-                            ],
-                        ],
-                    ]);
-                } else {
-                    $related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
-                }
-                if ($related_model_objects) {
-                    EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
-                    $is_blocked = true;
-                }
-            }
-        }
-        return $is_blocked;
-    }
-
-
-    /**
-     * Builds the columns and values for items to delete from the incoming $row_results_for_deleting array.
-     *
-     * @param array $row_results_for_deleting
-     * @param bool  $allow_blocking
-     * @return array   The shape of this array depends on whether the model `has_primary_key_field` or not.  If the
-     *                              model DOES have a primary_key_field, then the array will be a simple single
-     *                              dimension array where the key is the fully qualified primary key column and the
-     *                              value is an array of ids that will be deleted. Example: array('Event.EVT_ID' =>
-     *                              array( 1,2,3)) If the model DOES NOT have a primary_key_field, then the array will
-     *                              be a two dimensional array where each element is a group of columns and values that
-     *                              get deleted. Example: array(
-     *                              0 => array(
-     *                              'Term_Relationship.object_id' => 1
-     *                              'Term_Relationship.term_taxonomy_id' => 5
-     *                              ),
-     *                              1 => array(
-     *                              'Term_Relationship.object_id' => 1
-     *                              'Term_Relationship.term_taxonomy_id' => 6
-     *                              )
-     *                              )
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_ids_for_delete(array $row_results_for_deleting, $allow_blocking = true)
-    {
-        $ids_to_delete_indexed_by_column = [];
-        if ($this->has_primary_key_field()) {
-            $primary_table                   = $this->_get_main_table();
-            $primary_table_pk_field          =
-                $this->get_field_by_column($primary_table->get_fully_qualified_pk_column());
-            $other_tables                    = $this->_get_other_tables();
-            $ids_to_delete_indexed_by_column = $query = [];
-            foreach ($row_results_for_deleting as $item_to_delete) {
-                // before we mark this item for deletion,
-                // make sure there's no related entities blocking its deletion (if we're checking)
-                if (
-                    $allow_blocking
-                    && $this->delete_is_blocked_by_related_models(
-                        $item_to_delete[ $primary_table->get_fully_qualified_pk_column() ]
-                    )
-                ) {
-                    continue;
-                }
-                // primary table deletes
-                if (isset($item_to_delete[ $primary_table->get_fully_qualified_pk_column() ])) {
-                    $ids_to_delete_indexed_by_column[ $primary_table->get_fully_qualified_pk_column() ][] =
-                        $item_to_delete[ $primary_table->get_fully_qualified_pk_column() ];
-                }
-            }
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
-            $fields = $this->get_combined_primary_key_fields();
-            foreach ($row_results_for_deleting as $item_to_delete) {
-                $ids_to_delete_indexed_by_column_for_row = [];
-                foreach ($fields as $cpk_field) {
-                    if ($cpk_field instanceof EE_Model_Field_Base) {
-                        $ids_to_delete_indexed_by_column_for_row[ $cpk_field->get_qualified_column() ] =
-                            $item_to_delete[ $cpk_field->get_qualified_column() ];
-                    }
-                }
-                $ids_to_delete_indexed_by_column[] = $ids_to_delete_indexed_by_column_for_row;
-            }
-        } else {
-            // so there's no primary key and no combined key...
-            // sorry, can't help you
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Cannot delete objects of type %s because there is no primary key NOR combined key",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $ids_to_delete_indexed_by_column;
-    }
-
-
-    /**
-     * This receives an array of columns and values set to be deleted (as prepared by _get_ids_for_delete) and prepares
-     * the corresponding query_part for the query performing the delete.
-     *
-     * @param array $ids_to_delete_indexed_by_column @see _get_ids_for_delete for how this array might be shaped.
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _build_query_part_for_deleting_from_columns_and_values(array $ids_to_delete_indexed_by_column)
-    {
-        $query_part = '';
-        if (empty($ids_to_delete_indexed_by_column)) {
-            return $query_part;
-        } elseif ($this->has_primary_key_field()) {
-            $query = [];
-            foreach ($ids_to_delete_indexed_by_column as $column => $ids) {
-                $query[] = $column . ' IN' . $this->_construct_in_value($ids, $this->_primary_key_field);
-            }
-            $query_part = ! empty($query) ? implode(' AND ', $query) : $query_part;
-        } elseif (count($this->get_combined_primary_key_fields()) > 1) {
-            $ways_to_identify_a_row = [];
-            foreach ($ids_to_delete_indexed_by_column as $ids_to_delete_indexed_by_column_for_each_row) {
-                $values_for_each_combined_primary_key_for_a_row = [];
-                foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
-                    $values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
-                }
-                $ways_to_identify_a_row[] = '('
-                                            . implode(' AND ', $values_for_each_combined_primary_key_for_a_row)
-                                            . ')';
-            }
-            $query_part = implode(' OR ', $ways_to_identify_a_row);
-        }
-        return $query_part;
-    }
-
-
-    /**
-     * Gets the model field by the fully qualified name
-     *
-     * @param string $qualified_column_name eg 'Event_CPT.post_name' or $field_obj->get_qualified_column()
-     * @return EE_Model_Field_Base
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function get_field_by_column($qualified_column_name)
-    {
-        foreach ($this->field_settings(true) as $field_name => $field_obj) {
-            if ($field_obj->get_qualified_column() === $qualified_column_name) {
-                return $field_obj;
-            }
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__('Could not find a field on the model "%1$s" for qualified column "%2$s"', 'event_espresso'),
-                $this->get_this_model_name(),
-                $qualified_column_name
-            )
-        );
-    }
-
-
-    /**
-     * Count all the rows that match criteria the model query params.
-     * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
-     * column
-     *
-     * @param array  $query_params   @see
-     *                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_count field on model to count by (not column name)
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
-     *                               that by the setting $distinct to TRUE;
-     * @return int
-     * @throws EE_Error
-     */
-    public function count($query_params = [], $field_to_count = null, $distinct = false)
-    {
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
-        if ($field_to_count) {
-            $field_obj       = $this->field_settings_for($field_to_count);
-            $column_to_count = $field_obj->get_qualified_column();
-        } elseif ($this->has_primary_key_field()) {
-            $pk_field_obj    = $this->get_primary_key_field();
-            $column_to_count = $pk_field_obj->get_qualified_column();
-        } else {
-            // there's no primary key
-            // if we're counting distinct items, and there's no primary key,
-            // we need to list out the columns for distinction;
-            // otherwise we can just use star
-            if ($distinct) {
-                $columns_to_use = [];
-                foreach ($this->get_combined_primary_key_fields() as $field_obj) {
-                    $columns_to_use[] = $field_obj->get_qualified_column();
-                }
-                $column_to_count = implode(',', $columns_to_use);
-            } else {
-                $column_to_count = '*';
-            }
-        }
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
-        $SQL             =
-            "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
-        return (int) $this->_do_wpdb_query('get_var', [$SQL]);
-    }
-
-
-    /**
-     * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
-     *
-     * @param array  $query_params @see
-     *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_sum name of field (array key in $_fields array)
-     * @return float
-     * @throws EE_Error
-     */
-    public function sum($query_params, $field_to_sum = null)
-    {
-        $model_query_info = $this->_create_model_query_info_carrier($query_params);
-        if ($field_to_sum) {
-            $field_obj = $this->field_settings_for($field_to_sum);
-        } else {
-            $field_obj = $this->get_primary_key_field();
-        }
-        $column_to_count = $field_obj->get_qualified_column();
-        $SQL             =
-            "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
-        $return_value    = $this->_do_wpdb_query('get_var', [$SQL]);
-        $data_type       = $field_obj->get_wpdb_data_type();
-        if ($data_type === '%d' || $data_type === '%s') {
-            return (float) $return_value;
-        }
-        // must be %f
-        return (float) $return_value;
-    }
-
-
-    /**
-     * Just calls the specified method on $wpdb with the given arguments
-     * Consolidates a little extra error handling code
-     *
-     * @param string $wpdb_method
-     * @param array  $arguments_to_provide
-     * @return mixed
-     * @throws EE_Error
-     * @global wpdb  $wpdb
-     */
-    protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
-    {
-        // if we're in maintenance mode level 2, DON'T run any queries
-        // because level 2 indicates the database needs updating and
-        // is probably out of sync with the code
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Event Espresso Level 2 Maintenance mode is active. That means EE can not run ANY database queries until the necessary migration scripts have run which will take EE out of maintenance mode level 2. Please inform support of this error.",
-                        "event_espresso"
-                    )
-                )
-            );
-        }
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        if (! method_exists($wpdb, $wpdb_method)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'There is no method named "%s" on Wordpress\' $wpdb object',
-                        'event_espresso'
-                    ),
-                    $wpdb_method
-                )
-            );
-        }
-        if (WP_DEBUG) {
-            $old_show_errors_value = $wpdb->show_errors;
-            $wpdb->show_errors(false);
-        }
-        $result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
-        $this->show_db_query_if_previously_requested($wpdb->last_query);
-        if (WP_DEBUG) {
-            $wpdb->show_errors($old_show_errors_value);
-            if (! empty($wpdb->last_error)) {
-                throw new EE_Error(sprintf(esc_html__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
-            }
-            if ($result === false) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'WPDB Error occurred, but no error message was logged by wpdb! The wpdb method called was "%1$s" and the arguments were "%2$s"',
-                            'event_espresso'
-                        ),
-                        $wpdb_method,
-                        var_export($arguments_to_provide, true)
-                    )
-                );
-            }
-        } elseif ($result === false) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'A database error has occurred. Turn on WP_DEBUG for more information.||A database error occurred doing wpdb method "%1$s", with arguments "%2$s". The error was "%3$s"',
-                        'event_espresso'
-                    ),
-                    $wpdb_method,
-                    var_export($arguments_to_provide, true),
-                    $wpdb->last_error
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $result;
-    }
-
-
-    /**
-     * Attempts to run the indicated WPDB method with the provided arguments,
-     * and if there's an error tries to verify the DB is correct. Uses
-     * the static property EEM_Base::$_db_verification_level to determine whether
-     * we should try to fix the EE core db, the addons, or just give up
-     *
-     * @param string $wpdb_method
-     * @param array  $arguments_to_provide
-     * @return mixed
-     */
-    private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $wpdb->last_error = null;
-        $result           = call_user_func_array([$wpdb, $wpdb_method], $arguments_to_provide);
-        // was there an error running the query? but we don't care on new activations
-        // (we're going to setup the DB anyway on new activations)
-        if (
-            ($result === false || ! empty($wpdb->last_error))
-            && EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
-        ) {
-            switch (EEM_Base::$_db_verification_level) {
-                case EEM_Base::db_verified_none:
-                    // let's double-check core's DB
-                    $error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
-                    break;
-                case EEM_Base::db_verified_core:
-                    // STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
-                    $error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
-                    break;
-                case EEM_Base::db_verified_addons:
-                    // ummmm... you in trouble
-                    return $result;
-            }
-            if (! empty($error_message)) {
-                EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
-                trigger_error($error_message);
-            }
-            return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
-        }
-        return $result;
-    }
-
-
-    /**
-     * Verifies the EE core database is up-to-date and records that we've done it on
-     * EEM_Base::$_db_verification_level
-     *
-     * @param string $wpdb_method
-     * @param array  $arguments_to_provide
-     * @return string
-     */
-    private function _verify_core_db($wpdb_method, $arguments_to_provide)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        // ok remember that we've already attempted fixing the core db, in case the problem persists
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
-        $error_message                    = sprintf(
-            esc_html__(
-                'WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
-                'event_espresso'
-            ),
-            $wpdb->last_error,
-            $wpdb_method,
-            wp_json_encode($arguments_to_provide)
-        );
-        EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
-        return $error_message;
-    }
-
-
-    /**
-     * Verifies the EE addons' database is up-to-date and records that we've done it on
-     * EEM_Base::$_db_verification_level
-     *
-     * @param $wpdb_method
-     * @param $arguments_to_provide
-     * @return string
-     */
-    private function _verify_addons_db($wpdb_method, $arguments_to_provide)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        // ok remember that we've already attempted fixing the addons dbs, in case the problem persists
-        EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
-        $error_message                    = sprintf(
-            esc_html__(
-                'WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
-                'event_espresso'
-            ),
-            $wpdb->last_error,
-            $wpdb_method,
-            wp_json_encode($arguments_to_provide)
-        );
-        EE_System::instance()->initialize_addons();
-        return $error_message;
-    }
-
-
-    /**
-     * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
-     * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
-     * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
-     * ..."
-     *
-     * @param EE_Model_Query_Info_Carrier $model_query_info
-     * @return string
-     */
-    private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
-    {
-        return " FROM " . $model_query_info->get_full_join_sql() .
-               $model_query_info->get_where_sql() .
-               $model_query_info->get_group_by_sql() .
-               $model_query_info->get_having_sql() .
-               $model_query_info->get_order_by_sql() .
-               $model_query_info->get_limit_sql();
-    }
-
-
-    /**
-     * Set to easily debug the next X queries ran from this model.
-     *
-     * @param int $count
-     */
-    public function show_next_x_db_queries($count = 1)
-    {
-        $this->_show_next_x_db_queries = $count;
-    }
-
-
-    /**
-     * @param $sql_query
-     */
-    public function show_db_query_if_previously_requested($sql_query)
-    {
-        if ($this->_show_next_x_db_queries > 0) {
-            echo esc_html($sql_query);
-            $this->_show_next_x_db_queries--;
-        }
-    }
-
-
-    /**
-     * Adds a relationship of the correct type between $modelObject and $otherModelObject.
-     * There are the 3 cases:
-     * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
-     * $otherModelObject has no ID, it is first saved.
-     * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
-     * has no ID, it is first saved.
-     * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
-     * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
-     * join table
-     *
-     * @param EE_Base_Class                     /int $thisModelObject
-     * @param EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
-     * @param string $relationName                     , key in EEM_Base::_relations
-     *                                                 an attendee to a group, you also want to specify which role they
-     *                                                 will have in that group. So you would use this parameter to
-     *                                                 specify array('role-column-name'=>'role-id')
-     * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
-     *                                                 to for relation to methods that allow you to further specify
-     *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
-     *                                                 only acceptable query_params is strict "col" => "value" pairs
-     *                                                 because these will be inserted in any new rows created as well.
-     * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
-     * @throws EE_Error
-     */
-    public function add_relationship_to(
-        $id_or_obj,
-        $other_model_id_or_obj,
-        $relationName,
-        $extra_join_model_fields_n_values = []
-    ) {
-        $relation_obj = $this->related_settings_for($relationName);
-        return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
-    }
-
-
-    /**
-     * Removes a relationship of the correct type between $modelObject and $otherModelObject.
-     * There are the 3 cases:
-     * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
-     * error
-     * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
-     * an error
-     * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
-     *
-     * @param EE_Base_Class /int $id_or_obj
-     * @param EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
-     * @param string $relationName key in EEM_Base::_relations
-     * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
-     *                             methods that allow you to further specify extra columns to join by (such as HABTM).
-     *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
-     *                             because these will be inserted in any new rows created as well.
-     * @return boolean of success
-     * @throws EE_Error
-     */
-    public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = [])
-    {
-        $relation_obj = $this->related_settings_for($relationName);
-        return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
-    }
-
-
-    /**
-     * @param mixed  $id_or_obj
-     * @param string $relationName
-     * @param array  $where_query_params
-     * @param EE_Base_Class[] objects to which relations were removed
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function remove_relations($id_or_obj, $relationName, $where_query_params = [])
-    {
-        $relation_obj = $this->related_settings_for($relationName);
-        return $relation_obj->remove_relations($id_or_obj, $where_query_params);
-    }
-
-
-    /**
-     * Gets all the related items of the specified $model_name, using $query_params.
-     * Note: by default, we remove the "default query params"
-     * because we want to get even deleted items etc.
-     *
-     * @param mixed  $id_or_obj    EE_Base_Class child or its ID
-     * @param string $model_name   like 'Event', 'Registration', etc. always singular
-     * @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[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_related($id_or_obj, $model_name, $query_params = null)
-    {
-        $model_obj         = $this->ensure_is_obj($id_or_obj);
-        $relation_settings = $this->related_settings_for($model_name);
-        return $relation_settings->get_all_related($model_obj, $query_params);
-    }
-
-
-    /**
-     * Deletes all the model objects across the relation indicated by $model_name
-     * which are related to $id_or_obj which meet the criteria set in $query_params.
-     * However, if the model objects can't be deleted because of blocking related model objects, then
-     * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
-     *
-     * @param EE_Base_Class|int|string $id_or_obj
-     * @param string                   $model_name
-     * @param array                    $query_params
-     * @return int how many deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_related($id_or_obj, $model_name, $query_params = [])
-    {
-        $model_obj         = $this->ensure_is_obj($id_or_obj);
-        $relation_settings = $this->related_settings_for($model_name);
-        return $relation_settings->delete_all_related($model_obj, $query_params);
-    }
-
-
-    /**
-     * Hard deletes all the model objects across the relation indicated by $model_name
-     * which are related to $id_or_obj which meet the criteria set in $query_params. If
-     * the model objects can't be hard deleted because of blocking related model objects,
-     * just does a soft-delete on them instead.
-     *
-     * @param EE_Base_Class|int|string $id_or_obj
-     * @param string                   $model_name
-     * @param array                    $query_params
-     * @return int how many deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_related_permanently($id_or_obj, $model_name, $query_params = [])
-    {
-        $model_obj         = $this->ensure_is_obj($id_or_obj);
-        $relation_settings = $this->related_settings_for($model_name);
-        return $relation_settings->delete_related_permanently($model_obj, $query_params);
-    }
-
-
-    /**
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
-     * unless otherwise specified in the $query_params
-     *
-     * @param int             /EE_Base_Class $id_or_obj
-     * @param string $model_name     like 'Event', or 'Registration'
-     * @param array  $query_params   @see
-     *                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_count name of field to count by. By default, uses primary key
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
-     *                               that by the setting $distinct to TRUE;
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_related(
-        $id_or_obj,
-        $model_name,
-        $query_params = [],
-        $field_to_count = null,
-        $distinct = false
-    ) {
-        $related_model = $this->get_related_model_obj($model_name);
-        // we're just going to use the query params on the related model's normal get_all query,
-        // except add a condition to say to match the current mod
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
-        }
-        $this_model_name                                                 = $this->get_this_model_name();
-        $this_pk_field_name                                              = $this->get_primary_key_field()->get_name();
-        $query_params[0][ $this_model_name . "." . $this_pk_field_name ] = $id_or_obj;
-        return $related_model->count($query_params, $field_to_count, $distinct);
-    }
-
-
-    /**
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
-     *
-     * @param int           /EE_Base_Class $id_or_obj
-     * @param string $model_name   like 'Event', or 'Registration'
-     * @param array  $query_params @see
-     *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @param string $field_to_sum name of field to count by. By default, uses primary key
-     * @return float
-     * @throws EE_Error
-     */
-    public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
-    {
-        $related_model = $this->get_related_model_obj($model_name);
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong(
-                'EEM_Base::sum_related',
-                sprintf(
-                    esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)
-                ),
-                '4.6.0'
-            );
-            $query_params = [];
-        }
-        // we're just going to use the query params on the related model's normal get_all query,
-        // except add a condition to say to match the current mod
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
-        }
-        $this_model_name                                                 = $this->get_this_model_name();
-        $this_pk_field_name                                              = $this->get_primary_key_field()->get_name();
-        $query_params[0][ $this_model_name . "." . $this_pk_field_name ] = $id_or_obj;
-        return $related_model->sum($query_params, $field_to_sum);
-    }
-
-
-    /**
-     * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
-     * $modelObject
-     *
-     * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
-     * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
-     * @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
-     * @throws EE_Error
-     */
-    public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
-    {
-        $query_params['limit'] = 1;
-        $results               = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
-        if ($results) {
-            return array_shift($results);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
-     *
-     * @return string
-     */
-    public function get_this_model_name()
-    {
-        return str_replace("EEM_", "", get_class($this));
-    }
-
-
-    /**
-     * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
-     *
-     * @return EE_Any_Foreign_Model_Name_Field
-     * @throws EE_Error
-     */
-    public function get_field_containing_related_model_name()
-    {
-        foreach ($this->field_settings(true) as $field) {
-            if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
-                $field_with_model_name = $field;
-            }
-        }
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
-                    $this->get_this_model_name()
-                )
-            );
-        }
-        return $field_with_model_name;
-    }
-
-
-    /**
-     * Inserts a new entry into the database, for each table.
-     * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
-     * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
-     * we also know there is no model object with the newly inserted item's ID at the moment (because
-     * if there were, then they would already be in the DB and this would fail); and in the future if someone
-     * creates a model object with this ID (or grabs it from the DB) then it will be added to the
-     * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
-     *
-     * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
-     *                              $values_already_prepared_by_model_object is false, in the model object's domain if
-     *                              $values_already_prepared_by_model_object is true. See comment about this at the top
-     *                              of EEM_Base)
-     * @return int|string new primary key on main table that got inserted
-     * @throws EE_Error
-     */
-    public function insert($field_n_values)
-    {
-        /**
-         * Filters the fields and their values before inserting an item using the models
-         *
-         * @param array    $fields_n_values keys are the fields and values are their new values
-         * @param EEM_Base $model           the model used
-         */
-        $field_n_values = (array) apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
-        if ($this->_satisfies_unique_indexes($field_n_values)) {
-            $main_table = $this->_get_main_table();
-            $new_id     = $this->_insert_into_specific_table($main_table, $field_n_values, false);
-            if ($new_id !== false) {
-                foreach ($this->_get_other_tables() as $other_table) {
-                    $this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
-                }
-            }
-            /**
-             * Done just after attempting to insert a new model object
-             *
-             * @param EEM_Base $model           used
-             * @param array    $fields_n_values fields and their values
-             * @param int|string the              ID of the newly-inserted model object
-             */
-            do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
-            return $new_id;
-        }
-        return false;
-    }
-
-
-    /**
-     * Checks that the result would satisfy the unique indexes on this model
-     *
-     * @param array  $field_n_values
-     * @param string $action
-     * @return boolean
-     * @throws EE_Error
-     */
-    protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
-    {
-        foreach ($this->unique_indexes() as $index_name => $index) {
-            $uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
-            if ($this->exists([$uniqueness_where_params])) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            "Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
-                            "event_espresso"
-                        ),
-                        $action,
-                        $this->_get_class_name(),
-                        $index_name,
-                        implode(",", $index->field_names()),
-                        http_build_query($uniqueness_where_params)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * Checks the database for an item that conflicts (ie, if this item were
-     * saved to the DB would break some uniqueness requirement, like a primary key
-     * or an index primary key set) with the item specified. $id_obj_or_fields_array
-     * can be either an EE_Base_Class or an array of fields n values
-     *
-     * @param EE_Base_Class|array $obj_or_fields_array
-     * @param boolean             $include_primary_key whether to use the model object's primary key
-     *                                                 when looking for conflicts
-     *                                                 (ie, if false, we ignore the model object's primary key
-     *                                                 when finding "conflicts". If true, it's also considered).
-     *                                                 Only works for INT primary key,
-     *                                                 STRING primary keys cannot be ignored
-     * @return EE_Base_Class|array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
-    {
-        if ($obj_or_fields_array instanceof EE_Base_Class) {
-            $fields_n_values = $obj_or_fields_array->model_field_array();
-        } elseif (is_array($obj_or_fields_array)) {
-            $fields_n_values = $obj_or_fields_array;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
-                        "event_espresso"
-                    ),
-                    get_class($this),
-                    $obj_or_fields_array
-                )
-            );
-        }
-        $query_params = [];
-        if (
-            $this->has_primary_key_field()
-            && ($include_primary_key
-                || $this->get_primary_key_field()
-                   instanceof
-                   EE_Primary_Key_String_Field)
-            && isset($fields_n_values[ $this->primary_key_name() ])
-        ) {
-            $query_params[0]['OR'][ $this->primary_key_name() ] = $fields_n_values[ $this->primary_key_name() ];
-        }
-        foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
-            $uniqueness_where_params                              =
-                array_intersect_key($fields_n_values, $unique_index->fields());
-            $query_params[0]['OR'][ 'AND*' . $unique_index_name ] = $uniqueness_where_params;
-        }
-        // if there is nothing to base this search on, then we shouldn't find anything
-        if (empty($query_params)) {
-            return [];
-        }
-        return $this->get_one($query_params);
-    }
-
-
-    /**
-     * Like count, but is optimized and returns a boolean instead of an int
-     *
-     * @param array $query_params
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function exists($query_params)
-    {
-        $query_params['limit'] = 1;
-        return $this->count($query_params) > 0;
-    }
-
-
-    /**
-     * Wrapper for exists, except ignores default query parameters so we're only considering ID
-     *
-     * @param int|string $id
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function exists_by_ID($id)
-    {
-        return $this->exists(
-            [
-                'default_where_conditions' => EEM_Base::default_where_conditions_none,
-                [
-                    $this->primary_key_name() => $id,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Inserts a new row in $table, using the $cols_n_values which apply to that table.
-     * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
-     * we need to add a foreign key column to point to $new_id (which should be the primary key's value
-     * on the main table)
-     * This is protected rather than private because private is not accessible to any child methods and there MAY be
-     * cases where we want to call it directly rather than via insert().
-     *
-     * @access   protected
-     * @param EE_Table_Base $table
-     * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
-     *                                       float
-     * @param int           $new_id          for now we assume only int keys
-     * @return int ID of new row inserted, or FALSE on failure
-     * @throws EE_Error
-     * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
-     */
-    protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
-    {
-        global $wpdb;
-        $insertion_col_n_values = [];
-        $format_for_insertion   = [];
-        $fields_on_table        = $this->_get_fields_for_table($table->get_table_alias());
-        foreach ($fields_on_table as $field_name => $field_obj) {
-            // check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
-            if ($field_obj->is_auto_increment()) {
-                continue;
-            }
-            $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
-            // if the value we want to assign it to is NULL, just don't mention it for the insertion
-            if ($prepared_value !== null) {
-                $insertion_col_n_values[ $field_obj->get_table_column() ] = $prepared_value;
-                $format_for_insertion[]                                   = $field_obj->get_wpdb_data_type();
-            }
-        }
-        if ($table instanceof EE_Secondary_Table && $new_id) {
-            // its not the main table, so we should have already saved the main table's PK which we just inserted
-            // so add the fk to the main table as a column
-            $insertion_col_n_values[ $table->get_fk_on_table() ] = $new_id;
-            $format_for_insertion[]                              =
-                '%d';// yes right now we're only allowing these foreign keys to be INTs
-        }
-
-        // insert the new entry
-        $result = $this->_do_wpdb_query(
-            'insert',
-            [$table->get_table_name(), $insertion_col_n_values, $format_for_insertion]
-        );
-        if ($result === false) {
-            return false;
-        }
-        // ok, now what do we return for the ID of the newly-inserted thing?
-        if ($this->has_primary_key_field()) {
-            if ($this->get_primary_key_field()->is_auto_increment()) {
-                return $wpdb->insert_id;
-            }
-            // it's not an auto-increment primary key, so
-            // it must have been supplied
-            return $fields_n_values[ $this->get_primary_key_field()->get_name() ];
-        }
-        // we can't return a  primary key because there is none. instead return
-        // a unique string indicating this model
-        return $this->get_index_primary_key_string($fields_n_values);
-    }
-
-
-    /**
-     * Prepare the $field_obj 's value in $fields_n_values for use in the database.
-     * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
-     * and there is no default, we pass it along. WPDB will take care of it)
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param array               $fields_n_values
-     * @return mixed string|int|float depending on what the table column will be expecting
-     * @throws EE_Error
-     */
-    protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
-    {
-        $field_name = $field_obj->get_name();
-        // if this field doesn't allow nullable, don't allow it
-        if (! $field_obj->is_nullable() && ! isset($fields_n_values[ $field_name ])) {
-            $fields_n_values[ $field_name ] = $field_obj->get_default_value();
-        }
-        $unprepared_value = $fields_n_values[ $field_name ] ?? null;
-        return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
-    }
-
-
-    /**
-     * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
-     * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
-     * the field's prepare_for_set() method.
-     *
-     * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
-     *                                   false, otherwise a value in the model object's domain (see lengthy comment at
-     *                                   top of file)
-     * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
-     *                                   $value is a custom selection
-     * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
-     */
-    private function _prepare_value_for_use_in_db($value, $field)
-    {
-        if ($field instanceof EE_Model_Field_Base) {
-            // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
-            switch ($this->_values_already_prepared_by_model_object) {
-                /** @noinspection PhpMissingBreakStatementInspection */
-                case self::not_prepared_by_model_object:
-                    $value = $field->prepare_for_set($value);
-                // purposefully left out "return"
-                // no break
-                case self::prepared_by_model_object:
-                    /** @noinspection SuspiciousAssignmentsInspection */
-                    $value = $field->prepare_for_use_in_db($value);
-                // no break
-                case self::prepared_for_use_in_db:
-                    // leave the value alone
-            }
-            // phpcs:enable
-        }
-        return $value;
-    }
-
-
-    /**
-     * Returns the main table on this model
-     *
-     * @return EE_Primary_Table
-     * @throws EE_Error
-     */
-    protected function _get_main_table()
-    {
-        foreach ($this->_tables as $table) {
-            if ($table instanceof EE_Primary_Table) {
-                return $table;
-            }
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'There are no main tables on %s. They should be added to _tables array in the constructor',
-                    'event_espresso'
-                ),
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * table
-     * returns EE_Primary_Table table name
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function table()
-    {
-        return $this->_get_main_table()->get_table_name();
-    }
-
-
-    /**
-     * table
-     * returns first EE_Secondary_Table table name
-     *
-     * @return string
-     */
-    public function second_table()
-    {
-        // grab second table from tables array
-        $second_table = end($this->_tables);
-        return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
-    }
-
-
-    /**
-     * get_table_obj_by_alias
-     * returns table name given it's alias
-     *
-     * @param string $table_alias
-     * @return EE_Primary_Table | EE_Secondary_Table
-     */
-    public function get_table_obj_by_alias($table_alias = '')
-    {
-        return isset($this->_tables[ $table_alias ]) ? $this->_tables[ $table_alias ] : null;
-    }
-
-
-    /**
-     * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
-     *
-     * @return EE_Secondary_Table[]
-     */
-    protected function _get_other_tables()
-    {
-        $other_tables = [];
-        foreach ($this->_tables as $table_alias => $table) {
-            if ($table instanceof EE_Secondary_Table) {
-                $other_tables[ $table_alias ] = $table;
-            }
-        }
-        return $other_tables;
-    }
-
-
-    /**
-     * Finds all the fields that correspond to the given table
-     *
-     * @param string $table_alias , array key in EEM_Base::_tables
-     * @return EE_Model_Field_Base[]
-     */
-    public function _get_fields_for_table($table_alias)
-    {
-        return $this->_fields[ $table_alias ];
-    }
-
-
-    /**
-     * Recurses through all the where parameters, and finds all the related models we'll need
-     * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
-     * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
-     * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
-     * related Registration, Transaction, and Payment models.
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Model_Query_Info_Carrier
-     * @throws EE_Error
-     */
-    public function _extract_related_models_from_query($query_params)
-    {
-        $query_info_carrier = new EE_Model_Query_Info_Carrier();
-        if (array_key_exists(0, $query_params)) {
-            $this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
-        }
-        if (array_key_exists('group_by', $query_params)) {
-            if (is_array($query_params['group_by'])) {
-                $this->_extract_related_models_from_sub_params_array_values(
-                    $query_params['group_by'],
-                    $query_info_carrier,
-                    'group_by'
-                );
-            } elseif (! empty($query_params['group_by'])) {
-                $this->_extract_related_model_info_from_query_param(
-                    $query_params['group_by'],
-                    $query_info_carrier,
-                    'group_by'
-                );
-            }
-        }
-        if (array_key_exists('having', $query_params)) {
-            $this->_extract_related_models_from_sub_params_array_keys(
-                $query_params[0],
-                $query_info_carrier,
-                'having'
-            );
-        }
-        if (array_key_exists('order_by', $query_params)) {
-            if (is_array($query_params['order_by'])) {
-                $this->_extract_related_models_from_sub_params_array_keys(
-                    $query_params['order_by'],
-                    $query_info_carrier,
-                    'order_by'
-                );
-            } elseif (! empty($query_params['order_by'])) {
-                $this->_extract_related_model_info_from_query_param(
-                    $query_params['order_by'],
-                    $query_info_carrier,
-                    'order_by'
-                );
-            }
-        }
-        if (array_key_exists('force_join', $query_params)) {
-            $this->_extract_related_models_from_sub_params_array_values(
-                $query_params['force_join'],
-                $query_info_carrier,
-                'force_join'
-            );
-        }
-        $this->extractRelatedModelsFromCustomSelects($query_info_carrier);
-        return $query_info_carrier;
-    }
-
-
-    /**
-     * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
-     *
-     * @param array                       $sub_query_params @see
-     *                                                      https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#-0-where-conditions
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
-     * @param string                      $query_param_type one of $this->_allowed_query_params
-     * @return EE_Model_Query_Info_Carrier
-     * @throws EE_Error
-     */
-    private function _extract_related_models_from_sub_params_array_keys(
-        $sub_query_params,
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
-        $query_param_type
-    ) {
-        if (! empty($sub_query_params)) {
-            $sub_query_params = (array) $sub_query_params;
-            foreach ($sub_query_params as $param => $possibly_array_of_params) {
-                // $param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
-                $this->_extract_related_model_info_from_query_param(
-                    $param,
-                    $model_query_info_carrier,
-                    $query_param_type
-                );
-                // if $possibly_array_of_params is an array, try recursing into it, searching for keys which
-                // indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
-                // extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
-                // of array('Registration.TXN_ID'=>23)
-                $query_param_sans_stars =
-                    $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
-                if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
-                    if (! is_array($possibly_array_of_params)) {
-                        throw new EE_Error(
-                            sprintf(
-                                esc_html__(
-                                    "You used a special where query param %s, but the value isn't an array of where query params, it's just %s'. It should be an array, eg array('EVT_ID'=>23,'OR'=>array('Venue.VNU_ID'=>32,'Venue.VNU_name'=>'monkey_land'))",
-                                    "event_espresso"
-                                ),
-                                $param,
-                                $possibly_array_of_params
-                            )
-                        );
-                    }
-                    $this->_extract_related_models_from_sub_params_array_keys(
-                        $possibly_array_of_params,
-                        $model_query_info_carrier,
-                        $query_param_type
-                    );
-                } elseif (
-                    $query_param_type === 0 // ie WHERE
-                    && is_array($possibly_array_of_params)
-                    && isset($possibly_array_of_params[2])
-                    && $possibly_array_of_params[2] == true
-                ) {
-                    // then $possible_array_of_params looks something like array('<','DTT_sold',true)
-                    // indicating that $possible_array_of_params[1] is actually a field name,
-                    // from which we should extract query parameters!
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
-                        throw new EE_Error(
-                            sprintf(
-                                esc_html__(
-                                    "Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
-                                    "event_espresso"
-                                ),
-                                $query_param_type,
-                                implode(",", $possibly_array_of_params)
-                            )
-                        );
-                    }
-                    $this->_extract_related_model_info_from_query_param(
-                        $possibly_array_of_params[1],
-                        $model_query_info_carrier,
-                        $query_param_type
-                    );
-                }
-            }
-        }
-        return $model_query_info_carrier;
-    }
-
-
-    /**
-     * For extracting related models from forced_joins, where the array values contain the info about what
-     * models to join with. Eg an array like array('Attendee','Price.Price_Type');
-     *
-     * @param array                       $sub_query_params @see
-     *                                                      https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
-     * @param string                      $query_param_type one of $this->_allowed_query_params
-     * @return EE_Model_Query_Info_Carrier
-     * @throws EE_Error
-     */
-    private function _extract_related_models_from_sub_params_array_values(
-        $sub_query_params,
-        EE_Model_Query_Info_Carrier $model_query_info_carrier,
-        $query_param_type
-    ) {
-        if (! empty($sub_query_params)) {
-            if (! is_array($sub_query_params)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
-                        $sub_query_params
-                    )
-                );
-            }
-            foreach ($sub_query_params as $param) {
-                // $param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
-                $this->_extract_related_model_info_from_query_param(
-                    $param,
-                    $model_query_info_carrier,
-                    $query_param_type
-                );
-            }
-        }
-        return $model_query_info_carrier;
-    }
-
-
-    /**
-     * Extract all the query parts from  model query params
-     * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
-     * instead of directly constructing the SQL because often we need to extract info from the $query_params
-     * but use them in a different order. Eg, we need to know what models we are querying
-     * before we know what joins to perform. However, we need to know what data types correspond to which fields on
-     * other models before we can finalize the where clause SQL.
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Model_Query_Info_Carrier
-     * @throws EE_Error
-     * @throws ModelConfigurationException*@throws ReflectionException
-     * @throws ReflectionException
-     */
-    public function _create_model_query_info_carrier($query_params)
-    {
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong(
-                'EEM_Base::_create_model_query_info_carrier',
-                sprintf(
-                    esc_html__(
-                        '$query_params should be an array, you passed a variable of type %s',
-                        'event_espresso'
-                    ),
-                    gettype($query_params)
-                ),
-                '4.6.0'
-            );
-            $query_params = [];
-        }
-        $query_params[0] = isset($query_params[0]) ? $query_params[0] : [];
-        // first check if we should alter the query to account for caps or not
-        // because the caps might require us to do extra joins
-        if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
-            $query_params[0] = array_replace_recursive(
-                $query_params[0],
-                $this->caps_where_conditions($query_params['caps'])
-            );
-        }
-
-        // check if we should alter the query to remove data related to protected
-        // custom post types
-        if (isset($query_params['exclude_protected']) && $query_params['exclude_protected'] === true) {
-            $where_param_key_for_password = $this->modelChainAndPassword();
-            // only include if related to a cpt where no password has been set
-            $query_params[0]['OR*nopassword'] = [
-                $where_param_key_for_password       => '',
-                $where_param_key_for_password . '*' => ['IS_NULL'],
-            ];
-        }
-        $query_object = $this->_extract_related_models_from_query($query_params);
-        // verify where_query_params has NO numeric indexes.... that's simply not how you use it!
-        foreach ($query_params[0] as $key => $value) {
-            if (is_int($key)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "WHERE query params must NOT be numerically-indexed. You provided the array key '%s' for value '%s' while querying model %s. All the query params provided were '%s' Please read documentation on EEM_Base::get_all.",
-                            "event_espresso"
-                        ),
-                        $key,
-                        var_export($value, true),
-                        var_export($query_params, true),
-                        get_class($this)
-                    )
-                );
-            }
-        }
-        if (
-            array_key_exists('default_where_conditions', $query_params)
-            && ! empty($query_params['default_where_conditions'])
-        ) {
-            $use_default_where_conditions = $query_params['default_where_conditions'];
-        } else {
-            $use_default_where_conditions = EEM_Base::default_where_conditions_all;
-        }
-        $query_params[0] = array_merge(
-            $this->_get_default_where_conditions_for_models_in_query(
-                $query_object,
-                $use_default_where_conditions,
-                $query_params[0]
-            ),
-            $query_params[0]
-        );
-        $query_object->set_where_sql($this->_construct_where_clause($query_params[0]));
-        // if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
-        // So we need to setup a subquery and use that for the main join.
-        // Note for now this only works on the primary table for the model.
-        // So for instance, you could set the limit array like this:
-        // array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
-        if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
-            $query_object->set_main_model_join_sql(
-                $this->_construct_limit_join_select(
-                    $query_params['on_join_limit'][0],
-                    $query_params['on_join_limit'][1]
-                )
-            );
-        }
-        // set limit
-        if (array_key_exists('limit', $query_params)) {
-            if (is_array($query_params['limit'])) {
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
-                    $e = sprintf(
-                        esc_html__(
-                            "Invalid DB query. You passed '%s' for the LIMIT, but only the following are valid: an integer, string representing an integer, a string like 'int,int', or an array like array(int,int)",
-                            "event_espresso"
-                        ),
-                        http_build_query($query_params['limit'])
-                    );
-                    throw new EE_Error($e . "|" . $e);
-                }
-                // they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
-            } elseif (! empty($query_params['limit'])) {
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
-            }
-        }
-        // set order by
-        if (array_key_exists('order_by', $query_params)) {
-            if (is_array($query_params['order_by'])) {
-                // if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
-                // specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
-                // including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
-                if (array_key_exists('order', $query_params)) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                "In querying %s, we are using query parameter 'order_by' as an array (keys:%s,values:%s), and so we can't use query parameter 'order' (value %s). You should just use the 'order_by' parameter ",
-                                "event_espresso"
-                            ),
-                            get_class($this),
-                            implode(", ", array_keys($query_params['order_by'])),
-                            implode(", ", $query_params['order_by']),
-                            $query_params['order']
-                        )
-                    );
-                }
-                $this->_extract_related_models_from_sub_params_array_keys(
-                    $query_params['order_by'],
-                    $query_object,
-                    'order_by'
-                );
-                // assume it's an array of fields to order by
-                $order_array = [];
-                foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
-                    $order         = $this->_extract_order($order);
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
-                }
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
-            } elseif (! empty($query_params['order_by'])) {
-                $this->_extract_related_model_info_from_query_param(
-                    $query_params['order_by'],
-                    $query_object,
-                    'order',
-                    $query_params['order_by']
-                );
-                $order = isset($query_params['order'])
-                    ? $this->_extract_order($query_params['order'])
-                    : 'DESC';
-                $query_object->set_order_by_sql(
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
-                );
-            }
-        }
-        // if 'order_by' wasn't set, maybe they are just using 'order' on its own?
-        if (
-            ! array_key_exists('order_by', $query_params)
-            && array_key_exists('order', $query_params)
-            && ! empty($query_params['order'])
-        ) {
-            $pk_field = $this->get_primary_key_field();
-            $order    = $this->_extract_order($query_params['order']);
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
-        }
-        // set group by
-        if (array_key_exists('group_by', $query_params)) {
-            if (is_array($query_params['group_by'])) {
-                // it's an array, so assume we'll be grouping by a bunch of stuff
-                $group_by_array = [];
-                foreach ($query_params['group_by'] as $field_name_to_group_by) {
-                    $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
-                }
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
-            } elseif (! empty($query_params['group_by'])) {
-                $query_object->set_group_by_sql(
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
-                );
-            }
-        }
-        // set having
-        if (array_key_exists('having', $query_params) && $query_params['having']) {
-            $query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
-        }
-        // now, just verify they didn't pass anything wack
-        foreach ($query_params as $query_key => $query_value) {
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
-                            'event_espresso'
-                        ),
-                        $query_key,
-                        get_class($this),
-                        //                      print_r( $this->_allowed_query_params, TRUE )
-                        implode(',', $this->_allowed_query_params)
-                    )
-                );
-            }
-        }
-        $main_model_join_sql = $query_object->get_main_model_join_sql();
-        if (empty($main_model_join_sql)) {
-            $query_object->set_main_model_join_sql($this->_construct_internal_join());
-        }
-        return $query_object;
-    }
-
-
-    /**
-     * Gets the where conditions that should be imposed on the query based on the
-     * context (eg reading frontend, backend, edit or delete).
-     *
-     * @param string $context one of EEM_Base::valid_cap_contexts()
-     * @return array @see
-     *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @throws EE_Error
-     */
-    public function caps_where_conditions($context = self::caps_read)
-    {
-        EEM_Base::verify_is_valid_cap_context($context);
-        $cap_where_conditions = [];
-        $cap_restrictions     = $this->caps_missing($context);
-        /**
-         * @var $cap_restrictions EE_Default_Where_Conditions[]
-         */
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
-            $cap_where_conditions = array_replace_recursive(
-                $cap_where_conditions,
-                $restriction_if_no_cap->get_default_where_conditions()
-            );
-        }
-        return apply_filters(
-            'FHEE__EEM_Base__caps_where_conditions__return',
-            $cap_where_conditions,
-            $this,
-            $context,
-            $cap_restrictions
-        );
-    }
-
-
-    /**
-     * Verifies that $should_be_order_string is in $this->_allowed_order_values,
-     * otherwise throws an exception
-     *
-     * @param string $should_be_order_string
-     * @return string either ASC, asc, DESC or desc
-     * @throws EE_Error
-     */
-    private function _extract_order($should_be_order_string)
-    {
-        if (in_array($should_be_order_string, $this->_allowed_order_values)) {
-            return $should_be_order_string;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "While performing a query on '%s', tried to use '%s' as an order parameter. ",
-                    "event_espresso"
-                ),
-                get_class($this),
-                $should_be_order_string
-            )
-        );
-    }
-
-
-    /**
-     * Looks at all the models which are included in this query, and asks each
-     * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
-     * so they can be merged
-     *
-     * @param EE_Model_Query_Info_Carrier $query_info_carrier
-     * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
-     *                                                                  'none' means NO default where conditions will
-     *                                                                  be used AT ALL during this query.
-     *                                                                  'other_models_only' means default where
-     *                                                                  conditions from other models will be used, but
-     *                                                                  not for this primary model. 'all', the default,
-     *                                                                  means default where conditions will apply as
-     *                                                                  normal
-     * @param array                       $where_query_params           @see
-     *                                                                  https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @throws EE_Error
-     */
-    private function _get_default_where_conditions_for_models_in_query(
-        EE_Model_Query_Info_Carrier $query_info_carrier,
-        $use_default_where_conditions = EEM_Base::default_where_conditions_all,
-        $where_query_params = []
-    ) {
-        $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
-                        "event_espresso"
-                    ),
-                    $use_default_where_conditions,
-                    implode(", ", $allowed_used_default_where_conditions_values)
-                )
-            );
-        }
-        $universal_query_params = [];
-        if ($this->_should_use_default_where_conditions($use_default_where_conditions, true)) {
-            $universal_query_params = $this->_get_default_where_conditions();
-        } elseif ($this->_should_use_minimum_where_conditions($use_default_where_conditions, true)) {
-            $universal_query_params = $this->_get_minimum_where_conditions();
-        }
-        foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
-            $related_model = $this->get_related_model_obj($model_name);
-            if ($this->_should_use_default_where_conditions($use_default_where_conditions, false)) {
-                $related_model_universal_where_params =
-                    $related_model->_get_default_where_conditions($model_relation_path);
-            } elseif ($this->_should_use_minimum_where_conditions($use_default_where_conditions, false)) {
-                $related_model_universal_where_params =
-                    $related_model->_get_minimum_where_conditions($model_relation_path);
-            } else {
-                // we don't want to add full or even minimum default where conditions from this model, so just continue
-                continue;
-            }
-            $overrides              = $this->_override_defaults_or_make_null_friendly(
-                $related_model_universal_where_params,
-                $where_query_params,
-                $related_model,
-                $model_relation_path
-            );
-            $universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
-                $universal_query_params,
-                $overrides
-            );
-        }
-        return $universal_query_params;
-    }
-
-
-    /**
-     * Determines whether or not we should use default where conditions for the model in question
-     * (this model, or other related models).
-     * Basically, we should use default where conditions on this model if they have requested to use them on all models,
-     * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
-     * We should use default where conditions on related models when they requested to use default where conditions
-     * on all models, or specifically just on other related models
-     *
-     * @param      $default_where_conditions_value
-     * @param bool $for_this_model false means this is for OTHER related models
-     * @return bool
-     */
-    private function _should_use_default_where_conditions($default_where_conditions_value, $for_this_model = true)
-    {
-        return (
-                   $for_this_model
-                   && in_array(
-                       $default_where_conditions_value,
-                       [
-                           EEM_Base::default_where_conditions_all,
-                           EEM_Base::default_where_conditions_this_only,
-                           EEM_Base::default_where_conditions_minimum_others,
-                       ],
-                       true
-                   )
-               )
-               || (
-                   ! $for_this_model
-                   && in_array(
-                       $default_where_conditions_value,
-                       [
-                           EEM_Base::default_where_conditions_all,
-                           EEM_Base::default_where_conditions_others_only,
-                       ],
-                       true
-                   )
-               );
-    }
-
-
-    /**
-     * Determines whether or not we should use default minimum conditions for the model in question
-     * (this model, or other related models).
-     * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
-     * where conditions.
-     * We should use minimum where conditions on related models if they requested to use minimum where conditions
-     * on this model or others
-     *
-     * @param      $default_where_conditions_value
-     * @param bool $for_this_model false means this is for OTHER related models
-     * @return bool
-     */
-    private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
-    {
-        return (
-                   $for_this_model
-                   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
-               )
-               || (
-                   ! $for_this_model
-                   && in_array(
-                       $default_where_conditions_value,
-                       [
-                           EEM_Base::default_where_conditions_minimum_others,
-                           EEM_Base::default_where_conditions_minimum_all,
-                       ],
-                       true
-                   )
-               );
-    }
-
-
-    /**
-     * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
-     * then we also add a special where condition which allows for that model's primary key
-     * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
-     * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
-     *
-     * @param array    $default_where_conditions
-     * @param array    $provided_where_conditions
-     * @param EEM_Base $model
-     * @param string   $model_relation_path like 'Transaction.Payment.'
-     * @return array @see
-     *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @throws EE_Error
-     */
-    private function _override_defaults_or_make_null_friendly(
-        $default_where_conditions,
-        $provided_where_conditions,
-        $model,
-        $model_relation_path
-    ) {
-        $null_friendly_where_conditions = [];
-        $none_overridden                = true;
-        $or_condition_key_for_defaults  = 'OR*' . get_class($model);
-        foreach ($default_where_conditions as $key => $val) {
-            if (isset($provided_where_conditions[ $key ])) {
-                $none_overridden = false;
-            } else {
-                $null_friendly_where_conditions[ $or_condition_key_for_defaults ]['AND'][ $key ] = $val;
-            }
-        }
-        if ($none_overridden && $default_where_conditions) {
-            if ($model->has_primary_key_field()) {
-                $null_friendly_where_conditions[ $or_condition_key_for_defaults ][ $model_relation_path
-                                                                                   . "."
-                                                                                   . $model->primary_key_name() ] =
-                    ['IS NULL'];
-            }/*else{
+	/**
+	 * Flag to indicate whether the values provided to EEM_Base have already been prepared
+	 * by the model object or not (ie, the model object has used the field's _prepare_for_set function on the values).
+	 * They almost always WILL NOT, but it's not necessarily a requirement.
+	 * For example, if you want to run EEM_Event::instance()->get_all(array(array('EVT_ID'=>$_GET['event_id'])));
+	 *
+	 * @var boolean
+	 */
+	private $_values_already_prepared_by_model_object = 0;
+
+	/**
+	 * when $_values_already_prepared_by_model_object equals this, we assume
+	 * the data is just like form input that needs to have the model fields'
+	 * prepare_for_set and prepare_for_use_in_db called on it
+	 */
+	const not_prepared_by_model_object = 0;
+
+	/**
+	 * when $_values_already_prepared_by_model_object equals this, we
+	 * assume this value is coming from a model object and doesn't need to have
+	 * prepare_for_set called on it, just prepare_for_use_in_db is used
+	 */
+	const prepared_by_model_object = 1;
+
+	/**
+	 * when $_values_already_prepared_by_model_object equals this, we assume
+	 * the values are already to be used in the database (ie no processing is done
+	 * on them by the model's fields)
+	 */
+	const prepared_for_use_in_db = 2;
+
+
+	protected $singular_item = 'Item';
+
+	protected $plural_item   = 'Items';
+
+	/**
+	 * @type EE_Table_Base[] $_tables array of EE_Table objects for defining which tables comprise this model.
+	 */
+	protected $_tables;
+
+	/**
+	 * with two levels: top-level has array keys which are database table aliases (ie, keys in _tables)
+	 * and the value is an array. Each of those sub-arrays have keys of field names (eg 'ATT_ID', which should also be
+	 * variable names on the model objects (eg, EE_Attendee), and the keys should be children of EE_Model_Field
+	 *
+	 * @var EE_Model_Field_Base[][] $_fields
+	 */
+	protected $_fields;
+
+	/**
+	 * array of different kinds of relations
+	 *
+	 * @var EE_Model_Relation_Base[] $_model_relations
+	 */
+	protected $_model_relations = [];
+
+	/**
+	 * @var EE_Index[] $_indexes
+	 */
+	protected $_indexes = [];
+
+	/**
+	 * Default strategy for getting where conditions on this model. This strategy is used to get default
+	 * where conditions which are added to get_all, update, and delete queries. They can be overridden
+	 * by setting the same columns as used in these queries in the query yourself.
+	 *
+	 * @var EE_Default_Where_Conditions
+	 */
+	protected $_default_where_conditions_strategy;
+
+	/**
+	 * Strategy for getting conditions on this model when 'default_where_conditions' equals 'minimum'.
+	 * This is particularly useful when you want something between 'none' and 'default'
+	 *
+	 * @var EE_Default_Where_Conditions
+	 */
+	protected $_minimum_where_conditions_strategy;
+
+	/**
+	 * String describing how to find the "owner" of this model's objects.
+	 * When there is a foreign key on this model to the wp_users table, this isn't needed.
+	 * But when there isn't, this indicates which related model, or transiently-related model,
+	 * has the foreign key to the wp_users table.
+	 * Eg, for EEM_Registration this would be 'Event' because registrations are directly
+	 * related to events, and events have a foreign key to wp_users.
+	 * On EEM_Transaction, this would be 'Transaction.Event'
+	 *
+	 * @var string
+	 */
+	protected $_model_chain_to_wp_user = '';
+
+	/**
+	 * String describing how to find the model with a password controlling access to this model. This property has the
+	 * same format as $_model_chain_to_wp_user. This is primarily used by the query param "exclude_protected".
+	 * This value is the path of models to follow to arrive at the model with the password field.
+	 * If it is an empty string, it means this model has the password field. If it is null, it means there is no
+	 * model with a password that should affect reading this on the front-end.
+	 * Eg this is an empty string for the Event model because it has a password.
+	 * This is null for the Registration model, because its event's password has no bearing on whether
+	 * you can read the registration or not on the front-end (it just depends on your capabilities.)
+	 * This is 'Datetime.Event' on the Ticket model, because model queries for tickets that set "exclude_protected"
+	 * should hide tickets for datetimes for events that have a password set.
+	 *
+	 * @var string |null
+	 */
+	protected $model_chain_to_password = null;
+
+	/**
+	 * This is a flag typically set by updates so that we don't load the where strategy on updates because updates
+	 * don't need it (particularly CPT models)
+	 *
+	 * @var bool
+	 */
+	protected $_ignore_where_strategy = false;
+
+	/**
+	 * String used in caps relating to this model. Eg, if the caps relating to this
+	 * model are 'ee_edit_events', 'ee_read_events', etc, it would be 'events'.
+	 *
+	 * @var string. If null it hasn't been initialized yet. If false then we
+	 * have indicated capabilities don't apply to this
+	 */
+	protected $_caps_slug = null;
+
+	/**
+	 * 2d array where top-level keys are one of EEM_Base::valid_cap_contexts(),
+	 * and next-level keys are capability names, and each's value is a
+	 * EE_Default_Where_Condition. If the requester requests to apply caps to the query,
+	 * they specify which context to use (ie, frontend, backend, edit or delete)
+	 * and then each capability in the corresponding sub-array that they're missing
+	 * adds the where conditions onto the query.
+	 *
+	 * @var array
+	 */
+	protected $_cap_restrictions = [
+		self::caps_read       => [],
+		self::caps_read_admin => [],
+		self::caps_edit       => [],
+		self::caps_delete     => [],
+	];
+
+	/**
+	 * Array defining which cap restriction generators to use to create default
+	 * cap restrictions to put in EEM_Base::_cap_restrictions.
+	 * Array-keys are one of EEM_Base::valid_cap_contexts(), and values are a child of
+	 * EE_Restriction_Generator_Base. If you don't want any cap restrictions generated
+	 * automatically set this to false (not just null).
+	 *
+	 * @var EE_Restriction_Generator_Base[]
+	 */
+	protected $_cap_restriction_generators = [];
+
+	/**
+	 * constants used to categorize capability restrictions on EEM_Base::_caps_restrictions
+	 */
+	const caps_read       = 'read';
+
+	const caps_read_admin = 'read_admin';
+
+	const caps_edit       = 'edit';
+
+	const caps_delete     = 'delete';
+
+	/**
+	 * Keys are all the cap contexts (ie constants EEM_Base::_caps_*) and values are their 'action'
+	 * as how they'd be used in capability names. Eg EEM_Base::caps_read ('read_frontend')
+	 * maps to 'read' because when looking for relevant permissions we're going to use
+	 * 'read' in teh capabilities names like 'ee_read_events' etc.
+	 *
+	 * @var array
+	 */
+	protected $_cap_contexts_to_cap_action_map = [
+		self::caps_read       => 'read',
+		self::caps_read_admin => 'read',
+		self::caps_edit       => 'edit',
+		self::caps_delete     => 'delete',
+	];
+
+	/**
+	 * Timezone
+	 * This gets set via the constructor so that we know what timezone incoming strings|timestamps are in when there
+	 * are EE_Datetime_Fields in use.  This can also be used before a get to set what timezone you want strings coming
+	 * out of the created objects.  NOT all EEM_Base child classes use this property but any that use a
+	 * EE_Datetime_Field data type will have access to it.
+	 *
+	 * @var string
+	 */
+	protected $_timezone;
+
+
+	/**
+	 * This holds the id of the blog currently making the query.  Has no bearing on single site but is used for
+	 * multisite.
+	 *
+	 * @var int
+	 */
+	protected static $_model_query_blog_id;
+
+	/**
+	 * A copy of _fields, except the array keys are the model names pointed to by
+	 * the field
+	 *
+	 * @var EE_Model_Field_Base[]
+	 */
+	private $_cache_foreign_key_to_fields = [];
+
+	/**
+	 * Cached list of all the fields on the model, indexed by their name
+	 *
+	 * @var EE_Model_Field_Base[]
+	 */
+	private $_cached_fields = null;
+
+	/**
+	 * Cached list of all the fields on the model, except those that are
+	 * marked as only pertinent to the database
+	 *
+	 * @var EE_Model_Field_Base[]
+	 */
+	private $_cached_fields_non_db_only = null;
+
+	/**
+	 * A cached reference to the primary key for quick lookup
+	 *
+	 * @var EE_Model_Field_Base
+	 */
+	private $_primary_key_field = null;
+
+	/**
+	 * Flag indicating whether this model has a primary key or not
+	 *
+	 * @var boolean
+	 */
+	protected $_has_primary_key_field = null;
+
+	/**
+	 * array in the format:  [ FK alias => full PK ]
+	 * where keys are local column name aliases for foreign keys
+	 * and values are the fully qualified column name for the primary key they represent
+	 *  ex:
+	 *      [ 'Event.EVT_wp_user' => 'WP_User.ID' ]
+	 *
+	 * @var array $foreign_key_aliases
+	 */
+	protected $foreign_key_aliases = [];
+
+	/**
+	 * Whether or not this model is based off a table in WP core only (CPTs should set
+	 * this to FALSE, but if we were to make an EE_WP_Post model, it should set this to true).
+	 * This should be true for models that deal with data that should exist independent of EE.
+	 * For example, if the model can read and insert data that isn't used by EE, this should be true.
+	 * It would be false, however, if you could guarantee the model would only interact with EE data,
+	 * even if it uses a WP core table (eg event and venue models set this to false for that reason:
+	 * they can only read and insert events and venues custom post types, not arbitrary post types)
+	 *
+	 * @var boolean
+	 */
+	protected $_wp_core_model = false;
+
+	/**
+	 * @var bool stores whether this model has a password field or not.
+	 * null until initialized by hasPasswordField()
+	 */
+	protected $has_password_field;
+
+	/**
+	 * @var EE_Password_Field|null Automatically set when calling getPasswordField()
+	 */
+	protected $password_field;
+
+	/**
+	 *    List of valid operators that can be used for querying.
+	 * The keys are all operators we'll accept, the values are the real SQL
+	 * operators used
+	 *
+	 * @var array
+	 */
+	protected $_valid_operators = [
+		'='           => '=',
+		'<='          => '<=',
+		'<'           => '<',
+		'>='          => '>=',
+		'>'           => '>',
+		'!='          => '!=',
+		'LIKE'        => 'LIKE',
+		'like'        => 'LIKE',
+		'NOT_LIKE'    => 'NOT LIKE',
+		'not_like'    => 'NOT LIKE',
+		'NOT LIKE'    => 'NOT LIKE',
+		'not like'    => 'NOT LIKE',
+		'IN'          => 'IN',
+		'in'          => 'IN',
+		'NOT_IN'      => 'NOT IN',
+		'not_in'      => 'NOT IN',
+		'NOT IN'      => 'NOT IN',
+		'not in'      => 'NOT IN',
+		'between'     => 'BETWEEN',
+		'BETWEEN'     => 'BETWEEN',
+		'IS_NOT_NULL' => 'IS NOT NULL',
+		'is_not_null' => 'IS NOT NULL',
+		'IS NOT NULL' => 'IS NOT NULL',
+		'is not null' => 'IS NOT NULL',
+		'IS_NULL'     => 'IS NULL',
+		'is_null'     => 'IS NULL',
+		'IS NULL'     => 'IS NULL',
+		'is null'     => 'IS NULL',
+		'REGEXP'      => 'REGEXP',
+		'regexp'      => 'REGEXP',
+		'NOT_REGEXP'  => 'NOT REGEXP',
+		'not_regexp'  => 'NOT REGEXP',
+		'NOT REGEXP'  => 'NOT REGEXP',
+		'not regexp'  => 'NOT REGEXP',
+	];
+
+	/**
+	 * operators that work like 'IN', accepting a comma-separated list of values inside brackets. Eg '(1,2,3)'
+	 *
+	 * @var array
+	 */
+	protected $_in_style_operators = ['IN', 'NOT IN'];
+
+	/**
+	 * operators that work like 'BETWEEN'.  Typically used for datetime calculations, i.e. "BETWEEN '12-1-2011' AND
+	 * '12-31-2012'"
+	 *
+	 * @var array
+	 */
+	protected $_between_style_operators = ['BETWEEN'];
+
+	/**
+	 * Operators that work like SQL's like: input should be assumed to be a string, already prepared for a LIKE query.
+	 *
+	 * @var array
+	 */
+	protected $_like_style_operators = ['LIKE', 'NOT LIKE'];
+
+	/**
+	 * operators that are used for handling NUll and !NULL queries.  Typically used for when checking if a row exists
+	 * on a join table.
+	 *
+	 * @var array
+	 */
+	protected $_null_style_operators = ['IS NOT NULL', 'IS NULL'];
+
+	/**
+	 * Allowed values for $query_params['order'] for ordering in queries
+	 *
+	 * @var array
+	 */
+	protected $_allowed_order_values = ['asc', 'desc', 'ASC', 'DESC'];
+
+	/**
+	 * When these are keys in a WHERE or HAVING clause, they are handled much differently
+	 * than regular field names. It is assumed that their values are an array of WHERE conditions
+	 *
+	 * @var array
+	 */
+	private $_logic_query_param_keys = ['not', 'and', 'or', 'NOT', 'AND', 'OR'];
+
+	/**
+	 * Allowed keys in $query_params arrays passed into queries. Note that 0 is meant to always be a
+	 * 'where', but 'where' clauses are so common that we thought we'd omit it
+	 *
+	 * @var array
+	 */
+	private $_allowed_query_params = [
+		0,
+		'limit',
+		'order_by',
+		'group_by',
+		'having',
+		'force_join',
+		'order',
+		'on_join_limit',
+		'default_where_conditions',
+		'caps',
+		'extra_selects',
+		'exclude_protected',
+	];
+
+	/**
+	 * All the data types that can be used in $wpdb->prepare statements.
+	 *
+	 * @var array
+	 */
+	private $_valid_wpdb_data_types = ['%d', '%s', '%f'];
+
+	/**
+	 * @var EE_Registry $EE
+	 */
+	protected $EE = null;
+
+
+	/**
+	 * Property which, when set, will have this model echo out the next X queries to the page for debugging.
+	 *
+	 * @var int
+	 */
+	protected $_show_next_x_db_queries = 0;
+
+	/**
+	 * When using _get_all_wpdb_results, you can specify a custom selection. If you do so,
+	 * it gets saved on this property as an instance of CustomSelects so those selections can be used in
+	 * WHERE, GROUP_BY, etc.
+	 *
+	 * @var CustomSelects
+	 */
+	protected $_custom_selections = [];
+
+	/**
+	 * key => value Entity Map using  array( EEM_Base::$_model_query_blog_id => array( ID => model object ) )
+	 * caches every model object we've fetched from the DB on this request
+	 *
+	 * @var array
+	 */
+	protected $_entity_map;
+
+	/**
+	 * @var LoaderInterface
+	 */
+	protected static $loader;
+
+	/**
+	 * @var Mirror
+	 */
+	private static $mirror;
+
+
+	/**
+	 * constant used to show EEM_Base has not yet verified the db on this http request
+	 */
+	const db_verified_none = 0;
+
+	/**
+	 * constant used to show EEM_Base has verified the EE core db on this http request,
+	 * but not the addons' dbs
+	 */
+	const db_verified_core = 1;
+
+	/**
+	 * constant used to show EEM_Base has verified the addons' dbs (and implicitly
+	 * the EE core db too)
+	 */
+	const db_verified_addons = 2;
+
+	/**
+	 * indicates whether an EEM_Base child has already re-verified the DB
+	 * is ok (we don't want to do it repetitively). Should be set to one the constants
+	 * looking like EEM_Base::db_verified_*
+	 *
+	 * @var int - 0 = none, 1 = core, 2 = addons
+	 */
+	protected static $_db_verification_level = EEM_Base::db_verified_none;
+
+	/**
+	 * @const constant for 'default_where_conditions' to apply default where conditions to ALL queried models
+	 *        (eg, if retrieving registrations ordered by their datetimes, this will only return non-trashed
+	 *        registrations for non-trashed tickets for non-trashed datetimes)
+	 */
+	const default_where_conditions_all = 'all';
+
+	/**
+	 * @const constant for 'default_where_conditions' to apply default where conditions to THIS model only, but
+	 *        no other models which are joined to (eg, if retrieving registrations ordered by their datetimes, this will
+	 *        return non-trashed registrations, regardless of the related datetimes and tickets' statuses).
+	 *        It is preferred to use EEM_Base::default_where_conditions_minimum_others because, when joining to
+	 *        models which share tables with other models, this can return data for the wrong model.
+	 */
+	const default_where_conditions_this_only = 'this_model_only';
+
+	/**
+	 * @const constant for 'default_where_conditions' to apply default where conditions to other models queried,
+	 *        but not the current model (eg, if retrieving registrations ordered by their datetimes, this will
+	 *        return all registrations related to non-trashed tickets and non-trashed datetimes)
+	 */
+	const default_where_conditions_others_only = 'other_models_only';
+
+	/**
+	 * @const constant for 'default_where_conditions' to apply minimum where conditions to all models queried.
+	 *        For most models this the same as EEM_Base::default_where_conditions_none, except for models which share
+	 *        their table with other models, like the Event and Venue models. For example, when querying for events
+	 *        ordered by their venues' name, this will be sure to only return real events with associated real venues
+	 *        (regardless of whether those events and venues are trashed)
+	 *        In contrast, using EEM_Base::default_where_conditions_none would could return WP posts other than EE
+	 *        events.
+	 */
+	const default_where_conditions_minimum_all = 'minimum';
+
+	/**
+	 * @const constant for 'default_where_conditions' to apply apply where conditions to other models, and full default
+	 *        where conditions for the queried model (eg, when querying events ordered by venues' names, this will
+	 *        return non-trashed events for any venues, regardless of whether those associated venues are trashed or
+	 *        not)
+	 */
+	const default_where_conditions_minimum_others = 'full_this_minimum_others';
+
+	/**
+	 * @const constant for 'default_where_conditions' to NOT apply any where conditions. This should very rarely be
+	 *        used, because when querying from a model which shares its table with another model (eg Events and Venues)
+	 *        it's possible it will return table entries for other models. You should use
+	 *        EEM_Base::default_where_conditions_minimum_all instead.
+	 */
+	const default_where_conditions_none = 'none';
+
+
+	/**
+	 * About all child constructors:
+	 * they should define the _tables, _fields and _model_relations arrays.
+	 * Should ALWAYS be called after child constructor.
+	 * In order to make the child constructors to be as simple as possible, this parent constructor
+	 * finalizes constructing all the object's attributes.
+	 * Generally, rather than requiring a child to code
+	 * $this->_tables = array(
+	 *        'Event_Post_Table' => new EE_Table('Event_Post_Table','wp_posts')
+	 *        ...);
+	 *  (thus repeating itself in the array key and in the constructor of the new EE_Table,)
+	 * each EE_Table has a function to set the table's alias after the constructor, using
+	 * the array key ('Event_Post_Table'), instead of repeating it. The model fields and model relations
+	 * do something similar.
+	 *
+	 * @param null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		// check that the model has not been loaded too soon
+		if (! did_action('AHEE__EE_System__load_espresso_addons')) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The %1$s model can not be loaded before the "AHEE__EE_System__load_espresso_addons" hook has been called. This gives other addons a chance to extend this model.',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		/**
+		 * Set blogid for models to current blog. However we ONLY do this if $_model_query_blog_id is not already set.
+		 */
+		if (empty(EEM_Base::$_model_query_blog_id)) {
+			EEM_Base::set_model_query_blog_id();
+		}
+		/**
+		 * Filters the list of tables on a model. It is best to NOT use this directly and instead
+		 * just use EE_Register_Model_Extension
+		 *
+		 * @var EE_Table_Base[] $_tables
+		 */
+		$this->_tables = (array) apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
+		foreach ($this->_tables as $table_alias => $table_obj) {
+			/** @var $table_obj EE_Table_Base */
+			$table_obj->_construct_finalize_with_alias($table_alias);
+			if ($table_obj instanceof EE_Secondary_Table) {
+				$table_obj->_construct_finalize_set_table_to_join_with($this->_get_main_table());
+			}
+		}
+		/**
+		 * Filters the list of fields on a model. It is best to NOT use this directly and instead just use
+		 * EE_Register_Model_Extension
+		 *
+		 * @param EE_Model_Field_Base[] $_fields
+		 */
+		$this->_fields = (array) apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
+		$this->_invalidate_field_caches();
+		foreach ($this->_fields as $table_alias => $fields_for_table) {
+			if (! array_key_exists($table_alias, $this->_tables)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"Table alias %s does not exist in EEM_Base child's _tables array. Only tables defined are %s",
+							'event_espresso'
+						),
+						$table_alias,
+						implode(",", $this->_fields)
+					)
+				);
+			}
+			foreach ($fields_for_table as $field_name => $field_obj) {
+				/** @var $field_obj EE_Model_Field_Base | EE_Primary_Key_Field_Base */
+				// primary key field base has a slightly different _construct_finalize
+				/** @var $field_obj EE_Model_Field_Base */
+				$field_obj->_construct_finalize($table_alias, $field_name, $this->get_this_model_name());
+			}
+		}
+		// everything is related to Extra_Meta
+		if (get_class($this) !== 'EEM_Extra_Meta') {
+			// make extra meta related to everything, but don't block deleting things just
+			// because they have related extra meta info. For now just orphan those extra meta
+			// in the future we should automatically delete them
+			$this->_model_relations['Extra_Meta'] = new EE_Has_Many_Any_Relation(false);
+		}
+		// and change logs
+		if (get_class($this) !== 'EEM_Change_Log') {
+			$this->_model_relations['Change_Log'] = new EE_Has_Many_Any_Relation(false);
+		}
+		/**
+		 * Filters the list of relations on a model. It is best to NOT use this directly and instead just use
+		 * EE_Register_Model_Extension
+		 *
+		 * @param EE_Model_Relation_Base[] $_model_relations
+		 */
+		$this->_model_relations = (array) apply_filters(
+			'FHEE__' . get_class($this) . '__construct__model_relations',
+			$this->_model_relations
+		);
+		foreach ($this->_model_relations as $model_name => $relation_obj) {
+			/** @var $relation_obj EE_Model_Relation_Base */
+			$relation_obj->_construct_finalize_set_models($this->get_this_model_name(), $model_name);
+		}
+		foreach ($this->_indexes as $index_name => $index_obj) {
+			$index_obj->_construct_finalize($index_name, $this->get_this_model_name());
+		}
+		$this->set_timezone($timezone);
+		// finalize default where condition strategy, or set default
+		if (! $this->_default_where_conditions_strategy) {
+			// nothing was set during child constructor, so set default
+			$this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
+		}
+		$this->_default_where_conditions_strategy->_finalize_construct($this);
+		if (! $this->_minimum_where_conditions_strategy) {
+			// nothing was set during child constructor, so set default
+			$this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
+		}
+		$this->_minimum_where_conditions_strategy->_finalize_construct($this);
+		// if the cap slug hasn't been set, and we haven't set it to false on purpose
+		// to indicate to NOT set it, set it to the logical default
+		if ($this->_caps_slug === null) {
+			$this->_caps_slug = EEH_Inflector::pluralize_and_lower($this->get_this_model_name());
+		}
+		// initialize the standard cap restriction generators if none were specified by the child constructor
+		if (is_array($this->_cap_restriction_generators)) {
+			foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
+				if (! isset($this->_cap_restriction_generators[ $cap_context ])) {
+					$this->_cap_restriction_generators[ $cap_context ] = apply_filters(
+						'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
+						new EE_Restriction_Generator_Protected(),
+						$cap_context,
+						$this
+					);
+				}
+			}
+		}
+		// if there are cap restriction generators, use them to make the default cap restrictions
+		if (is_array($this->_cap_restriction_generators)) {
+			foreach ($this->_cap_restriction_generators as $context => $generator_object) {
+				if (! $generator_object) {
+					continue;
+				}
+				if (! $generator_object instanceof EE_Restriction_Generator_Base) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'Index "%1$s" in the model %2$s\'s _cap_restriction_generators is not a child of EE_Restriction_Generator_Base. It should be that or NULL.',
+								'event_espresso'
+							),
+							$context,
+							$this->get_this_model_name()
+						)
+					);
+				}
+				$action = $this->cap_action_for_context($context);
+				if (! $generator_object->construction_finalized()) {
+					$generator_object->_construct_finalize($this, $action);
+				}
+			}
+		}
+		do_action('AHEE__' . get_class($this) . '__construct__end');
+	}
+
+
+	/**
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function getLoader(): LoaderInterface
+	{
+		if (! EEM_Base::$loader instanceof LoaderInterface) {
+			EEM_Base::$loader = LoaderFactory::getLoader();
+		}
+		return EEM_Base::$loader;
+	}
+
+
+	/**
+	 * @return Mirror
+	 * @since   $VID:$
+	 */
+	private static function getMirror(): Mirror
+	{
+		if (! EEM_Base::$mirror instanceof Mirror) {
+			EEM_Base::$mirror = EEM_Base::getLoader()->getShared(Mirror::class);
+		}
+		return EEM_Base::$mirror;
+	}
+
+
+	/**
+	 * @param string $model_class_Name
+	 * @param string $timezone
+	 * @return array
+	 * @throws ReflectionException
+	 * @since   $VID:$
+	 */
+	private static function getModelArguments(string $model_class_Name, string $timezone): array
+	{
+		$arguments = [$timezone];
+		$params    = EEM_Base::getMirror()->getParameters($model_class_Name);
+		if (count($params) > 1) {
+			if ($params[1]->getName() === 'model_field_factory') {
+				$arguments = [
+					$timezone,
+					EEM_Base::getLoader()->getShared(ModelFieldFactory::class),
+				];
+			} elseif ($model_class_Name === 'EEM_Form_Section') {
+				$arguments = [
+					EEM_Base::getLoader()->getShared('EventEspresso\core\services\form\meta\FormStatus'),
+					$timezone,
+				];
+			} elseif ($model_class_Name === 'EEM_Form_Element') {
+				$arguments = [
+					EEM_Base::getLoader()->getShared('EventEspresso\core\services\form\meta\FormStatus'),
+					EEM_Base::getLoader()->getShared('EventEspresso\core\services\form\meta\InputTypes'),
+					$timezone,
+				];
+			}
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * This function is a singleton method used to instantiate the Espresso_model object
+	 *
+	 * @param string|null $timezone   string representing the timezone we want to set for returned Date Time Strings
+	 *                                (and any incoming timezone data that gets saved).
+	 *                                Note this just sends the timezone info to the date time model field objects.
+	 *                                Default is NULL
+	 *                                (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @return static (as in the concrete child class)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance($timezone = null)
+	{
+		// check if instance of Espresso_model already exists
+		if (! static::$_instance instanceof static) {
+			$arguments = EEM_Base::getModelArguments(static::class, (string) $timezone);
+			$model     = new static(...$arguments);
+			EEM_Base::getLoader()->share(static::class, $model, $arguments);
+			static::$_instance = $model;
+		}
+		// we might have a timezone set, let set_timezone decide what to do with it
+		if ($timezone) {
+			static::$_instance->set_timezone($timezone);
+		}
+		// Espresso_model object
+		return static::$_instance;
+	}
+
+
+	/**
+	 * resets the model and returns it
+	 *
+	 * @param string|null $timezone
+	 * @return EEM_Base|null (if the model was already instantiated, returns it, with
+	 * all its properties reset; if it wasn't instantiated, returns null)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function reset($timezone = null)
+	{
+		if (! static::$_instance instanceof EEM_Base) {
+			return null;
+		}
+		// Let's NOT swap out the current instance for a new one
+		// because if someone has a reference to it, we can't remove their reference.
+		// It's best to keep using the same reference but change the original object instead,
+		// so reset all its properties to their original values as defined in the class.
+		$static_properties = EEM_Base::getMirror()->getStaticProperties(static::class);
+		foreach (EEM_Base::getMirror()->getDefaultProperties(static::class) as $property => $value) {
+			// don't set instance to null like it was originally,
+			// but it's static anyways, and we're ignoring static properties (for now at least)
+			if (! isset($static_properties[ $property ])) {
+				static::$_instance->{$property} = $value;
+			}
+		}
+		// and then directly call its constructor again, like we would if we were creating a new one
+		$arguments = EEM_Base::getModelArguments(static::class, (string) $timezone);
+		static::$_instance->__construct(...$arguments);
+		return self::instance();
+	}
+
+
+	/**
+	 * Used to set the $_model_query_blog_id static property.
+	 *
+	 * @param int $blog_id  If provided then will set the blog_id for the models to this id.  If not provided then the
+	 *                      value for get_current_blog_id() will be used.
+	 */
+	public static function set_model_query_blog_id($blog_id = 0)
+	{
+		EEM_Base::$_model_query_blog_id = $blog_id > 0
+			? (int) $blog_id
+			: get_current_blog_id();
+	}
+
+
+	/**
+	 * Returns whatever is set as the internal $model_query_blog_id.
+	 *
+	 * @return int
+	 */
+	public static function get_model_query_blog_id()
+	{
+		return EEM_Base::$_model_query_blog_id;
+	}
+
+
+	/**
+	 * retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
+	 *
+	 * @param boolean $translated return localized strings or JUST the array.
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function status_array($translated = false)
+	{
+		if (! array_key_exists('Status', $this->_model_relations)) {
+			return [];
+		}
+		$model_name   = $this->get_this_model_name();
+		$status_type  = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
+		$stati        = EEM_Status::instance()->get_all([['STS_type' => $status_type]]);
+		$status_array = [];
+		foreach ($stati as $status) {
+			$status_array[ $status->ID() ] = $status->get('STS_code');
+		}
+		return $translated
+			? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
+			: $status_array;
+	}
+
+
+	/**
+	 * Gets all the EE_Base_Class objects which match the $query_params, by querying the DB.
+	 *
+	 * @param array $query_params             @see
+	 *                                        https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 *                                        or if you have the development copy of EE you can view this at the path:
+	 *                                        /docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]  *note that there is NO option to pass the output type. If you want results different
+	 *                                        from EE_Base_Class[], use get_all_wpdb_results(). Array keys are object
+	 *                                        IDs (if there is a primary key on the model. if not, numerically indexed)
+	 *                                        Some full examples: get 10 transactions which have Scottish attendees:
+	 *                                        EEM_Transaction::instance()->get_all( array( array(
+	 *                                        'OR'=>array(
+	 *                                        'Registration.Attendee.ATT_fname'=>array('like','Mc%'),
+	 *                                        'Registration.Attendee.ATT_fname*other'=>array('like','Mac%')
+	 *                                        )
+	 *                                        ),
+	 *                                        'limit'=>10,
+	 *                                        'group_by'=>'TXN_ID'
+	 *                                        ));
+	 *                                        get all the answers to the question titled "shirt size" for event with id
+	 *                                        12, ordered by their answer EEM_Answer::instance()->get_all(array( array(
+	 *                                        'Question.QST_display_text'=>'shirt size',
+	 *                                        'Registration.Event.EVT_ID'=>12
+	 *                                        ),
+	 *                                        'order_by'=>array('ANS_value'=>'ASC')
+	 *                                        ));
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all($query_params = [])
+	{
+		if (
+			isset($query_params['limit'])
+			&& ! isset($query_params['group_by'])
+		) {
+			$query_params['group_by'] = array_keys($this->get_combined_primary_key_fields());
+		}
+		return $this->_create_objects($this->_get_all_wpdb_results($query_params));
+	}
+
+
+	/**
+	 * Modifies the query parameters so we only get back model objects
+	 * that "belong" to the current user
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	public function alter_query_params_to_only_include_mine($query_params = [])
+	{
+		$wp_user_field_name = $this->wp_user_field_name();
+		if ($wp_user_field_name) {
+			$query_params[0][ $wp_user_field_name ] = get_current_user_id();
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * Returns the name of the field's name that points to the WP_User table
+	 *  on this model (or follows the _model_chain_to_wp_user and uses that model's
+	 * foreign key to the WP_User table)
+	 *
+	 * @return string|boolean string on success, boolean false when there is no
+	 * foreign key to the WP_User table
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	public function wp_user_field_name()
+	{
+		try {
+			if (! empty($this->_model_chain_to_wp_user)) {
+				$models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
+				$last_model_name              = end($models_to_follow_to_wp_users);
+				$model_with_fk_to_wp_users    = EE_Registry::instance()->load_model($last_model_name);
+				$model_chain_to_wp_user       = $this->_model_chain_to_wp_user . '.';
+			} else {
+				$model_with_fk_to_wp_users = $this;
+				$model_chain_to_wp_user    = '';
+			}
+			$wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
+			return $model_chain_to_wp_user . $wp_user_field->get_name();
+		} catch (EE_Error $e) {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Returns the _model_chain_to_wp_user string, which indicates which related model
+	 * (or transiently-related model) has a foreign key to the wp_users table;
+	 * useful for finding if model objects of this type are 'owned' by the current user.
+	 * This is an empty string when the foreign key is on this model and when it isn't,
+	 * but is only non-empty when this model's ownership is indicated by a RELATED model
+	 * (or transiently-related model)
+	 *
+	 * @return string
+	 */
+	public function model_chain_to_wp_user()
+	{
+		return $this->_model_chain_to_wp_user;
+	}
+
+
+	/**
+	 * Whether this model is 'owned' by a specific wordpress user (even indirectly,
+	 * like how registrations don't have a foreign key to wp_users, but the
+	 * events they are for are), or is unrelated to wp users.
+	 * generally available
+	 *
+	 * @return boolean
+	 */
+	public function is_owned()
+	{
+		if ($this->model_chain_to_wp_user()) {
+			return true;
+		}
+		try {
+			$this->get_foreign_key_to('WP_User');
+			return true;
+		} catch (EE_Error $e) {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Used internally to get WPDB results, because other functions, besides get_all, may want to do some queries, but
+	 * may want to preserve the WPDB results (eg, update, which first queries to make sure we have all the tables on
+	 * the model)
+	 *
+	 * @param array  $query_params      @see
+	 *                                  https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
+	 *                                  override this and set the select to "*", or a specific column name, like
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
+	 *                                  the aliases used to refer to this selection, and values are to be
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
+	 * @return array | stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	protected function _get_all_wpdb_results($query_params = [], $output = ARRAY_A, $columns_to_select = null)
+	{
+		$this->_custom_selections = $this->getCustomSelection($query_params, $columns_to_select);
+		$model_query_info         = $this->_create_model_query_info_carrier($query_params);
+		$select_expressions       = $columns_to_select === null
+			? $this->_construct_default_select_sql($model_query_info)
+			: '';
+		if ($this->_custom_selections instanceof CustomSelects) {
+			$custom_expressions = $this->_custom_selections->columnsToSelectExpression();
+			$select_expressions .= $select_expressions
+				? ', ' . $custom_expressions
+				: $custom_expressions;
+		}
+
+		$SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
+		return $this->_do_wpdb_query('get_results', [$SQL, $output]);
+	}
+
+
+	/**
+	 * Get a CustomSelects object if the $query_params or $columns_to_select allows for it.
+	 * Note: $query_params['extra_selects'] will always override any $columns_to_select values. It is the preferred
+	 * method of including extra select information.
+	 *
+	 * @param array             $query_params
+	 * @param null|array|string $columns_to_select
+	 * @return null|CustomSelects
+	 * @throws InvalidArgumentException
+	 */
+	protected function getCustomSelection(array $query_params, $columns_to_select = null)
+	{
+		if (! isset($query_params['extra_selects']) && $columns_to_select === null) {
+			return null;
+		}
+		$selects = isset($query_params['extra_selects']) ? $query_params['extra_selects'] : $columns_to_select;
+		$selects = is_string($selects) ? explode(',', $selects) : $selects;
+		return new CustomSelects($selects);
+	}
+
+
+	/**
+	 * Gets an array of rows from the database just like $wpdb->get_results would,
+	 * but you can use the model query params to more easily
+	 * take care of joins, field preparation etc.
+	 *
+	 * @param array  $query_params      @see
+	 *                                  https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $output            ARRAY_A, OBJECT_K, etc. Just like
+	 * @param mixed  $columns_to_select , What columns to select. By default, we select all columns specified by the
+	 *                                  fields on the model, and the models we joined to in the query. However, you can
+	 *                                  override this and set the select to "*", or a specific column name, like
+	 *                                  "ATT_ID", etc. If you would like to use these custom selections in WHERE,
+	 *                                  GROUP_BY, or HAVING clauses, you must instead provide an array. Array keys are
+	 *                                  the aliases used to refer to this selection, and values are to be
+	 *                                  numerically-indexed arrays, where 0 is the selection and 1 is the data type.
+	 *                                  Eg, array('count'=>array('COUNT(REG_ID)','%d'))
+	 * @return array|stdClass[] like results of $wpdb->get_results($sql,OBJECT), (ie, output type is OBJECT)
+	 * @throws EE_Error
+	 */
+	public function get_all_wpdb_results($query_params = [], $output = ARRAY_A, $columns_to_select = null)
+	{
+		return $this->_get_all_wpdb_results($query_params, $output, $columns_to_select);
+	}
+
+
+	/**
+	 * For creating a custom select statement
+	 *
+	 * @param mixed $columns_to_select either a string to be inserted directly as the select statement,
+	 *                                 or an array where keys are aliases, and values are arrays where 0=>the selection
+	 *                                 SQL, and 1=>is the datatype
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function _construct_select_from_input($columns_to_select)
+	{
+		if (is_array($columns_to_select)) {
+			$select_sql_array = [];
+			foreach ($columns_to_select as $alias => $selection_and_datatype) {
+				if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								"Custom selection %s (alias %s) needs to be an array like array('COUNT(REG_ID)','%%d')",
+								'event_espresso'
+							),
+							$selection_and_datatype,
+							$alias
+						)
+					);
+				}
+				if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types, true)) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								"Datatype %s (for selection '%s' and alias '%s') is not a valid wpdb datatype (eg %%s)",
+								'event_espresso'
+							),
+							$selection_and_datatype[1],
+							$selection_and_datatype[0],
+							$alias,
+							implode(', ', $this->_valid_wpdb_data_types)
+						)
+					);
+				}
+				$select_sql_array[] = "{$selection_and_datatype[0]} AS $alias";
+			}
+			$columns_to_select_string = implode(', ', $select_sql_array);
+		} else {
+			$columns_to_select_string = $columns_to_select;
+		}
+		return $columns_to_select_string;
+	}
+
+
+	/**
+	 * Convenient wrapper for getting the primary key field's name. Eg, on Registration, this would be 'REG_ID'
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function primary_key_name()
+	{
+		return $this->get_primary_key_field()->get_name();
+	}
+
+
+	/**
+	 * Gets a single item for this model from the DB, given only its ID (or null if none is found).
+	 * If there is no primary key on this model, $id is treated as primary key string
+	 *
+	 * @param mixed $id int or string, depending on the type of the model's primary key
+	 * @return EE_Base_Class|mixed|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_one_by_ID($id)
+	{
+		if ($this->get_from_entity_map($id)) {
+			return $this->get_from_entity_map($id);
+		}
+		$model_object = $this->get_one(
+			$this->alter_query_params_to_restrict_by_ID(
+				$id,
+				['default_where_conditions' => EEM_Base::default_where_conditions_minimum_all]
+			)
+		);
+		$className    = $this->_get_class_name();
+		if ($model_object instanceof $className) {
+			// make sure valid objects get added to the entity map
+			// so that the next call to this method doesn't trigger another trip to the db
+			$this->add_to_entity_map($model_object);
+		}
+		return $model_object;
+	}
+
+
+	/**
+	 * Alters query parameters to only get items with this ID are returned.
+	 * Takes into account that the ID might be a string produced by EEM_Base::get_index_primary_key_string(),
+	 * or could just be a simple primary key ID
+	 *
+	 * @param int   $id
+	 * @param array $query_params
+	 * @return array of normal query params, @see
+	 *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 */
+	public function alter_query_params_to_restrict_by_ID($id, $query_params = [])
+	{
+		if (! isset($query_params[0])) {
+			$query_params[0] = [];
+		}
+		$conditions_from_id = $this->parse_index_primary_key_string($id);
+		if ($conditions_from_id === null) {
+			$query_params[0][ $this->primary_key_name() ] = $id;
+		} else {
+			// no primary key, so the $id must be from the get_index_primary_key_string()
+			$query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * Gets a single item for this model from the DB, given the $query_params. Only returns a single class, not an
+	 * array. If no item is found, null is returned.
+	 *
+	 * @param array $query_params like EEM_Base's $query_params variable.
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one($query_params = [])
+	{
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong(
+				'EEM_Base::get_one',
+				sprintf(
+					esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)
+				),
+				'4.6.0'
+			);
+			$query_params = [];
+		}
+		$query_params['limit'] = 1;
+		$items                 = $this->get_all($query_params);
+		if (empty($items)) {
+			return null;
+		}
+		return array_shift($items);
+	}
+
+
+	/**
+	 * Returns the next x number of items in sequence from the given value as
+	 * found in the database matching the given query conditions.
+	 *
+	 * @param mixed $current_field_value    Value used for the reference point.
+	 * @param null  $field_to_order_by      What field is used for the
+	 *                                      reference point.
+	 * @param int   $limit                  How many to return.
+	 * @param array $query_params           Extra conditions on the query.
+	 * @param null  $columns_to_select      If left null, then an array of
+	 *                                      EE_Base_Class objects is returned,
+	 *                                      otherwise you can indicate just the
+	 *                                      columns you want returned.
+	 * @return EE_Base_Class[]|array
+	 * @throws EE_Error
+	 */
+	public function next_x(
+		$current_field_value,
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = [],
+		$columns_to_select = null
+	) {
+		return $this->_get_consecutive(
+			$current_field_value,
+			'>',
+			$field_to_order_by,
+			$limit,
+			$query_params,
+			$columns_to_select
+		);
+	}
+
+
+	/**
+	 * Returns the previous x number of items in sequence from the given value
+	 * as found in the database matching the given query conditions.
+	 *
+	 * @param mixed $current_field_value    Value used for the reference point.
+	 * @param null  $field_to_order_by      What field is used for the
+	 *                                      reference point.
+	 * @param int   $limit                  How many to return.
+	 * @param array $query_params           Extra conditions on the query.
+	 * @param null  $columns_to_select      If left null, then an array of
+	 *                                      EE_Base_Class objects is returned,
+	 *                                      otherwise you can indicate just the
+	 *                                      columns you want returned.
+	 * @return EE_Base_Class[]|array
+	 * @throws EE_Error
+	 */
+	public function previous_x(
+		$current_field_value,
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = [],
+		$columns_to_select = null
+	) {
+		return $this->_get_consecutive(
+			$current_field_value,
+			'<',
+			$field_to_order_by,
+			$limit,
+			$query_params,
+			$columns_to_select
+		);
+	}
+
+
+	/**
+	 * Returns the next item in sequence from the given value as found in the
+	 * database matching the given query conditions.
+	 *
+	 * @param mixed $current_field_value    Value used for the reference point.
+	 * @param null  $field_to_order_by      What field is used for the
+	 *                                      reference point.
+	 * @param array $query_params           Extra conditions on the query.
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
+	 *                                      object is returned, otherwise you
+	 *                                      can indicate just the columns you
+	 *                                      want and a single array indexed by
+	 *                                      the columns will be returned.
+	 * @return EE_Base_Class|null|array()
+	 * @throws EE_Error
+	 */
+	public function next(
+		$current_field_value,
+		$field_to_order_by = null,
+		$query_params = [],
+		$columns_to_select = null
+	) {
+		$results = $this->_get_consecutive(
+			$current_field_value,
+			'>',
+			$field_to_order_by,
+			1,
+			$query_params,
+			$columns_to_select
+		);
+		return empty($results) ? null : reset($results);
+	}
+
+
+	/**
+	 * Returns the previous item in sequence from the given value as found in
+	 * the database matching the given query conditions.
+	 *
+	 * @param mixed $current_field_value    Value used for the reference point.
+	 * @param null  $field_to_order_by      What field is used for the
+	 *                                      reference point.
+	 * @param array $query_params           Extra conditions on the query.
+	 * @param null  $columns_to_select      If left null, then an EE_Base_Class
+	 *                                      object is returned, otherwise you
+	 *                                      can indicate just the columns you
+	 *                                      want and a single array indexed by
+	 *                                      the columns will be returned.
+	 * @return EE_Base_Class|null|array()
+	 * @throws EE_Error
+	 */
+	public function previous(
+		$current_field_value,
+		$field_to_order_by = null,
+		$query_params = [],
+		$columns_to_select = null
+	) {
+		$results = $this->_get_consecutive(
+			$current_field_value,
+			'<',
+			$field_to_order_by,
+			1,
+			$query_params,
+			$columns_to_select
+		);
+		return empty($results) ? null : reset($results);
+	}
+
+
+	/**
+	 * Returns the a consecutive number of items in sequence from the given
+	 * value as found in the database matching the given query conditions.
+	 *
+	 * @param mixed  $current_field_value   Value used for the reference point.
+	 * @param string $operand               What operand is used for the sequence.
+	 * @param string $field_to_order_by     What field is used for the reference point.
+	 * @param int    $limit                 How many to return.
+	 * @param array  $query_params          Extra conditions on the query.
+	 * @param null   $columns_to_select     If left null, then an array of EE_Base_Class objects is returned,
+	 *                                      otherwise you can indicate just the columns you want returned.
+	 * @return EE_Base_Class[]|array
+	 * @throws EE_Error
+	 */
+	protected function _get_consecutive(
+		$current_field_value,
+		$operand = '>',
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = [],
+		$columns_to_select = null
+	) {
+		// if $field_to_order_by is empty then let's assume we're ordering by the primary key.
+		if (empty($field_to_order_by)) {
+			if ($this->has_primary_key_field()) {
+				$field_to_order_by = $this->get_primary_key_field()->get_name();
+			} else {
+				if (WP_DEBUG) {
+					throw new EE_Error(
+						esc_html__(
+							'EEM_Base::_get_consecutive() has been called with no $field_to_order_by argument and there is no primary key on the field.  Please provide the field you would like to use as the base for retrieving the next item(s).',
+							'event_espresso'
+						)
+					);
+				}
+				EE_Error::add_error(
+					esc_html__('There was an error with the query.', 'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				return [];
+			}
+		}
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong(
+				'EEM_Base::_get_consecutive',
+				sprintf(
+					esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)
+				),
+				'4.6.0'
+			);
+			$query_params = [];
+		}
+		// let's add the where query param for consecutive look up.
+		$query_params[0][ $field_to_order_by ] = [$operand, $current_field_value];
+		$query_params['limit']                 = $limit;
+		// set direction
+		$incoming_orderby         = isset($query_params['order_by']) ? (array) $query_params['order_by'] : [];
+		$query_params['order_by'] = $operand === '>'
+			? [$field_to_order_by => 'ASC'] + $incoming_orderby
+			: [$field_to_order_by => 'DESC'] + $incoming_orderby;
+		// if $columns_to_select is empty then that means we're returning EE_Base_Class objects
+		if (empty($columns_to_select)) {
+			return $this->get_all($query_params);
+		}
+		// getting just the fields
+		return $this->_get_all_wpdb_results($query_params, ARRAY_A, $columns_to_select);
+	}
+
+
+	/**
+	 * This sets the _timezone property after model object has been instantiated.
+	 *
+	 * @param null | string $timezone valid PHP DateTimeZone timezone string
+	 */
+	public function set_timezone($timezone)
+	{
+		if ($timezone !== null) {
+			$this->_timezone = $timezone;
+		}
+		// note we need to loop through relations and set the timezone on those objects as well.
+		foreach ($this->_model_relations as $relation) {
+			$relation->set_timezone($timezone);
+		}
+		// and finally we do the same for any datetime fields
+		foreach ($this->_fields as $field) {
+			if ($field instanceof EE_Datetime_Field) {
+				$field->set_timezone($timezone);
+			}
+		}
+	}
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function get_timezone()
+	{
+		// first validate if timezone is set.  If not, then let's set it be whatever is set on the model fields.
+		if (empty($this->_timezone)) {
+			foreach ($this->_fields as $field) {
+				if ($field instanceof EE_Datetime_Field) {
+					$this->set_timezone($field->get_timezone());
+					break;
+				}
+			}
+		}
+		// if timezone STILL empty then return the default timezone for the site.
+		if (empty($this->_timezone)) {
+			$this->set_timezone(EEH_DTT_Helper::get_timezone());
+		}
+		return $this->_timezone;
+	}
+
+
+	/**
+	 * This returns the date formats set for the given field name and also ensures that
+	 * $this->_timezone property is set correctly.
+	 *
+	 * @param string $field_name The name of the field the formats are being retrieved for.
+	 * @param bool   $pretty     Whether to return the pretty formats (true) or not (false).
+	 * @return array formats in an array with the date format first, and the time format last.
+	 * @throws EE_Error   If the given field_name is not of the EE_Datetime_Field type.
+	 * @since 4.6.x
+	 */
+	public function get_formats_for($field_name, $pretty = false)
+	{
+		$field_settings = $this->field_settings_for($field_name);
+		// if not a valid EE_Datetime_Field then throw error
+		if (! $field_settings instanceof EE_Datetime_Field) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The field sent into EEM_Base::get_formats_for (%s) is not registered as a EE_Datetime_Field. Please check the spelling and make sure you are submitting the right field name to retrieve date_formats for.',
+						'event_espresso'
+					),
+					$field_name
+				)
+			);
+		}
+		// while we are here, let's make sure the timezone internally in EEM_Base matches what is stored on
+		// the field.
+		$this->_timezone = $field_settings->get_timezone();
+		return [$field_settings->get_date_format($pretty), $field_settings->get_time_format($pretty)];
+	}
+
+
+	/**
+	 * This returns the current time in a format setup for a query on this model.
+	 * Usage of this method makes it easier to setup queries against EE_Datetime_Field columns because
+	 * it will return:
+	 *  - a formatted string in the timezone and format currently set on the EE_Datetime_Field for the given field for
+	 *  NOW
+	 *  - or a unix timestamp (equivalent to time())
+	 * Note: When requesting a formatted string, if the date or time format doesn't include seconds, for example,
+	 * the time returned, because it uses that format, will also NOT include seconds. For this reason, if you want
+	 * the time returned to be the current time down to the exact second, set $timestamp to true.
+	 *
+	 * @param string $field_name       The field the current time is needed for.
+	 * @param bool   $timestamp        True means to return a unix timestamp. Otherwise a
+	 *                                 formatted string matching the set format for the field in the set timezone will
+	 *                                 be returned.
+	 * @param string $what             Whether to return the string in just the time format, the date format, or both.
+	 * @return int|string  If the given field_name is not of the EE_Datetime_Field type, then an EE_Error
+	 *                                 exception is triggered.
+	 * @throws EE_Error    If the given field_name is not of the EE_Datetime_Field type.
+	 * @throws Exception
+	 * @since 4.6.x
+	 */
+	public function current_time_for_query($field_name, $timestamp = false, $what = 'both')
+	{
+		$formats  = $this->get_formats_for($field_name);
+		$DateTime = new DateTime("now", new DateTimeZone($this->_timezone));
+		if ($timestamp) {
+			return $DateTime->format('U');
+		}
+		// not returning timestamp, so return formatted string in timezone.
+		switch ($what) {
+			case 'time':
+				return $DateTime->format($formats[1]);
+			case 'date':
+				return $DateTime->format($formats[0]);
+			default:
+				return $DateTime->format(implode(' ', $formats));
+		}
+	}
+
+
+	/**
+	 * This receives a time string for a given field and ensures that it is setup to match what the internal settings
+	 * for the model are.  Returns a DateTime object.
+	 * Note: a gotcha for when you send in unix timestamp.  Remember a unix timestamp is already timezone agnostic,
+	 * (functionally the equivalent of UTC+0).  So when you send it in, whatever timezone string you include is
+	 * ignored.
+	 *
+	 * @param string $field_name      The field being setup.
+	 * @param string $timestring      The date time string being used.
+	 * @param string $incoming_format The format for the time string.
+	 * @param string $timezone        By default, it is assumed the incoming time string is in timezone for
+	 *                                the blog.  If this is not the case, then it can be specified here.  If incoming
+	 *                                format is
+	 *                                'U', this is ignored.
+	 * @return DateTime
+	 * @throws EE_Error
+	 */
+	public function convert_datetime_for_query($field_name, $timestring, $incoming_format, $timezone = '')
+	{
+		// just using this to ensure the timezone is set correctly internally
+		$this->get_formats_for($field_name);
+		// load EEH_DTT_Helper
+		$set_timezone     = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
+		$incomingDateTime = date_create_from_format($incoming_format, $timestring, new DateTimeZone($set_timezone));
+		EEH_DTT_Helper::setTimezone($incomingDateTime, new DateTimeZone($this->_timezone));
+		return \EventEspresso\core\domain\entities\DbSafeDateTime::createFromDateTime($incomingDateTime);
+	}
+
+
+	/**
+	 * Gets all the tables comprising this model. Array keys are the table aliases, and values are EE_Table objects
+	 *
+	 * @return EE_Table_Base[]
+	 */
+	public function get_tables()
+	{
+		return $this->_tables;
+	}
+
+
+	/**
+	 * Updates all the database entries (in each table for this model) according to $fields_n_values and optionally
+	 * also updates all the model objects, where the criteria expressed in $query_params are met..
+	 * Also note: if this model has multiple tables, this update verifies all the secondary tables have an entry for
+	 * each row (in the primary table) we're trying to update; if not, it inserts an entry in the secondary table. Eg:
+	 * if our model has 2 tables: wp_posts (primary), and wp_esp_event (secondary). Let's say we are trying to update a
+	 * model object with EVT_ID = 1
+	 * (which means where wp_posts has ID = 1, because wp_posts.ID is the primary key's column), which exists, but
+	 * there is no entry in wp_esp_event for this entry in wp_posts. So, this update script will insert a row into
+	 * wp_esp_event, using any available parameters from $fields_n_values (eg, if "EVT_limit" => 40 is in
+	 * $fields_n_values, the new entry in wp_esp_event will set EVT_limit = 40, and use default for other columns which
+	 * are not specified)
+	 *
+	 * @param array   $fields_n_values         keys are model fields (exactly like keys in EEM_Base::_fields, NOT db
+	 *                                         columns!), values are strings, ints, floats, and maybe arrays if they
+	 *                                         are to be serialized. Basically, the values are what you'd expect to be
+	 *                                         values on the model, NOT necessarily what's in the DB. For example, if
+	 *                                         we wanted to update only the TXN_details on any Transactions where its
+	 *                                         ID=34, we'd use this method as follows:
+	 *                                         EEM_Transaction::instance()->update(
+	 *                                         array('TXN_details'=>array('detail1'=>'monkey','detail2'=>'banana'),
+	 *                                         array(array('TXN_ID'=>34)));
+	 * @param array   $query_params            @see
+	 *                                         https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 *                                         Eg, consider updating Question's QST_admin_label field is of type
+	 *                                         Simple_HTML. If you use this function to update that field to $new_value
+	 *                                         = (note replace 8's with appropriate opening and closing tags in the
+	 *                                         following example)"8script8alert('I hack all');8/script88b8boom
+	 *                                         baby8/b8", then if you set $values_already_prepared_by_model_object to
+	 *                                         TRUE, it is assumed that you've already called
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value), which removes the
+	 *                                         malicious javascript. However, if
+	 *                                         $values_already_prepared_by_model_object is left as FALSE, then
+	 *                                         EE_Simple_HTML_Field->prepare_for_set($new_value) will be called on it,
+	 *                                         and every other field, before insertion. We provide this parameter
+	 *                                         because model objects perform their prepare_for_set function on all
+	 *                                         their values, and so don't need to be called again (and in many cases,
+	 *                                         shouldn't be called again. Eg: if we escape HTML characters in the
+	 *                                         prepare_for_set method...)
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
+	 *                                         in this model's entity map according to $fields_n_values that match
+	 *                                         $query_params. This obviously has some overhead, so you can disable it
+	 *                                         by setting this to FALSE, but be aware that model objects being used
+	 *                                         could get out-of-sync with the database
+	 * @return int how many rows got updated or FALSE if something went wrong with the query (wp returns FALSE or num
+	 *                                         rows affected which *could* include 0 which DOES NOT mean the query was
+	 *                                         bad)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
+	{
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong(
+				'EEM_Base::update',
+				sprintf(
+					esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)
+				),
+				'4.6.0'
+			);
+			$query_params = [];
+		}
+		/**
+		 * Action called before a model update call has been made.
+		 *
+		 * @param EEM_Base $model
+		 * @param array    $fields_n_values the updated fields and their new values
+		 * @param array    $query_params    @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+		 */
+		do_action('AHEE__EEM_Base__update__begin', $this, $fields_n_values, $query_params);
+		/**
+		 * Filters the fields about to be updated given the query parameters. You can provide the
+		 * $query_params to $this->get_all() to find exactly which records will be updated
+		 *
+		 * @param array    $fields_n_values fields and their new values
+		 * @param EEM_Base $model           the model being queried
+		 * @param array    $query_params    @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+		 */
+		$fields_n_values = (array) apply_filters(
+			'FHEE__EEM_Base__update__fields_n_values',
+			$fields_n_values,
+			$this,
+			$query_params
+		);
+		// need to verify that, for any entry we want to update, there are entries in each secondary table.
+		// to do that, for each table, verify that it's PK isn't null.
+		$tables = $this->get_tables();
+		// and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
+		// NOTE: we should make this code more efficient by NOT querying twice
+		// before the real update, but that needs to first go through ALPHA testing
+		// as it's dangerous. says Mike August 8 2014
+		// we want to make sure the default_where strategy is ignored
+		$this->_ignore_where_strategy = true;
+		$wpdb_select_results          = $this->_get_all_wpdb_results($query_params);
+		foreach ($wpdb_select_results as $wpdb_result) {
+			// type cast stdClass as array
+			$wpdb_result = (array) $wpdb_result;
+			// get the model object's PK, as we'll want this if we need to insert a row into secondary tables
+			if ($this->has_primary_key_field()) {
+				$main_table_pk_value = $wpdb_result[ $this->get_primary_key_field()->get_qualified_column() ];
+			} else {
+				// if there's no primary key, we basically can't support having a 2nd table on the model (we could but it would be lots of work)
+				$main_table_pk_value = null;
+			}
+			// if there are more than 1 tables, we'll want to verify that each table for this model has an entry in the other tables
+			// and if the other tables don't have a row for each table-to-be-updated, we'll insert one with whatever values available in the current update query
+			if (count($tables) > 1) {
+				// foreach matching row in the DB, ensure that each table's PK isn't null. If so, there must not be an entry
+				// in that table, and so we'll want to insert one
+				foreach ($tables as $table_obj) {
+					$this_table_pk_column = $table_obj->get_fully_qualified_pk_column();
+					// if there is no private key for this table on the results, it means there's no entry
+					// in this table, right? so insert a row in the current table, using any fields available
+					if (
+						! (array_key_exists($this_table_pk_column, $wpdb_result)
+						   && $wpdb_result[ $this_table_pk_column ])
+					) {
+						$success = $this->_insert_into_specific_table(
+							$table_obj,
+							$fields_n_values,
+							$main_table_pk_value
+						);
+						// if we died here, report the error
+						if (! $success) {
+							return false;
+						}
+					}
+				}
+			}
+			//              //and now check that if we have cached any models by that ID on the model, that
+			//              //they also get updated properly
+			//              $model_object = $this->get_from_entity_map( $main_table_pk_value );
+			//              if( $model_object ){
+			//                  foreach( $fields_n_values as $field => $value ){
+			//                      $model_object->set($field, $value);
+			// let's make sure default_where strategy is followed now
+			$this->_ignore_where_strategy = false;
+		}
+		// if we want to keep model objects in sync, AND
+		// if this wasn't called from a model object (to update itself)
+		// then we want to make sure we keep all the existing
+		// model objects in sync with the db
+		if ($keep_model_objs_in_sync && ! $this->_values_already_prepared_by_model_object) {
+			if ($this->has_primary_key_field()) {
+				$model_objs_affected_ids = $this->get_col($query_params);
+			} else {
+				// we need to select a bunch of columns and then combine them into the the "index primary key string"s
+				$models_affected_key_columns = $this->_get_all_wpdb_results($query_params, ARRAY_A);
+				$model_objs_affected_ids     = [];
+				foreach ($models_affected_key_columns as $row) {
+					$combined_index_key                             = $this->get_index_primary_key_string($row);
+					$model_objs_affected_ids[ $combined_index_key ] = $combined_index_key;
+				}
+			}
+			if (! $model_objs_affected_ids) {
+				// wait wait wait- if nothing was affected let's stop here
+				return 0;
+			}
+			foreach ($model_objs_affected_ids as $id) {
+				$model_obj_in_entity_map = $this->get_from_entity_map($id);
+				if ($model_obj_in_entity_map) {
+					foreach ($fields_n_values as $field => $new_value) {
+						$model_obj_in_entity_map->set($field, $new_value);
+					}
+				}
+			}
+			// if there is a primary key on this model, we can now do a slight optimization
+			if ($this->has_primary_key_field()) {
+				// we already know what we want to update. So let's make the query simpler so it's a little more efficient
+				$query_params = [
+					[$this->primary_key_name() => ['IN', $model_objs_affected_ids]],
+					'limit'                    => count($model_objs_affected_ids),
+					'default_where_conditions' => EEM_Base::default_where_conditions_none,
+				];
+			}
+		}
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
+		$SQL              = "UPDATE "
+							. $model_query_info->get_full_join_sql()
+							. " SET "
+							. $this->_construct_update_sql($fields_n_values)
+							. $model_query_info->get_where_sql(
+			);// note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
+		$rows_affected    = $this->_do_wpdb_query('query', [$SQL]);
+		/**
+		 * Action called after a model update call has been made.
+		 *
+		 * @param EEM_Base $model
+		 * @param array    $fields_n_values the updated fields and their new values
+		 * @param array    $query_params    @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+		 * @param int      $rows_affected
+		 */
+		do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
+		return $rows_affected;// how many supposedly got updated
+	}
+
+
+	/**
+	 * Analogous to $wpdb->get_col, returns a 1-dimensional array where teh values
+	 * are teh values of the field specified (or by default the primary key field)
+	 * that matched the query params. Note that you should pass the name of the
+	 * model FIELD, not the database table's column name.
+	 *
+	 * @param array  $query_params @see
+	 *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_select
+	 * @return array just like $wpdb->get_col()
+	 * @throws EE_Error
+	 */
+	public function get_col($query_params = [], $field_to_select = null)
+	{
+		if ($field_to_select) {
+			$field = $this->field_settings_for($field_to_select);
+		} elseif ($this->has_primary_key_field()) {
+			$field = $this->get_primary_key_field();
+		} else {
+			$field_settings = $this->field_settings();
+			// no primary key, just grab the first column
+			$field = reset($field_settings);
+			// don't need this array now
+			unset($field_settings);
+		}
+		$model_query_info   = $this->_create_model_query_info_carrier($query_params);
+		$select_expressions = $field->get_qualified_column();
+		$SQL                =
+			"SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
+		return $this->_do_wpdb_query('get_col', [$SQL]);
+	}
+
+
+	/**
+	 * Returns a single column value for a single row from the database
+	 *
+	 * @param array  $query_params    @see
+	 *                                https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_select @see EEM_Base::get_col()
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_var($query_params = [], $field_to_select = null)
+	{
+		$query_params['limit'] = 1;
+		$col                   = $this->get_col($query_params, $field_to_select);
+		if (! empty($col)) {
+			return reset($col);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Makes the SQL for after "UPDATE table_X inner join table_Y..." and before "...WHERE". Eg "Question.name='party
+	 * time?', Question.desc='what do you think?',..." Values are filtered through wpdb->prepare to avoid against SQL
+	 * injection, but currently no further filtering is done
+	 *
+	 * @param array $fields_n_values array keys are field names on this model, and values are what those fields should
+	 *                               be updated to in the DB
+	 * @return string of SQL
+	 * @throws EE_Error
+	 * @global      $wpdb
+	 */
+	public function _construct_update_sql($fields_n_values)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$cols_n_values = [];
+		foreach ($fields_n_values as $field_name => $value) {
+			$field_obj = $this->field_settings_for($field_name);
+			// if the value is NULL, we want to assign the value to that.
+			// wpdb->prepare doesn't really handle that properly
+			$prepared_value  = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
+			$value_sql       = $prepared_value === null ? 'NULL'
+				: $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
+			$cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
+		}
+		return implode(",", $cols_n_values);
+	}
+
+
+	/**
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
+	 * Performs a HARD delete, meaning the database row should always be removed,
+	 * not just have a flag field on it switched
+	 * Wrapper for EEM_Base::delete_permanently()
+	 *
+	 * @param mixed   $id
+	 * @param boolean $allow_blocking
+	 * @return int the number of rows deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_permanently_by_ID($id, $allow_blocking = true)
+	{
+		return $this->delete_permanently(
+			[
+				[$this->get_primary_key_field()->get_name() => $id],
+				'limit' => 1,
+			],
+			$allow_blocking
+		);
+	}
+
+
+	/**
+	 * Deletes a single row from the DB given the model object's primary key value. (eg, EE_Attendee->ID()'s value).
+	 * Wrapper for EEM_Base::delete()
+	 *
+	 * @param mixed   $id
+	 * @param boolean $allow_blocking
+	 * @return int the number of rows deleted
+	 * @throws EE_Error
+	 */
+	public function delete_by_ID($id, $allow_blocking = true)
+	{
+		return $this->delete(
+			[
+				[$this->get_primary_key_field()->get_name() => $id],
+				'limit' => 1,
+			],
+			$allow_blocking
+		);
+	}
+
+
+	/**
+	 * Identical to delete_permanently, but does a "soft" delete if possible,
+	 * meaning if the model has a field that indicates its been "trashed" or
+	 * "soft deleted", we will just set that instead of actually deleting the rows.
+	 *
+	 * @param array   $query_params
+	 * @param boolean $allow_blocking
+	 * @return int how many rows got deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see EEM_Base::delete_permanently
+	 */
+	public function delete($query_params, $allow_blocking = true)
+	{
+		return $this->delete_permanently($query_params, $allow_blocking);
+	}
+
+
+	/**
+	 * Deletes the model objects that meet the query params. Note: this method is overridden
+	 * in EEM_Soft_Delete_Base so that soft-deleted model objects are instead only flagged
+	 * as archived, not actually deleted
+	 *
+	 * @param array   $query_params   @see
+	 *                                https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
+	 *                                that blocks it (ie, there' sno other data that depends on this data); if false,
+	 *                                deletes regardless of other objects which may depend on it. Its generally
+	 *                                advisable to always leave this as TRUE, otherwise you could easily corrupt your
+	 *                                DB
+	 * @return int how many rows got deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_permanently($query_params, $allow_blocking = true)
+	{
+		/**
+		 * Action called just before performing a real deletion query. You can use the
+		 * model and its $query_params to find exactly which items will be deleted
+		 *
+		 * @param EEM_Base $model
+		 * @param array    $query_params   @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+		 * @param boolean  $allow_blocking whether or not to allow related model objects
+		 *                                 to block (prevent) this deletion
+		 */
+		do_action('AHEE__EEM_Base__delete__begin', $this, $query_params, $allow_blocking);
+		// some MySQL databases may be running safe mode, which may restrict
+		// deletion if there is no KEY column used in the WHERE statement of a deletion.
+		// to get around this, we first do a SELECT, get all the IDs, and then run another query
+		// to delete them
+		$items_for_deletion           = $this->_get_all_wpdb_results($query_params);
+		$columns_and_ids_for_deleting = $this->_get_ids_for_delete($items_for_deletion, $allow_blocking);
+		$deletion_where_query_part    = $this->_build_query_part_for_deleting_from_columns_and_values(
+			$columns_and_ids_for_deleting
+		);
+		/**
+		 * Allows client code to act on the items being deleted before the query is actually executed.
+		 *
+		 * @param EEM_Base $this                            The model instance being acted on.
+		 * @param array    $query_params                    The incoming array of query parameters influencing what gets deleted.
+		 * @param bool     $allow_blocking                  @see param description in method phpdoc block.
+		 * @param array    $columns_and_ids_for_deleting    An array indicating what entities will get removed as
+		 *                                                  derived from the incoming query parameters.
+		 * @see details on the structure of this array in the phpdocs
+		 *                                                  for the `_get_ids_for_delete_method`
+		 *
+		 */
+		do_action(
+			'AHEE__EEM_Base__delete__before_query',
+			$this,
+			$query_params,
+			$allow_blocking,
+			$columns_and_ids_for_deleting
+		);
+		if ($deletion_where_query_part) {
+			$model_query_info = $this->_create_model_query_info_carrier($query_params);
+			$table_aliases    = array_keys($this->_tables);
+			$SQL              = "DELETE "
+								. implode(", ", $table_aliases)
+								. " FROM "
+								. $model_query_info->get_full_join_sql()
+								. " WHERE "
+								. $deletion_where_query_part;
+			$rows_deleted     = $this->_do_wpdb_query('query', [$SQL]);
+		} else {
+			$rows_deleted = 0;
+		}
+
+		// Next, make sure those items are removed from the entity map; if they could be put into it at all; and if
+		// there was no error with the delete query.
+		if (
+			$this->has_primary_key_field()
+			&& $rows_deleted !== false
+			&& isset($columns_and_ids_for_deleting[ $this->get_primary_key_field()->get_qualified_column() ])
+		) {
+			$ids_for_removal = $columns_and_ids_for_deleting[ $this->get_primary_key_field()->get_qualified_column() ];
+			foreach ($ids_for_removal as $id) {
+				if (isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])) {
+					unset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]);
+				}
+			}
+
+			// delete any extra meta attached to the deleted entities but ONLY if this model is not an instance of
+			// `EEM_Extra_Meta`.  In other words we want to prevent recursion on EEM_Extra_Meta::delete_permanently calls
+			// unnecessarily.  It's very unlikely that users will have assigned Extra Meta to Extra Meta
+			// (although it is possible).
+			// Note this can be skipped by using the provided filter and returning false.
+			if (
+				apply_filters(
+					'FHEE__EEM_Base__delete_permanently__dont_delete_extra_meta_for_extra_meta',
+					! $this instanceof EEM_Extra_Meta,
+					$this
+				)
+			) {
+				EEM_Extra_Meta::instance()->delete_permanently([
+																   0 => [
+																	   'EXM_type' => $this->get_this_model_name(),
+																	   'OBJ_ID'   => [
+																		   'IN',
+																		   $ids_for_removal,
+																	   ],
+																   ],
+															   ]);
+			}
+		}
+
+		/**
+		 * Action called just after performing a real deletion query. Although at this point the
+		 * items should have been deleted
+		 *
+		 * @param EEM_Base $model
+		 * @param array    $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+		 * @param int      $rows_deleted
+		 */
+		do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted, $columns_and_ids_for_deleting);
+		return $rows_deleted;// how many supposedly got deleted
+	}
+
+
+	/**
+	 * Checks all the relations that throw error messages when there are blocking related objects
+	 * for related model objects. If there are any related model objects on those relations,
+	 * adds an EE_Error, and return true
+	 *
+	 * @param EE_Base_Class|int $this_model_obj_or_id
+	 * @param EE_Base_Class     $ignore_this_model_obj a model object like 'EE_Event', or 'EE_Term_Taxonomy', which
+	 *                                                 should be ignored when determining whether there are related
+	 *                                                 model objects which block this model object's deletion. Useful
+	 *                                                 if you know A is related to B and are considering deleting A,
+	 *                                                 but want to see if A has any other objects blocking its deletion
+	 *                                                 before removing the relation between A and B
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_is_blocked_by_related_models($this_model_obj_or_id, $ignore_this_model_obj = null)
+	{
+		// first, if $ignore_this_model_obj was supplied, get its model
+		if ($ignore_this_model_obj && $ignore_this_model_obj instanceof EE_Base_Class) {
+			$ignored_model = $ignore_this_model_obj->get_model();
+		} else {
+			$ignored_model = null;
+		}
+		// now check all the relations of $this_model_obj_or_id and see if there
+		// are any related model objects blocking it?
+		$is_blocked = false;
+		foreach ($this->_model_relations as $relation_name => $relation_obj) {
+			if ($relation_obj->block_delete_if_related_models_exist()) {
+				// if $ignore_this_model_obj was supplied, then for the query
+				// on that model needs to be told to ignore $ignore_this_model_obj
+				if ($ignored_model && $relation_name === $ignored_model->get_this_model_name()) {
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id, [
+						[
+							$ignored_model->get_primary_key_field()->get_name() => [
+								'!=',
+								$ignore_this_model_obj->ID(),
+							],
+						],
+					]);
+				} else {
+					$related_model_objects = $relation_obj->get_all_related($this_model_obj_or_id);
+				}
+				if ($related_model_objects) {
+					EE_Error::add_error($relation_obj->get_deletion_error_message(), __FILE__, __FUNCTION__, __LINE__);
+					$is_blocked = true;
+				}
+			}
+		}
+		return $is_blocked;
+	}
+
+
+	/**
+	 * Builds the columns and values for items to delete from the incoming $row_results_for_deleting array.
+	 *
+	 * @param array $row_results_for_deleting
+	 * @param bool  $allow_blocking
+	 * @return array   The shape of this array depends on whether the model `has_primary_key_field` or not.  If the
+	 *                              model DOES have a primary_key_field, then the array will be a simple single
+	 *                              dimension array where the key is the fully qualified primary key column and the
+	 *                              value is an array of ids that will be deleted. Example: array('Event.EVT_ID' =>
+	 *                              array( 1,2,3)) If the model DOES NOT have a primary_key_field, then the array will
+	 *                              be a two dimensional array where each element is a group of columns and values that
+	 *                              get deleted. Example: array(
+	 *                              0 => array(
+	 *                              'Term_Relationship.object_id' => 1
+	 *                              'Term_Relationship.term_taxonomy_id' => 5
+	 *                              ),
+	 *                              1 => array(
+	 *                              'Term_Relationship.object_id' => 1
+	 *                              'Term_Relationship.term_taxonomy_id' => 6
+	 *                              )
+	 *                              )
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_ids_for_delete(array $row_results_for_deleting, $allow_blocking = true)
+	{
+		$ids_to_delete_indexed_by_column = [];
+		if ($this->has_primary_key_field()) {
+			$primary_table                   = $this->_get_main_table();
+			$primary_table_pk_field          =
+				$this->get_field_by_column($primary_table->get_fully_qualified_pk_column());
+			$other_tables                    = $this->_get_other_tables();
+			$ids_to_delete_indexed_by_column = $query = [];
+			foreach ($row_results_for_deleting as $item_to_delete) {
+				// before we mark this item for deletion,
+				// make sure there's no related entities blocking its deletion (if we're checking)
+				if (
+					$allow_blocking
+					&& $this->delete_is_blocked_by_related_models(
+						$item_to_delete[ $primary_table->get_fully_qualified_pk_column() ]
+					)
+				) {
+					continue;
+				}
+				// primary table deletes
+				if (isset($item_to_delete[ $primary_table->get_fully_qualified_pk_column() ])) {
+					$ids_to_delete_indexed_by_column[ $primary_table->get_fully_qualified_pk_column() ][] =
+						$item_to_delete[ $primary_table->get_fully_qualified_pk_column() ];
+				}
+			}
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
+			$fields = $this->get_combined_primary_key_fields();
+			foreach ($row_results_for_deleting as $item_to_delete) {
+				$ids_to_delete_indexed_by_column_for_row = [];
+				foreach ($fields as $cpk_field) {
+					if ($cpk_field instanceof EE_Model_Field_Base) {
+						$ids_to_delete_indexed_by_column_for_row[ $cpk_field->get_qualified_column() ] =
+							$item_to_delete[ $cpk_field->get_qualified_column() ];
+					}
+				}
+				$ids_to_delete_indexed_by_column[] = $ids_to_delete_indexed_by_column_for_row;
+			}
+		} else {
+			// so there's no primary key and no combined key...
+			// sorry, can't help you
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Cannot delete objects of type %s because there is no primary key NOR combined key",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $ids_to_delete_indexed_by_column;
+	}
+
+
+	/**
+	 * This receives an array of columns and values set to be deleted (as prepared by _get_ids_for_delete) and prepares
+	 * the corresponding query_part for the query performing the delete.
+	 *
+	 * @param array $ids_to_delete_indexed_by_column @see _get_ids_for_delete for how this array might be shaped.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _build_query_part_for_deleting_from_columns_and_values(array $ids_to_delete_indexed_by_column)
+	{
+		$query_part = '';
+		if (empty($ids_to_delete_indexed_by_column)) {
+			return $query_part;
+		} elseif ($this->has_primary_key_field()) {
+			$query = [];
+			foreach ($ids_to_delete_indexed_by_column as $column => $ids) {
+				$query[] = $column . ' IN' . $this->_construct_in_value($ids, $this->_primary_key_field);
+			}
+			$query_part = ! empty($query) ? implode(' AND ', $query) : $query_part;
+		} elseif (count($this->get_combined_primary_key_fields()) > 1) {
+			$ways_to_identify_a_row = [];
+			foreach ($ids_to_delete_indexed_by_column as $ids_to_delete_indexed_by_column_for_each_row) {
+				$values_for_each_combined_primary_key_for_a_row = [];
+				foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
+					$values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
+				}
+				$ways_to_identify_a_row[] = '('
+											. implode(' AND ', $values_for_each_combined_primary_key_for_a_row)
+											. ')';
+			}
+			$query_part = implode(' OR ', $ways_to_identify_a_row);
+		}
+		return $query_part;
+	}
+
+
+	/**
+	 * Gets the model field by the fully qualified name
+	 *
+	 * @param string $qualified_column_name eg 'Event_CPT.post_name' or $field_obj->get_qualified_column()
+	 * @return EE_Model_Field_Base
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function get_field_by_column($qualified_column_name)
+	{
+		foreach ($this->field_settings(true) as $field_name => $field_obj) {
+			if ($field_obj->get_qualified_column() === $qualified_column_name) {
+				return $field_obj;
+			}
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__('Could not find a field on the model "%1$s" for qualified column "%2$s"', 'event_espresso'),
+				$this->get_this_model_name(),
+				$qualified_column_name
+			)
+		);
+	}
+
+
+	/**
+	 * Count all the rows that match criteria the model query params.
+	 * If $field_to_count isn't provided, the model's primary key is used. Otherwise, we count by field_to_count's
+	 * column
+	 *
+	 * @param array  $query_params   @see
+	 *                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_count field on model to count by (not column name)
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
+	 *                               that by the setting $distinct to TRUE;
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count($query_params = [], $field_to_count = null, $distinct = false)
+	{
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
+		if ($field_to_count) {
+			$field_obj       = $this->field_settings_for($field_to_count);
+			$column_to_count = $field_obj->get_qualified_column();
+		} elseif ($this->has_primary_key_field()) {
+			$pk_field_obj    = $this->get_primary_key_field();
+			$column_to_count = $pk_field_obj->get_qualified_column();
+		} else {
+			// there's no primary key
+			// if we're counting distinct items, and there's no primary key,
+			// we need to list out the columns for distinction;
+			// otherwise we can just use star
+			if ($distinct) {
+				$columns_to_use = [];
+				foreach ($this->get_combined_primary_key_fields() as $field_obj) {
+					$columns_to_use[] = $field_obj->get_qualified_column();
+				}
+				$column_to_count = implode(',', $columns_to_use);
+			} else {
+				$column_to_count = '*';
+			}
+		}
+		$column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
+		$SQL             =
+			"SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
+		return (int) $this->_do_wpdb_query('get_var', [$SQL]);
+	}
+
+
+	/**
+	 * Sums up the value of the $field_to_sum (defaults to the primary key, which isn't terribly useful)
+	 *
+	 * @param array  $query_params @see
+	 *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_sum name of field (array key in $_fields array)
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function sum($query_params, $field_to_sum = null)
+	{
+		$model_query_info = $this->_create_model_query_info_carrier($query_params);
+		if ($field_to_sum) {
+			$field_obj = $this->field_settings_for($field_to_sum);
+		} else {
+			$field_obj = $this->get_primary_key_field();
+		}
+		$column_to_count = $field_obj->get_qualified_column();
+		$SQL             =
+			"SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
+		$return_value    = $this->_do_wpdb_query('get_var', [$SQL]);
+		$data_type       = $field_obj->get_wpdb_data_type();
+		if ($data_type === '%d' || $data_type === '%s') {
+			return (float) $return_value;
+		}
+		// must be %f
+		return (float) $return_value;
+	}
+
+
+	/**
+	 * Just calls the specified method on $wpdb with the given arguments
+	 * Consolidates a little extra error handling code
+	 *
+	 * @param string $wpdb_method
+	 * @param array  $arguments_to_provide
+	 * @return mixed
+	 * @throws EE_Error
+	 * @global wpdb  $wpdb
+	 */
+	protected function _do_wpdb_query($wpdb_method, $arguments_to_provide)
+	{
+		// if we're in maintenance mode level 2, DON'T run any queries
+		// because level 2 indicates the database needs updating and
+		// is probably out of sync with the code
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Event Espresso Level 2 Maintenance mode is active. That means EE can not run ANY database queries until the necessary migration scripts have run which will take EE out of maintenance mode level 2. Please inform support of this error.",
+						"event_espresso"
+					)
+				)
+			);
+		}
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		if (! method_exists($wpdb, $wpdb_method)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'There is no method named "%s" on Wordpress\' $wpdb object',
+						'event_espresso'
+					),
+					$wpdb_method
+				)
+			);
+		}
+		if (WP_DEBUG) {
+			$old_show_errors_value = $wpdb->show_errors;
+			$wpdb->show_errors(false);
+		}
+		$result = $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
+		$this->show_db_query_if_previously_requested($wpdb->last_query);
+		if (WP_DEBUG) {
+			$wpdb->show_errors($old_show_errors_value);
+			if (! empty($wpdb->last_error)) {
+				throw new EE_Error(sprintf(esc_html__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
+			}
+			if ($result === false) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'WPDB Error occurred, but no error message was logged by wpdb! The wpdb method called was "%1$s" and the arguments were "%2$s"',
+							'event_espresso'
+						),
+						$wpdb_method,
+						var_export($arguments_to_provide, true)
+					)
+				);
+			}
+		} elseif ($result === false) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'A database error has occurred. Turn on WP_DEBUG for more information.||A database error occurred doing wpdb method "%1$s", with arguments "%2$s". The error was "%3$s"',
+						'event_espresso'
+					),
+					$wpdb_method,
+					var_export($arguments_to_provide, true),
+					$wpdb->last_error
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Attempts to run the indicated WPDB method with the provided arguments,
+	 * and if there's an error tries to verify the DB is correct. Uses
+	 * the static property EEM_Base::$_db_verification_level to determine whether
+	 * we should try to fix the EE core db, the addons, or just give up
+	 *
+	 * @param string $wpdb_method
+	 * @param array  $arguments_to_provide
+	 * @return mixed
+	 */
+	private function _process_wpdb_query($wpdb_method, $arguments_to_provide)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$wpdb->last_error = null;
+		$result           = call_user_func_array([$wpdb, $wpdb_method], $arguments_to_provide);
+		// was there an error running the query? but we don't care on new activations
+		// (we're going to setup the DB anyway on new activations)
+		if (
+			($result === false || ! empty($wpdb->last_error))
+			&& EE_System::instance()->detect_req_type() !== EE_System::req_type_new_activation
+		) {
+			switch (EEM_Base::$_db_verification_level) {
+				case EEM_Base::db_verified_none:
+					// let's double-check core's DB
+					$error_message = $this->_verify_core_db($wpdb_method, $arguments_to_provide);
+					break;
+				case EEM_Base::db_verified_core:
+					// STILL NO LOVE?? verify all the addons too. Maybe they need to be fixed
+					$error_message = $this->_verify_addons_db($wpdb_method, $arguments_to_provide);
+					break;
+				case EEM_Base::db_verified_addons:
+					// ummmm... you in trouble
+					return $result;
+			}
+			if (! empty($error_message)) {
+				EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
+				trigger_error($error_message);
+			}
+			return $this->_process_wpdb_query($wpdb_method, $arguments_to_provide);
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Verifies the EE core database is up-to-date and records that we've done it on
+	 * EEM_Base::$_db_verification_level
+	 *
+	 * @param string $wpdb_method
+	 * @param array  $arguments_to_provide
+	 * @return string
+	 */
+	private function _verify_core_db($wpdb_method, $arguments_to_provide)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		// ok remember that we've already attempted fixing the core db, in case the problem persists
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_core;
+		$error_message                    = sprintf(
+			esc_html__(
+				'WPDB Error "%1$s" while running wpdb method "%2$s" with arguments %3$s. Automatically attempting to fix EE Core DB',
+				'event_espresso'
+			),
+			$wpdb->last_error,
+			$wpdb_method,
+			wp_json_encode($arguments_to_provide)
+		);
+		EE_System::instance()->initialize_db_if_no_migrations_required(false, true);
+		return $error_message;
+	}
+
+
+	/**
+	 * Verifies the EE addons' database is up-to-date and records that we've done it on
+	 * EEM_Base::$_db_verification_level
+	 *
+	 * @param $wpdb_method
+	 * @param $arguments_to_provide
+	 * @return string
+	 */
+	private function _verify_addons_db($wpdb_method, $arguments_to_provide)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		// ok remember that we've already attempted fixing the addons dbs, in case the problem persists
+		EEM_Base::$_db_verification_level = EEM_Base::db_verified_addons;
+		$error_message                    = sprintf(
+			esc_html__(
+				'WPDB AGAIN: Error "%1$s" while running the same method and arguments as before. Automatically attempting to fix EE Addons DB',
+				'event_espresso'
+			),
+			$wpdb->last_error,
+			$wpdb_method,
+			wp_json_encode($arguments_to_provide)
+		);
+		EE_System::instance()->initialize_addons();
+		return $error_message;
+	}
+
+
+	/**
+	 * In order to avoid repeating this code for the get_all, sum, and count functions, put the code parts
+	 * that are identical in here. Returns a string of SQL of everything in a SELECT query except the beginning
+	 * SELECT clause, eg " FROM wp_posts AS Event INNER JOIN ... WHERE ... ORDER BY ... LIMIT ... GROUP BY ... HAVING
+	 * ..."
+	 *
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
+	 * @return string
+	 */
+	private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
+	{
+		return " FROM " . $model_query_info->get_full_join_sql() .
+			   $model_query_info->get_where_sql() .
+			   $model_query_info->get_group_by_sql() .
+			   $model_query_info->get_having_sql() .
+			   $model_query_info->get_order_by_sql() .
+			   $model_query_info->get_limit_sql();
+	}
+
+
+	/**
+	 * Set to easily debug the next X queries ran from this model.
+	 *
+	 * @param int $count
+	 */
+	public function show_next_x_db_queries($count = 1)
+	{
+		$this->_show_next_x_db_queries = $count;
+	}
+
+
+	/**
+	 * @param $sql_query
+	 */
+	public function show_db_query_if_previously_requested($sql_query)
+	{
+		if ($this->_show_next_x_db_queries > 0) {
+			echo esc_html($sql_query);
+			$this->_show_next_x_db_queries--;
+		}
+	}
+
+
+	/**
+	 * Adds a relationship of the correct type between $modelObject and $otherModelObject.
+	 * There are the 3 cases:
+	 * 'belongsTo' relationship: sets $id_or_obj's foreign_key to be $other_model_id_or_obj's primary_key. If
+	 * $otherModelObject has no ID, it is first saved.
+	 * 'hasMany' relationship: sets $other_model_id_or_obj's foreign_key to be $id_or_obj's primary_key. If $id_or_obj
+	 * has no ID, it is first saved.
+	 * 'hasAndBelongsToMany' relationships: checks that there isn't already an entry in the join table, and adds one.
+	 * If one of the model Objects has not yet been saved to the database, it is saved before adding the entry in the
+	 * join table
+	 *
+	 * @param EE_Base_Class                     /int $thisModelObject
+	 * @param EE_Base_Class                     /int $id_or_obj EE_base_Class or ID of other Model Object
+	 * @param string $relationName                     , key in EEM_Base::_relations
+	 *                                                 an attendee to a group, you also want to specify which role they
+	 *                                                 will have in that group. So you would use this parameter to
+	 *                                                 specify array('role-column-name'=>'role-id')
+	 * @param array  $extra_join_model_fields_n_values This allows you to enter further query params for the relation
+	 *                                                 to for relation to methods that allow you to further specify
+	 *                                                 extra columns to join by (such as HABTM).  Keep in mind that the
+	 *                                                 only acceptable query_params is strict "col" => "value" pairs
+	 *                                                 because these will be inserted in any new rows created as well.
+	 * @return EE_Base_Class which was added as a relation. Object referred to by $other_model_id_or_obj
+	 * @throws EE_Error
+	 */
+	public function add_relationship_to(
+		$id_or_obj,
+		$other_model_id_or_obj,
+		$relationName,
+		$extra_join_model_fields_n_values = []
+	) {
+		$relation_obj = $this->related_settings_for($relationName);
+		return $relation_obj->add_relation_to($id_or_obj, $other_model_id_or_obj, $extra_join_model_fields_n_values);
+	}
+
+
+	/**
+	 * Removes a relationship of the correct type between $modelObject and $otherModelObject.
+	 * There are the 3 cases:
+	 * 'belongsTo' relationship: sets $modelObject's foreign_key to null, if that field is nullable.Otherwise throws an
+	 * error
+	 * 'hasMany' relationship: sets $otherModelObject's foreign_key to null,if that field is nullable.Otherwise throws
+	 * an error
+	 * 'hasAndBelongsToMany' relationships:removes any existing entry in the join table between the two models.
+	 *
+	 * @param EE_Base_Class /int $id_or_obj
+	 * @param EE_Base_Class /int $other_model_id_or_obj EE_Base_Class or ID of other Model Object
+	 * @param string $relationName key in EEM_Base::_relations
+	 * @param array  $where_query  This allows you to enter further query params for the relation to for relation to
+	 *                             methods that allow you to further specify extra columns to join by (such as HABTM).
+	 *                             Keep in mind that the only acceptable query_params is strict "col" => "value" pairs
+	 *                             because these will be inserted in any new rows created as well.
+	 * @return boolean of success
+	 * @throws EE_Error
+	 */
+	public function remove_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = [])
+	{
+		$relation_obj = $this->related_settings_for($relationName);
+		return $relation_obj->remove_relation_to($id_or_obj, $other_model_id_or_obj, $where_query);
+	}
+
+
+	/**
+	 * @param mixed  $id_or_obj
+	 * @param string $relationName
+	 * @param array  $where_query_params
+	 * @param EE_Base_Class[] objects to which relations were removed
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function remove_relations($id_or_obj, $relationName, $where_query_params = [])
+	{
+		$relation_obj = $this->related_settings_for($relationName);
+		return $relation_obj->remove_relations($id_or_obj, $where_query_params);
+	}
+
+
+	/**
+	 * Gets all the related items of the specified $model_name, using $query_params.
+	 * Note: by default, we remove the "default query params"
+	 * because we want to get even deleted items etc.
+	 *
+	 * @param mixed  $id_or_obj    EE_Base_Class child or its ID
+	 * @param string $model_name   like 'Event', 'Registration', etc. always singular
+	 * @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[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_related($id_or_obj, $model_name, $query_params = null)
+	{
+		$model_obj         = $this->ensure_is_obj($id_or_obj);
+		$relation_settings = $this->related_settings_for($model_name);
+		return $relation_settings->get_all_related($model_obj, $query_params);
+	}
+
+
+	/**
+	 * Deletes all the model objects across the relation indicated by $model_name
+	 * which are related to $id_or_obj which meet the criteria set in $query_params.
+	 * However, if the model objects can't be deleted because of blocking related model objects, then
+	 * they aren't deleted. (Unless the thing that would have been deleted can be soft-deleted, that still happens).
+	 *
+	 * @param EE_Base_Class|int|string $id_or_obj
+	 * @param string                   $model_name
+	 * @param array                    $query_params
+	 * @return int how many deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_related($id_or_obj, $model_name, $query_params = [])
+	{
+		$model_obj         = $this->ensure_is_obj($id_or_obj);
+		$relation_settings = $this->related_settings_for($model_name);
+		return $relation_settings->delete_all_related($model_obj, $query_params);
+	}
+
+
+	/**
+	 * Hard deletes all the model objects across the relation indicated by $model_name
+	 * which are related to $id_or_obj which meet the criteria set in $query_params. If
+	 * the model objects can't be hard deleted because of blocking related model objects,
+	 * just does a soft-delete on them instead.
+	 *
+	 * @param EE_Base_Class|int|string $id_or_obj
+	 * @param string                   $model_name
+	 * @param array                    $query_params
+	 * @return int how many deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_related_permanently($id_or_obj, $model_name, $query_params = [])
+	{
+		$model_obj         = $this->ensure_is_obj($id_or_obj);
+		$relation_settings = $this->related_settings_for($model_name);
+		return $relation_settings->delete_related_permanently($model_obj, $query_params);
+	}
+
+
+	/**
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
+	 * unless otherwise specified in the $query_params
+	 *
+	 * @param int             /EE_Base_Class $id_or_obj
+	 * @param string $model_name     like 'Event', or 'Registration'
+	 * @param array  $query_params   @see
+	 *                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
+	 *                               that by the setting $distinct to TRUE;
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_related(
+		$id_or_obj,
+		$model_name,
+		$query_params = [],
+		$field_to_count = null,
+		$distinct = false
+	) {
+		$related_model = $this->get_related_model_obj($model_name);
+		// we're just going to use the query params on the related model's normal get_all query,
+		// except add a condition to say to match the current mod
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
+		}
+		$this_model_name                                                 = $this->get_this_model_name();
+		$this_pk_field_name                                              = $this->get_primary_key_field()->get_name();
+		$query_params[0][ $this_model_name . "." . $this_pk_field_name ] = $id_or_obj;
+		return $related_model->count($query_params, $field_to_count, $distinct);
+	}
+
+
+	/**
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
+	 *
+	 * @param int           /EE_Base_Class $id_or_obj
+	 * @param string $model_name   like 'Event', or 'Registration'
+	 * @param array  $query_params @see
+	 *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @param string $field_to_sum name of field to count by. By default, uses primary key
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
+	{
+		$related_model = $this->get_related_model_obj($model_name);
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong(
+				'EEM_Base::sum_related',
+				sprintf(
+					esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)
+				),
+				'4.6.0'
+			);
+			$query_params = [];
+		}
+		// we're just going to use the query params on the related model's normal get_all query,
+		// except add a condition to say to match the current mod
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
+		}
+		$this_model_name                                                 = $this->get_this_model_name();
+		$this_pk_field_name                                              = $this->get_primary_key_field()->get_name();
+		$query_params[0][ $this_model_name . "." . $this_pk_field_name ] = $id_or_obj;
+		return $related_model->sum($query_params, $field_to_sum);
+	}
+
+
+	/**
+	 * Uses $this->_relatedModels info to find the first related model object of relation $relationName to the given
+	 * $modelObject
+	 *
+	 * @param int | EE_Base_Class $id_or_obj        EE_Base_Class child or its ID
+	 * @param string              $other_model_name , key in $this->_relatedModels, eg 'Registration', or 'Events'
+	 * @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
+	 * @throws EE_Error
+	 */
+	public function get_first_related(EE_Base_Class $id_or_obj, $other_model_name, $query_params)
+	{
+		$query_params['limit'] = 1;
+		$results               = $this->get_all_related($id_or_obj, $other_model_name, $query_params);
+		if ($results) {
+			return array_shift($results);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the model's name as it's expected in queries. For example, if this is EEM_Event model, that would be Event
+	 *
+	 * @return string
+	 */
+	public function get_this_model_name()
+	{
+		return str_replace("EEM_", "", get_class($this));
+	}
+
+
+	/**
+	 * Gets the model field on this model which is of type EE_Any_Foreign_Model_Name_Field
+	 *
+	 * @return EE_Any_Foreign_Model_Name_Field
+	 * @throws EE_Error
+	 */
+	public function get_field_containing_related_model_name()
+	{
+		foreach ($this->field_settings(true) as $field) {
+			if ($field instanceof EE_Any_Foreign_Model_Name_Field) {
+				$field_with_model_name = $field;
+			}
+		}
+		if (! isset($field_with_model_name) || ! $field_with_model_name) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
+					$this->get_this_model_name()
+				)
+			);
+		}
+		return $field_with_model_name;
+	}
+
+
+	/**
+	 * Inserts a new entry into the database, for each table.
+	 * Note: does not add the item to the entity map because that is done by EE_Base_Class::save() right after this.
+	 * If client code uses EEM_Base::insert() directly, then although the item isn't in the entity map,
+	 * we also know there is no model object with the newly inserted item's ID at the moment (because
+	 * if there were, then they would already be in the DB and this would fail); and in the future if someone
+	 * creates a model object with this ID (or grabs it from the DB) then it will be added to the
+	 * entity map at that time anyways. SO, no need for EEM_Base::insert ot add to the entity map
+	 *
+	 * @param array $field_n_values keys are field names, values are their values (in the client code's domain if
+	 *                              $values_already_prepared_by_model_object is false, in the model object's domain if
+	 *                              $values_already_prepared_by_model_object is true. See comment about this at the top
+	 *                              of EEM_Base)
+	 * @return int|string new primary key on main table that got inserted
+	 * @throws EE_Error
+	 */
+	public function insert($field_n_values)
+	{
+		/**
+		 * Filters the fields and their values before inserting an item using the models
+		 *
+		 * @param array    $fields_n_values keys are the fields and values are their new values
+		 * @param EEM_Base $model           the model used
+		 */
+		$field_n_values = (array) apply_filters('FHEE__EEM_Base__insert__fields_n_values', $field_n_values, $this);
+		if ($this->_satisfies_unique_indexes($field_n_values)) {
+			$main_table = $this->_get_main_table();
+			$new_id     = $this->_insert_into_specific_table($main_table, $field_n_values, false);
+			if ($new_id !== false) {
+				foreach ($this->_get_other_tables() as $other_table) {
+					$this->_insert_into_specific_table($other_table, $field_n_values, $new_id);
+				}
+			}
+			/**
+			 * Done just after attempting to insert a new model object
+			 *
+			 * @param EEM_Base $model           used
+			 * @param array    $fields_n_values fields and their values
+			 * @param int|string the              ID of the newly-inserted model object
+			 */
+			do_action('AHEE__EEM_Base__insert__end', $this, $field_n_values, $new_id);
+			return $new_id;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Checks that the result would satisfy the unique indexes on this model
+	 *
+	 * @param array  $field_n_values
+	 * @param string $action
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	protected function _satisfies_unique_indexes($field_n_values, $action = 'insert')
+	{
+		foreach ($this->unique_indexes() as $index_name => $index) {
+			$uniqueness_where_params = array_intersect_key($field_n_values, $index->fields());
+			if ($this->exists([$uniqueness_where_params])) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							"Could not %s %s. %s uniqueness index failed. Fields %s must form a unique set, but an entry already exists with values %s.",
+							"event_espresso"
+						),
+						$action,
+						$this->_get_class_name(),
+						$index_name,
+						implode(",", $index->field_names()),
+						http_build_query($uniqueness_where_params)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * Checks the database for an item that conflicts (ie, if this item were
+	 * saved to the DB would break some uniqueness requirement, like a primary key
+	 * or an index primary key set) with the item specified. $id_obj_or_fields_array
+	 * can be either an EE_Base_Class or an array of fields n values
+	 *
+	 * @param EE_Base_Class|array $obj_or_fields_array
+	 * @param boolean             $include_primary_key whether to use the model object's primary key
+	 *                                                 when looking for conflicts
+	 *                                                 (ie, if false, we ignore the model object's primary key
+	 *                                                 when finding "conflicts". If true, it's also considered).
+	 *                                                 Only works for INT primary key,
+	 *                                                 STRING primary keys cannot be ignored
+	 * @return EE_Base_Class|array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_one_conflicting($obj_or_fields_array, $include_primary_key = true)
+	{
+		if ($obj_or_fields_array instanceof EE_Base_Class) {
+			$fields_n_values = $obj_or_fields_array->model_field_array();
+		} elseif (is_array($obj_or_fields_array)) {
+			$fields_n_values = $obj_or_fields_array;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"%s get_all_conflicting should be called with a model object or an array of field names and values, you provided %d",
+						"event_espresso"
+					),
+					get_class($this),
+					$obj_or_fields_array
+				)
+			);
+		}
+		$query_params = [];
+		if (
+			$this->has_primary_key_field()
+			&& ($include_primary_key
+				|| $this->get_primary_key_field()
+				   instanceof
+				   EE_Primary_Key_String_Field)
+			&& isset($fields_n_values[ $this->primary_key_name() ])
+		) {
+			$query_params[0]['OR'][ $this->primary_key_name() ] = $fields_n_values[ $this->primary_key_name() ];
+		}
+		foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
+			$uniqueness_where_params                              =
+				array_intersect_key($fields_n_values, $unique_index->fields());
+			$query_params[0]['OR'][ 'AND*' . $unique_index_name ] = $uniqueness_where_params;
+		}
+		// if there is nothing to base this search on, then we shouldn't find anything
+		if (empty($query_params)) {
+			return [];
+		}
+		return $this->get_one($query_params);
+	}
+
+
+	/**
+	 * Like count, but is optimized and returns a boolean instead of an int
+	 *
+	 * @param array $query_params
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function exists($query_params)
+	{
+		$query_params['limit'] = 1;
+		return $this->count($query_params) > 0;
+	}
+
+
+	/**
+	 * Wrapper for exists, except ignores default query parameters so we're only considering ID
+	 *
+	 * @param int|string $id
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function exists_by_ID($id)
+	{
+		return $this->exists(
+			[
+				'default_where_conditions' => EEM_Base::default_where_conditions_none,
+				[
+					$this->primary_key_name() => $id,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Inserts a new row in $table, using the $cols_n_values which apply to that table.
+	 * If a $new_id is supplied and if $table is an EE_Other_Table, we assume
+	 * we need to add a foreign key column to point to $new_id (which should be the primary key's value
+	 * on the main table)
+	 * This is protected rather than private because private is not accessible to any child methods and there MAY be
+	 * cases where we want to call it directly rather than via insert().
+	 *
+	 * @access   protected
+	 * @param EE_Table_Base $table
+	 * @param array         $fields_n_values each key should be in field's keys, and value should be an int, string or
+	 *                                       float
+	 * @param int           $new_id          for now we assume only int keys
+	 * @return int ID of new row inserted, or FALSE on failure
+	 * @throws EE_Error
+	 * @global WPDB         $wpdb            only used to get the $wpdb->insert_id after performing an insert
+	 */
+	protected function _insert_into_specific_table(EE_Table_Base $table, $fields_n_values, $new_id = 0)
+	{
+		global $wpdb;
+		$insertion_col_n_values = [];
+		$format_for_insertion   = [];
+		$fields_on_table        = $this->_get_fields_for_table($table->get_table_alias());
+		foreach ($fields_on_table as $field_name => $field_obj) {
+			// check if its an auto-incrementing column, in which case we should just leave it to do its autoincrement thing
+			if ($field_obj->is_auto_increment()) {
+				continue;
+			}
+			$prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
+			// if the value we want to assign it to is NULL, just don't mention it for the insertion
+			if ($prepared_value !== null) {
+				$insertion_col_n_values[ $field_obj->get_table_column() ] = $prepared_value;
+				$format_for_insertion[]                                   = $field_obj->get_wpdb_data_type();
+			}
+		}
+		if ($table instanceof EE_Secondary_Table && $new_id) {
+			// its not the main table, so we should have already saved the main table's PK which we just inserted
+			// so add the fk to the main table as a column
+			$insertion_col_n_values[ $table->get_fk_on_table() ] = $new_id;
+			$format_for_insertion[]                              =
+				'%d';// yes right now we're only allowing these foreign keys to be INTs
+		}
+
+		// insert the new entry
+		$result = $this->_do_wpdb_query(
+			'insert',
+			[$table->get_table_name(), $insertion_col_n_values, $format_for_insertion]
+		);
+		if ($result === false) {
+			return false;
+		}
+		// ok, now what do we return for the ID of the newly-inserted thing?
+		if ($this->has_primary_key_field()) {
+			if ($this->get_primary_key_field()->is_auto_increment()) {
+				return $wpdb->insert_id;
+			}
+			// it's not an auto-increment primary key, so
+			// it must have been supplied
+			return $fields_n_values[ $this->get_primary_key_field()->get_name() ];
+		}
+		// we can't return a  primary key because there is none. instead return
+		// a unique string indicating this model
+		return $this->get_index_primary_key_string($fields_n_values);
+	}
+
+
+	/**
+	 * Prepare the $field_obj 's value in $fields_n_values for use in the database.
+	 * If the field doesn't allow NULL, try to use its default. (If it doesn't allow NULL,
+	 * and there is no default, we pass it along. WPDB will take care of it)
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param array               $fields_n_values
+	 * @return mixed string|int|float depending on what the table column will be expecting
+	 * @throws EE_Error
+	 */
+	protected function _prepare_value_or_use_default($field_obj, $fields_n_values)
+	{
+		$field_name = $field_obj->get_name();
+		// if this field doesn't allow nullable, don't allow it
+		if (! $field_obj->is_nullable() && ! isset($fields_n_values[ $field_name ])) {
+			$fields_n_values[ $field_name ] = $field_obj->get_default_value();
+		}
+		$unprepared_value = $fields_n_values[ $field_name ] ?? null;
+		return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
+	}
+
+
+	/**
+	 * Consolidates code for preparing  a value supplied to the model for use int eh db. Calls the field's
+	 * prepare_for_use_in_db method on the value, and depending on $value_already_prepare_by_model_obj, may also call
+	 * the field's prepare_for_set() method.
+	 *
+	 * @param mixed               $value value in the client code domain if $value_already_prepared_by_model_object is
+	 *                                   false, otherwise a value in the model object's domain (see lengthy comment at
+	 *                                   top of file)
+	 * @param EE_Model_Field_Base $field field which will be doing the preparing of the value. If null, we assume
+	 *                                   $value is a custom selection
+	 * @return mixed a value ready for use in the database for insertions, updating, or in a where clause
+	 */
+	private function _prepare_value_for_use_in_db($value, $field)
+	{
+		if ($field instanceof EE_Model_Field_Base) {
+			// phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
+			switch ($this->_values_already_prepared_by_model_object) {
+				/** @noinspection PhpMissingBreakStatementInspection */
+				case self::not_prepared_by_model_object:
+					$value = $field->prepare_for_set($value);
+				// purposefully left out "return"
+				// no break
+				case self::prepared_by_model_object:
+					/** @noinspection SuspiciousAssignmentsInspection */
+					$value = $field->prepare_for_use_in_db($value);
+				// no break
+				case self::prepared_for_use_in_db:
+					// leave the value alone
+			}
+			// phpcs:enable
+		}
+		return $value;
+	}
+
+
+	/**
+	 * Returns the main table on this model
+	 *
+	 * @return EE_Primary_Table
+	 * @throws EE_Error
+	 */
+	protected function _get_main_table()
+	{
+		foreach ($this->_tables as $table) {
+			if ($table instanceof EE_Primary_Table) {
+				return $table;
+			}
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'There are no main tables on %s. They should be added to _tables array in the constructor',
+					'event_espresso'
+				),
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * table
+	 * returns EE_Primary_Table table name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function table()
+	{
+		return $this->_get_main_table()->get_table_name();
+	}
+
+
+	/**
+	 * table
+	 * returns first EE_Secondary_Table table name
+	 *
+	 * @return string
+	 */
+	public function second_table()
+	{
+		// grab second table from tables array
+		$second_table = end($this->_tables);
+		return $second_table instanceof EE_Secondary_Table ? $second_table->get_table_name() : null;
+	}
+
+
+	/**
+	 * get_table_obj_by_alias
+	 * returns table name given it's alias
+	 *
+	 * @param string $table_alias
+	 * @return EE_Primary_Table | EE_Secondary_Table
+	 */
+	public function get_table_obj_by_alias($table_alias = '')
+	{
+		return isset($this->_tables[ $table_alias ]) ? $this->_tables[ $table_alias ] : null;
+	}
+
+
+	/**
+	 * Gets all the tables of type EE_Other_Table from EEM_CPT_Basel_Model::_tables
+	 *
+	 * @return EE_Secondary_Table[]
+	 */
+	protected function _get_other_tables()
+	{
+		$other_tables = [];
+		foreach ($this->_tables as $table_alias => $table) {
+			if ($table instanceof EE_Secondary_Table) {
+				$other_tables[ $table_alias ] = $table;
+			}
+		}
+		return $other_tables;
+	}
+
+
+	/**
+	 * Finds all the fields that correspond to the given table
+	 *
+	 * @param string $table_alias , array key in EEM_Base::_tables
+	 * @return EE_Model_Field_Base[]
+	 */
+	public function _get_fields_for_table($table_alias)
+	{
+		return $this->_fields[ $table_alias ];
+	}
+
+
+	/**
+	 * Recurses through all the where parameters, and finds all the related models we'll need
+	 * to complete this query. Eg, given where parameters like array('EVT_ID'=>3) from within Event model, we won't
+	 * need any related models. But if the array were array('Registrations.REG_ID'=>3), we'd need the related
+	 * Registration model. If it were array('Registrations.Transactions.Payments.PAY_ID'=>3), then we'd need the
+	 * related Registration, Transaction, and Payment models.
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Model_Query_Info_Carrier
+	 * @throws EE_Error
+	 */
+	public function _extract_related_models_from_query($query_params)
+	{
+		$query_info_carrier = new EE_Model_Query_Info_Carrier();
+		if (array_key_exists(0, $query_params)) {
+			$this->_extract_related_models_from_sub_params_array_keys($query_params[0], $query_info_carrier, 0);
+		}
+		if (array_key_exists('group_by', $query_params)) {
+			if (is_array($query_params['group_by'])) {
+				$this->_extract_related_models_from_sub_params_array_values(
+					$query_params['group_by'],
+					$query_info_carrier,
+					'group_by'
+				);
+			} elseif (! empty($query_params['group_by'])) {
+				$this->_extract_related_model_info_from_query_param(
+					$query_params['group_by'],
+					$query_info_carrier,
+					'group_by'
+				);
+			}
+		}
+		if (array_key_exists('having', $query_params)) {
+			$this->_extract_related_models_from_sub_params_array_keys(
+				$query_params[0],
+				$query_info_carrier,
+				'having'
+			);
+		}
+		if (array_key_exists('order_by', $query_params)) {
+			if (is_array($query_params['order_by'])) {
+				$this->_extract_related_models_from_sub_params_array_keys(
+					$query_params['order_by'],
+					$query_info_carrier,
+					'order_by'
+				);
+			} elseif (! empty($query_params['order_by'])) {
+				$this->_extract_related_model_info_from_query_param(
+					$query_params['order_by'],
+					$query_info_carrier,
+					'order_by'
+				);
+			}
+		}
+		if (array_key_exists('force_join', $query_params)) {
+			$this->_extract_related_models_from_sub_params_array_values(
+				$query_params['force_join'],
+				$query_info_carrier,
+				'force_join'
+			);
+		}
+		$this->extractRelatedModelsFromCustomSelects($query_info_carrier);
+		return $query_info_carrier;
+	}
+
+
+	/**
+	 * For extracting related models from WHERE (0), HAVING (having), ORDER BY (order_by) or forced joins (force_join)
+	 *
+	 * @param array                       $sub_query_params @see
+	 *                                                      https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#-0-where-conditions
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
+	 * @return EE_Model_Query_Info_Carrier
+	 * @throws EE_Error
+	 */
+	private function _extract_related_models_from_sub_params_array_keys(
+		$sub_query_params,
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
+		$query_param_type
+	) {
+		if (! empty($sub_query_params)) {
+			$sub_query_params = (array) $sub_query_params;
+			foreach ($sub_query_params as $param => $possibly_array_of_params) {
+				// $param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
+				$this->_extract_related_model_info_from_query_param(
+					$param,
+					$model_query_info_carrier,
+					$query_param_type
+				);
+				// if $possibly_array_of_params is an array, try recursing into it, searching for keys which
+				// indicate needed joins. Eg, array('NOT'=>array('Registration.TXN_ID'=>23)). In this case, we tried
+				// extracting models out of the 'NOT', which obviously wasn't successful, and then we recurse into the value
+				// of array('Registration.TXN_ID'=>23)
+				$query_param_sans_stars =
+					$this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
+				if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
+					if (! is_array($possibly_array_of_params)) {
+						throw new EE_Error(
+							sprintf(
+								esc_html__(
+									"You used a special where query param %s, but the value isn't an array of where query params, it's just %s'. It should be an array, eg array('EVT_ID'=>23,'OR'=>array('Venue.VNU_ID'=>32,'Venue.VNU_name'=>'monkey_land'))",
+									"event_espresso"
+								),
+								$param,
+								$possibly_array_of_params
+							)
+						);
+					}
+					$this->_extract_related_models_from_sub_params_array_keys(
+						$possibly_array_of_params,
+						$model_query_info_carrier,
+						$query_param_type
+					);
+				} elseif (
+					$query_param_type === 0 // ie WHERE
+					&& is_array($possibly_array_of_params)
+					&& isset($possibly_array_of_params[2])
+					&& $possibly_array_of_params[2] == true
+				) {
+					// then $possible_array_of_params looks something like array('<','DTT_sold',true)
+					// indicating that $possible_array_of_params[1] is actually a field name,
+					// from which we should extract query parameters!
+					if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
+						throw new EE_Error(
+							sprintf(
+								esc_html__(
+									"Improperly formed query parameter %s. It should be numerically indexed like array('<','DTT_sold',true); but you provided %s",
+									"event_espresso"
+								),
+								$query_param_type,
+								implode(",", $possibly_array_of_params)
+							)
+						);
+					}
+					$this->_extract_related_model_info_from_query_param(
+						$possibly_array_of_params[1],
+						$model_query_info_carrier,
+						$query_param_type
+					);
+				}
+			}
+		}
+		return $model_query_info_carrier;
+	}
+
+
+	/**
+	 * For extracting related models from forced_joins, where the array values contain the info about what
+	 * models to join with. Eg an array like array('Attendee','Price.Price_Type');
+	 *
+	 * @param array                       $sub_query_params @see
+	 *                                                      https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @param EE_Model_Query_Info_Carrier $model_query_info_carrier
+	 * @param string                      $query_param_type one of $this->_allowed_query_params
+	 * @return EE_Model_Query_Info_Carrier
+	 * @throws EE_Error
+	 */
+	private function _extract_related_models_from_sub_params_array_values(
+		$sub_query_params,
+		EE_Model_Query_Info_Carrier $model_query_info_carrier,
+		$query_param_type
+	) {
+		if (! empty($sub_query_params)) {
+			if (! is_array($sub_query_params)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
+						$sub_query_params
+					)
+				);
+			}
+			foreach ($sub_query_params as $param) {
+				// $param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
+				$this->_extract_related_model_info_from_query_param(
+					$param,
+					$model_query_info_carrier,
+					$query_param_type
+				);
+			}
+		}
+		return $model_query_info_carrier;
+	}
+
+
+	/**
+	 * Extract all the query parts from  model query params
+	 * and put into a EEM_Related_Model_Info_Carrier for easy extraction into a query. We create this object
+	 * instead of directly constructing the SQL because often we need to extract info from the $query_params
+	 * but use them in a different order. Eg, we need to know what models we are querying
+	 * before we know what joins to perform. However, we need to know what data types correspond to which fields on
+	 * other models before we can finalize the where clause SQL.
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Model_Query_Info_Carrier
+	 * @throws EE_Error
+	 * @throws ModelConfigurationException*@throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	public function _create_model_query_info_carrier($query_params)
+	{
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong(
+				'EEM_Base::_create_model_query_info_carrier',
+				sprintf(
+					esc_html__(
+						'$query_params should be an array, you passed a variable of type %s',
+						'event_espresso'
+					),
+					gettype($query_params)
+				),
+				'4.6.0'
+			);
+			$query_params = [];
+		}
+		$query_params[0] = isset($query_params[0]) ? $query_params[0] : [];
+		// first check if we should alter the query to account for caps or not
+		// because the caps might require us to do extra joins
+		if (isset($query_params['caps']) && $query_params['caps'] !== 'none') {
+			$query_params[0] = array_replace_recursive(
+				$query_params[0],
+				$this->caps_where_conditions($query_params['caps'])
+			);
+		}
+
+		// check if we should alter the query to remove data related to protected
+		// custom post types
+		if (isset($query_params['exclude_protected']) && $query_params['exclude_protected'] === true) {
+			$where_param_key_for_password = $this->modelChainAndPassword();
+			// only include if related to a cpt where no password has been set
+			$query_params[0]['OR*nopassword'] = [
+				$where_param_key_for_password       => '',
+				$where_param_key_for_password . '*' => ['IS_NULL'],
+			];
+		}
+		$query_object = $this->_extract_related_models_from_query($query_params);
+		// verify where_query_params has NO numeric indexes.... that's simply not how you use it!
+		foreach ($query_params[0] as $key => $value) {
+			if (is_int($key)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"WHERE query params must NOT be numerically-indexed. You provided the array key '%s' for value '%s' while querying model %s. All the query params provided were '%s' Please read documentation on EEM_Base::get_all.",
+							"event_espresso"
+						),
+						$key,
+						var_export($value, true),
+						var_export($query_params, true),
+						get_class($this)
+					)
+				);
+			}
+		}
+		if (
+			array_key_exists('default_where_conditions', $query_params)
+			&& ! empty($query_params['default_where_conditions'])
+		) {
+			$use_default_where_conditions = $query_params['default_where_conditions'];
+		} else {
+			$use_default_where_conditions = EEM_Base::default_where_conditions_all;
+		}
+		$query_params[0] = array_merge(
+			$this->_get_default_where_conditions_for_models_in_query(
+				$query_object,
+				$use_default_where_conditions,
+				$query_params[0]
+			),
+			$query_params[0]
+		);
+		$query_object->set_where_sql($this->_construct_where_clause($query_params[0]));
+		// if this is a "on_join_limit" then we are limiting on on a specific table in a multi_table join.
+		// So we need to setup a subquery and use that for the main join.
+		// Note for now this only works on the primary table for the model.
+		// So for instance, you could set the limit array like this:
+		// array( 'on_join_limit' => array('Primary_Table_Alias', array(1,10) ) )
+		if (array_key_exists('on_join_limit', $query_params) && ! empty($query_params['on_join_limit'])) {
+			$query_object->set_main_model_join_sql(
+				$this->_construct_limit_join_select(
+					$query_params['on_join_limit'][0],
+					$query_params['on_join_limit'][1]
+				)
+			);
+		}
+		// set limit
+		if (array_key_exists('limit', $query_params)) {
+			if (is_array($query_params['limit'])) {
+				if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
+					$e = sprintf(
+						esc_html__(
+							"Invalid DB query. You passed '%s' for the LIMIT, but only the following are valid: an integer, string representing an integer, a string like 'int,int', or an array like array(int,int)",
+							"event_espresso"
+						),
+						http_build_query($query_params['limit'])
+					);
+					throw new EE_Error($e . "|" . $e);
+				}
+				// they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
+			} elseif (! empty($query_params['limit'])) {
+				$query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
+			}
+		}
+		// set order by
+		if (array_key_exists('order_by', $query_params)) {
+			if (is_array($query_params['order_by'])) {
+				// if they're using 'order_by' as an array, they can't use 'order' (because 'order_by' must
+				// specify whether to ascend or descend on each field. Eg 'order_by'=>array('EVT_ID'=>'ASC'). So
+				// including 'order' wouldn't make any sense if 'order_by' has already specified which way to order!
+				if (array_key_exists('order', $query_params)) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								"In querying %s, we are using query parameter 'order_by' as an array (keys:%s,values:%s), and so we can't use query parameter 'order' (value %s). You should just use the 'order_by' parameter ",
+								"event_espresso"
+							),
+							get_class($this),
+							implode(", ", array_keys($query_params['order_by'])),
+							implode(", ", $query_params['order_by']),
+							$query_params['order']
+						)
+					);
+				}
+				$this->_extract_related_models_from_sub_params_array_keys(
+					$query_params['order_by'],
+					$query_object,
+					'order_by'
+				);
+				// assume it's an array of fields to order by
+				$order_array = [];
+				foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
+					$order         = $this->_extract_order($order);
+					$order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
+				}
+				$query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
+			} elseif (! empty($query_params['order_by'])) {
+				$this->_extract_related_model_info_from_query_param(
+					$query_params['order_by'],
+					$query_object,
+					'order',
+					$query_params['order_by']
+				);
+				$order = isset($query_params['order'])
+					? $this->_extract_order($query_params['order'])
+					: 'DESC';
+				$query_object->set_order_by_sql(
+					" ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
+				);
+			}
+		}
+		// if 'order_by' wasn't set, maybe they are just using 'order' on its own?
+		if (
+			! array_key_exists('order_by', $query_params)
+			&& array_key_exists('order', $query_params)
+			&& ! empty($query_params['order'])
+		) {
+			$pk_field = $this->get_primary_key_field();
+			$order    = $this->_extract_order($query_params['order']);
+			$query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
+		}
+		// set group by
+		if (array_key_exists('group_by', $query_params)) {
+			if (is_array($query_params['group_by'])) {
+				// it's an array, so assume we'll be grouping by a bunch of stuff
+				$group_by_array = [];
+				foreach ($query_params['group_by'] as $field_name_to_group_by) {
+					$group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
+				}
+				$query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
+			} elseif (! empty($query_params['group_by'])) {
+				$query_object->set_group_by_sql(
+					" GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
+				);
+			}
+		}
+		// set having
+		if (array_key_exists('having', $query_params) && $query_params['having']) {
+			$query_object->set_having_sql($this->_construct_having_clause($query_params['having']));
+		}
+		// now, just verify they didn't pass anything wack
+		foreach ($query_params as $query_key => $query_value) {
+			if (! in_array($query_key, $this->_allowed_query_params, true)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"You passed %s as a query parameter to %s, which is illegal! The allowed query parameters are %s",
+							'event_espresso'
+						),
+						$query_key,
+						get_class($this),
+						//                      print_r( $this->_allowed_query_params, TRUE )
+						implode(',', $this->_allowed_query_params)
+					)
+				);
+			}
+		}
+		$main_model_join_sql = $query_object->get_main_model_join_sql();
+		if (empty($main_model_join_sql)) {
+			$query_object->set_main_model_join_sql($this->_construct_internal_join());
+		}
+		return $query_object;
+	}
+
+
+	/**
+	 * Gets the where conditions that should be imposed on the query based on the
+	 * context (eg reading frontend, backend, edit or delete).
+	 *
+	 * @param string $context one of EEM_Base::valid_cap_contexts()
+	 * @return array @see
+	 *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @throws EE_Error
+	 */
+	public function caps_where_conditions($context = self::caps_read)
+	{
+		EEM_Base::verify_is_valid_cap_context($context);
+		$cap_where_conditions = [];
+		$cap_restrictions     = $this->caps_missing($context);
+		/**
+		 * @var $cap_restrictions EE_Default_Where_Conditions[]
+		 */
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
+			$cap_where_conditions = array_replace_recursive(
+				$cap_where_conditions,
+				$restriction_if_no_cap->get_default_where_conditions()
+			);
+		}
+		return apply_filters(
+			'FHEE__EEM_Base__caps_where_conditions__return',
+			$cap_where_conditions,
+			$this,
+			$context,
+			$cap_restrictions
+		);
+	}
+
+
+	/**
+	 * Verifies that $should_be_order_string is in $this->_allowed_order_values,
+	 * otherwise throws an exception
+	 *
+	 * @param string $should_be_order_string
+	 * @return string either ASC, asc, DESC or desc
+	 * @throws EE_Error
+	 */
+	private function _extract_order($should_be_order_string)
+	{
+		if (in_array($should_be_order_string, $this->_allowed_order_values)) {
+			return $should_be_order_string;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"While performing a query on '%s', tried to use '%s' as an order parameter. ",
+					"event_espresso"
+				),
+				get_class($this),
+				$should_be_order_string
+			)
+		);
+	}
+
+
+	/**
+	 * Looks at all the models which are included in this query, and asks each
+	 * for their universal_where_params, and returns them in the same format as $query_params[0] (where),
+	 * so they can be merged
+	 *
+	 * @param EE_Model_Query_Info_Carrier $query_info_carrier
+	 * @param string                      $use_default_where_conditions can be 'none','other_models_only', or 'all'.
+	 *                                                                  'none' means NO default where conditions will
+	 *                                                                  be used AT ALL during this query.
+	 *                                                                  'other_models_only' means default where
+	 *                                                                  conditions from other models will be used, but
+	 *                                                                  not for this primary model. 'all', the default,
+	 *                                                                  means default where conditions will apply as
+	 *                                                                  normal
+	 * @param array                       $where_query_params           @see
+	 *                                                                  https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @throws EE_Error
+	 */
+	private function _get_default_where_conditions_for_models_in_query(
+		EE_Model_Query_Info_Carrier $query_info_carrier,
+		$use_default_where_conditions = EEM_Base::default_where_conditions_all,
+		$where_query_params = []
+	) {
+		$allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
+		if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"You passed an invalid value to the query parameter 'default_where_conditions' of '%s'. Allowed values are %s",
+						"event_espresso"
+					),
+					$use_default_where_conditions,
+					implode(", ", $allowed_used_default_where_conditions_values)
+				)
+			);
+		}
+		$universal_query_params = [];
+		if ($this->_should_use_default_where_conditions($use_default_where_conditions, true)) {
+			$universal_query_params = $this->_get_default_where_conditions();
+		} elseif ($this->_should_use_minimum_where_conditions($use_default_where_conditions, true)) {
+			$universal_query_params = $this->_get_minimum_where_conditions();
+		}
+		foreach ($query_info_carrier->get_model_names_included() as $model_relation_path => $model_name) {
+			$related_model = $this->get_related_model_obj($model_name);
+			if ($this->_should_use_default_where_conditions($use_default_where_conditions, false)) {
+				$related_model_universal_where_params =
+					$related_model->_get_default_where_conditions($model_relation_path);
+			} elseif ($this->_should_use_minimum_where_conditions($use_default_where_conditions, false)) {
+				$related_model_universal_where_params =
+					$related_model->_get_minimum_where_conditions($model_relation_path);
+			} else {
+				// we don't want to add full or even minimum default where conditions from this model, so just continue
+				continue;
+			}
+			$overrides              = $this->_override_defaults_or_make_null_friendly(
+				$related_model_universal_where_params,
+				$where_query_params,
+				$related_model,
+				$model_relation_path
+			);
+			$universal_query_params = EEH_Array::merge_arrays_and_overwrite_keys(
+				$universal_query_params,
+				$overrides
+			);
+		}
+		return $universal_query_params;
+	}
+
+
+	/**
+	 * Determines whether or not we should use default where conditions for the model in question
+	 * (this model, or other related models).
+	 * Basically, we should use default where conditions on this model if they have requested to use them on all models,
+	 * this model only, or to use minimum where conditions on all other models and normal where conditions on this one.
+	 * We should use default where conditions on related models when they requested to use default where conditions
+	 * on all models, or specifically just on other related models
+	 *
+	 * @param      $default_where_conditions_value
+	 * @param bool $for_this_model false means this is for OTHER related models
+	 * @return bool
+	 */
+	private function _should_use_default_where_conditions($default_where_conditions_value, $for_this_model = true)
+	{
+		return (
+				   $for_this_model
+				   && in_array(
+					   $default_where_conditions_value,
+					   [
+						   EEM_Base::default_where_conditions_all,
+						   EEM_Base::default_where_conditions_this_only,
+						   EEM_Base::default_where_conditions_minimum_others,
+					   ],
+					   true
+				   )
+			   )
+			   || (
+				   ! $for_this_model
+				   && in_array(
+					   $default_where_conditions_value,
+					   [
+						   EEM_Base::default_where_conditions_all,
+						   EEM_Base::default_where_conditions_others_only,
+					   ],
+					   true
+				   )
+			   );
+	}
+
+
+	/**
+	 * Determines whether or not we should use default minimum conditions for the model in question
+	 * (this model, or other related models).
+	 * Basically, we should use minimum where conditions on this model only if they requested all models to use minimum
+	 * where conditions.
+	 * We should use minimum where conditions on related models if they requested to use minimum where conditions
+	 * on this model or others
+	 *
+	 * @param      $default_where_conditions_value
+	 * @param bool $for_this_model false means this is for OTHER related models
+	 * @return bool
+	 */
+	private function _should_use_minimum_where_conditions($default_where_conditions_value, $for_this_model = true)
+	{
+		return (
+				   $for_this_model
+				   && $default_where_conditions_value === EEM_Base::default_where_conditions_minimum_all
+			   )
+			   || (
+				   ! $for_this_model
+				   && in_array(
+					   $default_where_conditions_value,
+					   [
+						   EEM_Base::default_where_conditions_minimum_others,
+						   EEM_Base::default_where_conditions_minimum_all,
+					   ],
+					   true
+				   )
+			   );
+	}
+
+
+	/**
+	 * Checks if any of the defaults have been overridden. If there are any that AREN'T overridden,
+	 * then we also add a special where condition which allows for that model's primary key
+	 * to be null (which is important for JOINs. Eg, if you want to see all Events ordered by Venue's name,
+	 * then Event's with NO Venue won't appear unless you allow VNU_ID to be NULL)
+	 *
+	 * @param array    $default_where_conditions
+	 * @param array    $provided_where_conditions
+	 * @param EEM_Base $model
+	 * @param string   $model_relation_path like 'Transaction.Payment.'
+	 * @return array @see
+	 *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @throws EE_Error
+	 */
+	private function _override_defaults_or_make_null_friendly(
+		$default_where_conditions,
+		$provided_where_conditions,
+		$model,
+		$model_relation_path
+	) {
+		$null_friendly_where_conditions = [];
+		$none_overridden                = true;
+		$or_condition_key_for_defaults  = 'OR*' . get_class($model);
+		foreach ($default_where_conditions as $key => $val) {
+			if (isset($provided_where_conditions[ $key ])) {
+				$none_overridden = false;
+			} else {
+				$null_friendly_where_conditions[ $or_condition_key_for_defaults ]['AND'][ $key ] = $val;
+			}
+		}
+		if ($none_overridden && $default_where_conditions) {
+			if ($model->has_primary_key_field()) {
+				$null_friendly_where_conditions[ $or_condition_key_for_defaults ][ $model_relation_path
+																				   . "."
+																				   . $model->primary_key_name() ] =
+					['IS NULL'];
+			}/*else{
                 //@todo NO PK, use other defaults
             }*/
-        }
-        return $null_friendly_where_conditions;
-    }
-
-
-    /**
-     * Uses the _default_where_conditions_strategy set during __construct() to get
-     * default where conditions on all get_all, update, and delete queries done by this model.
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
-     * NOT array('Event_CPT.post_type'=>'esp_event').
-     *
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
-     * @return array @see
-     *                                    https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    private function _get_default_where_conditions($model_relation_path = '')
-    {
-        if ($this->_ignore_where_strategy) {
-            return [];
-        }
-        return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
-    }
-
-
-    /**
-     * Uses the _minimum_where_conditions_strategy set during __construct() to get
-     * minimum where conditions on all get_all, update, and delete queries done by this model.
-     * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
-     * NOT array('Event_CPT.post_type'=>'esp_event').
-     * Similar to _get_default_where_conditions
-     *
-     * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
-     * @return array @see
-     *                                    https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _get_minimum_where_conditions($model_relation_path = '')
-    {
-        if ($this->_ignore_where_strategy) {
-            return [];
-        }
-        return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
-    }
-
-
-    /**
-     * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
-     * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
-     *
-     * @param EE_Model_Query_Info_Carrier $model_query_info
-     * @return string
-     * @throws EE_Error
-     */
-    private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
-    {
-        $selects = $this->_get_columns_to_select_for_this_model();
-        foreach (
-            $model_query_info->get_model_names_included() as $model_relation_chain => $name_of_other_model_included
-        ) {
-            $other_model_included = $this->get_related_model_obj($name_of_other_model_included);
-            $other_model_selects  = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
-            foreach ($other_model_selects as $key => $value) {
-                $selects[] = $value;
-            }
-        }
-        return implode(", ", $selects);
-    }
-
-
-    /**
-     * Gets an array of columns to select for this model, which are necessary for it to create its objects.
-     * So that's going to be the columns for all the fields on the model
-     *
-     * @param string $model_relation_chain like 'Question.Question_Group.Event'
-     * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
-     */
-    public function _get_columns_to_select_for_this_model($model_relation_chain = '')
-    {
-        $fields                                       = $this->field_settings();
-        $selects                                      = [];
-        $table_alias_with_model_relation_chain_prefix =
-            EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $model_relation_chain,
-                $this->get_this_model_name()
-            );
-        foreach ($fields as $field_obj) {
-            $selects[] = $table_alias_with_model_relation_chain_prefix
-                         . $field_obj->get_table_alias()
-                         . "."
-                         . $field_obj->get_table_column()
-                         . " AS '"
-                         . $table_alias_with_model_relation_chain_prefix
-                         . $field_obj->get_table_alias()
-                         . "."
-                         . $field_obj->get_table_column()
-                         . "'";
-        }
-        // make sure we are also getting the PKs of each table
-        $tables = $this->get_tables();
-        if (count($tables) > 1) {
-            foreach ($tables as $table_obj) {
-                $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
-                                       . $table_obj->get_fully_qualified_pk_column();
-                if (! in_array($qualified_pk_column, $selects)) {
-                    $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
-                }
-            }
-        }
-        return $selects;
-    }
-
-
-    /**
-     * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
-     * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
-     * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
-     * SQL for joining, and the data types
-     *
-     * @param null|string                 $original_query_param
-     * @param string                      $query_param          like Registration.Transaction.TXN_ID
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
-     * @param string                      $query_param_type     like Registration.Transaction.TXN_ID
-     *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
-     *                                                          column name. We only want model names, eg 'Event.Venue'
-     *                                                          or 'Registration's
-     * @param string                      $original_query_param what it originally was (eg
-     *                                                          Registration.Transaction.TXN_ID). If null, we assume it
-     *                                                          matches $query_param
-     * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
-     * @throws EE_Error
-     */
-    private function _extract_related_model_info_from_query_param(
-        $query_param,
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
-        $query_param_type,
-        $original_query_param = null
-    ) {
-        if ($original_query_param === null) {
-            $original_query_param = $query_param;
-        }
-        $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
-        // check to see if we have a field on this model
-        $this_model_fields = $this->field_settings(true);
-        if (array_key_exists($query_param, $this_model_fields)) {
-            $field_is_allowed = in_array(
-                $query_param_type,
-                [0, 'where', 'having', 'order_by', 'group_by', 'order', 'custom_selects'],
-                true
-            );
-            if ($field_is_allowed) {
-                return;
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
-                        "event_espresso"
-                    ),
-                    $query_param,
-                    get_class($this),
-                    $query_param_type,
-                    $original_query_param
-                )
-            );
-        }
-        // check if this is a special logic query param
-        if (in_array($query_param, $this->_logic_query_param_keys, true)) {
-            $operator_is_allowed = in_array($query_param_type, ['where', 'having', 0, 'custom_selects'], true);
-            if ($operator_is_allowed) {
-                return;
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Logic query params ("%1$s") are being used incorrectly with the following query param ("%2$s") on model %3$s. %4$sAdditional Info:%4$s%5$s',
-                        'event_espresso'
-                    ),
-                    implode('", "', $this->_logic_query_param_keys),
-                    $query_param,
-                    get_class($this),
-                    '<br />',
-                    "\t"
-                    . ' $passed_in_query_info = <pre>'
-                    . print_r($passed_in_query_info, true)
-                    . '</pre>'
-                    . "\n\t"
-                    . ' $query_param_type = '
-                    . $query_param_type
-                    . "\n\t"
-                    . ' $original_query_param = '
-                    . $original_query_param
-                )
-            );
-        }
-        // check if it's a custom selection
-        if (
-            $this->_custom_selections instanceof CustomSelects
-            && in_array($query_param, $this->_custom_selections->columnAliases(), true)
-        ) {
-            return;
-        }
-        // check if has a model name at the beginning
-        // and
-        // check if it's a field on a related model
-        if (
-            $this->extractJoinModelFromQueryParams(
-                $passed_in_query_info,
-                $query_param,
-                $original_query_param,
-                $query_param_type
-            )
-        ) {
-            return;
-        }
-
-        // ok so $query_param didn't start with a model name
-        // and we previously confirmed it wasn't a logic query param or field on the current model
-        // it's wack, that's what it is
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "There is no model named '%s' related to %s. Query param type is %s and original query param is %s",
-                    "event_espresso"
-                ),
-                $query_param,
-                get_class($this),
-                $query_param_type,
-                $original_query_param
-            )
-        );
-    }
-
-
-    /**
-     * Extracts any possible join model information from the provided possible_join_string.
-     * This method will read the provided $possible_join_string value and determine if there are any possible model
-     * join
-     * parts that should be added to the query.
-     *
-     * @param EE_Model_Query_Info_Carrier $query_info_carrier
-     * @param string                      $possible_join_string  Such as Registration.REG_ID, or Registration
-     * @param null|string                 $original_query_param
-     * @param string                      $query_parameter_type  The type for the source of the $possible_join_string
-     *                                                           ('where', 'order_by', 'group_by', 'custom_selects'
-     *                                                           etc.)
-     * @return bool  returns true if a join was added and false if not.
-     * @throws EE_Error
-     */
-    private function extractJoinModelFromQueryParams(
-        EE_Model_Query_Info_Carrier $query_info_carrier,
-        $possible_join_string,
-        $original_query_param,
-        $query_parameter_type
-    ) {
-        foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
-            if (strpos($possible_join_string, $valid_related_model_name . ".") === 0) {
-                $this->_add_join_to_model($valid_related_model_name, $query_info_carrier, $original_query_param);
-                $possible_join_string = substr($possible_join_string, strlen($valid_related_model_name . "."));
-                if ($possible_join_string === '') {
-                    // nothing left to $query_param
-                    // we should actually end in a field name, not a model like this!
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                "Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
-                                "event_espresso"
-                            ),
-                            $possible_join_string,
-                            $query_parameter_type,
-                            get_class($this),
-                            $valid_related_model_name
-                        )
-                    );
-                }
-                $related_model_obj = $this->get_related_model_obj($valid_related_model_name);
-                $related_model_obj->_extract_related_model_info_from_query_param(
-                    $possible_join_string,
-                    $query_info_carrier,
-                    $query_parameter_type,
-                    $original_query_param
-                );
-                return true;
-            }
-            if ($possible_join_string === $valid_related_model_name) {
-                $this->_add_join_to_model(
-                    $valid_related_model_name,
-                    $query_info_carrier,
-                    $original_query_param
-                );
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Extracts related models from Custom Selects and sets up any joins for those related models.
-     *
-     * @param EE_Model_Query_Info_Carrier $query_info_carrier
-     * @throws EE_Error
-     */
-    private function extractRelatedModelsFromCustomSelects(EE_Model_Query_Info_Carrier $query_info_carrier)
-    {
-        if (
-            $this->_custom_selections instanceof CustomSelects
-            && (
-                $this->_custom_selections->type() === CustomSelects::TYPE_STRUCTURED
-                || $this->_custom_selections->type() == CustomSelects::TYPE_COMPLEX
-            )
-        ) {
-            $original_selects = $this->_custom_selections->originalSelects();
-            foreach ($original_selects as $alias => $select_configuration) {
-                $this->extractJoinModelFromQueryParams(
-                    $query_info_carrier,
-                    $select_configuration[0],
-                    $select_configuration[0],
-                    'custom_selects'
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
-     * and store it on $passed_in_query_info
-     *
-     * @param string                      $model_name
-     * @param EE_Model_Query_Info_Carrier $passed_in_query_info
-     * @param string                      $original_query_param used to extract the relation chain between the queried
-     *                                                          model and $model_name. Eg, if we are querying Event,
-     *                                                          and are adding a join to 'Payment' with the original
-     *                                                          query param key
-     *                                                          'Registration.Transaction.Payment.PAY_amount', we want
-     *                                                          to extract 'Registration.Transaction.Payment', in case
-     *                                                          Payment wants to add default query params so that it
-     *                                                          will know what models to prepend onto its default query
-     *                                                          params or in case it wants to rename tables (in case
-     *                                                          there are multiple joins to the same table)
-     * @return void
-     * @throws EE_Error
-     */
-    private function _add_join_to_model(
-        $model_name,
-        EE_Model_Query_Info_Carrier $passed_in_query_info,
-        $original_query_param
-    ) {
-        $relation_obj         = $this->related_settings_for($model_name);
-        $model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
-        // check if the relation is HABTM, because then we're essentially doing two joins
-        // If so, join first to the JOIN table, and add its data types, and then continue as normal
-        if ($relation_obj instanceof EE_HABTM_Relation) {
-            $join_model_obj = $relation_obj->get_join_model();
-            // replace the model specified with the join model for this relation chain, whi
-            $relation_chain_to_join_model =
-                EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain(
-                    $model_name,
-                    $join_model_obj->get_this_model_name(),
-                    $model_relation_chain
-                );
-            $passed_in_query_info->merge(
-                new EE_Model_Query_Info_Carrier(
-                    [$relation_chain_to_join_model => $join_model_obj->get_this_model_name()],
-                    $relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model)
-                )
-            );
-        }
-        // now just join to the other table pointed to by the relation object, and add its data types
-        $passed_in_query_info->merge(
-            new EE_Model_Query_Info_Carrier(
-                [$model_relation_chain => $model_name],
-                $relation_obj->get_join_statement($model_relation_chain)
-            )
-        );
-    }
-
-
-    /**
-     * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
-     *
-     * @param array $where_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @return string of SQL
-     * @throws EE_Error
-     */
-    private function _construct_where_clause($where_params)
-    {
-        $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
-        if ($SQL) {
-            return " WHERE " . $SQL;
-        }
-        return '';
-    }
-
-
-    /**
-     * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
-     * and should be passed HAVING parameters, not WHERE parameters
-     *
-     * @param array $having_params
-     * @return string
-     * @throws EE_Error
-     */
-    private function _construct_having_clause($having_params)
-    {
-        $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
-        if ($SQL) {
-            return " HAVING " . $SQL;
-        }
-        return '';
-    }
-
-
-    /**
-     * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
-     * Event_Meta.meta_value = 'foo'))"
-     *
-     * @param array  $where_params @see
-     *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
-     * @return string of SQL
-     * @throws EE_Error
-     */
-    private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
-    {
-        $where_clauses = [];
-        foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
-            $query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
-            if (in_array($query_param, $this->_logic_query_param_keys, true)) {
-                switch ($query_param) {
-                    case 'not':
-                    case 'NOT':
-                        $where_clauses[] = "! ("
-                                           . $this->_construct_condition_clause_recursive(
-                                $op_and_value_or_sub_condition,
-                                $glue
-                            )
-                                           . ")";
-                        break;
-                    case 'and':
-                    case 'AND':
-                        $where_clauses[] = " ("
-                                           . $this->_construct_condition_clause_recursive(
-                                $op_and_value_or_sub_condition,
-                                ' AND '
-                            )
-                                           . ")";
-                        break;
-                    case 'or':
-                    case 'OR':
-                        $where_clauses[] = " ("
-                                           . $this->_construct_condition_clause_recursive(
-                                $op_and_value_or_sub_condition,
-                                ' OR '
-                            )
-                                           . ")";
-                        break;
-                }
-            } else {
-                $field_obj = $this->_deduce_field_from_query_param($query_param);
-                // if it's not a normal field, maybe it's a custom selection?
-                if (! $field_obj) {
-                    if ($this->_custom_selections instanceof CustomSelects) {
-                        $field_obj = $this->_custom_selections->getDataTypeForAlias($query_param);
-                    } else {
-                        throw new EE_Error(
-                            sprintf(
-                                esc_html__(
-                                    "%s is neither a valid model field name, nor a custom selection",
-                                    "event_espresso"
-                                ),
-                                $query_param
-                            )
-                        );
-                    }
-                }
-                $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
-                $where_clauses[]  = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
-            }
-        }
-        return $where_clauses ? implode($glue, $where_clauses) : '';
-    }
-
-
-    /**
-     * Takes the input parameter and extract the table name (alias) and column name
-     *
-     * @param string $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
-     * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
-     * @throws EE_Error
-     */
-    private function _deduce_column_name_from_query_param($query_param)
-    {
-        $field = $this->_deduce_field_from_query_param($query_param);
-        if ($field) {
-            $table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param(
-                $field->get_model_name(),
-                $query_param
-            );
-            return $table_alias_prefix . $field->get_qualified_column();
-        }
-        if (
-            $this->_custom_selections instanceof CustomSelects
-            && in_array($query_param, $this->_custom_selections->columnAliases(), true)
-        ) {
-            // maybe it's custom selection item?
-            // if so, just use it as the "column name"
-            return $query_param;
-        }
-        $custom_select_aliases = $this->_custom_selections instanceof CustomSelects
-            ? implode(',', $this->_custom_selections->columnAliases())
-            : '';
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "%s is not a valid field on this model, nor a custom selection (%s)",
-                    "event_espresso"
-                ),
-                $query_param,
-                $custom_select_aliases
-            )
-        );
-    }
-
-
-    /**
-     * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
-     * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
-     * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
-     * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
-     *
-     * @param string $condition_query_param_key
-     * @return string
-     */
-    private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
-    {
-        $pos_of_star = strpos($condition_query_param_key, '*');
-        if ($pos_of_star === false) {
-            return $condition_query_param_key;
-        }
-        $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
-        return $condition_query_param_sans_star;
-    }
-
-
-    /**
-     * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
-     *
-     * @param mixed      array | string    $op_and_value
-     * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
-     * @return string
-     * @throws EE_Error
-     */
-    private function _construct_op_and_value($op_and_value, $field_obj)
-    {
-        if (is_array($op_and_value)) {
-            $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
-            if (! $operator) {
-                $php_array_like_string = [];
-                foreach ($op_and_value as $key => $value) {
-                    $php_array_like_string[] = "$key=>$value";
-                }
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "You setup a query parameter like you were going to specify an operator, but didn't. You provided '(%s)', but the operator should be at array key index 0 (eg array('>',32))",
-                            "event_espresso"
-                        ),
-                        implode(",", $php_array_like_string)
-                    )
-                );
-            }
-            $value = isset($op_and_value[1]) ? $op_and_value[1] : null;
-        } else {
-            $operator = '=';
-            $value    = $op_and_value;
-        }
-        // check to see if the value is actually another field
-        if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
-        }
-        if (in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
-            // in this case, the value should be an array, or at least a comma-separated list
-            // it will need to handle a little differently
-            $cleaned_value = $this->_construct_in_value($value, $field_obj);
-            // note: $cleaned_value has already been run through $wpdb->prepare()
-            return $operator . SP . $cleaned_value;
-        }
-        if (in_array($operator, $this->valid_between_style_operators()) && is_array($value)) {
-            // the value should be an array with count of two.
-            if (count($value) !== 2) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
-                            'event_espresso'
-                        ),
-                        "BETWEEN"
-                    )
-                );
-            }
-            $cleaned_value = $this->_construct_between_value($value, $field_obj);
-            return $operator . SP . $cleaned_value;
-        }
-        if (in_array($operator, $this->valid_null_style_operators())) {
-            if ($value !== null) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
-                            "event_espresso"
-                        ),
-                        $value,
-                        $operator
-                    )
-                );
-            }
-            return $operator;
-        }
-        if (in_array($operator, $this->valid_like_style_operators()) && ! is_array($value)) {
-            // if the operator is 'LIKE', we want to allow percent signs (%) and not
-            // remove other junk. So just treat it as a string.
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
-        }
-        if (! in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
-        }
-        if (in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
-                        'event_espresso'
-                    ),
-                    $operator,
-                    $operator
-                )
-            );
-        }
-        if (! in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
-                        'event_espresso'
-                    ),
-                    $operator,
-                    $operator
-                )
-            );
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
-                    "event_espresso"
-                ),
-                http_build_query($op_and_value)
-            )
-        );
-    }
-
-
-    /**
-     * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
-     *
-     * @param array                      $values
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
-     *                                              '%s'
-     * @return string
-     * @throws EE_Error
-     */
-    public function _construct_between_value($values, $field_obj)
-    {
-        $cleaned_values = [];
-        foreach ($values as $value) {
-            $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
-        }
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
-    }
-
-
-    /**
-     * Takes an array or a comma-separated list of $values and cleans them
-     * according to $data_type using $wpdb->prepare, and then makes the list a
-     * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
-     * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
-     * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
-     *
-     * @param mixed                      $values    array or comma-separated string
-     * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
-     * @return string of SQL to follow an 'IN' or 'NOT IN' operator
-     * @throws EE_Error
-     */
-    public function _construct_in_value($values, $field_obj)
-    {
-        $prepped = [];
-        // check if the value is a CSV list
-        if (is_string($values)) {
-            // in which case, turn it into an array
-            $values = explode(',', $values);
-        }
-        // make sure we only have one of each value in the list
-        $values = array_unique($values);
-        foreach ($values as $value) {
-            $prepped[] = $this->_wpdb_prepare_using_field($value, $field_obj);
-        }
-        // we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
-        // but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
-        // which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
-        if (empty($prepped)) {
-            $all_fields  = $this->field_settings();
-            $first_field = reset($all_fields);
-            $main_table  = $this->_get_main_table();
-            $prepped[]   = "SELECT {$first_field->get_table_column()} FROM {$main_table->get_table_name()} WHERE FALSE";
-        }
-        return '(' . implode(',', $prepped) . ')';
-    }
-
-
-    /**
-     * @param mixed                      $value
-     * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
-     * @return false|null|string
-     * @throws EE_Error
-     */
-    private function _wpdb_prepare_using_field($value, $field_obj)
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            return $wpdb->prepare(
-                $field_obj->get_wpdb_data_type(),
-                $this->_prepare_value_for_use_in_db($value, $field_obj)
-            );
-        } //$field_obj should really just be a data type
-        if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
-                    $field_obj,
-                    implode(",", $this->_valid_wpdb_data_types)
-                )
-            );
-        }
-        return $wpdb->prepare($field_obj, $value);
-    }
-
-
-    /**
-     * Takes the input parameter and finds the model field that it indicates.
-     *
-     * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
-     * @return EE_Model_Field_Base
-     * @throws EE_Error
-     */
-    protected function _deduce_field_from_query_param($query_param_name)
-    {
-        // ok, now proceed with deducing which part is the model's name, and which is the field's name
-        // which will help us find the database table and column
-        $query_param_parts = explode(".", $query_param_name);
-        if (empty($query_param_parts)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "_extract_column_name is empty when trying to extract column and table name from %s",
-                        'event_espresso'
-                    ),
-                    $query_param_name
-                )
-            );
-        }
-        $number_of_parts       = count($query_param_parts);
-        $last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ];
-        if ($number_of_parts === 1) {
-            $field_name = $last_query_param_part;
-            $model_obj  = $this;
-        } else {// $number_of_parts >= 2
-            // the last part is the column name, and there are only 2parts. therefore...
-            $field_name = $last_query_param_part;
-            $model_obj  = $this->get_related_model_obj($query_param_parts[ $number_of_parts - 2 ]);
-        }
-        try {
-            return $model_obj->field_settings_for($field_name);
-        } catch (EE_Error $e) {
-            return null;
-        }
-    }
-
-
-    /**
-     * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
-     * alias and column which corresponds to it
-     *
-     * @param string $field_name
-     * @return string
-     * @throws EE_Error
-     */
-    public function _get_qualified_column_for_field($field_name)
-    {
-        $all_fields = $this->field_settings();
-        $field      = isset($all_fields[ $field_name ]) ? $all_fields[ $field_name ] : false;
-        if ($field) {
-            return $field->get_qualified_column();
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "There is no field titled %s on model %s. Either the query trying to use it is bad, or you need to add it to the list of fields on the model.",
-                    'event_espresso'
-                ),
-                $field_name,
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * similar to \EEM_Base::_get_qualified_column_for_field() but returns an array with data for ALL fields.
-     * Example usage:
-     * EEM_Ticket::instance()->get_all_wpdb_results(
-     *      array(),
-     *      ARRAY_A,
-     *      EEM_Ticket::instance()->get_qualified_columns_for_all_fields()
-     *  );
-     * is equivalent to
-     *  EEM_Ticket::instance()->get_all_wpdb_results( array(), ARRAY_A, '*' );
-     * and
-     *  EEM_Event::instance()->get_all_wpdb_results(
-     *      array(
-     *          array(
-     *              'Datetime.Ticket.TKT_ID' => array( '<', 100 ),
-     *          ),
-     *          ARRAY_A,
-     *          implode(
-     *              ', ',
-     *              array_merge(
-     *                  EEM_Event::instance()->get_qualified_columns_for_all_fields( '', false ),
-     *                  EEM_Ticket::instance()->get_qualified_columns_for_all_fields( 'Datetime', false )
-     *              )
-     *          )
-     *      )
-     *  );
-     * selects rows from the database, selecting all the event and ticket columns, where the ticket ID is below 100
-     *
-     * @param string $model_relation_chain        the chain of models used to join between the model you want to query
-     *                                            and the one whose fields you are selecting for example: when querying
-     *                                            tickets model and selecting fields from the tickets model you would
-     *                                            leave this parameter empty, because no models are needed to join
-     *                                            between the queried model and the selected one. Likewise when
-     *                                            querying the datetime model and selecting fields from the tickets
-     *                                            model, it would also be left empty, because there is a direct
-     *                                            relation from datetimes to tickets, so no model is needed to join
-     *                                            them together. However, when querying from the event model and
-     *                                            selecting fields from the ticket model, you should provide the string
-     *                                            'Datetime', indicating that the event model must first join to the
-     *                                            datetime model in order to find its relation to ticket model.
-     *                                            Also, when querying from the venue model and selecting fields from
-     *                                            the ticket model, you should provide the string 'Event.Datetime',
-     *                                            indicating you need to join the venue model to the event model,
-     *                                            to the datetime model, in order to find its relation to the ticket
-     *                                            model. This string is used to deduce the prefix that gets added onto
-     *                                            the models' tables qualified columns
-     * @param bool   $return_string               if true, will return a string with qualified column names separated
-     *                                            by ', ' if false, will simply return a numerically indexed array of
-     *                                            qualified column names
-     * @return array|string
-     */
-    public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
-    {
-        $table_prefix      = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
-        $qualified_columns = [];
-        foreach ($this->field_settings() as $field_name => $field) {
-            $qualified_columns[] = $table_prefix . $field->get_qualified_column();
-        }
-        return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
-    }
-
-
-    /**
-     * constructs the select use on special limit joins
-     * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
-     * its setup so the select query will be setup on and just doing the special select join off of the primary table
-     * (as that is typically where the limits would be set).
-     *
-     * @param string       $table_alias The table the select is being built for
-     * @param mixed|string $limit       The limit for this select
-     * @return string                The final select join element for the query.
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function _construct_limit_join_select($table_alias, $limit)
-    {
-        $SQL = '';
-        foreach ($this->_tables as $table_obj) {
-            if ($table_obj instanceof EE_Primary_Table) {
-                $SQL .= $table_alias === $table_obj->get_table_alias()
-                    ? $table_obj->get_select_join_limit($limit)
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
-            } elseif ($table_obj instanceof EE_Secondary_Table) {
-                $SQL .= $table_alias === $table_obj->get_table_alias()
-                    ? $table_obj->get_select_join_limit_join($limit)
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
-            }
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * Constructs the internal join if there are multiple tables, or simply the table's name and alias
-     * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
-     *
-     * @return string SQL
-     * @throws EE_Error
-     */
-    public function _construct_internal_join()
-    {
-        $SQL = $this->_get_main_table()->get_table_sql();
-        $SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
-        return $SQL;
-    }
-
-
-    /**
-     * Constructs the SQL for joining all the tables on this model.
-     * Normally $alias should be the primary table's alias, but in cases where
-     * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
-     * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
-     * alias, this will construct SQL like:
-     * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
-     * With $alias being a secondary table's alias, this will construct SQL like:
-     * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
-     *
-     * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
-     * @return string
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function _construct_internal_join_to_table_with_alias($alias_prefixed)
-    {
-        $SQL               = '';
-        $alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
-        foreach ($this->_tables as $table_obj) {
-            if ($table_obj instanceof EE_Secondary_Table) {// table is secondary table
-                if ($alias_sans_prefix === $table_obj->get_table_alias()) {
-                    // so we're joining to this table, meaning the table is already in
-                    // the FROM statement, BUT the primary table isn't. So we want
-                    // to add the inverse join sql
-                    $SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
-                } else {
-                    // just add a regular JOIN to this table from the primary table
-                    $SQL .= $table_obj->get_join_sql($alias_prefixed);
-                }
-            }//if it's a primary table, dont add any SQL. it should already be in the FROM statement
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * Gets an array for storing all the data types on the next-to-be-executed-query.
-     * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
-     * their data type (eg, '%s', '%d', etc)
-     *
-     * @return array
-     */
-    public function _get_data_types()
-    {
-        $data_types = [];
-        foreach ($this->field_settings() as $field_obj) {
-            // $data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
-            /** @var $field_obj EE_Model_Field_Base */
-            $data_types[ $field_obj->get_qualified_column() ] = $field_obj->get_wpdb_data_type();
-        }
-        return $data_types;
-    }
-
-
-    /**
-     * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
-     *
-     * @param string $model_name
-     * @return EEM_Base
-     * @throws EE_Error
-     */
-    public function get_related_model_obj($model_name)
-    {
-        $model_classname = "EEM_" . $model_name;
-        if (! class_exists($model_classname)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "You specified a related model named %s in your query. No such model exists, if it did, it would have the classname %s",
-                        'event_espresso'
-                    ),
-                    $model_name,
-                    $model_classname
-                )
-            );
-        }
-        return call_user_func($model_classname . "::instance");
-    }
-
-
-    /**
-     * Returns the array of EE_ModelRelations for this model.
-     *
-     * @return EE_Model_Relation_Base[]
-     */
-    public function relation_settings()
-    {
-        return $this->_model_relations;
-    }
-
-
-    /**
-     * Gets all related models that this model BELONGS TO. Handy to know sometimes
-     * because without THOSE models, this model probably doesn't have much purpose.
-     * (Eg, without an event, datetimes have little purpose.)
-     *
-     * @return EE_Belongs_To_Relation[]
-     */
-    public function belongs_to_relations()
-    {
-        $belongs_to_relations = [];
-        foreach ($this->relation_settings() as $model_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $belongs_to_relations[ $model_name ] = $relation_obj;
-            }
-        }
-        return $belongs_to_relations;
-    }
-
-
-    /**
-     * Returns the specified EE_Model_Relation, or throws an exception
-     *
-     * @param string $relation_name name of relation, key in $this->_relatedModels
-     * @return EE_Model_Relation_Base
-     * @throws EE_Error
-     */
-    public function related_settings_for($relation_name)
-    {
-        $relatedModels = $this->relation_settings();
-        if (! array_key_exists($relation_name, $relatedModels)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
-                        'event_espresso'
-                    ),
-                    $relation_name,
-                    $this->_get_class_name(),
-                    implode(', ', array_keys($relatedModels))
-                )
-            );
-        }
-        return $relatedModels[ $relation_name ];
-    }
-
-
-    /**
-     * A convenience method for getting a specific field's settings, instead of getting all field settings for all
-     * fields
-     *
-     * @param string  $fieldName
-     * @param boolean $include_db_only_fields
-     * @return EE_Model_Field_Base
-     * @throws EE_Error
-     */
-    public function field_settings_for($fieldName, $include_db_only_fields = true)
-    {
-        $fieldSettings = $this->field_settings($include_db_only_fields);
-        if (! array_key_exists($fieldName, $fieldSettings)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("There is no field/column '%s' on '%s'", 'event_espresso'),
-                    $fieldName,
-                    get_class($this)
-                )
-            );
-        }
-        return $fieldSettings[ $fieldName ];
-    }
-
-
-    /**
-     * Checks if this field exists on this model
-     *
-     * @param string $fieldName a key in the model's _field_settings array
-     * @return boolean
-     */
-    public function has_field($fieldName)
-    {
-        $fieldSettings = $this->field_settings(true);
-        if (isset($fieldSettings[ $fieldName ])) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns whether or not this model has a relation to the specified model
-     *
-     * @param string $relation_name possibly one of the keys in the relation_settings array
-     * @return boolean
-     */
-    public function has_relation($relation_name)
-    {
-        $relations = $this->relation_settings();
-        if (isset($relations[ $relation_name ])) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
-     * Eg, on EE_Answer that would be ANS_ID field object
-     *
-     * @param $field_obj
-     * @return boolean
-     */
-    public function is_primary_key_field($field_obj)
-    {
-        return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
-    }
-
-
-    /**
-     * gets the field object of type 'primary_key' from the fieldsSettings attribute.
-     * Eg, on EE_Answer that would be ANS_ID field object
-     *
-     * @return EE_Primary_Key_Field_Base
-     * @throws EE_Error
-     */
-    public function get_primary_key_field()
-    {
-        if ($this->_primary_key_field === null) {
-            foreach ($this->field_settings(true) as $field_obj) {
-                if ($this->is_primary_key_field($field_obj)) {
-                    $this->_primary_key_field = $field_obj;
-                    break;
-                }
-            }
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__("There is no Primary Key defined on model %s", 'event_espresso'),
-                        get_class($this)
-                    )
-                );
-            }
-        }
-        return $this->_primary_key_field;
-    }
-
-
-    /**
-     * Returns whether or not not there is a primary key on this model.
-     * Internally does some caching.
-     *
-     * @return boolean
-     */
-    public function has_primary_key_field()
-    {
-        if ($this->_has_primary_key_field === null) {
-            try {
-                $this->get_primary_key_field();
-                $this->_has_primary_key_field = true;
-            } catch (EE_Error $e) {
-                $this->_has_primary_key_field = false;
-            }
-        }
-        return $this->_has_primary_key_field;
-    }
-
-
-    /**
-     * Finds the first field of type $field_class_name.
-     *
-     * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
-     *                                 EE_Foreign_Key_Field, etc
-     * @return EE_Model_Field_Base or null if none is found
-     */
-    public function get_a_field_of_type($field_class_name)
-    {
-        foreach ($this->field_settings() as $field) {
-            if ($field instanceof $field_class_name) {
-                return $field;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets a foreign key field pointing to model.
-     *
-     * @param string $model_name eg Event, Registration, not EEM_Event
-     * @return EE_Foreign_Key_Field_Base
-     * @throws EE_Error
-     */
-    public function get_foreign_key_to($model_name)
-    {
-        if (! isset($this->_cache_foreign_key_to_fields[ $model_name ])) {
-            foreach ($this->field_settings() as $field) {
-                if (
-                    $field instanceof EE_Foreign_Key_Field_Base
-                    && in_array($model_name, $field->get_model_names_pointed_to())
-                ) {
-                    $this->_cache_foreign_key_to_fields[ $model_name ] = $field;
-                    break;
-                }
-            }
-            if (! isset($this->_cache_foreign_key_to_fields[ $model_name ])) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "There is no foreign key field pointing to model %s on model %s",
-                            'event_espresso'
-                        ),
-                        $model_name,
-                        get_class($this)
-                    )
-                );
-            }
-        }
-        return $this->_cache_foreign_key_to_fields[ $model_name ];
-    }
-
-
-    /**
-     * Gets the table name (including $wpdb->prefix) for the table alias
-     *
-     * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
-     *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
-     *                            Either one works
-     * @return string
-     */
-    public function get_table_for_alias($table_alias)
-    {
-        $table_alias_sans_model_relation_chain_prefix =
-            EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
-        return $this->_tables[ $table_alias_sans_model_relation_chain_prefix ]->get_table_name();
-    }
-
-
-    /**
-     * Returns a flat array of all field son this model, instead of organizing them
-     * by table_alias as they are in the constructor.
-     *
-     * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
-     * @return EE_Model_Field_Base[] where the keys are the field's name
-     */
-    public function field_settings($include_db_only_fields = false)
-    {
-        if ($include_db_only_fields) {
-            if ($this->_cached_fields === null) {
-                $this->_cached_fields = [];
-                foreach ($this->_fields as $fields_corresponding_to_table) {
-                    foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
-                        $this->_cached_fields[ $field_name ] = $field_obj;
-                    }
-                }
-            }
-            return $this->_cached_fields;
-        }
-        if ($this->_cached_fields_non_db_only === null) {
-            $this->_cached_fields_non_db_only = [];
-            foreach ($this->_fields as $fields_corresponding_to_table) {
-                foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
-                    /** @var $field_obj EE_Model_Field_Base */
-                    if (! $field_obj->is_db_only_field()) {
-                        $this->_cached_fields_non_db_only[ $field_name ] = $field_obj;
-                    }
-                }
-            }
-        }
-        return $this->_cached_fields_non_db_only;
-    }
-
-
-    /**
-     *        cycle though array of attendees and create objects out of each item
-     *
-     * @access        private
-     * @param array $rows        of results of $wpdb->get_results($query,ARRAY_A)
-     * @return EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
-     *                           numerically indexed)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _create_objects($rows = [])
-    {
-        $array_of_objects = [];
-        if (empty($rows)) {
-            return [];
-        }
-        $count_if_model_has_no_primary_key = 0;
-        $has_primary_key                   = $this->has_primary_key_field();
-        $primary_key_field                 = $has_primary_key ? $this->get_primary_key_field() : null;
-        foreach ((array) $rows as $row) {
-            if (empty($row)) {
-                // wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
-                return [];
-            }
-            // check if we've already set this object in the results array,
-            // in which case there's no need to process it further (again)
-            if ($has_primary_key) {
-                $table_pk_value = $this->_get_column_value_with_table_alias_or_not(
-                    $row,
-                    $primary_key_field->get_qualified_column(),
-                    $primary_key_field->get_table_column()
-                );
-                if ($table_pk_value && isset($array_of_objects[ $table_pk_value ])) {
-                    continue;
-                }
-            }
-            $classInstance = $this->instantiate_class_from_array_or_object($row);
-            if (! $classInstance) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__('Could not create instance of class %s from row %s', 'event_espresso'),
-                        $this->get_this_model_name(),
-                        http_build_query($row)
-                    )
-                );
-            }
-            // set the timezone on the instantiated objects
-            $classInstance->set_timezone($this->_timezone);
-            // make sure if there is any timezone setting present that we set the timezone for the object
-            $key                      = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
-            $array_of_objects[ $key ] = $classInstance;
-            // also, for all the relations of type BelongsTo, see if we can cache
-            // those related models
-            // (we could do this for other relations too, but if there are conditions
-            // that filtered out some fo the results, then we'd be caching an incomplete set
-            // so it requires a little more thought than just caching them immediately...)
-            foreach ($this->_model_relations as $modelName => $relation_obj) {
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                    // check if this model's INFO is present. If so, cache it on the model
-                    $other_model           = $relation_obj->get_other_model();
-                    $other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
-                    // if we managed to make a model object from the results, cache it on the main model object
-                    if ($other_model_obj_maybe) {
-                        // set timezone on these other model objects if they are present
-                        $other_model_obj_maybe->set_timezone($this->_timezone);
-                        $classInstance->cache($modelName, $other_model_obj_maybe);
-                    }
-                }
-            }
-            // also, if this was a custom select query, let's see if there are any results for the custom select fields
-            // and add them to the object as well.  We'll convert according to the set data_type if there's any set for
-            // the field in the CustomSelects object
-            if ($this->_custom_selections instanceof CustomSelects) {
-                $classInstance->setCustomSelectsValues(
-                    $this->getValuesForCustomSelectAliasesFromResults($row)
-                );
-            }
-        }
-        return $array_of_objects;
-    }
-
-
-    /**
-     * This will parse a given row of results from the db and see if any keys in the results match an alias within the
-     * current CustomSelects object. This will be used to build an array of values indexed by those keys.
-     *
-     * @param array $db_results_row
-     * @return array
-     */
-    protected function getValuesForCustomSelectAliasesFromResults(array $db_results_row)
-    {
-        $results = [];
-        if ($this->_custom_selections instanceof CustomSelects) {
-            foreach ($this->_custom_selections->columnAliases() as $alias) {
-                if (isset($db_results_row[ $alias ])) {
-                    $results[ $alias ] = $this->convertValueToDataType(
-                        $db_results_row[ $alias ],
-                        $this->_custom_selections->getDataTypeForAlias($alias)
-                    );
-                }
-            }
-        }
-        return $results;
-    }
-
-
-    /**
-     * This will set the value for the given alias
-     *
-     * @param string $value
-     * @param string $datatype (one of %d, %s, %f)
-     * @return int|string|float (int for %d, string for %s, float for %f)
-     */
-    protected function convertValueToDataType($value, $datatype)
-    {
-        switch ($datatype) {
-            case '%f':
-                return (float) $value;
-            case '%d':
-                return (int) $value;
-            default:
-                return (string) $value;
-        }
-    }
-
-
-    /**
-     * The purpose of this method is to allow us to create a model object that is not in the db that holds default
-     * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
-     * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
-     * object (as set in the model_field!).
-     *
-     * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create_default_object()
-    {
-        $this_model_fields_and_values = [];
-        // setup the row using default values;
-        foreach ($this->field_settings() as $field_name => $field_obj) {
-            $this_model_fields_and_values[ $field_name ] = $field_obj->get_default_value();
-        }
-        $className     = $this->_get_class_name();
-        return EE_Registry::instance()->load_class($className, [$this_model_fields_and_values], false, false);
-    }
-
-
-    /**
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
-     *                             or an stdClass where each property is the name of a column,
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
-            $cols_n_values = get_object_vars($cols_n_values);
-        }
-        $primary_key = null;
-        // make sure the array only has keys that are fields/columns on this model
-        $this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
-        if ($this->has_primary_key_field() && isset($this_model_fields_n_values[ $this->primary_key_name() ])) {
-            $primary_key = $this_model_fields_n_values[ $this->primary_key_name() ];
-        }
-        $className = $this->_get_class_name();
-        // check we actually found results that we can use to build our model object
-        // if not, return null
-        if ($this->has_primary_key_field()) {
-            if (empty($this_model_fields_n_values[ $this->primary_key_name() ])) {
-                return null;
-            }
-        } elseif ($this->unique_indexes()) {
-            $first_column = reset($this_model_fields_n_values);
-            if (empty($first_column)) {
-                return null;
-            }
-        }
-        // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
-        if ($primary_key) {
-            $classInstance = $this->get_from_entity_map($primary_key);
-            if (! $classInstance) {
-                $classInstance = EE_Registry::instance()
-                                            ->load_class(
-                                                $className,
-                                                [$this_model_fields_n_values, $this->_timezone],
-                                                true,
-                                                false
-                                            );
-                // add this new object to the entity map
-                $classInstance = $this->add_to_entity_map($classInstance);
-            }
-        } else {
-            $classInstance = EE_Registry::instance()
-                                        ->load_class(
-                                            $className,
-                                            [$this_model_fields_n_values, $this->_timezone],
-                                            true,
-                                            false
-                                        );
-        }
-        return $classInstance;
-    }
-
-
-    /**
-     * Gets the model object from the  entity map if it exists
-     *
-     * @param int|string $id the ID of the model object
-     * @return EE_Base_Class
-     */
-    public function get_from_entity_map($id)
-    {
-        return isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])
-            ? $this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ] : null;
-    }
-
-
-    /**
-     * add_to_entity_map
-     * Adds the object to the model's entity mappings
-     *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
-     *        and for the remainder of the request, it's even more up-to-date than what's in the database.
-     *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
-     *        If the database gets updated directly and you want the entity mapper to reflect that change,
-     *        then this method should be called immediately after the update query
-     * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
-     * so on multisite, the entity map is specific to the query being done for a specific site.
-     *
-     * @param EE_Base_Class $object
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_to_entity_map(EE_Base_Class $object)
-    {
-        $className = $this->_get_class_name();
-        if (! $object instanceof $className) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("You tried adding a %s to a mapping of %ss", "event_espresso"),
-                    is_object($object) ? get_class($object) : $object,
-                    $className
-                )
-            );
-        }
-        /** @var $object EE_Base_Class */
-        if (! $object->ID()) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "You tried storing a model object with NO ID in the %s entity mapper.",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        // double check it's not already there
-        $classInstance = $this->get_from_entity_map($object->ID());
-        if ($classInstance) {
-            return $classInstance;
-        }
-        $this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $object->ID() ] = $object;
-        return $object;
-    }
-
-
-    /**
-     * if a valid identifier is provided, then that entity is unset from the entity map,
-     * if no identifier is provided, then the entire entity map is emptied
-     *
-     * @param int|string $id the ID of the model object
-     * @return boolean
-     */
-    public function clear_entity_map($id = null)
-    {
-        if (empty($id)) {
-            $this->_entity_map[ EEM_Base::$_model_query_blog_id ] = [];
-            return true;
-        }
-        if (isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])) {
-            unset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
-     * Given an array where keys are column (or column alias) names and values,
-     * returns an array of their corresponding field names and database values
-     *
-     * @param array $cols_n_values
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function deduce_fields_n_values_from_cols_n_values(array $cols_n_values): array
-    {
-        return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
-    }
-
-
-    /**
-     * _deduce_fields_n_values_from_cols_n_values
-     * Given an array where keys are column (or column alias) names and values,
-     * returns an array of their corresponding field names and database values
-     *
-     * @param array|stdClass $cols_n_values
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values): array
-    {
-        if ($cols_n_values instanceof stdClass) {
-            $cols_n_values = get_object_vars($cols_n_values);
-        }
-        $this_model_fields_n_values = [];
-        foreach ($this->get_tables() as $table_alias => $table_obj) {
-            $table_pk_value = $this->_get_column_value_with_table_alias_or_not(
-                $cols_n_values,
-                $table_obj->get_fully_qualified_pk_column(),
-                $table_obj->get_pk_column()
-            );
-            // there is a primary key on this table and its not set. Use defaults for all its columns
-            if ($table_pk_value === null && $table_obj->get_pk_column()) {
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
-                    if (! $field_obj->is_db_only_field()) {
-                        // prepare field as if its coming from db
-                        $prepared_value                            =
-                            $field_obj->prepare_for_set($field_obj->get_default_value());
-                        $this_model_fields_n_values[ $field_name ] = $field_obj->prepare_for_use_in_db($prepared_value);
-                    }
-                }
-            } else {
-                // the table's rows existed. Use their values
-                foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
-                    if (! $field_obj->is_db_only_field()) {
-                        $this_model_fields_n_values[ $field_name ] = $this->_get_column_value_with_table_alias_or_not(
-                            $cols_n_values,
-                            $field_obj->get_qualified_column(),
-                            $field_obj->get_table_column()
-                        );
-                    }
-                }
-            }
-        }
-        return $this_model_fields_n_values;
-    }
-
-
-    /**
-     * @param $cols_n_values
-     * @param $qualified_column
-     * @param $regular_column
-     * @return null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
-    {
-        $value = null;
-        // ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
-        // does the field on the model relate to this column retrieved from the db?
-        // or is it a db-only field? (not relating to the model)
-        if (isset($cols_n_values[ $qualified_column ])) {
-            $value = $cols_n_values[ $qualified_column ];
-        } elseif (isset($cols_n_values[ $regular_column ])) {
-            $value = $cols_n_values[ $regular_column ];
-        } elseif (! empty($this->foreign_key_aliases)) {
-            // no PK?  ok check if there is a foreign key alias set for this table
-            // then check if that alias exists in the incoming data
-            // AND that the actual PK the $FK_alias represents matches the $qualified_column (full PK)
-            foreach ($this->foreign_key_aliases as $FK_alias => $PK_column) {
-                if ($PK_column === $qualified_column && isset($cols_n_values[ $FK_alias ])) {
-                    $value = $cols_n_values[ $FK_alias ];
-                    [$pk_class] = explode('.', $PK_column);
-                    $pk_model_name = "EEM_{$pk_class}";
-                    /** @var EEM_Base $pk_model */
-                    $pk_model = EE_Registry::instance()->load_model($pk_model_name);
-                    if ($pk_model instanceof EEM_Base) {
-                        // make sure object is pulled from db and added to entity map
-                        $pk_model->get_one_by_ID($value);
-                    }
-                    break;
-                }
-            }
-        }
-        return $value;
-    }
-
-
-    /**
-     * refresh_entity_map_from_db
-     * Makes sure the model object in the entity map at $id assumes the values
-     * of the database (opposite of EE_base_Class::save())
-     *
-     * @param int|string $id
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class|mixed|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function refresh_entity_map_from_db($id)
-    {
-        $obj_in_map = $this->get_from_entity_map($id);
-        if ($obj_in_map) {
-            $wpdb_results = $this->_get_all_wpdb_results(
-                [[$this->get_primary_key_field()->get_name() => $id], 'limit' => 1]
-            );
-            if ($wpdb_results && is_array($wpdb_results)) {
-                $one_row = reset($wpdb_results);
-                foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
-                    $obj_in_map->set_from_db($field_name, $db_value);
-                }
-                // clear the cache of related model objects
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
-                    $obj_in_map->clear_cache($relation_name, null, true);
-                }
-            }
-            $this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ] = $obj_in_map;
-            return $obj_in_map;
-        }
-        return $this->get_one_by_ID($id);
-    }
-
-
-    /**
-     * refresh_entity_map_with
-     * Leaves the entry in the entity map alone, but updates it to match the provided
-     * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
-     * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
-     * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
-     *
-     * @param int|string    $id
-     * @param EE_Base_Class $replacing_model_obj
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function refresh_entity_map_with($id, $replacing_model_obj)
-    {
-        $obj_in_map = $this->get_from_entity_map($id);
-        if ($obj_in_map) {
-            if ($replacing_model_obj instanceof EE_Base_Class) {
-                foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
-                    $obj_in_map->set($field_name, $value);
-                }
-                // make the model object in the entity map's cache match the $replacing_model_obj
-                foreach ($this->relation_settings() as $relation_name => $relation_obj) {
-                    $obj_in_map->clear_cache($relation_name, null, true);
-                    foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
-                        $obj_in_map->cache($relation_name, $cached_obj, $cache_id);
-                    }
-                }
-            }
-            return $obj_in_map;
-        }
-        $this->add_to_entity_map($replacing_model_obj);
-        return $replacing_model_obj;
-    }
-
-
-    /**
-     * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
-     * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
-     * require_once($this->_getClassName().".class.php");
-     *
-     * @return string
-     */
-    private function _get_class_name()
-    {
-        return "EE_" . $this->get_this_model_name();
-    }
-
-
-    /**
-     * Get the name of the items this model represents, for the quantity specified. Eg,
-     * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
-     * it would be 'Events'.
-     *
-     * @param int|float|null $quantity
-     * @return string
-     */
-    public function item_name($quantity = 1): string
-    {
-        $quantity = floor($quantity);
-        return apply_filters(
-            'FHEE__EEM_Base__item_name__plural_or_singular',
-            $quantity > 1 ? $this->plural_item : $this->singular_item,
-            $quantity,
-            $this->plural_item,
-            $this->singular_item
-        );
-    }
-
-
-    /**
-     * Very handy general function to allow for plugins to extend any child of EE_TempBase.
-     * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
-     * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
-     * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
-     * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
-     * was called, and an array of the original arguments passed to the function. Whatever their callback function
-     * returns will be returned by this function. Example: in functions.php (or in a plugin):
-     * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
-     * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
-     * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
-     *        return $previousReturnValue.$returnString;
-     * }
-     * require('EEM_Answer.model.php');
-     * echo EEM_Answer::instance()->my_callback('monkeys',100);
-     * // will output "you called my_callback! and passed args:monkeys,100"
-     *
-     * @param string $methodName name of method which was called on a child of EE_TempBase, but which
-     * @param array  $args       array of original arguments passed to the function
-     * @return mixed whatever the plugin which calls add_filter decides
-     * @throws EE_Error
-     */
-    public function __call($methodName, $args)
-    {
-        $className = get_class($this);
-        $tagName   = "FHEE__{$className}__{$methodName}";
-        if (! has_filter($tagName)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Method %1$s on model %2$s does not exist! You can create one with the following code in functions.php or in a plugin: %4$s function my_callback(%4$s \$previousReturnValue, EEM_Base \$object\ $argsArray=NULL ){%4$s     /*function body*/%4$s      return \$whatever;%4$s }%4$s add_filter( \'%3$s\', \'my_callback\', 10, 3 );',
-                        'event_espresso'
-                    ),
-                    $methodName,
-                    $className,
-                    $tagName,
-                    '<br />'
-                )
-            );
-        }
-        return apply_filters($tagName, null, $this, $args);
-    }
-
-
-    /**
-     * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
-     * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
-     *
-     * @param EE_Base_Class|string|int $base_class_obj_or_id either:
-     *                                                       the EE_Base_Class object that corresponds to this Model,
-     *                                                       the object's class name
-     *                                                       or object's ID
-     * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
-     *                                                       exists in the database. If it does not, we add it
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
-    {
-        $className = $this->_get_class_name();
-        if ($base_class_obj_or_id instanceof $className) {
-            $model_object = $base_class_obj_or_id;
-        } else {
-            $primary_key_field = $this->get_primary_key_field();
-            if (
-                $primary_key_field instanceof EE_Primary_Key_Int_Field
-                && (
-                    is_int($base_class_obj_or_id)
-                    || is_string($base_class_obj_or_id)
-                )
-            ) {
-                // assume it's an ID.
-                // either a proper integer or a string representing an integer (eg "101" instead of 101)
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
-            } elseif (
-                $primary_key_field instanceof EE_Primary_Key_String_Field
-                && is_string($base_class_obj_or_id)
-            ) {
-                // assume its a string representation of the object
-                $model_object = $this->get_one_by_ID($base_class_obj_or_id);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
-                            'event_espresso'
-                        ),
-                        $base_class_obj_or_id,
-                        $this->_get_class_name(),
-                        print_r($base_class_obj_or_id, true)
-                    )
-                );
-            }
-        }
-        if ($ensure_is_in_db && $model_object->ID() !== null) {
-            $model_object->save();
-        }
-        return $model_object;
-    }
-
-
-    /**
-     * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
-     * is a value of the this model's primary key. If it's an EE_Base_Class child,
-     * returns it ID.
-     *
-     * @param EE_Base_Class|int|string $base_class_obj_or_id
-     * @return int|string depending on the type of this model object's ID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ensure_is_ID($base_class_obj_or_id)
-    {
-        $className = $this->_get_class_name();
-        if ($base_class_obj_or_id instanceof $className) {
-            /** @var $base_class_obj_or_id EE_Base_Class */
-            $id = $base_class_obj_or_id->ID();
-        } elseif (is_int($base_class_obj_or_id)) {
-            // assume it's an ID
-            $id = $base_class_obj_or_id;
-        } elseif (is_string($base_class_obj_or_id)) {
-            // assume its a string representation of the object
-            $id = $base_class_obj_or_id;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
-                        'event_espresso'
-                    ),
-                    $base_class_obj_or_id,
-                    $this->_get_class_name(),
-                    print_r($base_class_obj_or_id, true)
-                )
-            );
-        }
-        return $id;
-    }
-
-
-    /**
-     * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
-     * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
-     * been sanitized and converted into the appropriate domain.
-     * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
-     * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
-     * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
-     * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
-     * $EVT = EEM_Event::instance(); $old_setting =
-     * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
-     * $EVT->assume_values_already_prepared_by_model_object(true);
-     * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
-     * $EVT->assume_values_already_prepared_by_model_object($old_setting);
-     *
-     * @param int $values_already_prepared like one of the constants on EEM_Base
-     * @return void
-     */
-    public function assume_values_already_prepared_by_model_object(
-        $values_already_prepared = self::not_prepared_by_model_object
-    ) {
-        $this->_values_already_prepared_by_model_object = $values_already_prepared;
-    }
-
-
-    /**
-     * Read comments for assume_values_already_prepared_by_model_object()
-     *
-     * @return int
-     */
-    public function get_assumption_concerning_values_already_prepared_by_model_object()
-    {
-        return $this->_values_already_prepared_by_model_object;
-    }
-
-
-    /**
-     * Gets all the indexes on this model
-     *
-     * @return EE_Index[]
-     */
-    public function indexes()
-    {
-        return $this->_indexes;
-    }
-
-
-    /**
-     * Gets all the Unique Indexes on this model
-     *
-     * @return EE_Unique_Index[]
-     */
-    public function unique_indexes()
-    {
-        $unique_indexes = [];
-        foreach ($this->_indexes as $name => $index) {
-            if ($index instanceof EE_Unique_Index) {
-                $unique_indexes [ $name ] = $index;
-            }
-        }
-        return $unique_indexes;
-    }
-
-
-    /**
-     * Gets all the fields which, when combined, make the primary key.
-     * This is usually just an array with 1 element (the primary key), but in cases
-     * where there is no primary key, it's a combination of fields as defined
-     * on a primary index
-     *
-     * @return EE_Model_Field_Base[] indexed by the field's name
-     * @throws EE_Error
-     */
-    public function get_combined_primary_key_fields()
-    {
-        foreach ($this->indexes() as $index) {
-            if ($index instanceof EE_Primary_Key_Index) {
-                return $index->fields();
-            }
-        }
-        return [$this->primary_key_name() => $this->get_primary_key_field()];
-    }
-
-
-    /**
-     * Used to build a primary key string (when the model has no primary key),
-     * which can be used a unique string to identify this model object.
-     *
-     * @param array $fields_n_values keys are field names, values are their values.
-     *                               Note: if you have results from `EEM_Base::get_all_wpdb_results()`, you need to
-     *                               run it through `EEM_Base::deduce_fields_n_values_from_cols_n_values()`
-     *                               before passing it to this function (that will convert it from columns-n-values
-     *                               to field-names-n-values).
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_index_primary_key_string($fields_n_values)
-    {
-        $cols_n_values_for_primary_key_index = array_intersect_key(
-            $fields_n_values,
-            $this->get_combined_primary_key_fields()
-        );
-        return http_build_query($cols_n_values_for_primary_key_index);
-    }
-
-
-    /**
-     * Gets the field values from the primary key string
-     *
-     * @param string $index_primary_key_string
-     * @return null|array
-     * @throws EE_Error
-     * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
-     */
-    public function parse_index_primary_key_string($index_primary_key_string)
-    {
-        $key_fields = $this->get_combined_primary_key_fields();
-        // check all of them are in the $id
-        $key_vals_in_combined_pk = [];
-        parse_str($index_primary_key_string, $key_vals_in_combined_pk);
-        foreach ($key_fields as $key_field_name => $field_obj) {
-            if (! isset($key_vals_in_combined_pk[ $key_field_name ])) {
-                return null;
-            }
-        }
-        return $key_vals_in_combined_pk;
-    }
-
-
-    /**
-     * verifies that an array of key-value pairs for model fields has a key
-     * for each field comprising the primary key index
-     *
-     * @param array $key_vals
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function has_all_combined_primary_key_fields($key_vals)
-    {
-        $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
-        foreach ($keys_it_should_have as $key) {
-            if (! isset($key_vals[ $key ])) {
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
-     * We consider something to be a copy if all the attributes match (except the ID, of course).
-     *
-     * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
-     * @param array               $query_params                     @see
-     *                                                              https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @return EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
-     *                                                              indexed)
-     */
-    public function get_all_copies($model_object_or_attributes_array, $query_params = [])
-    {
-        if ($model_object_or_attributes_array instanceof EE_Base_Class) {
-            $attributes_array = $model_object_or_attributes_array->model_field_array();
-        } elseif (is_array($model_object_or_attributes_array)) {
-            $attributes_array = $model_object_or_attributes_array;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "get_all_copies should be provided with either a model object or an array of field-value-pairs, but was given %s",
-                        "event_espresso"
-                    ),
-                    $model_object_or_attributes_array
-                )
-            );
-        }
-        // even copies obviously won't have the same ID, so remove the primary key
-        // from the WHERE conditions for finding copies (if there is a primary key, of course)
-        if ($this->has_primary_key_field() && isset($attributes_array[ $this->primary_key_name() ])) {
-            unset($attributes_array[ $this->primary_key_name() ]);
-        }
-        if (isset($query_params[0])) {
-            $query_params[0] = array_merge($attributes_array, $query_params);
-        } else {
-            $query_params[0] = $attributes_array;
-        }
-        return $this->get_all($query_params);
-    }
-
-
-    /**
-     * Gets the first copy we find. See get_all_copies for more details
-     *
-     * @param mixed EE_Base_Class | array        $model_object_or_attributes_array
-     * @param array $query_params
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_one_copy($model_object_or_attributes_array, $query_params = [])
-    {
-        if (! is_array($query_params)) {
-            EE_Error::doing_it_wrong(
-                'EEM_Base::get_one_copy',
-                sprintf(
-                    esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
-                    gettype($query_params)
-                ),
-                '4.6.0'
-            );
-            $query_params = [];
-        }
-        $query_params['limit'] = 1;
-        $copies                = $this->get_all_copies($model_object_or_attributes_array, $query_params);
-        if (is_array($copies)) {
-            return array_shift($copies);
-        }
-        return null;
-    }
-
-
-    /**
-     * Updates the item with the specified id. Ignores default query parameters because
-     * we have specified the ID, and its assumed we KNOW what we're doing
-     *
-     * @param array      $fields_n_values keys are field names, values are their new values
-     * @param int|string $id              the value of the primary key to update
-     * @return int number of rows updated
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_by_ID($fields_n_values, $id)
-    {
-        $query_params = [
-            0                          => [$this->get_primary_key_field()->get_name() => $id],
-            'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
-        ];
-        return $this->update($fields_n_values, $query_params);
-    }
-
-
-    /**
-     * Changes an operator which was supplied to the models into one usable in SQL
-     *
-     * @param string $operator_supplied
-     * @return string an operator which can be used in SQL
-     * @throws EE_Error
-     */
-    private function _prepare_operator_for_sql($operator_supplied)
-    {
-        $sql_operator = $this->_valid_operators[ $operator_supplied ] ?? null;
-        if ($sql_operator) {
-            return $sql_operator;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "The operator '%s' is not in the list of valid operators: %s",
-                    "event_espresso"
-                ),
-                $operator_supplied,
-                implode(",", array_keys($this->_valid_operators))
-            )
-        );
-    }
-
-
-    /**
-     * Gets the valid operators
-     *
-     * @return array keys are accepted strings, values are the SQL they are converted to
-     */
-    public function valid_operators()
-    {
-        return $this->_valid_operators;
-    }
-
-
-    /**
-     * Gets the between-style operators (take 2 arguments).
-     *
-     * @return array keys are accepted strings, values are the SQL they are converted to
-     */
-    public function valid_between_style_operators()
-    {
-        return array_intersect(
-            $this->valid_operators(),
-            $this->_between_style_operators
-        );
-    }
-
-
-    /**
-     * Gets the "like"-style operators (take a single argument, but it may contain wildcards)
-     *
-     * @return array keys are accepted strings, values are the SQL they are converted to
-     */
-    public function valid_like_style_operators()
-    {
-        return array_intersect(
-            $this->valid_operators(),
-            $this->_like_style_operators
-        );
-    }
-
-
-    /**
-     * Gets the "in"-style operators
-     *
-     * @return array keys are accepted strings, values are the SQL they are converted to
-     */
-    public function valid_in_style_operators()
-    {
-        return array_intersect(
-            $this->valid_operators(),
-            $this->_in_style_operators
-        );
-    }
-
-
-    /**
-     * Gets the "null"-style operators (accept no arguments)
-     *
-     * @return array keys are accepted strings, values are the SQL they are converted to
-     */
-    public function valid_null_style_operators()
-    {
-        return array_intersect(
-            $this->valid_operators(),
-            $this->_null_style_operators
-        );
-    }
-
-
-    /**
-     * Gets an array where keys are the primary keys and values are their 'names'
-     * (as determined by the model object's name() function, which is often overridden)
-     *
-     * @param array $query_params like get_all's
-     * @return string[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_names($query_params = [])
-    {
-        $objs  = $this->get_all($query_params);
-        $names = [];
-        foreach ($objs as $obj) {
-            $names[ $obj->ID() ] = $obj->name();
-        }
-        return $names;
-    }
-
-
-    /**
-     * Gets an array of primary keys from the model objects. If you acquired the model objects
-     * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
-     * this is duplicated effort and reduces efficiency) you would be better to use
-     * array_keys() on $model_objects.
-     *
-     * @param \EE_Base_Class[] $model_objects
-     * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
-     *                                               in the returned array
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_IDs($model_objects, $filter_out_empty_ids = false)
-    {
-        if (! $this->has_primary_key_field()) {
-            if (WP_DEBUG) {
-                EE_Error::add_error(
-                    esc_html__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        $IDs = [];
-        foreach ($model_objects as $model_object) {
-            $id = $model_object->ID();
-            if (! $id) {
-                if ($filter_out_empty_ids) {
-                    continue;
-                }
-                if (WP_DEBUG) {
-                    EE_Error::add_error(
-                        esc_html__(
-                            'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
-                            'event_espresso'
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-            $IDs[] = $id;
-        }
-        return $IDs;
-    }
-
-
-    /**
-     * Returns the string used in capabilities relating to this model. If there
-     * are no capabilities that relate to this model returns false
-     *
-     * @return string|false
-     */
-    public function cap_slug()
-    {
-        return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
-    }
-
-
-    /**
-     * Returns the capability-restrictions array (@param string $context
-     *
-     * @return EE_Default_Where_Conditions[] indexed by associated capability
-     * @throws EE_Error
-     * @see EEM_Base::_cap_restrictions).
-     *      If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
-     *      only returns the cap restrictions array in that context (ie, the array
-     *      at that key)
-     *
-     */
-    public function cap_restrictions($context = EEM_Base::caps_read)
-    {
-        EEM_Base::verify_is_valid_cap_context($context);
-        // check if we ought to run the restriction generator first
-        if (
-            isset($this->_cap_restriction_generators[ $context ])
-            && $this->_cap_restriction_generators[ $context ] instanceof EE_Restriction_Generator_Base
-            && ! $this->_cap_restriction_generators[ $context ]->has_generated_cap_restrictions()
-        ) {
-            $this->_cap_restrictions[ $context ] = array_merge(
-                $this->_cap_restrictions[ $context ],
-                $this->_cap_restriction_generators[ $context ]->generate_restrictions()
-            );
-        }
-        // and make sure we've finalized the construction of each restriction
-        foreach ($this->_cap_restrictions[ $context ] as $where_conditions_obj) {
-            if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
-                $where_conditions_obj->_finalize_construct($this);
-            }
-        }
-        return $this->_cap_restrictions[ $context ];
-    }
-
-
-    /**
-     * Indicating whether or not this model thinks its a wp core model
-     *
-     * @return boolean
-     */
-    public function is_wp_core_model()
-    {
-        return $this->_wp_core_model;
-    }
-
-
-    /**
-     * Gets all the caps that are missing which impose a restriction on
-     * queries made in this context
-     *
-     * @param string $context one of EEM_Base::caps_ constants
-     * @return EE_Default_Where_Conditions[] indexed by capability name
-     * @throws EE_Error
-     */
-    public function caps_missing($context = EEM_Base::caps_read)
-    {
-        $missing_caps     = [];
-        $cap_restrictions = $this->cap_restrictions($context);
-        foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
-            if (
-                ! EE_Capabilities::instance()
-                                 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
-            ) {
-                $missing_caps[ $cap ] = $restriction_if_no_cap;
-            }
-        }
-        return $missing_caps;
-    }
-
-
-    /**
-     * Gets the mapping from capability contexts to action strings used in capability names
-     *
-     * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
-     * one of 'read', 'edit', or 'delete'
-     */
-    public function cap_contexts_to_cap_action_map()
-    {
-        return apply_filters(
-            'FHEE__EEM_Base__cap_contexts_to_cap_action_map',
-            $this->_cap_contexts_to_cap_action_map,
-            $this
-        );
-    }
-
-
-    /**
-     * Gets the action string for the specified capability context
-     *
-     * @param string $context
-     * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
-     * @throws EE_Error
-     */
-    public function cap_action_for_context($context)
-    {
-        $mapping = $this->cap_contexts_to_cap_action_map();
-        if (isset($mapping[ $context ])) {
-            return $mapping[ $context ];
-        }
-        if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
-            return $action;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'Cannot find capability restrictions for context "%1$s", allowed values are:%2$s',
-                    'event_espresso'
-                ),
-                $context,
-                implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
-            )
-        );
-    }
-
-
-    /**
-     * Returns all the capability contexts which are valid when querying models
-     *
-     * @return array
-     */
-    public static function valid_cap_contexts()
-    {
-        return apply_filters('FHEE__EEM_Base__valid_cap_contexts', [
-            self::caps_read,
-            self::caps_read_admin,
-            self::caps_edit,
-            self::caps_delete,
-        ]);
-    }
-
-
-    /**
-     * Returns all valid options for 'default_where_conditions'
-     *
-     * @return array
-     */
-    public static function valid_default_where_conditions()
-    {
-        return [
-            EEM_Base::default_where_conditions_all,
-            EEM_Base::default_where_conditions_this_only,
-            EEM_Base::default_where_conditions_others_only,
-            EEM_Base::default_where_conditions_minimum_all,
-            EEM_Base::default_where_conditions_minimum_others,
-            EEM_Base::default_where_conditions_none,
-        ];
-    }
-
-    // public static function default_where_conditions_full
-
-
-    /**
-     * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
-     *
-     * @param string $context
-     * @return bool
-     * @throws EE_Error
-     */
-    public static function verify_is_valid_cap_context($context)
-    {
-        $valid_cap_contexts = EEM_Base::valid_cap_contexts();
-        if (in_array($context, $valid_cap_contexts)) {
-            return true;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
-                    'event_espresso'
-                ),
-                $context,
-                'EEM_Base',
-                implode(',', $valid_cap_contexts)
-            )
-        );
-    }
-
-
-    /**
-     * Clears all the models field caches. This is only useful when a sub-class
-     * might have added a field or something and these caches might be invalidated
-     */
-    protected function _invalidate_field_caches()
-    {
-        $this->_cache_foreign_key_to_fields = [];
-        $this->_cached_fields               = null;
-        $this->_cached_fields_non_db_only   = null;
-    }
-
-
-    /**
-     * Gets the list of all the where query param keys that relate to logic instead of field names
-     * (eg "and", "or", "not").
-     *
-     * @return array
-     */
-    public function logic_query_param_keys()
-    {
-        return $this->_logic_query_param_keys;
-    }
-
-
-    /**
-     * Determines whether or not the where query param array key is for a logic query param.
-     * Eg 'OR', 'not*', and 'and*because-i-say-so' should all return true, whereas
-     * 'ATT_fname', 'EVT_name*not-you-or-me', and 'ORG_name' should return false
-     *
-     * @param $query_param_key
-     * @return bool
-     */
-    public function is_logic_query_param_key($query_param_key)
-    {
-        foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
-            if (
-                $query_param_key === $logic_query_param_key
-                || strpos($query_param_key, $logic_query_param_key . '*') === 0
-            ) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns true if this model has a password field on it (regardless of whether that password field has any content)
-     *
-     * @return boolean
-     * @since 4.9.74.p
-     */
-    public function hasPassword()
-    {
-        // if we don't yet know if there's a password field, find out and remember it for next time.
-        if ($this->has_password_field === null) {
-            $password_field           = $this->getPasswordField();
-            $this->has_password_field = $password_field instanceof EE_Password_Field ? true : false;
-        }
-        return $this->has_password_field;
-    }
-
-
-    /**
-     * Returns the password field on this model, if there is one
-     *
-     * @return EE_Password_Field|null
-     * @since 4.9.74.p
-     */
-    public function getPasswordField()
-    {
-        // if we definetely already know there is a password field or not (because has_password_field is true or false)
-        // there's no need to search for it. If we don't know yet, then find out
-        if ($this->has_password_field === null && $this->password_field === null) {
-            $this->password_field = $this->get_a_field_of_type('EE_Password_Field');
-        }
-        // don't bother setting has_password_field because that's hasPassword()'s job.
-        return $this->password_field;
-    }
-
-
-    /**
-     * Returns the list of field (as EE_Model_Field_Bases) that are protected by the password
-     *
-     * @return EE_Model_Field_Base[]
-     * @throws EE_Error
-     * @since 4.9.74.p
-     */
-    public function getPasswordProtectedFields()
-    {
-        $password_field = $this->getPasswordField();
-        $fields         = [];
-        if ($password_field instanceof EE_Password_Field) {
-            $field_names = $password_field->protectedFields();
-            foreach ($field_names as $field_name) {
-                $fields[ $field_name ] = $this->field_settings_for($field_name);
-            }
-        }
-        return $fields;
-    }
-
-
-    /**
-     * Checks if the current user can perform the requested action on this model
-     *
-     * @param string              $cap_to_check one of the array keys from _cap_contexts_to_cap_action_map
-     * @param EE_Base_Class|array $model_obj_or_fields_n_values
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     * @since 4.9.74.p
-     */
-    public function currentUserCan($cap_to_check, $model_obj_or_fields_n_values)
-    {
-        if ($model_obj_or_fields_n_values instanceof EE_Base_Class) {
-            $model_obj_or_fields_n_values = $model_obj_or_fields_n_values->model_field_array();
-        }
-        if (! is_array($model_obj_or_fields_n_values)) {
-            throw new UnexpectedEntityException(
-                $model_obj_or_fields_n_values,
-                'EE_Base_Class',
-                sprintf(
-                    esc_html__(
-                        '%1$s must be passed an `EE_Base_Class or an array of fields names with their values. You passed in something different.',
-                        'event_espresso'
-                    ),
-                    __FUNCTION__
-                )
-            );
-        }
-        return $this->exists(
-            $this->alter_query_params_to_restrict_by_ID(
-                $this->get_index_primary_key_string($model_obj_or_fields_n_values),
-                [
-                    'default_where_conditions' => 'none',
-                    'caps'                     => $cap_to_check,
-                ]
-            )
-        );
-    }
-
-
-    /**
-     * Returns the query param where conditions key to the password affecting this model.
-     * Eg on EEM_Event this would just be "password", on EEM_Datetime this would be "Event.password", etc.
-     *
-     * @return null|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @since 4.9.74.p
-     */
-    public function modelChainAndPassword()
-    {
-        if ($this->model_chain_to_password === null) {
-            throw new ModelConfigurationException(
-                $this,
-                esc_html_x(
-                // @codingStandardsIgnoreStart
-                    'Cannot exclude protected data because the model has not specified which model has the password.',
-                    // @codingStandardsIgnoreEnd
-                    '1: model name',
-                    'event_espresso'
-                )
-            );
-        }
-        if ($this->model_chain_to_password === '') {
-            $model_with_password = $this;
-        } else {
-            if ($pos_of_period = strrpos($this->model_chain_to_password, '.')) {
-                $last_model_in_chain = substr($this->model_chain_to_password, $pos_of_period + 1);
-            } else {
-                $last_model_in_chain = $this->model_chain_to_password;
-            }
-            $model_with_password = EE_Registry::instance()->load_model($last_model_in_chain);
-        }
-
-        $password_field = $model_with_password->getPasswordField();
-        if ($password_field instanceof EE_Password_Field) {
-            $password_field_name = $password_field->get_name();
-        } else {
-            throw new ModelConfigurationException(
-                $this,
-                sprintf(
-                    esc_html_x(
-                        'This model claims related model "%1$s" should have a password field on it, but none was found. The model relation chain is "%2$s"',
-                        '1: model name, 2: special string',
-                        'event_espresso'
-                    ),
-                    $model_with_password->get_this_model_name(),
-                    $this->model_chain_to_password
-                )
-            );
-        }
-        return ($this->model_chain_to_password ? $this->model_chain_to_password . '.' : '') . $password_field_name;
-    }
-
-
-    /**
-     * Returns true if there is a password on a related model which restricts access to some of this model's rows,
-     * or if this model itself has a password affecting access to some of its other fields.
-     *
-     * @return boolean
-     * @since 4.9.74.p
-     */
-    public function restrictedByRelatedModelPassword()
-    {
-        return $this->model_chain_to_password !== null;
-    }
+		}
+		return $null_friendly_where_conditions;
+	}
+
+
+	/**
+	 * Uses the _default_where_conditions_strategy set during __construct() to get
+	 * default where conditions on all get_all, update, and delete queries done by this model.
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
+	 *
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
+	 * @return array @see
+	 *                                    https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	private function _get_default_where_conditions($model_relation_path = '')
+	{
+		if ($this->_ignore_where_strategy) {
+			return [];
+		}
+		return $this->_default_where_conditions_strategy->get_default_where_conditions($model_relation_path);
+	}
+
+
+	/**
+	 * Uses the _minimum_where_conditions_strategy set during __construct() to get
+	 * minimum where conditions on all get_all, update, and delete queries done by this model.
+	 * Use the same syntax as client code. Eg on the Event model, use array('Event.EVT_post_type'=>'esp_event'),
+	 * NOT array('Event_CPT.post_type'=>'esp_event').
+	 * Similar to _get_default_where_conditions
+	 *
+	 * @param string $model_relation_path eg, path from Event to Payment is "Registration.Transaction.Payment."
+	 * @return array @see
+	 *                                    https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _get_minimum_where_conditions($model_relation_path = '')
+	{
+		if ($this->_ignore_where_strategy) {
+			return [];
+		}
+		return $this->_minimum_where_conditions_strategy->get_default_where_conditions($model_relation_path);
+	}
+
+
+	/**
+	 * Creates the string of SQL for the select part of a select query, everything behind SELECT and before FROM.
+	 * Eg, "Event.post_id, Event.post_name,Event_Detail.EVT_ID..."
+	 *
+	 * @param EE_Model_Query_Info_Carrier $model_query_info
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function _construct_default_select_sql(EE_Model_Query_Info_Carrier $model_query_info)
+	{
+		$selects = $this->_get_columns_to_select_for_this_model();
+		foreach (
+			$model_query_info->get_model_names_included() as $model_relation_chain => $name_of_other_model_included
+		) {
+			$other_model_included = $this->get_related_model_obj($name_of_other_model_included);
+			$other_model_selects  = $other_model_included->_get_columns_to_select_for_this_model($model_relation_chain);
+			foreach ($other_model_selects as $key => $value) {
+				$selects[] = $value;
+			}
+		}
+		return implode(", ", $selects);
+	}
+
+
+	/**
+	 * Gets an array of columns to select for this model, which are necessary for it to create its objects.
+	 * So that's going to be the columns for all the fields on the model
+	 *
+	 * @param string $model_relation_chain like 'Question.Question_Group.Event'
+	 * @return array numerically indexed, values are columns to select and rename, eg "Event.ID AS 'Event.ID'"
+	 */
+	public function _get_columns_to_select_for_this_model($model_relation_chain = '')
+	{
+		$fields                                       = $this->field_settings();
+		$selects                                      = [];
+		$table_alias_with_model_relation_chain_prefix =
+			EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$model_relation_chain,
+				$this->get_this_model_name()
+			);
+		foreach ($fields as $field_obj) {
+			$selects[] = $table_alias_with_model_relation_chain_prefix
+						 . $field_obj->get_table_alias()
+						 . "."
+						 . $field_obj->get_table_column()
+						 . " AS '"
+						 . $table_alias_with_model_relation_chain_prefix
+						 . $field_obj->get_table_alias()
+						 . "."
+						 . $field_obj->get_table_column()
+						 . "'";
+		}
+		// make sure we are also getting the PKs of each table
+		$tables = $this->get_tables();
+		if (count($tables) > 1) {
+			foreach ($tables as $table_obj) {
+				$qualified_pk_column = $table_alias_with_model_relation_chain_prefix
+									   . $table_obj->get_fully_qualified_pk_column();
+				if (! in_array($qualified_pk_column, $selects)) {
+					$selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
+				}
+			}
+		}
+		return $selects;
+	}
+
+
+	/**
+	 * Given a $query_param like 'Registration.Transaction.TXN_ID', pops off 'Registration.',
+	 * gets the join statement for it; gets the data types for it; and passes the remaining 'Transaction.TXN_ID'
+	 * onto its related Transaction object to do the same. Returns an EE_Join_And_Data_Types object which contains the
+	 * SQL for joining, and the data types
+	 *
+	 * @param null|string                 $original_query_param
+	 * @param string                      $query_param          like Registration.Transaction.TXN_ID
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
+	 * @param string                      $query_param_type     like Registration.Transaction.TXN_ID
+	 *                                                          or 'PAY_ID'. Otherwise, we don't expect there to be a
+	 *                                                          column name. We only want model names, eg 'Event.Venue'
+	 *                                                          or 'Registration's
+	 * @param string                      $original_query_param what it originally was (eg
+	 *                                                          Registration.Transaction.TXN_ID). If null, we assume it
+	 *                                                          matches $query_param
+	 * @return void only modifies the EEM_Related_Model_Info_Carrier passed into it
+	 * @throws EE_Error
+	 */
+	private function _extract_related_model_info_from_query_param(
+		$query_param,
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
+		$query_param_type,
+		$original_query_param = null
+	) {
+		if ($original_query_param === null) {
+			$original_query_param = $query_param;
+		}
+		$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
+		// check to see if we have a field on this model
+		$this_model_fields = $this->field_settings(true);
+		if (array_key_exists($query_param, $this_model_fields)) {
+			$field_is_allowed = in_array(
+				$query_param_type,
+				[0, 'where', 'having', 'order_by', 'group_by', 'order', 'custom_selects'],
+				true
+			);
+			if ($field_is_allowed) {
+				return;
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Using a field name (%s) on model %s is not allowed on this query param type '%s'. Original query param was %s",
+						"event_espresso"
+					),
+					$query_param,
+					get_class($this),
+					$query_param_type,
+					$original_query_param
+				)
+			);
+		}
+		// check if this is a special logic query param
+		if (in_array($query_param, $this->_logic_query_param_keys, true)) {
+			$operator_is_allowed = in_array($query_param_type, ['where', 'having', 0, 'custom_selects'], true);
+			if ($operator_is_allowed) {
+				return;
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Logic query params ("%1$s") are being used incorrectly with the following query param ("%2$s") on model %3$s. %4$sAdditional Info:%4$s%5$s',
+						'event_espresso'
+					),
+					implode('", "', $this->_logic_query_param_keys),
+					$query_param,
+					get_class($this),
+					'<br />',
+					"\t"
+					. ' $passed_in_query_info = <pre>'
+					. print_r($passed_in_query_info, true)
+					. '</pre>'
+					. "\n\t"
+					. ' $query_param_type = '
+					. $query_param_type
+					. "\n\t"
+					. ' $original_query_param = '
+					. $original_query_param
+				)
+			);
+		}
+		// check if it's a custom selection
+		if (
+			$this->_custom_selections instanceof CustomSelects
+			&& in_array($query_param, $this->_custom_selections->columnAliases(), true)
+		) {
+			return;
+		}
+		// check if has a model name at the beginning
+		// and
+		// check if it's a field on a related model
+		if (
+			$this->extractJoinModelFromQueryParams(
+				$passed_in_query_info,
+				$query_param,
+				$original_query_param,
+				$query_param_type
+			)
+		) {
+			return;
+		}
+
+		// ok so $query_param didn't start with a model name
+		// and we previously confirmed it wasn't a logic query param or field on the current model
+		// it's wack, that's what it is
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"There is no model named '%s' related to %s. Query param type is %s and original query param is %s",
+					"event_espresso"
+				),
+				$query_param,
+				get_class($this),
+				$query_param_type,
+				$original_query_param
+			)
+		);
+	}
+
+
+	/**
+	 * Extracts any possible join model information from the provided possible_join_string.
+	 * This method will read the provided $possible_join_string value and determine if there are any possible model
+	 * join
+	 * parts that should be added to the query.
+	 *
+	 * @param EE_Model_Query_Info_Carrier $query_info_carrier
+	 * @param string                      $possible_join_string  Such as Registration.REG_ID, or Registration
+	 * @param null|string                 $original_query_param
+	 * @param string                      $query_parameter_type  The type for the source of the $possible_join_string
+	 *                                                           ('where', 'order_by', 'group_by', 'custom_selects'
+	 *                                                           etc.)
+	 * @return bool  returns true if a join was added and false if not.
+	 * @throws EE_Error
+	 */
+	private function extractJoinModelFromQueryParams(
+		EE_Model_Query_Info_Carrier $query_info_carrier,
+		$possible_join_string,
+		$original_query_param,
+		$query_parameter_type
+	) {
+		foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
+			if (strpos($possible_join_string, $valid_related_model_name . ".") === 0) {
+				$this->_add_join_to_model($valid_related_model_name, $query_info_carrier, $original_query_param);
+				$possible_join_string = substr($possible_join_string, strlen($valid_related_model_name . "."));
+				if ($possible_join_string === '') {
+					// nothing left to $query_param
+					// we should actually end in a field name, not a model like this!
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								"Query param '%s' (of type %s on model %s) shouldn't end on a period (.) ",
+								"event_espresso"
+							),
+							$possible_join_string,
+							$query_parameter_type,
+							get_class($this),
+							$valid_related_model_name
+						)
+					);
+				}
+				$related_model_obj = $this->get_related_model_obj($valid_related_model_name);
+				$related_model_obj->_extract_related_model_info_from_query_param(
+					$possible_join_string,
+					$query_info_carrier,
+					$query_parameter_type,
+					$original_query_param
+				);
+				return true;
+			}
+			if ($possible_join_string === $valid_related_model_name) {
+				$this->_add_join_to_model(
+					$valid_related_model_name,
+					$query_info_carrier,
+					$original_query_param
+				);
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Extracts related models from Custom Selects and sets up any joins for those related models.
+	 *
+	 * @param EE_Model_Query_Info_Carrier $query_info_carrier
+	 * @throws EE_Error
+	 */
+	private function extractRelatedModelsFromCustomSelects(EE_Model_Query_Info_Carrier $query_info_carrier)
+	{
+		if (
+			$this->_custom_selections instanceof CustomSelects
+			&& (
+				$this->_custom_selections->type() === CustomSelects::TYPE_STRUCTURED
+				|| $this->_custom_selections->type() == CustomSelects::TYPE_COMPLEX
+			)
+		) {
+			$original_selects = $this->_custom_selections->originalSelects();
+			foreach ($original_selects as $alias => $select_configuration) {
+				$this->extractJoinModelFromQueryParams(
+					$query_info_carrier,
+					$select_configuration[0],
+					$select_configuration[0],
+					'custom_selects'
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Privately used by _extract_related_model_info_from_query_param to add a join to $model_name
+	 * and store it on $passed_in_query_info
+	 *
+	 * @param string                      $model_name
+	 * @param EE_Model_Query_Info_Carrier $passed_in_query_info
+	 * @param string                      $original_query_param used to extract the relation chain between the queried
+	 *                                                          model and $model_name. Eg, if we are querying Event,
+	 *                                                          and are adding a join to 'Payment' with the original
+	 *                                                          query param key
+	 *                                                          'Registration.Transaction.Payment.PAY_amount', we want
+	 *                                                          to extract 'Registration.Transaction.Payment', in case
+	 *                                                          Payment wants to add default query params so that it
+	 *                                                          will know what models to prepend onto its default query
+	 *                                                          params or in case it wants to rename tables (in case
+	 *                                                          there are multiple joins to the same table)
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _add_join_to_model(
+		$model_name,
+		EE_Model_Query_Info_Carrier $passed_in_query_info,
+		$original_query_param
+	) {
+		$relation_obj         = $this->related_settings_for($model_name);
+		$model_relation_chain = EE_Model_Parser::extract_model_relation_chain($model_name, $original_query_param);
+		// check if the relation is HABTM, because then we're essentially doing two joins
+		// If so, join first to the JOIN table, and add its data types, and then continue as normal
+		if ($relation_obj instanceof EE_HABTM_Relation) {
+			$join_model_obj = $relation_obj->get_join_model();
+			// replace the model specified with the join model for this relation chain, whi
+			$relation_chain_to_join_model =
+				EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain(
+					$model_name,
+					$join_model_obj->get_this_model_name(),
+					$model_relation_chain
+				);
+			$passed_in_query_info->merge(
+				new EE_Model_Query_Info_Carrier(
+					[$relation_chain_to_join_model => $join_model_obj->get_this_model_name()],
+					$relation_obj->get_join_to_intermediate_model_statement($relation_chain_to_join_model)
+				)
+			);
+		}
+		// now just join to the other table pointed to by the relation object, and add its data types
+		$passed_in_query_info->merge(
+			new EE_Model_Query_Info_Carrier(
+				[$model_relation_chain => $model_name],
+				$relation_obj->get_join_statement($model_relation_chain)
+			)
+		);
+	}
+
+
+	/**
+	 * Constructs SQL for where clause, like "WHERE Event.ID = 23 AND Transaction.amount > 100" etc.
+	 *
+	 * @param array $where_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @return string of SQL
+	 * @throws EE_Error
+	 */
+	private function _construct_where_clause($where_params)
+	{
+		$SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
+		if ($SQL) {
+			return " WHERE " . $SQL;
+		}
+		return '';
+	}
+
+
+	/**
+	 * Just like the _construct_where_clause, except prepends 'HAVING' instead of 'WHERE',
+	 * and should be passed HAVING parameters, not WHERE parameters
+	 *
+	 * @param array $having_params
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function _construct_having_clause($having_params)
+	{
+		$SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
+		if ($SQL) {
+			return " HAVING " . $SQL;
+		}
+		return '';
+	}
+
+
+	/**
+	 * Used for creating nested WHERE conditions. Eg "WHERE ! (Event.ID = 3 OR ( Event_Meta.meta_key = 'bob' AND
+	 * Event_Meta.meta_value = 'foo'))"
+	 *
+	 * @param array  $where_params @see
+	 *                             https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @param string $glue         joins each subclause together. Should really only be " AND " or " OR "...
+	 * @return string of SQL
+	 * @throws EE_Error
+	 */
+	private function _construct_condition_clause_recursive($where_params, $glue = ' AND')
+	{
+		$where_clauses = [];
+		foreach ($where_params as $query_param => $op_and_value_or_sub_condition) {
+			$query_param = $this->_remove_stars_and_anything_after_from_condition_query_param_key($query_param);
+			if (in_array($query_param, $this->_logic_query_param_keys, true)) {
+				switch ($query_param) {
+					case 'not':
+					case 'NOT':
+						$where_clauses[] = "! ("
+										   . $this->_construct_condition_clause_recursive(
+								$op_and_value_or_sub_condition,
+								$glue
+							)
+										   . ")";
+						break;
+					case 'and':
+					case 'AND':
+						$where_clauses[] = " ("
+										   . $this->_construct_condition_clause_recursive(
+								$op_and_value_or_sub_condition,
+								' AND '
+							)
+										   . ")";
+						break;
+					case 'or':
+					case 'OR':
+						$where_clauses[] = " ("
+										   . $this->_construct_condition_clause_recursive(
+								$op_and_value_or_sub_condition,
+								' OR '
+							)
+										   . ")";
+						break;
+				}
+			} else {
+				$field_obj = $this->_deduce_field_from_query_param($query_param);
+				// if it's not a normal field, maybe it's a custom selection?
+				if (! $field_obj) {
+					if ($this->_custom_selections instanceof CustomSelects) {
+						$field_obj = $this->_custom_selections->getDataTypeForAlias($query_param);
+					} else {
+						throw new EE_Error(
+							sprintf(
+								esc_html__(
+									"%s is neither a valid model field name, nor a custom selection",
+									"event_espresso"
+								),
+								$query_param
+							)
+						);
+					}
+				}
+				$op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
+				$where_clauses[]  = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
+			}
+		}
+		return $where_clauses ? implode($glue, $where_clauses) : '';
+	}
+
+
+	/**
+	 * Takes the input parameter and extract the table name (alias) and column name
+	 *
+	 * @param string $query_param like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
+	 * @return string table alias and column name for SQL, eg "Transaction.TXN_ID"
+	 * @throws EE_Error
+	 */
+	private function _deduce_column_name_from_query_param($query_param)
+	{
+		$field = $this->_deduce_field_from_query_param($query_param);
+		if ($field) {
+			$table_alias_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_from_query_param(
+				$field->get_model_name(),
+				$query_param
+			);
+			return $table_alias_prefix . $field->get_qualified_column();
+		}
+		if (
+			$this->_custom_selections instanceof CustomSelects
+			&& in_array($query_param, $this->_custom_selections->columnAliases(), true)
+		) {
+			// maybe it's custom selection item?
+			// if so, just use it as the "column name"
+			return $query_param;
+		}
+		$custom_select_aliases = $this->_custom_selections instanceof CustomSelects
+			? implode(',', $this->_custom_selections->columnAliases())
+			: '';
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"%s is not a valid field on this model, nor a custom selection (%s)",
+					"event_espresso"
+				),
+				$query_param,
+				$custom_select_aliases
+			)
+		);
+	}
+
+
+	/**
+	 * Removes the * and anything after it from the condition query param key. It is useful to add the * to condition
+	 * query param keys (eg, 'OR*', 'EVT_ID') in order for the array keys to still be unique, so that they don't get
+	 * overwritten Takes a string like 'Event.EVT_ID*', 'TXN_total**', 'OR*1st', and 'DTT_reg_start*foobar' to
+	 * 'Event.EVT_ID', 'TXN_total', 'OR', and 'DTT_reg_start', respectively.
+	 *
+	 * @param string $condition_query_param_key
+	 * @return string
+	 */
+	private function _remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
+	{
+		$pos_of_star = strpos($condition_query_param_key, '*');
+		if ($pos_of_star === false) {
+			return $condition_query_param_key;
+		}
+		$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
+		return $condition_query_param_sans_star;
+	}
+
+
+	/**
+	 * creates the SQL for the operator and the value in a WHERE clause, eg "< 23" or "LIKE '%monkey%'"
+	 *
+	 * @param mixed      array | string    $op_and_value
+	 * @param EE_Model_Field_Base|string $field_obj . If string, should be one of EEM_Base::_valid_wpdb_data_types
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function _construct_op_and_value($op_and_value, $field_obj)
+	{
+		if (is_array($op_and_value)) {
+			$operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
+			if (! $operator) {
+				$php_array_like_string = [];
+				foreach ($op_and_value as $key => $value) {
+					$php_array_like_string[] = "$key=>$value";
+				}
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"You setup a query parameter like you were going to specify an operator, but didn't. You provided '(%s)', but the operator should be at array key index 0 (eg array('>',32))",
+							"event_espresso"
+						),
+						implode(",", $php_array_like_string)
+					)
+				);
+			}
+			$value = isset($op_and_value[1]) ? $op_and_value[1] : null;
+		} else {
+			$operator = '=';
+			$value    = $op_and_value;
+		}
+		// check to see if the value is actually another field
+		if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
+			return $operator . SP . $this->_deduce_column_name_from_query_param($value);
+		}
+		if (in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
+			// in this case, the value should be an array, or at least a comma-separated list
+			// it will need to handle a little differently
+			$cleaned_value = $this->_construct_in_value($value, $field_obj);
+			// note: $cleaned_value has already been run through $wpdb->prepare()
+			return $operator . SP . $cleaned_value;
+		}
+		if (in_array($operator, $this->valid_between_style_operators()) && is_array($value)) {
+			// the value should be an array with count of two.
+			if (count($value) !== 2) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"The '%s' operator must be used with an array of values and there must be exactly TWO values in that array.",
+							'event_espresso'
+						),
+						"BETWEEN"
+					)
+				);
+			}
+			$cleaned_value = $this->_construct_between_value($value, $field_obj);
+			return $operator . SP . $cleaned_value;
+		}
+		if (in_array($operator, $this->valid_null_style_operators())) {
+			if ($value !== null) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"You attempted to give a value  (%s) while using a NULL-style operator (%s). That isn't valid",
+							"event_espresso"
+						),
+						$value,
+						$operator
+					)
+				);
+			}
+			return $operator;
+		}
+		if (in_array($operator, $this->valid_like_style_operators()) && ! is_array($value)) {
+			// if the operator is 'LIKE', we want to allow percent signs (%) and not
+			// remove other junk. So just treat it as a string.
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
+		}
+		if (! in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
+			return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
+		}
+		if (in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Operator '%s' must be used with an array of values, eg 'Registration.REG_ID' => array('%s',array(1,2,3))",
+						'event_espresso'
+					),
+					$operator,
+					$operator
+				)
+			);
+		}
+		if (! in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Operator '%s' must be used with a single value, not an array. Eg 'Registration.REG_ID => array('%s',23))",
+						'event_espresso'
+					),
+					$operator,
+					$operator
+				)
+			);
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"It appears you've provided some totally invalid query parameters. Operator and value were:'%s', which isn't right at all",
+					"event_espresso"
+				),
+				http_build_query($op_and_value)
+			)
+		);
+	}
+
+
+	/**
+	 * Creates the operands to be used in a BETWEEN query, eg "'2014-12-31 20:23:33' AND '2015-01-23 12:32:54'"
+	 *
+	 * @param array                      $values
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be the datatype to be used when querying, eg
+	 *                                              '%s'
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function _construct_between_value($values, $field_obj)
+	{
+		$cleaned_values = [];
+		foreach ($values as $value) {
+			$cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
+		}
+		return $cleaned_values[0] . " AND " . $cleaned_values[1];
+	}
+
+
+	/**
+	 * Takes an array or a comma-separated list of $values and cleans them
+	 * according to $data_type using $wpdb->prepare, and then makes the list a
+	 * string surrounded by ( and ). Eg, _construct_in_value(array(1,2,3),'%d') would
+	 * return '(1,2,3)'; _construct_in_value("1,2,hack",'%d') would return '(1,2,1)' (assuming
+	 * I'm right that a string, when interpreted as a digit, becomes a 1. It might become a 0)
+	 *
+	 * @param mixed                      $values    array or comma-separated string
+	 * @param EE_Model_Field_Base|string $field_obj if string, it should be a wpdb data type like '%s', or '%d'
+	 * @return string of SQL to follow an 'IN' or 'NOT IN' operator
+	 * @throws EE_Error
+	 */
+	public function _construct_in_value($values, $field_obj)
+	{
+		$prepped = [];
+		// check if the value is a CSV list
+		if (is_string($values)) {
+			// in which case, turn it into an array
+			$values = explode(',', $values);
+		}
+		// make sure we only have one of each value in the list
+		$values = array_unique($values);
+		foreach ($values as $value) {
+			$prepped[] = $this->_wpdb_prepare_using_field($value, $field_obj);
+		}
+		// we would just LOVE to leave $cleaned_values as an empty array, and return the value as "()",
+		// but unfortunately that's invalid SQL. So instead we return a string which we KNOW will evaluate to be the empty set
+		// which is effectively equivalent to returning "()". We don't return "(0)" because that only works for auto-incrementing columns
+		if (empty($prepped)) {
+			$all_fields  = $this->field_settings();
+			$first_field = reset($all_fields);
+			$main_table  = $this->_get_main_table();
+			$prepped[]   = "SELECT {$first_field->get_table_column()} FROM {$main_table->get_table_name()} WHERE FALSE";
+		}
+		return '(' . implode(',', $prepped) . ')';
+	}
+
+
+	/**
+	 * @param mixed                      $value
+	 * @param EE_Model_Field_Base|string $field_obj if string it should be a wpdb data type like '%d'
+	 * @return false|null|string
+	 * @throws EE_Error
+	 */
+	private function _wpdb_prepare_using_field($value, $field_obj)
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			return $wpdb->prepare(
+				$field_obj->get_wpdb_data_type(),
+				$this->_prepare_value_for_use_in_db($value, $field_obj)
+			);
+		} //$field_obj should really just be a data type
+		if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
+					$field_obj,
+					implode(",", $this->_valid_wpdb_data_types)
+				)
+			);
+		}
+		return $wpdb->prepare($field_obj, $value);
+	}
+
+
+	/**
+	 * Takes the input parameter and finds the model field that it indicates.
+	 *
+	 * @param string $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
+	 * @return EE_Model_Field_Base
+	 * @throws EE_Error
+	 */
+	protected function _deduce_field_from_query_param($query_param_name)
+	{
+		// ok, now proceed with deducing which part is the model's name, and which is the field's name
+		// which will help us find the database table and column
+		$query_param_parts = explode(".", $query_param_name);
+		if (empty($query_param_parts)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"_extract_column_name is empty when trying to extract column and table name from %s",
+						'event_espresso'
+					),
+					$query_param_name
+				)
+			);
+		}
+		$number_of_parts       = count($query_param_parts);
+		$last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ];
+		if ($number_of_parts === 1) {
+			$field_name = $last_query_param_part;
+			$model_obj  = $this;
+		} else {// $number_of_parts >= 2
+			// the last part is the column name, and there are only 2parts. therefore...
+			$field_name = $last_query_param_part;
+			$model_obj  = $this->get_related_model_obj($query_param_parts[ $number_of_parts - 2 ]);
+		}
+		try {
+			return $model_obj->field_settings_for($field_name);
+		} catch (EE_Error $e) {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Given a field's name (ie, a key in $this->field_settings()), uses the EE_Model_Field object to get the table's
+	 * alias and column which corresponds to it
+	 *
+	 * @param string $field_name
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function _get_qualified_column_for_field($field_name)
+	{
+		$all_fields = $this->field_settings();
+		$field      = isset($all_fields[ $field_name ]) ? $all_fields[ $field_name ] : false;
+		if ($field) {
+			return $field->get_qualified_column();
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"There is no field titled %s on model %s. Either the query trying to use it is bad, or you need to add it to the list of fields on the model.",
+					'event_espresso'
+				),
+				$field_name,
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * similar to \EEM_Base::_get_qualified_column_for_field() but returns an array with data for ALL fields.
+	 * Example usage:
+	 * EEM_Ticket::instance()->get_all_wpdb_results(
+	 *      array(),
+	 *      ARRAY_A,
+	 *      EEM_Ticket::instance()->get_qualified_columns_for_all_fields()
+	 *  );
+	 * is equivalent to
+	 *  EEM_Ticket::instance()->get_all_wpdb_results( array(), ARRAY_A, '*' );
+	 * and
+	 *  EEM_Event::instance()->get_all_wpdb_results(
+	 *      array(
+	 *          array(
+	 *              'Datetime.Ticket.TKT_ID' => array( '<', 100 ),
+	 *          ),
+	 *          ARRAY_A,
+	 *          implode(
+	 *              ', ',
+	 *              array_merge(
+	 *                  EEM_Event::instance()->get_qualified_columns_for_all_fields( '', false ),
+	 *                  EEM_Ticket::instance()->get_qualified_columns_for_all_fields( 'Datetime', false )
+	 *              )
+	 *          )
+	 *      )
+	 *  );
+	 * selects rows from the database, selecting all the event and ticket columns, where the ticket ID is below 100
+	 *
+	 * @param string $model_relation_chain        the chain of models used to join between the model you want to query
+	 *                                            and the one whose fields you are selecting for example: when querying
+	 *                                            tickets model and selecting fields from the tickets model you would
+	 *                                            leave this parameter empty, because no models are needed to join
+	 *                                            between the queried model and the selected one. Likewise when
+	 *                                            querying the datetime model and selecting fields from the tickets
+	 *                                            model, it would also be left empty, because there is a direct
+	 *                                            relation from datetimes to tickets, so no model is needed to join
+	 *                                            them together. However, when querying from the event model and
+	 *                                            selecting fields from the ticket model, you should provide the string
+	 *                                            'Datetime', indicating that the event model must first join to the
+	 *                                            datetime model in order to find its relation to ticket model.
+	 *                                            Also, when querying from the venue model and selecting fields from
+	 *                                            the ticket model, you should provide the string 'Event.Datetime',
+	 *                                            indicating you need to join the venue model to the event model,
+	 *                                            to the datetime model, in order to find its relation to the ticket
+	 *                                            model. This string is used to deduce the prefix that gets added onto
+	 *                                            the models' tables qualified columns
+	 * @param bool   $return_string               if true, will return a string with qualified column names separated
+	 *                                            by ', ' if false, will simply return a numerically indexed array of
+	 *                                            qualified column names
+	 * @return array|string
+	 */
+	public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
+	{
+		$table_prefix      = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
+		$qualified_columns = [];
+		foreach ($this->field_settings() as $field_name => $field) {
+			$qualified_columns[] = $table_prefix . $field->get_qualified_column();
+		}
+		return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
+	}
+
+
+	/**
+	 * constructs the select use on special limit joins
+	 * NOTE: for now this has only been tested and will work when the  table alias is for the PRIMARY table. Although
+	 * its setup so the select query will be setup on and just doing the special select join off of the primary table
+	 * (as that is typically where the limits would be set).
+	 *
+	 * @param string       $table_alias The table the select is being built for
+	 * @param mixed|string $limit       The limit for this select
+	 * @return string                The final select join element for the query.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function _construct_limit_join_select($table_alias, $limit)
+	{
+		$SQL = '';
+		foreach ($this->_tables as $table_obj) {
+			if ($table_obj instanceof EE_Primary_Table) {
+				$SQL .= $table_alias === $table_obj->get_table_alias()
+					? $table_obj->get_select_join_limit($limit)
+					: SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
+			} elseif ($table_obj instanceof EE_Secondary_Table) {
+				$SQL .= $table_alias === $table_obj->get_table_alias()
+					? $table_obj->get_select_join_limit_join($limit)
+					: SP . $table_obj->get_join_sql($table_alias) . SP;
+			}
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * Constructs the internal join if there are multiple tables, or simply the table's name and alias
+	 * Eg "wp_post AS Event" or "wp_post AS Event INNER JOIN wp_postmeta Event_Meta ON Event.ID = Event_Meta.post_id"
+	 *
+	 * @return string SQL
+	 * @throws EE_Error
+	 */
+	public function _construct_internal_join()
+	{
+		$SQL = $this->_get_main_table()->get_table_sql();
+		$SQL .= $this->_construct_internal_join_to_table_with_alias($this->_get_main_table()->get_table_alias());
+		return $SQL;
+	}
+
+
+	/**
+	 * Constructs the SQL for joining all the tables on this model.
+	 * Normally $alias should be the primary table's alias, but in cases where
+	 * we have already joined to a secondary table (eg, the secondary table has a foreign key and is joined before the
+	 * primary table) then we should provide that secondary table's alias. Eg, with $alias being the primary table's
+	 * alias, this will construct SQL like:
+	 * " INNER JOIN wp_esp_secondary_table AS Secondary_Table ON Primary_Table.pk = Secondary_Table.fk".
+	 * With $alias being a secondary table's alias, this will construct SQL like:
+	 * " INNER JOIN wp_esp_primary_table AS Primary_Table ON Primary_Table.pk = Secondary_Table.fk".
+	 *
+	 * @param string $alias_prefixed table alias to join to (this table should already be in the FROM SQL clause)
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function _construct_internal_join_to_table_with_alias($alias_prefixed)
+	{
+		$SQL               = '';
+		$alias_sans_prefix = EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($alias_prefixed);
+		foreach ($this->_tables as $table_obj) {
+			if ($table_obj instanceof EE_Secondary_Table) {// table is secondary table
+				if ($alias_sans_prefix === $table_obj->get_table_alias()) {
+					// so we're joining to this table, meaning the table is already in
+					// the FROM statement, BUT the primary table isn't. So we want
+					// to add the inverse join sql
+					$SQL .= $table_obj->get_inverse_join_sql($alias_prefixed);
+				} else {
+					// just add a regular JOIN to this table from the primary table
+					$SQL .= $table_obj->get_join_sql($alias_prefixed);
+				}
+			}//if it's a primary table, dont add any SQL. it should already be in the FROM statement
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * Gets an array for storing all the data types on the next-to-be-executed-query.
+	 * This should be a growing array of keys being table-columns (eg 'EVT_ID' and 'Event.EVT_ID'), and values being
+	 * their data type (eg, '%s', '%d', etc)
+	 *
+	 * @return array
+	 */
+	public function _get_data_types()
+	{
+		$data_types = [];
+		foreach ($this->field_settings() as $field_obj) {
+			// $data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
+			/** @var $field_obj EE_Model_Field_Base */
+			$data_types[ $field_obj->get_qualified_column() ] = $field_obj->get_wpdb_data_type();
+		}
+		return $data_types;
+	}
+
+
+	/**
+	 * Gets the model object given the relation's name / model's name (eg, 'Event', 'Registration',etc. Always singular)
+	 *
+	 * @param string $model_name
+	 * @return EEM_Base
+	 * @throws EE_Error
+	 */
+	public function get_related_model_obj($model_name)
+	{
+		$model_classname = "EEM_" . $model_name;
+		if (! class_exists($model_classname)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"You specified a related model named %s in your query. No such model exists, if it did, it would have the classname %s",
+						'event_espresso'
+					),
+					$model_name,
+					$model_classname
+				)
+			);
+		}
+		return call_user_func($model_classname . "::instance");
+	}
+
+
+	/**
+	 * Returns the array of EE_ModelRelations for this model.
+	 *
+	 * @return EE_Model_Relation_Base[]
+	 */
+	public function relation_settings()
+	{
+		return $this->_model_relations;
+	}
+
+
+	/**
+	 * Gets all related models that this model BELONGS TO. Handy to know sometimes
+	 * because without THOSE models, this model probably doesn't have much purpose.
+	 * (Eg, without an event, datetimes have little purpose.)
+	 *
+	 * @return EE_Belongs_To_Relation[]
+	 */
+	public function belongs_to_relations()
+	{
+		$belongs_to_relations = [];
+		foreach ($this->relation_settings() as $model_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
+				$belongs_to_relations[ $model_name ] = $relation_obj;
+			}
+		}
+		return $belongs_to_relations;
+	}
+
+
+	/**
+	 * Returns the specified EE_Model_Relation, or throws an exception
+	 *
+	 * @param string $relation_name name of relation, key in $this->_relatedModels
+	 * @return EE_Model_Relation_Base
+	 * @throws EE_Error
+	 */
+	public function related_settings_for($relation_name)
+	{
+		$relatedModels = $this->relation_settings();
+		if (! array_key_exists($relation_name, $relatedModels)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Cannot get %s related to %s. There is no model relation of that type. There is, however, %s...',
+						'event_espresso'
+					),
+					$relation_name,
+					$this->_get_class_name(),
+					implode(', ', array_keys($relatedModels))
+				)
+			);
+		}
+		return $relatedModels[ $relation_name ];
+	}
+
+
+	/**
+	 * A convenience method for getting a specific field's settings, instead of getting all field settings for all
+	 * fields
+	 *
+	 * @param string  $fieldName
+	 * @param boolean $include_db_only_fields
+	 * @return EE_Model_Field_Base
+	 * @throws EE_Error
+	 */
+	public function field_settings_for($fieldName, $include_db_only_fields = true)
+	{
+		$fieldSettings = $this->field_settings($include_db_only_fields);
+		if (! array_key_exists($fieldName, $fieldSettings)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("There is no field/column '%s' on '%s'", 'event_espresso'),
+					$fieldName,
+					get_class($this)
+				)
+			);
+		}
+		return $fieldSettings[ $fieldName ];
+	}
+
+
+	/**
+	 * Checks if this field exists on this model
+	 *
+	 * @param string $fieldName a key in the model's _field_settings array
+	 * @return boolean
+	 */
+	public function has_field($fieldName)
+	{
+		$fieldSettings = $this->field_settings(true);
+		if (isset($fieldSettings[ $fieldName ])) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns whether or not this model has a relation to the specified model
+	 *
+	 * @param string $relation_name possibly one of the keys in the relation_settings array
+	 * @return boolean
+	 */
+	public function has_relation($relation_name)
+	{
+		$relations = $this->relation_settings();
+		if (isset($relations[ $relation_name ])) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
+	 * Eg, on EE_Answer that would be ANS_ID field object
+	 *
+	 * @param $field_obj
+	 * @return boolean
+	 */
+	public function is_primary_key_field($field_obj)
+	{
+		return $field_obj instanceof EE_Primary_Key_Field_Base ? true : false;
+	}
+
+
+	/**
+	 * gets the field object of type 'primary_key' from the fieldsSettings attribute.
+	 * Eg, on EE_Answer that would be ANS_ID field object
+	 *
+	 * @return EE_Primary_Key_Field_Base
+	 * @throws EE_Error
+	 */
+	public function get_primary_key_field()
+	{
+		if ($this->_primary_key_field === null) {
+			foreach ($this->field_settings(true) as $field_obj) {
+				if ($this->is_primary_key_field($field_obj)) {
+					$this->_primary_key_field = $field_obj;
+					break;
+				}
+			}
+			if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__("There is no Primary Key defined on model %s", 'event_espresso'),
+						get_class($this)
+					)
+				);
+			}
+		}
+		return $this->_primary_key_field;
+	}
+
+
+	/**
+	 * Returns whether or not not there is a primary key on this model.
+	 * Internally does some caching.
+	 *
+	 * @return boolean
+	 */
+	public function has_primary_key_field()
+	{
+		if ($this->_has_primary_key_field === null) {
+			try {
+				$this->get_primary_key_field();
+				$this->_has_primary_key_field = true;
+			} catch (EE_Error $e) {
+				$this->_has_primary_key_field = false;
+			}
+		}
+		return $this->_has_primary_key_field;
+	}
+
+
+	/**
+	 * Finds the first field of type $field_class_name.
+	 *
+	 * @param string $field_class_name class name of field that you want to find. Eg, EE_Datetime_Field,
+	 *                                 EE_Foreign_Key_Field, etc
+	 * @return EE_Model_Field_Base or null if none is found
+	 */
+	public function get_a_field_of_type($field_class_name)
+	{
+		foreach ($this->field_settings() as $field) {
+			if ($field instanceof $field_class_name) {
+				return $field;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets a foreign key field pointing to model.
+	 *
+	 * @param string $model_name eg Event, Registration, not EEM_Event
+	 * @return EE_Foreign_Key_Field_Base
+	 * @throws EE_Error
+	 */
+	public function get_foreign_key_to($model_name)
+	{
+		if (! isset($this->_cache_foreign_key_to_fields[ $model_name ])) {
+			foreach ($this->field_settings() as $field) {
+				if (
+					$field instanceof EE_Foreign_Key_Field_Base
+					&& in_array($model_name, $field->get_model_names_pointed_to())
+				) {
+					$this->_cache_foreign_key_to_fields[ $model_name ] = $field;
+					break;
+				}
+			}
+			if (! isset($this->_cache_foreign_key_to_fields[ $model_name ])) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"There is no foreign key field pointing to model %s on model %s",
+							'event_espresso'
+						),
+						$model_name,
+						get_class($this)
+					)
+				);
+			}
+		}
+		return $this->_cache_foreign_key_to_fields[ $model_name ];
+	}
+
+
+	/**
+	 * Gets the table name (including $wpdb->prefix) for the table alias
+	 *
+	 * @param string $table_alias eg Event, Event_Meta, Registration, Transaction, but maybe
+	 *                            a table alias with a model chain prefix, like 'Venue__Event_Venue___Event_Meta'.
+	 *                            Either one works
+	 * @return string
+	 */
+	public function get_table_for_alias($table_alias)
+	{
+		$table_alias_sans_model_relation_chain_prefix =
+			EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
+		return $this->_tables[ $table_alias_sans_model_relation_chain_prefix ]->get_table_name();
+	}
+
+
+	/**
+	 * Returns a flat array of all field son this model, instead of organizing them
+	 * by table_alias as they are in the constructor.
+	 *
+	 * @param bool $include_db_only_fields flag indicating whether or not to include the db-only fields
+	 * @return EE_Model_Field_Base[] where the keys are the field's name
+	 */
+	public function field_settings($include_db_only_fields = false)
+	{
+		if ($include_db_only_fields) {
+			if ($this->_cached_fields === null) {
+				$this->_cached_fields = [];
+				foreach ($this->_fields as $fields_corresponding_to_table) {
+					foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
+						$this->_cached_fields[ $field_name ] = $field_obj;
+					}
+				}
+			}
+			return $this->_cached_fields;
+		}
+		if ($this->_cached_fields_non_db_only === null) {
+			$this->_cached_fields_non_db_only = [];
+			foreach ($this->_fields as $fields_corresponding_to_table) {
+				foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
+					/** @var $field_obj EE_Model_Field_Base */
+					if (! $field_obj->is_db_only_field()) {
+						$this->_cached_fields_non_db_only[ $field_name ] = $field_obj;
+					}
+				}
+			}
+		}
+		return $this->_cached_fields_non_db_only;
+	}
+
+
+	/**
+	 *        cycle though array of attendees and create objects out of each item
+	 *
+	 * @access        private
+	 * @param array $rows        of results of $wpdb->get_results($query,ARRAY_A)
+	 * @return EE_Base_Class[] array keys are primary keys (if there is a primary key on the model. if not,
+	 *                           numerically indexed)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _create_objects($rows = [])
+	{
+		$array_of_objects = [];
+		if (empty($rows)) {
+			return [];
+		}
+		$count_if_model_has_no_primary_key = 0;
+		$has_primary_key                   = $this->has_primary_key_field();
+		$primary_key_field                 = $has_primary_key ? $this->get_primary_key_field() : null;
+		foreach ((array) $rows as $row) {
+			if (empty($row)) {
+				// wp did its weird thing where it returns an array like array(0=>null), which is totally not helpful...
+				return [];
+			}
+			// check if we've already set this object in the results array,
+			// in which case there's no need to process it further (again)
+			if ($has_primary_key) {
+				$table_pk_value = $this->_get_column_value_with_table_alias_or_not(
+					$row,
+					$primary_key_field->get_qualified_column(),
+					$primary_key_field->get_table_column()
+				);
+				if ($table_pk_value && isset($array_of_objects[ $table_pk_value ])) {
+					continue;
+				}
+			}
+			$classInstance = $this->instantiate_class_from_array_or_object($row);
+			if (! $classInstance) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__('Could not create instance of class %s from row %s', 'event_espresso'),
+						$this->get_this_model_name(),
+						http_build_query($row)
+					)
+				);
+			}
+			// set the timezone on the instantiated objects
+			$classInstance->set_timezone($this->_timezone);
+			// make sure if there is any timezone setting present that we set the timezone for the object
+			$key                      = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
+			$array_of_objects[ $key ] = $classInstance;
+			// also, for all the relations of type BelongsTo, see if we can cache
+			// those related models
+			// (we could do this for other relations too, but if there are conditions
+			// that filtered out some fo the results, then we'd be caching an incomplete set
+			// so it requires a little more thought than just caching them immediately...)
+			foreach ($this->_model_relations as $modelName => $relation_obj) {
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
+					// check if this model's INFO is present. If so, cache it on the model
+					$other_model           = $relation_obj->get_other_model();
+					$other_model_obj_maybe = $other_model->instantiate_class_from_array_or_object($row);
+					// if we managed to make a model object from the results, cache it on the main model object
+					if ($other_model_obj_maybe) {
+						// set timezone on these other model objects if they are present
+						$other_model_obj_maybe->set_timezone($this->_timezone);
+						$classInstance->cache($modelName, $other_model_obj_maybe);
+					}
+				}
+			}
+			// also, if this was a custom select query, let's see if there are any results for the custom select fields
+			// and add them to the object as well.  We'll convert according to the set data_type if there's any set for
+			// the field in the CustomSelects object
+			if ($this->_custom_selections instanceof CustomSelects) {
+				$classInstance->setCustomSelectsValues(
+					$this->getValuesForCustomSelectAliasesFromResults($row)
+				);
+			}
+		}
+		return $array_of_objects;
+	}
+
+
+	/**
+	 * This will parse a given row of results from the db and see if any keys in the results match an alias within the
+	 * current CustomSelects object. This will be used to build an array of values indexed by those keys.
+	 *
+	 * @param array $db_results_row
+	 * @return array
+	 */
+	protected function getValuesForCustomSelectAliasesFromResults(array $db_results_row)
+	{
+		$results = [];
+		if ($this->_custom_selections instanceof CustomSelects) {
+			foreach ($this->_custom_selections->columnAliases() as $alias) {
+				if (isset($db_results_row[ $alias ])) {
+					$results[ $alias ] = $this->convertValueToDataType(
+						$db_results_row[ $alias ],
+						$this->_custom_selections->getDataTypeForAlias($alias)
+					);
+				}
+			}
+		}
+		return $results;
+	}
+
+
+	/**
+	 * This will set the value for the given alias
+	 *
+	 * @param string $value
+	 * @param string $datatype (one of %d, %s, %f)
+	 * @return int|string|float (int for %d, string for %s, float for %f)
+	 */
+	protected function convertValueToDataType($value, $datatype)
+	{
+		switch ($datatype) {
+			case '%f':
+				return (float) $value;
+			case '%d':
+				return (int) $value;
+			default:
+				return (string) $value;
+		}
+	}
+
+
+	/**
+	 * The purpose of this method is to allow us to create a model object that is not in the db that holds default
+	 * values. A typical example of where this is used is when creating a new item and the initial load of a form.  We
+	 * dont' necessarily want to test for if the object is present but just assume it is BUT load the defaults from the
+	 * object (as set in the model_field!).
+	 *
+	 * @return EE_Base_Class single EE_Base_Class object with default values for the properties.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create_default_object()
+	{
+		$this_model_fields_and_values = [];
+		// setup the row using default values;
+		foreach ($this->field_settings() as $field_name => $field_obj) {
+			$this_model_fields_and_values[ $field_name ] = $field_obj->get_default_value();
+		}
+		$className     = $this->_get_class_name();
+		return EE_Registry::instance()->load_class($className, [$this_model_fields_and_values], false, false);
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
+	 *                             or an stdClass where each property is the name of a column,
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		if (! is_array($cols_n_values) && is_object($cols_n_values)) {
+			$cols_n_values = get_object_vars($cols_n_values);
+		}
+		$primary_key = null;
+		// make sure the array only has keys that are fields/columns on this model
+		$this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
+		if ($this->has_primary_key_field() && isset($this_model_fields_n_values[ $this->primary_key_name() ])) {
+			$primary_key = $this_model_fields_n_values[ $this->primary_key_name() ];
+		}
+		$className = $this->_get_class_name();
+		// check we actually found results that we can use to build our model object
+		// if not, return null
+		if ($this->has_primary_key_field()) {
+			if (empty($this_model_fields_n_values[ $this->primary_key_name() ])) {
+				return null;
+			}
+		} elseif ($this->unique_indexes()) {
+			$first_column = reset($this_model_fields_n_values);
+			if (empty($first_column)) {
+				return null;
+			}
+		}
+		// if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
+		if ($primary_key) {
+			$classInstance = $this->get_from_entity_map($primary_key);
+			if (! $classInstance) {
+				$classInstance = EE_Registry::instance()
+											->load_class(
+												$className,
+												[$this_model_fields_n_values, $this->_timezone],
+												true,
+												false
+											);
+				// add this new object to the entity map
+				$classInstance = $this->add_to_entity_map($classInstance);
+			}
+		} else {
+			$classInstance = EE_Registry::instance()
+										->load_class(
+											$className,
+											[$this_model_fields_n_values, $this->_timezone],
+											true,
+											false
+										);
+		}
+		return $classInstance;
+	}
+
+
+	/**
+	 * Gets the model object from the  entity map if it exists
+	 *
+	 * @param int|string $id the ID of the model object
+	 * @return EE_Base_Class
+	 */
+	public function get_from_entity_map($id)
+	{
+		return isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])
+			? $this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ] : null;
+	}
+
+
+	/**
+	 * add_to_entity_map
+	 * Adds the object to the model's entity mappings
+	 *        Effectively tells the models "Hey, this model object is the most up-to-date representation of the data,
+	 *        and for the remainder of the request, it's even more up-to-date than what's in the database.
+	 *        So, if the database doesn't agree with what's in the entity mapper, ignore the database"
+	 *        If the database gets updated directly and you want the entity mapper to reflect that change,
+	 *        then this method should be called immediately after the update query
+	 * Note: The map is indexed by whatever the current blog id is set (via EEM_Base::$_model_query_blog_id).  This is
+	 * so on multisite, the entity map is specific to the query being done for a specific site.
+	 *
+	 * @param EE_Base_Class $object
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_to_entity_map(EE_Base_Class $object)
+	{
+		$className = $this->_get_class_name();
+		if (! $object instanceof $className) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("You tried adding a %s to a mapping of %ss", "event_espresso"),
+					is_object($object) ? get_class($object) : $object,
+					$className
+				)
+			);
+		}
+		/** @var $object EE_Base_Class */
+		if (! $object->ID()) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"You tried storing a model object with NO ID in the %s entity mapper.",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		// double check it's not already there
+		$classInstance = $this->get_from_entity_map($object->ID());
+		if ($classInstance) {
+			return $classInstance;
+		}
+		$this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $object->ID() ] = $object;
+		return $object;
+	}
+
+
+	/**
+	 * if a valid identifier is provided, then that entity is unset from the entity map,
+	 * if no identifier is provided, then the entire entity map is emptied
+	 *
+	 * @param int|string $id the ID of the model object
+	 * @return boolean
+	 */
+	public function clear_entity_map($id = null)
+	{
+		if (empty($id)) {
+			$this->_entity_map[ EEM_Base::$_model_query_blog_id ] = [];
+			return true;
+		}
+		if (isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])) {
+			unset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Public wrapper for _deduce_fields_n_values_from_cols_n_values.
+	 * Given an array where keys are column (or column alias) names and values,
+	 * returns an array of their corresponding field names and database values
+	 *
+	 * @param array $cols_n_values
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function deduce_fields_n_values_from_cols_n_values(array $cols_n_values): array
+	{
+		return $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
+	}
+
+
+	/**
+	 * _deduce_fields_n_values_from_cols_n_values
+	 * Given an array where keys are column (or column alias) names and values,
+	 * returns an array of their corresponding field names and database values
+	 *
+	 * @param array|stdClass $cols_n_values
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _deduce_fields_n_values_from_cols_n_values($cols_n_values): array
+	{
+		if ($cols_n_values instanceof stdClass) {
+			$cols_n_values = get_object_vars($cols_n_values);
+		}
+		$this_model_fields_n_values = [];
+		foreach ($this->get_tables() as $table_alias => $table_obj) {
+			$table_pk_value = $this->_get_column_value_with_table_alias_or_not(
+				$cols_n_values,
+				$table_obj->get_fully_qualified_pk_column(),
+				$table_obj->get_pk_column()
+			);
+			// there is a primary key on this table and its not set. Use defaults for all its columns
+			if ($table_pk_value === null && $table_obj->get_pk_column()) {
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
+					if (! $field_obj->is_db_only_field()) {
+						// prepare field as if its coming from db
+						$prepared_value                            =
+							$field_obj->prepare_for_set($field_obj->get_default_value());
+						$this_model_fields_n_values[ $field_name ] = $field_obj->prepare_for_use_in_db($prepared_value);
+					}
+				}
+			} else {
+				// the table's rows existed. Use their values
+				foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
+					if (! $field_obj->is_db_only_field()) {
+						$this_model_fields_n_values[ $field_name ] = $this->_get_column_value_with_table_alias_or_not(
+							$cols_n_values,
+							$field_obj->get_qualified_column(),
+							$field_obj->get_table_column()
+						);
+					}
+				}
+			}
+		}
+		return $this_model_fields_n_values;
+	}
+
+
+	/**
+	 * @param $cols_n_values
+	 * @param $qualified_column
+	 * @param $regular_column
+	 * @return null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_column_value_with_table_alias_or_not($cols_n_values, $qualified_column, $regular_column)
+	{
+		$value = null;
+		// ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
+		// does the field on the model relate to this column retrieved from the db?
+		// or is it a db-only field? (not relating to the model)
+		if (isset($cols_n_values[ $qualified_column ])) {
+			$value = $cols_n_values[ $qualified_column ];
+		} elseif (isset($cols_n_values[ $regular_column ])) {
+			$value = $cols_n_values[ $regular_column ];
+		} elseif (! empty($this->foreign_key_aliases)) {
+			// no PK?  ok check if there is a foreign key alias set for this table
+			// then check if that alias exists in the incoming data
+			// AND that the actual PK the $FK_alias represents matches the $qualified_column (full PK)
+			foreach ($this->foreign_key_aliases as $FK_alias => $PK_column) {
+				if ($PK_column === $qualified_column && isset($cols_n_values[ $FK_alias ])) {
+					$value = $cols_n_values[ $FK_alias ];
+					[$pk_class] = explode('.', $PK_column);
+					$pk_model_name = "EEM_{$pk_class}";
+					/** @var EEM_Base $pk_model */
+					$pk_model = EE_Registry::instance()->load_model($pk_model_name);
+					if ($pk_model instanceof EEM_Base) {
+						// make sure object is pulled from db and added to entity map
+						$pk_model->get_one_by_ID($value);
+					}
+					break;
+				}
+			}
+		}
+		return $value;
+	}
+
+
+	/**
+	 * refresh_entity_map_from_db
+	 * Makes sure the model object in the entity map at $id assumes the values
+	 * of the database (opposite of EE_base_Class::save())
+	 *
+	 * @param int|string $id
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class|mixed|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function refresh_entity_map_from_db($id)
+	{
+		$obj_in_map = $this->get_from_entity_map($id);
+		if ($obj_in_map) {
+			$wpdb_results = $this->_get_all_wpdb_results(
+				[[$this->get_primary_key_field()->get_name() => $id], 'limit' => 1]
+			);
+			if ($wpdb_results && is_array($wpdb_results)) {
+				$one_row = reset($wpdb_results);
+				foreach ($this->_deduce_fields_n_values_from_cols_n_values($one_row) as $field_name => $db_value) {
+					$obj_in_map->set_from_db($field_name, $db_value);
+				}
+				// clear the cache of related model objects
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
+					$obj_in_map->clear_cache($relation_name, null, true);
+				}
+			}
+			$this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ] = $obj_in_map;
+			return $obj_in_map;
+		}
+		return $this->get_one_by_ID($id);
+	}
+
+
+	/**
+	 * refresh_entity_map_with
+	 * Leaves the entry in the entity map alone, but updates it to match the provided
+	 * $replacing_model_obj (which we assume to be its equivalent but somehow NOT in the entity map).
+	 * This is useful if you have a model object you want to make authoritative over what's in the entity map currently.
+	 * Note: The old $replacing_model_obj should now be destroyed as it's now un-authoritative
+	 *
+	 * @param int|string    $id
+	 * @param EE_Base_Class $replacing_model_obj
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function refresh_entity_map_with($id, $replacing_model_obj)
+	{
+		$obj_in_map = $this->get_from_entity_map($id);
+		if ($obj_in_map) {
+			if ($replacing_model_obj instanceof EE_Base_Class) {
+				foreach ($replacing_model_obj->model_field_array() as $field_name => $value) {
+					$obj_in_map->set($field_name, $value);
+				}
+				// make the model object in the entity map's cache match the $replacing_model_obj
+				foreach ($this->relation_settings() as $relation_name => $relation_obj) {
+					$obj_in_map->clear_cache($relation_name, null, true);
+					foreach ($replacing_model_obj->get_all_from_cache($relation_name) as $cache_id => $cached_obj) {
+						$obj_in_map->cache($relation_name, $cached_obj, $cache_id);
+					}
+				}
+			}
+			return $obj_in_map;
+		}
+		$this->add_to_entity_map($replacing_model_obj);
+		return $replacing_model_obj;
+	}
+
+
+	/**
+	 * Gets the EE class that corresponds to this model. Eg, for EEM_Answer that
+	 * would be EE_Answer.To import that class, you'd just add ".class.php" to the name, like so
+	 * require_once($this->_getClassName().".class.php");
+	 *
+	 * @return string
+	 */
+	private function _get_class_name()
+	{
+		return "EE_" . $this->get_this_model_name();
+	}
+
+
+	/**
+	 * Get the name of the items this model represents, for the quantity specified. Eg,
+	 * if $quantity==1, on EEM_Event, it would 'Event' (internationalized), otherwise
+	 * it would be 'Events'.
+	 *
+	 * @param int|float|null $quantity
+	 * @return string
+	 */
+	public function item_name($quantity = 1): string
+	{
+		$quantity = floor($quantity);
+		return apply_filters(
+			'FHEE__EEM_Base__item_name__plural_or_singular',
+			$quantity > 1 ? $this->plural_item : $this->singular_item,
+			$quantity,
+			$this->plural_item,
+			$this->singular_item
+		);
+	}
+
+
+	/**
+	 * Very handy general function to allow for plugins to extend any child of EE_TempBase.
+	 * If a method is called on a child of EE_TempBase that doesn't exist, this function is called
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments. Instead of
+	 * requiring a plugin to extend the EE_TempBase (which works fine is there's only 1 plugin, but when will that
+	 * happen?) they can add a hook onto 'filters_hook_espresso__{className}__{methodName}' (eg,
+	 * filters_hook_espresso__EE_Answer__my_great_function) and accepts 2 arguments: the object on which the function
+	 * was called, and an array of the original arguments passed to the function. Whatever their callback function
+	 * returns will be returned by this function. Example: in functions.php (or in a plugin):
+	 * add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3); function
+	 * my_callback($previousReturnValue,EE_TempBase $object,$argsArray){
+	 * $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
+	 *        return $previousReturnValue.$returnString;
+	 * }
+	 * require('EEM_Answer.model.php');
+	 * echo EEM_Answer::instance()->my_callback('monkeys',100);
+	 * // will output "you called my_callback! and passed args:monkeys,100"
+	 *
+	 * @param string $methodName name of method which was called on a child of EE_TempBase, but which
+	 * @param array  $args       array of original arguments passed to the function
+	 * @return mixed whatever the plugin which calls add_filter decides
+	 * @throws EE_Error
+	 */
+	public function __call($methodName, $args)
+	{
+		$className = get_class($this);
+		$tagName   = "FHEE__{$className}__{$methodName}";
+		if (! has_filter($tagName)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Method %1$s on model %2$s does not exist! You can create one with the following code in functions.php or in a plugin: %4$s function my_callback(%4$s \$previousReturnValue, EEM_Base \$object\ $argsArray=NULL ){%4$s     /*function body*/%4$s      return \$whatever;%4$s }%4$s add_filter( \'%3$s\', \'my_callback\', 10, 3 );',
+						'event_espresso'
+					),
+					$methodName,
+					$className,
+					$tagName,
+					'<br />'
+				)
+			);
+		}
+		return apply_filters($tagName, null, $this, $args);
+	}
+
+
+	/**
+	 * Ensures $base_class_obj_or_id is of the EE_Base_Class child that corresponds ot this model.
+	 * If not, assumes its an ID, and uses $this->get_one_by_ID() to get the EE_Base_Class.
+	 *
+	 * @param EE_Base_Class|string|int $base_class_obj_or_id either:
+	 *                                                       the EE_Base_Class object that corresponds to this Model,
+	 *                                                       the object's class name
+	 *                                                       or object's ID
+	 * @param boolean                  $ensure_is_in_db      if set, we will also verify this model object
+	 *                                                       exists in the database. If it does not, we add it
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
+	{
+		$className = $this->_get_class_name();
+		if ($base_class_obj_or_id instanceof $className) {
+			$model_object = $base_class_obj_or_id;
+		} else {
+			$primary_key_field = $this->get_primary_key_field();
+			if (
+				$primary_key_field instanceof EE_Primary_Key_Int_Field
+				&& (
+					is_int($base_class_obj_or_id)
+					|| is_string($base_class_obj_or_id)
+				)
+			) {
+				// assume it's an ID.
+				// either a proper integer or a string representing an integer (eg "101" instead of 101)
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
+			} elseif (
+				$primary_key_field instanceof EE_Primary_Key_String_Field
+				&& is_string($base_class_obj_or_id)
+			) {
+				// assume its a string representation of the object
+				$model_object = $this->get_one_by_ID($base_class_obj_or_id);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
+							'event_espresso'
+						),
+						$base_class_obj_or_id,
+						$this->_get_class_name(),
+						print_r($base_class_obj_or_id, true)
+					)
+				);
+			}
+		}
+		if ($ensure_is_in_db && $model_object->ID() !== null) {
+			$model_object->save();
+		}
+		return $model_object;
+	}
+
+
+	/**
+	 * Similar to ensure_is_obj(), this method makes sure $base_class_obj_or_id
+	 * is a value of the this model's primary key. If it's an EE_Base_Class child,
+	 * returns it ID.
+	 *
+	 * @param EE_Base_Class|int|string $base_class_obj_or_id
+	 * @return int|string depending on the type of this model object's ID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ensure_is_ID($base_class_obj_or_id)
+	{
+		$className = $this->_get_class_name();
+		if ($base_class_obj_or_id instanceof $className) {
+			/** @var $base_class_obj_or_id EE_Base_Class */
+			$id = $base_class_obj_or_id->ID();
+		} elseif (is_int($base_class_obj_or_id)) {
+			// assume it's an ID
+			$id = $base_class_obj_or_id;
+		} elseif (is_string($base_class_obj_or_id)) {
+			// assume its a string representation of the object
+			$id = $base_class_obj_or_id;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"'%s' is neither an object of type %s, nor an ID! Its full value is '%s'",
+						'event_espresso'
+					),
+					$base_class_obj_or_id,
+					$this->_get_class_name(),
+					print_r($base_class_obj_or_id, true)
+				)
+			);
+		}
+		return $id;
+	}
+
+
+	/**
+	 * Sets whether the values passed to the model (eg, values in WHERE, values in INSERT, UPDATE, etc)
+	 * have already been ran through the appropriate model field's prepare_for_use_in_db method. IE, they have
+	 * been sanitized and converted into the appropriate domain.
+	 * Usually the only place you'll want to change the default (which is to assume values have NOT been sanitized by
+	 * the model object/model field) is when making a method call from WITHIN a model object, which has direct access
+	 * to its sanitized values. Note: after changing this setting, you should set it back to its previous value (using
+	 * get_assumption_concerning_values_already_prepared_by_model_object()) eg.
+	 * $EVT = EEM_Event::instance(); $old_setting =
+	 * $EVT->get_assumption_concerning_values_already_prepared_by_model_object();
+	 * $EVT->assume_values_already_prepared_by_model_object(true);
+	 * $EVT->update(array('foo'=>'bar'),array(array('foo'=>'monkey')));
+	 * $EVT->assume_values_already_prepared_by_model_object($old_setting);
+	 *
+	 * @param int $values_already_prepared like one of the constants on EEM_Base
+	 * @return void
+	 */
+	public function assume_values_already_prepared_by_model_object(
+		$values_already_prepared = self::not_prepared_by_model_object
+	) {
+		$this->_values_already_prepared_by_model_object = $values_already_prepared;
+	}
+
+
+	/**
+	 * Read comments for assume_values_already_prepared_by_model_object()
+	 *
+	 * @return int
+	 */
+	public function get_assumption_concerning_values_already_prepared_by_model_object()
+	{
+		return $this->_values_already_prepared_by_model_object;
+	}
+
+
+	/**
+	 * Gets all the indexes on this model
+	 *
+	 * @return EE_Index[]
+	 */
+	public function indexes()
+	{
+		return $this->_indexes;
+	}
+
+
+	/**
+	 * Gets all the Unique Indexes on this model
+	 *
+	 * @return EE_Unique_Index[]
+	 */
+	public function unique_indexes()
+	{
+		$unique_indexes = [];
+		foreach ($this->_indexes as $name => $index) {
+			if ($index instanceof EE_Unique_Index) {
+				$unique_indexes [ $name ] = $index;
+			}
+		}
+		return $unique_indexes;
+	}
+
+
+	/**
+	 * Gets all the fields which, when combined, make the primary key.
+	 * This is usually just an array with 1 element (the primary key), but in cases
+	 * where there is no primary key, it's a combination of fields as defined
+	 * on a primary index
+	 *
+	 * @return EE_Model_Field_Base[] indexed by the field's name
+	 * @throws EE_Error
+	 */
+	public function get_combined_primary_key_fields()
+	{
+		foreach ($this->indexes() as $index) {
+			if ($index instanceof EE_Primary_Key_Index) {
+				return $index->fields();
+			}
+		}
+		return [$this->primary_key_name() => $this->get_primary_key_field()];
+	}
+
+
+	/**
+	 * Used to build a primary key string (when the model has no primary key),
+	 * which can be used a unique string to identify this model object.
+	 *
+	 * @param array $fields_n_values keys are field names, values are their values.
+	 *                               Note: if you have results from `EEM_Base::get_all_wpdb_results()`, you need to
+	 *                               run it through `EEM_Base::deduce_fields_n_values_from_cols_n_values()`
+	 *                               before passing it to this function (that will convert it from columns-n-values
+	 *                               to field-names-n-values).
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_index_primary_key_string($fields_n_values)
+	{
+		$cols_n_values_for_primary_key_index = array_intersect_key(
+			$fields_n_values,
+			$this->get_combined_primary_key_fields()
+		);
+		return http_build_query($cols_n_values_for_primary_key_index);
+	}
+
+
+	/**
+	 * Gets the field values from the primary key string
+	 *
+	 * @param string $index_primary_key_string
+	 * @return null|array
+	 * @throws EE_Error
+	 * @see EEM_Base::get_combined_primary_key_fields() and EEM_Base::get_index_primary_key_string()
+	 */
+	public function parse_index_primary_key_string($index_primary_key_string)
+	{
+		$key_fields = $this->get_combined_primary_key_fields();
+		// check all of them are in the $id
+		$key_vals_in_combined_pk = [];
+		parse_str($index_primary_key_string, $key_vals_in_combined_pk);
+		foreach ($key_fields as $key_field_name => $field_obj) {
+			if (! isset($key_vals_in_combined_pk[ $key_field_name ])) {
+				return null;
+			}
+		}
+		return $key_vals_in_combined_pk;
+	}
+
+
+	/**
+	 * verifies that an array of key-value pairs for model fields has a key
+	 * for each field comprising the primary key index
+	 *
+	 * @param array $key_vals
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function has_all_combined_primary_key_fields($key_vals)
+	{
+		$keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
+		foreach ($keys_it_should_have as $key) {
+			if (! isset($key_vals[ $key ])) {
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * Finds all model objects in the DB that appear to be a copy of $model_object_or_attributes_array.
+	 * We consider something to be a copy if all the attributes match (except the ID, of course).
+	 *
+	 * @param array|EE_Base_Class $model_object_or_attributes_array If its an array, it's field-value pairs
+	 * @param array               $query_params                     @see
+	 *                                                              https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @return EE_Base_Class[] Array keys are object IDs (if there is a primary key on the model. if not, numerically
+	 *                                                              indexed)
+	 */
+	public function get_all_copies($model_object_or_attributes_array, $query_params = [])
+	{
+		if ($model_object_or_attributes_array instanceof EE_Base_Class) {
+			$attributes_array = $model_object_or_attributes_array->model_field_array();
+		} elseif (is_array($model_object_or_attributes_array)) {
+			$attributes_array = $model_object_or_attributes_array;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"get_all_copies should be provided with either a model object or an array of field-value-pairs, but was given %s",
+						"event_espresso"
+					),
+					$model_object_or_attributes_array
+				)
+			);
+		}
+		// even copies obviously won't have the same ID, so remove the primary key
+		// from the WHERE conditions for finding copies (if there is a primary key, of course)
+		if ($this->has_primary_key_field() && isset($attributes_array[ $this->primary_key_name() ])) {
+			unset($attributes_array[ $this->primary_key_name() ]);
+		}
+		if (isset($query_params[0])) {
+			$query_params[0] = array_merge($attributes_array, $query_params);
+		} else {
+			$query_params[0] = $attributes_array;
+		}
+		return $this->get_all($query_params);
+	}
+
+
+	/**
+	 * Gets the first copy we find. See get_all_copies for more details
+	 *
+	 * @param mixed EE_Base_Class | array        $model_object_or_attributes_array
+	 * @param array $query_params
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_one_copy($model_object_or_attributes_array, $query_params = [])
+	{
+		if (! is_array($query_params)) {
+			EE_Error::doing_it_wrong(
+				'EEM_Base::get_one_copy',
+				sprintf(
+					esc_html__('$query_params should be an array, you passed a variable of type %s', 'event_espresso'),
+					gettype($query_params)
+				),
+				'4.6.0'
+			);
+			$query_params = [];
+		}
+		$query_params['limit'] = 1;
+		$copies                = $this->get_all_copies($model_object_or_attributes_array, $query_params);
+		if (is_array($copies)) {
+			return array_shift($copies);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Updates the item with the specified id. Ignores default query parameters because
+	 * we have specified the ID, and its assumed we KNOW what we're doing
+	 *
+	 * @param array      $fields_n_values keys are field names, values are their new values
+	 * @param int|string $id              the value of the primary key to update
+	 * @return int number of rows updated
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_by_ID($fields_n_values, $id)
+	{
+		$query_params = [
+			0                          => [$this->get_primary_key_field()->get_name() => $id],
+			'default_where_conditions' => EEM_Base::default_where_conditions_others_only,
+		];
+		return $this->update($fields_n_values, $query_params);
+	}
+
+
+	/**
+	 * Changes an operator which was supplied to the models into one usable in SQL
+	 *
+	 * @param string $operator_supplied
+	 * @return string an operator which can be used in SQL
+	 * @throws EE_Error
+	 */
+	private function _prepare_operator_for_sql($operator_supplied)
+	{
+		$sql_operator = $this->_valid_operators[ $operator_supplied ] ?? null;
+		if ($sql_operator) {
+			return $sql_operator;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"The operator '%s' is not in the list of valid operators: %s",
+					"event_espresso"
+				),
+				$operator_supplied,
+				implode(",", array_keys($this->_valid_operators))
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the valid operators
+	 *
+	 * @return array keys are accepted strings, values are the SQL they are converted to
+	 */
+	public function valid_operators()
+	{
+		return $this->_valid_operators;
+	}
+
+
+	/**
+	 * Gets the between-style operators (take 2 arguments).
+	 *
+	 * @return array keys are accepted strings, values are the SQL they are converted to
+	 */
+	public function valid_between_style_operators()
+	{
+		return array_intersect(
+			$this->valid_operators(),
+			$this->_between_style_operators
+		);
+	}
+
+
+	/**
+	 * Gets the "like"-style operators (take a single argument, but it may contain wildcards)
+	 *
+	 * @return array keys are accepted strings, values are the SQL they are converted to
+	 */
+	public function valid_like_style_operators()
+	{
+		return array_intersect(
+			$this->valid_operators(),
+			$this->_like_style_operators
+		);
+	}
+
+
+	/**
+	 * Gets the "in"-style operators
+	 *
+	 * @return array keys are accepted strings, values are the SQL they are converted to
+	 */
+	public function valid_in_style_operators()
+	{
+		return array_intersect(
+			$this->valid_operators(),
+			$this->_in_style_operators
+		);
+	}
+
+
+	/**
+	 * Gets the "null"-style operators (accept no arguments)
+	 *
+	 * @return array keys are accepted strings, values are the SQL they are converted to
+	 */
+	public function valid_null_style_operators()
+	{
+		return array_intersect(
+			$this->valid_operators(),
+			$this->_null_style_operators
+		);
+	}
+
+
+	/**
+	 * Gets an array where keys are the primary keys and values are their 'names'
+	 * (as determined by the model object's name() function, which is often overridden)
+	 *
+	 * @param array $query_params like get_all's
+	 * @return string[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_names($query_params = [])
+	{
+		$objs  = $this->get_all($query_params);
+		$names = [];
+		foreach ($objs as $obj) {
+			$names[ $obj->ID() ] = $obj->name();
+		}
+		return $names;
+	}
+
+
+	/**
+	 * Gets an array of primary keys from the model objects. If you acquired the model objects
+	 * using EEM_Base::get_all() you don't need to call this (and probably shouldn't because
+	 * this is duplicated effort and reduces efficiency) you would be better to use
+	 * array_keys() on $model_objects.
+	 *
+	 * @param \EE_Base_Class[] $model_objects
+	 * @param boolean          $filter_out_empty_ids if a model object has an ID of '' or 0, don't bother including it
+	 *                                               in the returned array
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_IDs($model_objects, $filter_out_empty_ids = false)
+	{
+		if (! $this->has_primary_key_field()) {
+			if (WP_DEBUG) {
+				EE_Error::add_error(
+					esc_html__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		$IDs = [];
+		foreach ($model_objects as $model_object) {
+			$id = $model_object->ID();
+			if (! $id) {
+				if ($filter_out_empty_ids) {
+					continue;
+				}
+				if (WP_DEBUG) {
+					EE_Error::add_error(
+						esc_html__(
+							'Called %1$s on a model object that has no ID and so probably hasn\'t been saved to the database',
+							'event_espresso'
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+			$IDs[] = $id;
+		}
+		return $IDs;
+	}
+
+
+	/**
+	 * Returns the string used in capabilities relating to this model. If there
+	 * are no capabilities that relate to this model returns false
+	 *
+	 * @return string|false
+	 */
+	public function cap_slug()
+	{
+		return apply_filters('FHEE__EEM_Base__cap_slug', $this->_caps_slug, $this);
+	}
+
+
+	/**
+	 * Returns the capability-restrictions array (@param string $context
+	 *
+	 * @return EE_Default_Where_Conditions[] indexed by associated capability
+	 * @throws EE_Error
+	 * @see EEM_Base::_cap_restrictions).
+	 *      If $context is provided (which should be set to one of EEM_Base::valid_cap_contexts())
+	 *      only returns the cap restrictions array in that context (ie, the array
+	 *      at that key)
+	 *
+	 */
+	public function cap_restrictions($context = EEM_Base::caps_read)
+	{
+		EEM_Base::verify_is_valid_cap_context($context);
+		// check if we ought to run the restriction generator first
+		if (
+			isset($this->_cap_restriction_generators[ $context ])
+			&& $this->_cap_restriction_generators[ $context ] instanceof EE_Restriction_Generator_Base
+			&& ! $this->_cap_restriction_generators[ $context ]->has_generated_cap_restrictions()
+		) {
+			$this->_cap_restrictions[ $context ] = array_merge(
+				$this->_cap_restrictions[ $context ],
+				$this->_cap_restriction_generators[ $context ]->generate_restrictions()
+			);
+		}
+		// and make sure we've finalized the construction of each restriction
+		foreach ($this->_cap_restrictions[ $context ] as $where_conditions_obj) {
+			if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
+				$where_conditions_obj->_finalize_construct($this);
+			}
+		}
+		return $this->_cap_restrictions[ $context ];
+	}
+
+
+	/**
+	 * Indicating whether or not this model thinks its a wp core model
+	 *
+	 * @return boolean
+	 */
+	public function is_wp_core_model()
+	{
+		return $this->_wp_core_model;
+	}
+
+
+	/**
+	 * Gets all the caps that are missing which impose a restriction on
+	 * queries made in this context
+	 *
+	 * @param string $context one of EEM_Base::caps_ constants
+	 * @return EE_Default_Where_Conditions[] indexed by capability name
+	 * @throws EE_Error
+	 */
+	public function caps_missing($context = EEM_Base::caps_read)
+	{
+		$missing_caps     = [];
+		$cap_restrictions = $this->cap_restrictions($context);
+		foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
+			if (
+				! EE_Capabilities::instance()
+								 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
+			) {
+				$missing_caps[ $cap ] = $restriction_if_no_cap;
+			}
+		}
+		return $missing_caps;
+	}
+
+
+	/**
+	 * Gets the mapping from capability contexts to action strings used in capability names
+	 *
+	 * @return array keys are one of EEM_Base::valid_cap_contexts(), and values are usually
+	 * one of 'read', 'edit', or 'delete'
+	 */
+	public function cap_contexts_to_cap_action_map()
+	{
+		return apply_filters(
+			'FHEE__EEM_Base__cap_contexts_to_cap_action_map',
+			$this->_cap_contexts_to_cap_action_map,
+			$this
+		);
+	}
+
+
+	/**
+	 * Gets the action string for the specified capability context
+	 *
+	 * @param string $context
+	 * @return string one of EEM_Base::cap_contexts_to_cap_action_map() values
+	 * @throws EE_Error
+	 */
+	public function cap_action_for_context($context)
+	{
+		$mapping = $this->cap_contexts_to_cap_action_map();
+		if (isset($mapping[ $context ])) {
+			return $mapping[ $context ];
+		}
+		if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
+			return $action;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'Cannot find capability restrictions for context "%1$s", allowed values are:%2$s',
+					'event_espresso'
+				),
+				$context,
+				implode(',', array_keys($this->cap_contexts_to_cap_action_map()))
+			)
+		);
+	}
+
+
+	/**
+	 * Returns all the capability contexts which are valid when querying models
+	 *
+	 * @return array
+	 */
+	public static function valid_cap_contexts()
+	{
+		return apply_filters('FHEE__EEM_Base__valid_cap_contexts', [
+			self::caps_read,
+			self::caps_read_admin,
+			self::caps_edit,
+			self::caps_delete,
+		]);
+	}
+
+
+	/**
+	 * Returns all valid options for 'default_where_conditions'
+	 *
+	 * @return array
+	 */
+	public static function valid_default_where_conditions()
+	{
+		return [
+			EEM_Base::default_where_conditions_all,
+			EEM_Base::default_where_conditions_this_only,
+			EEM_Base::default_where_conditions_others_only,
+			EEM_Base::default_where_conditions_minimum_all,
+			EEM_Base::default_where_conditions_minimum_others,
+			EEM_Base::default_where_conditions_none,
+		];
+	}
+
+	// public static function default_where_conditions_full
+
+
+	/**
+	 * Verifies $context is one of EEM_Base::valid_cap_contexts(), if not it throws an exception
+	 *
+	 * @param string $context
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public static function verify_is_valid_cap_context($context)
+	{
+		$valid_cap_contexts = EEM_Base::valid_cap_contexts();
+		if (in_array($context, $valid_cap_contexts)) {
+			return true;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'Context "%1$s" passed into model "%2$s" is not a valid context. They are: %3$s',
+					'event_espresso'
+				),
+				$context,
+				'EEM_Base',
+				implode(',', $valid_cap_contexts)
+			)
+		);
+	}
+
+
+	/**
+	 * Clears all the models field caches. This is only useful when a sub-class
+	 * might have added a field or something and these caches might be invalidated
+	 */
+	protected function _invalidate_field_caches()
+	{
+		$this->_cache_foreign_key_to_fields = [];
+		$this->_cached_fields               = null;
+		$this->_cached_fields_non_db_only   = null;
+	}
+
+
+	/**
+	 * Gets the list of all the where query param keys that relate to logic instead of field names
+	 * (eg "and", "or", "not").
+	 *
+	 * @return array
+	 */
+	public function logic_query_param_keys()
+	{
+		return $this->_logic_query_param_keys;
+	}
+
+
+	/**
+	 * Determines whether or not the where query param array key is for a logic query param.
+	 * Eg 'OR', 'not*', and 'and*because-i-say-so' should all return true, whereas
+	 * 'ATT_fname', 'EVT_name*not-you-or-me', and 'ORG_name' should return false
+	 *
+	 * @param $query_param_key
+	 * @return bool
+	 */
+	public function is_logic_query_param_key($query_param_key)
+	{
+		foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
+			if (
+				$query_param_key === $logic_query_param_key
+				|| strpos($query_param_key, $logic_query_param_key . '*') === 0
+			) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns true if this model has a password field on it (regardless of whether that password field has any content)
+	 *
+	 * @return boolean
+	 * @since 4.9.74.p
+	 */
+	public function hasPassword()
+	{
+		// if we don't yet know if there's a password field, find out and remember it for next time.
+		if ($this->has_password_field === null) {
+			$password_field           = $this->getPasswordField();
+			$this->has_password_field = $password_field instanceof EE_Password_Field ? true : false;
+		}
+		return $this->has_password_field;
+	}
+
+
+	/**
+	 * Returns the password field on this model, if there is one
+	 *
+	 * @return EE_Password_Field|null
+	 * @since 4.9.74.p
+	 */
+	public function getPasswordField()
+	{
+		// if we definetely already know there is a password field or not (because has_password_field is true or false)
+		// there's no need to search for it. If we don't know yet, then find out
+		if ($this->has_password_field === null && $this->password_field === null) {
+			$this->password_field = $this->get_a_field_of_type('EE_Password_Field');
+		}
+		// don't bother setting has_password_field because that's hasPassword()'s job.
+		return $this->password_field;
+	}
+
+
+	/**
+	 * Returns the list of field (as EE_Model_Field_Bases) that are protected by the password
+	 *
+	 * @return EE_Model_Field_Base[]
+	 * @throws EE_Error
+	 * @since 4.9.74.p
+	 */
+	public function getPasswordProtectedFields()
+	{
+		$password_field = $this->getPasswordField();
+		$fields         = [];
+		if ($password_field instanceof EE_Password_Field) {
+			$field_names = $password_field->protectedFields();
+			foreach ($field_names as $field_name) {
+				$fields[ $field_name ] = $this->field_settings_for($field_name);
+			}
+		}
+		return $fields;
+	}
+
+
+	/**
+	 * Checks if the current user can perform the requested action on this model
+	 *
+	 * @param string              $cap_to_check one of the array keys from _cap_contexts_to_cap_action_map
+	 * @param EE_Base_Class|array $model_obj_or_fields_n_values
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 * @since 4.9.74.p
+	 */
+	public function currentUserCan($cap_to_check, $model_obj_or_fields_n_values)
+	{
+		if ($model_obj_or_fields_n_values instanceof EE_Base_Class) {
+			$model_obj_or_fields_n_values = $model_obj_or_fields_n_values->model_field_array();
+		}
+		if (! is_array($model_obj_or_fields_n_values)) {
+			throw new UnexpectedEntityException(
+				$model_obj_or_fields_n_values,
+				'EE_Base_Class',
+				sprintf(
+					esc_html__(
+						'%1$s must be passed an `EE_Base_Class or an array of fields names with their values. You passed in something different.',
+						'event_espresso'
+					),
+					__FUNCTION__
+				)
+			);
+		}
+		return $this->exists(
+			$this->alter_query_params_to_restrict_by_ID(
+				$this->get_index_primary_key_string($model_obj_or_fields_n_values),
+				[
+					'default_where_conditions' => 'none',
+					'caps'                     => $cap_to_check,
+				]
+			)
+		);
+	}
+
+
+	/**
+	 * Returns the query param where conditions key to the password affecting this model.
+	 * Eg on EEM_Event this would just be "password", on EEM_Datetime this would be "Event.password", etc.
+	 *
+	 * @return null|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @since 4.9.74.p
+	 */
+	public function modelChainAndPassword()
+	{
+		if ($this->model_chain_to_password === null) {
+			throw new ModelConfigurationException(
+				$this,
+				esc_html_x(
+				// @codingStandardsIgnoreStart
+					'Cannot exclude protected data because the model has not specified which model has the password.',
+					// @codingStandardsIgnoreEnd
+					'1: model name',
+					'event_espresso'
+				)
+			);
+		}
+		if ($this->model_chain_to_password === '') {
+			$model_with_password = $this;
+		} else {
+			if ($pos_of_period = strrpos($this->model_chain_to_password, '.')) {
+				$last_model_in_chain = substr($this->model_chain_to_password, $pos_of_period + 1);
+			} else {
+				$last_model_in_chain = $this->model_chain_to_password;
+			}
+			$model_with_password = EE_Registry::instance()->load_model($last_model_in_chain);
+		}
+
+		$password_field = $model_with_password->getPasswordField();
+		if ($password_field instanceof EE_Password_Field) {
+			$password_field_name = $password_field->get_name();
+		} else {
+			throw new ModelConfigurationException(
+				$this,
+				sprintf(
+					esc_html_x(
+						'This model claims related model "%1$s" should have a password field on it, but none was found. The model relation chain is "%2$s"',
+						'1: model name, 2: special string',
+						'event_espresso'
+					),
+					$model_with_password->get_this_model_name(),
+					$this->model_chain_to_password
+				)
+			);
+		}
+		return ($this->model_chain_to_password ? $this->model_chain_to_password . '.' : '') . $password_field_name;
+	}
+
+
+	/**
+	 * Returns true if there is a password on a related model which restricts access to some of this model's rows,
+	 * or if this model itself has a password affecting access to some of its other fields.
+	 *
+	 * @return boolean
+	 * @since 4.9.74.p
+	 */
+	public function restrictedByRelatedModelPassword()
+	{
+		return $this->model_chain_to_password !== null;
+	}
 }

Spacing +230 added lines, -230 removed lines

@@ -564,7 +564,7 @@ 
     protected function __construct($timezone = null)
     {
         // check that the model has not been loaded too soon
-        if (! did_action('AHEE__EE_System__load_espresso_addons')) {
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons')) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -587,7 +587,7 @@ 
          *
          * @var EE_Table_Base[] $_tables
          */
-        $this->_tables = (array) apply_filters('FHEE__' . get_class($this) . '__construct__tables', $this->_tables);
+        $this->_tables = (array) apply_filters('FHEE__'.get_class($this).'__construct__tables', $this->_tables);
         foreach ($this->_tables as $table_alias => $table_obj) {
             /** @var $table_obj EE_Table_Base */
             $table_obj->_construct_finalize_with_alias($table_alias);
@@ -601,10 +601,10 @@ 
          *
          * @param EE_Model_Field_Base[] $_fields
          */
-        $this->_fields = (array) apply_filters('FHEE__' . get_class($this) . '__construct__fields', $this->_fields);
+        $this->_fields = (array) apply_filters('FHEE__'.get_class($this).'__construct__fields', $this->_fields);
         $this->_invalidate_field_caches();
         foreach ($this->_fields as $table_alias => $fields_for_table) {
-            if (! array_key_exists($table_alias, $this->_tables)) {
+            if ( ! array_key_exists($table_alias, $this->_tables)) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -641,7 +641,7 @@ 
          * @param EE_Model_Relation_Base[] $_model_relations
          */
         $this->_model_relations = (array) apply_filters(
-            'FHEE__' . get_class($this) . '__construct__model_relations',
+            'FHEE__'.get_class($this).'__construct__model_relations',
             $this->_model_relations
         );
         foreach ($this->_model_relations as $model_name => $relation_obj) {
@@ -653,12 +653,12 @@ 
         }
         $this->set_timezone($timezone);
         // finalize default where condition strategy, or set default
-        if (! $this->_default_where_conditions_strategy) {
+        if ( ! $this->_default_where_conditions_strategy) {
             // nothing was set during child constructor, so set default
             $this->_default_where_conditions_strategy = new EE_Default_Where_Conditions();
         }
         $this->_default_where_conditions_strategy->_finalize_construct($this);
-        if (! $this->_minimum_where_conditions_strategy) {
+        if ( ! $this->_minimum_where_conditions_strategy) {
             // nothing was set during child constructor, so set default
             $this->_minimum_where_conditions_strategy = new EE_Default_Where_Conditions();
         }
@@ -671,8 +671,8 @@ 
         // initialize the standard cap restriction generators if none were specified by the child constructor
         if (is_array($this->_cap_restriction_generators)) {
             foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-                if (! isset($this->_cap_restriction_generators[ $cap_context ])) {
-                    $this->_cap_restriction_generators[ $cap_context ] = apply_filters(
+                if ( ! isset($this->_cap_restriction_generators[$cap_context])) {
+                    $this->_cap_restriction_generators[$cap_context] = apply_filters(
                         'FHEE__EEM_Base___construct__standard_cap_restriction_generator',
                         new EE_Restriction_Generator_Protected(),
                         $cap_context,
@@ -684,10 +684,10 @@ 
         // if there are cap restriction generators, use them to make the default cap restrictions
         if (is_array($this->_cap_restriction_generators)) {
             foreach ($this->_cap_restriction_generators as $context => $generator_object) {
-                if (! $generator_object) {
+                if ( ! $generator_object) {
                     continue;
                 }
-                if (! $generator_object instanceof EE_Restriction_Generator_Base) {
+                if ( ! $generator_object instanceof EE_Restriction_Generator_Base) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -700,12 +700,12 @@ 
                     );
                 }
                 $action = $this->cap_action_for_context($context);
-                if (! $generator_object->construction_finalized()) {
+                if ( ! $generator_object->construction_finalized()) {
                     $generator_object->_construct_finalize($this, $action);
                 }
             }
         }
-        do_action('AHEE__' . get_class($this) . '__construct__end');
+        do_action('AHEE__'.get_class($this).'__construct__end');
     }
 
 
@@ -717,7 +717,7 @@ 
      */
     protected static function getLoader(): LoaderInterface
     {
-        if (! EEM_Base::$loader instanceof LoaderInterface) {
+        if ( ! EEM_Base::$loader instanceof LoaderInterface) {
             EEM_Base::$loader = LoaderFactory::getLoader();
         }
         return EEM_Base::$loader;
@@ -730,7 +730,7 @@ 
      */
     private static function getMirror(): Mirror
     {
-        if (! EEM_Base::$mirror instanceof Mirror) {
+        if ( ! EEM_Base::$mirror instanceof Mirror) {
             EEM_Base::$mirror = EEM_Base::getLoader()->getShared(Mirror::class);
         }
         return EEM_Base::$mirror;
@@ -786,7 +786,7 @@ 
     public static function instance($timezone = null)
     {
         // check if instance of Espresso_model already exists
-        if (! static::$_instance instanceof static) {
+        if ( ! static::$_instance instanceof static) {
             $arguments = EEM_Base::getModelArguments(static::class, (string) $timezone);
             $model     = new static(...$arguments);
             EEM_Base::getLoader()->share(static::class, $model, $arguments);
@@ -815,7 +815,7 @@ 
      */
     public static function reset($timezone = null)
     {
-        if (! static::$_instance instanceof EEM_Base) {
+        if ( ! static::$_instance instanceof EEM_Base) {
             return null;
         }
         // Let's NOT swap out the current instance for a new one
@@ -826,7 +826,7 @@ 
         foreach (EEM_Base::getMirror()->getDefaultProperties(static::class) as $property => $value) {
             // don't set instance to null like it was originally,
             // but it's static anyways, and we're ignoring static properties (for now at least)
-            if (! isset($static_properties[ $property ])) {
+            if ( ! isset($static_properties[$property])) {
                 static::$_instance->{$property} = $value;
             }
         }
@@ -875,7 +875,7 @@ 
      */
     public function status_array($translated = false)
     {
-        if (! array_key_exists('Status', $this->_model_relations)) {
+        if ( ! array_key_exists('Status', $this->_model_relations)) {
             return [];
         }
         $model_name   = $this->get_this_model_name();
@@ -883,7 +883,7 @@ 
         $stati        = EEM_Status::instance()->get_all([['STS_type' => $status_type]]);
         $status_array = [];
         foreach ($stati as $status) {
-            $status_array[ $status->ID() ] = $status->get('STS_code');
+            $status_array[$status->ID()] = $status->get('STS_code');
         }
         return $translated
             ? EEM_Status::instance()->localized_status($status_array, false, 'sentence')
@@ -948,7 +948,7 @@ 
     {
         $wp_user_field_name = $this->wp_user_field_name();
         if ($wp_user_field_name) {
-            $query_params[0][ $wp_user_field_name ] = get_current_user_id();
+            $query_params[0][$wp_user_field_name] = get_current_user_id();
         }
         return $query_params;
     }
@@ -967,17 +967,17 @@ 
     public function wp_user_field_name()
     {
         try {
-            if (! empty($this->_model_chain_to_wp_user)) {
+            if ( ! empty($this->_model_chain_to_wp_user)) {
                 $models_to_follow_to_wp_users = explode('.', $this->_model_chain_to_wp_user);
                 $last_model_name              = end($models_to_follow_to_wp_users);
                 $model_with_fk_to_wp_users    = EE_Registry::instance()->load_model($last_model_name);
-                $model_chain_to_wp_user       = $this->_model_chain_to_wp_user . '.';
+                $model_chain_to_wp_user       = $this->_model_chain_to_wp_user.'.';
             } else {
                 $model_with_fk_to_wp_users = $this;
                 $model_chain_to_wp_user    = '';
             }
             $wp_user_field = $model_with_fk_to_wp_users->get_foreign_key_to('WP_User');
-            return $model_chain_to_wp_user . $wp_user_field->get_name();
+            return $model_chain_to_wp_user.$wp_user_field->get_name();
         } catch (EE_Error $e) {
             return false;
         }
@@ -1052,11 +1052,11 @@ 
         if ($this->_custom_selections instanceof CustomSelects) {
             $custom_expressions = $this->_custom_selections->columnsToSelectExpression();
             $select_expressions .= $select_expressions
-                ? ', ' . $custom_expressions
+                ? ', '.$custom_expressions
                 : $custom_expressions;
         }
 
-        $SQL = "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
+        $SQL = "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
         return $this->_do_wpdb_query('get_results', [$SQL, $output]);
     }
 
@@ -1073,7 +1073,7 @@ 
      */
     protected function getCustomSelection(array $query_params, $columns_to_select = null)
     {
-        if (! isset($query_params['extra_selects']) && $columns_to_select === null) {
+        if ( ! isset($query_params['extra_selects']) && $columns_to_select === null) {
             return null;
         }
         $selects = isset($query_params['extra_selects']) ? $query_params['extra_selects'] : $columns_to_select;
@@ -1121,7 +1121,7 @@ 
         if (is_array($columns_to_select)) {
             $select_sql_array = [];
             foreach ($columns_to_select as $alias => $selection_and_datatype) {
-                if (! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
+                if ( ! is_array($selection_and_datatype) || ! isset($selection_and_datatype[1])) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -1133,7 +1133,7 @@ 
                         )
                     );
                 }
-                if (! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types, true)) {
+                if ( ! in_array($selection_and_datatype[1], $this->_valid_wpdb_data_types, true)) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -1189,7 +1189,7 @@ 
                 ['default_where_conditions' => EEM_Base::default_where_conditions_minimum_all]
             )
         );
-        $className    = $this->_get_class_name();
+        $className = $this->_get_class_name();
         if ($model_object instanceof $className) {
             // make sure valid objects get added to the entity map
             // so that the next call to this method doesn't trigger another trip to the db
@@ -1212,12 +1212,12 @@ 
      */
     public function alter_query_params_to_restrict_by_ID($id, $query_params = [])
     {
-        if (! isset($query_params[0])) {
+        if ( ! isset($query_params[0])) {
             $query_params[0] = [];
         }
         $conditions_from_id = $this->parse_index_primary_key_string($id);
         if ($conditions_from_id === null) {
-            $query_params[0][ $this->primary_key_name() ] = $id;
+            $query_params[0][$this->primary_key_name()] = $id;
         } else {
             // no primary key, so the $id must be from the get_index_primary_key_string()
             $query_params[0] = array_replace_recursive($query_params[0], $this->parse_index_primary_key_string($id));
@@ -1236,7 +1236,7 @@ 
      */
     public function get_one($query_params = [])
     {
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong(
                 'EEM_Base::get_one',
                 sprintf(
@@ -1434,7 +1434,7 @@ 
                 return [];
             }
         }
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong(
                 'EEM_Base::_get_consecutive',
                 sprintf(
@@ -1446,7 +1446,7 @@ 
             $query_params = [];
         }
         // let's add the where query param for consecutive look up.
-        $query_params[0][ $field_to_order_by ] = [$operand, $current_field_value];
+        $query_params[0][$field_to_order_by] = [$operand, $current_field_value];
         $query_params['limit']                 = $limit;
         // set direction
         $incoming_orderby         = isset($query_params['order_by']) ? (array) $query_params['order_by'] : [];
@@ -1524,7 +1524,7 @@ 
     {
         $field_settings = $this->field_settings_for($field_name);
         // if not a valid EE_Datetime_Field then throw error
-        if (! $field_settings instanceof EE_Datetime_Field) {
+        if ( ! $field_settings instanceof EE_Datetime_Field) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -1675,7 +1675,7 @@ 
      */
     public function update($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
     {
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong(
                 'EEM_Base::update',
                 sprintf(
@@ -1723,7 +1723,7 @@ 
             $wpdb_result = (array) $wpdb_result;
             // get the model object's PK, as we'll want this if we need to insert a row into secondary tables
             if ($this->has_primary_key_field()) {
-                $main_table_pk_value = $wpdb_result[ $this->get_primary_key_field()->get_qualified_column() ];
+                $main_table_pk_value = $wpdb_result[$this->get_primary_key_field()->get_qualified_column()];
             } else {
                 // if there's no primary key, we basically can't support having a 2nd table on the model (we could but it would be lots of work)
                 $main_table_pk_value = null;
@@ -1739,7 +1739,7 @@ 
                     // in this table, right? so insert a row in the current table, using any fields available
                     if (
                         ! (array_key_exists($this_table_pk_column, $wpdb_result)
-                           && $wpdb_result[ $this_table_pk_column ])
+                           && $wpdb_result[$this_table_pk_column])
                     ) {
                         $success = $this->_insert_into_specific_table(
                             $table_obj,
@@ -1747,7 +1747,7 @@ 
                             $main_table_pk_value
                         );
                         // if we died here, report the error
-                        if (! $success) {
+                        if ( ! $success) {
                             return false;
                         }
                     }
@@ -1775,10 +1775,10 @@ 
                 $model_objs_affected_ids     = [];
                 foreach ($models_affected_key_columns as $row) {
                     $combined_index_key                             = $this->get_index_primary_key_string($row);
-                    $model_objs_affected_ids[ $combined_index_key ] = $combined_index_key;
+                    $model_objs_affected_ids[$combined_index_key] = $combined_index_key;
                 }
             }
-            if (! $model_objs_affected_ids) {
+            if ( ! $model_objs_affected_ids) {
                 // wait wait wait- if nothing was affected let's stop here
                 return 0;
             }
@@ -1806,8 +1806,8 @@ 
                             . " SET "
                             . $this->_construct_update_sql($fields_n_values)
                             . $model_query_info->get_where_sql(
-            );// note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
-        $rows_affected    = $this->_do_wpdb_query('query', [$SQL]);
+            ); // note: doesn't use _construct_2nd_half_of_select_query() because doesn't accept LIMIT, ORDER BY, etc.
+        $rows_affected = $this->_do_wpdb_query('query', [$SQL]);
         /**
          * Action called after a model update call has been made.
          *
@@ -1817,7 +1817,7 @@ 
          * @param int      $rows_affected
          */
         do_action('AHEE__EEM_Base__update__end', $this, $fields_n_values, $query_params, $rows_affected);
-        return $rows_affected;// how many supposedly got updated
+        return $rows_affected; // how many supposedly got updated
     }
 
 
@@ -1849,7 +1849,7 @@ 
         $model_query_info   = $this->_create_model_query_info_carrier($query_params);
         $select_expressions = $field->get_qualified_column();
         $SQL                =
-            "SELECT $select_expressions " . $this->_construct_2nd_half_of_select_query($model_query_info);
+            "SELECT $select_expressions ".$this->_construct_2nd_half_of_select_query($model_query_info);
         return $this->_do_wpdb_query('get_col', [$SQL]);
     }
 
@@ -1867,7 +1867,7 @@ 
     {
         $query_params['limit'] = 1;
         $col                   = $this->get_col($query_params, $field_to_select);
-        if (! empty($col)) {
+        if ( ! empty($col)) {
             return reset($col);
         }
         return null;
@@ -1897,7 +1897,7 @@ 
             $prepared_value  = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
             $value_sql       = $prepared_value === null ? 'NULL'
                 : $wpdb->prepare($field_obj->get_wpdb_data_type(), $prepared_value);
-            $cols_n_values[] = $field_obj->get_qualified_column() . "=" . $value_sql;
+            $cols_n_values[] = $field_obj->get_qualified_column()."=".$value_sql;
         }
         return implode(",", $cols_n_values);
     }
@@ -2031,7 +2031,7 @@ 
                                 . $model_query_info->get_full_join_sql()
                                 . " WHERE "
                                 . $deletion_where_query_part;
-            $rows_deleted     = $this->_do_wpdb_query('query', [$SQL]);
+            $rows_deleted = $this->_do_wpdb_query('query', [$SQL]);
         } else {
             $rows_deleted = 0;
         }
@@ -2041,12 +2041,12 @@ 
         if (
             $this->has_primary_key_field()
             && $rows_deleted !== false
-            && isset($columns_and_ids_for_deleting[ $this->get_primary_key_field()->get_qualified_column() ])
+            && isset($columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()])
         ) {
-            $ids_for_removal = $columns_and_ids_for_deleting[ $this->get_primary_key_field()->get_qualified_column() ];
+            $ids_for_removal = $columns_and_ids_for_deleting[$this->get_primary_key_field()->get_qualified_column()];
             foreach ($ids_for_removal as $id) {
-                if (isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])) {
-                    unset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]);
+                if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
+                    unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
                 }
             }
 
@@ -2083,7 +2083,7 @@ 
          * @param int      $rows_deleted
          */
         do_action('AHEE__EEM_Base__delete__end', $this, $query_params, $rows_deleted, $columns_and_ids_for_deleting);
-        return $rows_deleted;// how many supposedly got deleted
+        return $rows_deleted; // how many supposedly got deleted
     }
 
 
@@ -2179,15 +2179,15 @@ 
                 if (
                     $allow_blocking
                     && $this->delete_is_blocked_by_related_models(
-                        $item_to_delete[ $primary_table->get_fully_qualified_pk_column() ]
+                        $item_to_delete[$primary_table->get_fully_qualified_pk_column()]
                     )
                 ) {
                     continue;
                 }
                 // primary table deletes
-                if (isset($item_to_delete[ $primary_table->get_fully_qualified_pk_column() ])) {
-                    $ids_to_delete_indexed_by_column[ $primary_table->get_fully_qualified_pk_column() ][] =
-                        $item_to_delete[ $primary_table->get_fully_qualified_pk_column() ];
+                if (isset($item_to_delete[$primary_table->get_fully_qualified_pk_column()])) {
+                    $ids_to_delete_indexed_by_column[$primary_table->get_fully_qualified_pk_column()][] =
+                        $item_to_delete[$primary_table->get_fully_qualified_pk_column()];
                 }
             }
         } elseif (count($this->get_combined_primary_key_fields()) > 1) {
@@ -2196,8 +2196,8 @@ 
                 $ids_to_delete_indexed_by_column_for_row = [];
                 foreach ($fields as $cpk_field) {
                     if ($cpk_field instanceof EE_Model_Field_Base) {
-                        $ids_to_delete_indexed_by_column_for_row[ $cpk_field->get_qualified_column() ] =
-                            $item_to_delete[ $cpk_field->get_qualified_column() ];
+                        $ids_to_delete_indexed_by_column_for_row[$cpk_field->get_qualified_column()] =
+                            $item_to_delete[$cpk_field->get_qualified_column()];
                     }
                 }
                 $ids_to_delete_indexed_by_column[] = $ids_to_delete_indexed_by_column_for_row;
@@ -2235,7 +2235,7 @@ 
         } elseif ($this->has_primary_key_field()) {
             $query = [];
             foreach ($ids_to_delete_indexed_by_column as $column => $ids) {
-                $query[] = $column . ' IN' . $this->_construct_in_value($ids, $this->_primary_key_field);
+                $query[] = $column.' IN'.$this->_construct_in_value($ids, $this->_primary_key_field);
             }
             $query_part = ! empty($query) ? implode(' AND ', $query) : $query_part;
         } elseif (count($this->get_combined_primary_key_fields()) > 1) {
@@ -2243,7 +2243,7 @@ 
             foreach ($ids_to_delete_indexed_by_column as $ids_to_delete_indexed_by_column_for_each_row) {
                 $values_for_each_combined_primary_key_for_a_row = [];
                 foreach ($ids_to_delete_indexed_by_column_for_each_row as $column => $id) {
-                    $values_for_each_combined_primary_key_for_a_row[] = $column . '=' . $id;
+                    $values_for_each_combined_primary_key_for_a_row[] = $column.'='.$id;
                 }
                 $ways_to_identify_a_row[] = '('
                                             . implode(' AND ', $values_for_each_combined_primary_key_for_a_row)
@@ -2317,9 +2317,9 @@ 
                 $column_to_count = '*';
             }
         }
-        $column_to_count = $distinct ? "DISTINCT " . $column_to_count : $column_to_count;
+        $column_to_count = $distinct ? "DISTINCT ".$column_to_count : $column_to_count;
         $SQL             =
-            "SELECT COUNT(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
+            "SELECT COUNT(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
         return (int) $this->_do_wpdb_query('get_var', [$SQL]);
     }
 
@@ -2343,7 +2343,7 @@ 
         }
         $column_to_count = $field_obj->get_qualified_column();
         $SQL             =
-            "SELECT SUM(" . $column_to_count . ")" . $this->_construct_2nd_half_of_select_query($model_query_info);
+            "SELECT SUM(".$column_to_count.")".$this->_construct_2nd_half_of_select_query($model_query_info);
         $return_value    = $this->_do_wpdb_query('get_var', [$SQL]);
         $data_type       = $field_obj->get_wpdb_data_type();
         if ($data_type === '%d' || $data_type === '%s') {
@@ -2369,7 +2369,7 @@ 
         // if we're in maintenance mode level 2, DON'T run any queries
         // because level 2 indicates the database needs updating and
         // is probably out of sync with the code
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -2381,7 +2381,7 @@ 
         }
         /** @type WPDB $wpdb */
         global $wpdb;
-        if (! method_exists($wpdb, $wpdb_method)) {
+        if ( ! method_exists($wpdb, $wpdb_method)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -2400,7 +2400,7 @@ 
         $this->show_db_query_if_previously_requested($wpdb->last_query);
         if (WP_DEBUG) {
             $wpdb->show_errors($old_show_errors_value);
-            if (! empty($wpdb->last_error)) {
+            if ( ! empty($wpdb->last_error)) {
                 throw new EE_Error(sprintf(esc_html__('WPDB Error: "%s"', 'event_espresso'), $wpdb->last_error));
             }
             if ($result === false) {
@@ -2470,7 +2470,7 @@ 
                     // ummmm... you in trouble
                     return $result;
             }
-            if (! empty($error_message)) {
+            if ( ! empty($error_message)) {
                 EE_Log::instance()->log(__FILE__, __FUNCTION__, $error_message, 'error');
                 trigger_error($error_message);
             }
@@ -2547,11 +2547,11 @@ 
      */
     private function _construct_2nd_half_of_select_query(EE_Model_Query_Info_Carrier $model_query_info)
     {
-        return " FROM " . $model_query_info->get_full_join_sql() .
-               $model_query_info->get_where_sql() .
-               $model_query_info->get_group_by_sql() .
-               $model_query_info->get_having_sql() .
-               $model_query_info->get_order_by_sql() .
+        return " FROM ".$model_query_info->get_full_join_sql().
+               $model_query_info->get_where_sql().
+               $model_query_info->get_group_by_sql().
+               $model_query_info->get_having_sql().
+               $model_query_info->get_order_by_sql().
                $model_query_info->get_limit_sql();
     }
 
@@ -2743,12 +2743,12 @@ 
         $related_model = $this->get_related_model_obj($model_name);
         // we're just going to use the query params on the related model's normal get_all query,
         // except add a condition to say to match the current mod
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
         }
         $this_model_name                                                 = $this->get_this_model_name();
         $this_pk_field_name                                              = $this->get_primary_key_field()->get_name();
-        $query_params[0][ $this_model_name . "." . $this_pk_field_name ] = $id_or_obj;
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
         return $related_model->count($query_params, $field_to_count, $distinct);
     }
 
@@ -2768,7 +2768,7 @@ 
     public function sum_related($id_or_obj, $model_name, $query_params, $field_to_sum = null)
     {
         $related_model = $this->get_related_model_obj($model_name);
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong(
                 'EEM_Base::sum_related',
                 sprintf(
@@ -2781,12 +2781,12 @@ 
         }
         // we're just going to use the query params on the related model's normal get_all query,
         // except add a condition to say to match the current mod
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = EEM_Base::default_where_conditions_none;
         }
         $this_model_name                                                 = $this->get_this_model_name();
         $this_pk_field_name                                              = $this->get_primary_key_field()->get_name();
-        $query_params[0][ $this_model_name . "." . $this_pk_field_name ] = $id_or_obj;
+        $query_params[0][$this_model_name.".".$this_pk_field_name] = $id_or_obj;
         return $related_model->sum($query_params, $field_to_sum);
     }
 
@@ -2837,7 +2837,7 @@ 
                 $field_with_model_name = $field;
             }
         }
-        if (! isset($field_with_model_name) || ! $field_with_model_name) {
+        if ( ! isset($field_with_model_name) || ! $field_with_model_name) {
             throw new EE_Error(
                 sprintf(
                     esc_html__("There is no EE_Any_Foreign_Model_Name field on model %s", "event_espresso"),
@@ -2974,14 +2974,14 @@ 
                 || $this->get_primary_key_field()
                    instanceof
                    EE_Primary_Key_String_Field)
-            && isset($fields_n_values[ $this->primary_key_name() ])
+            && isset($fields_n_values[$this->primary_key_name()])
         ) {
-            $query_params[0]['OR'][ $this->primary_key_name() ] = $fields_n_values[ $this->primary_key_name() ];
+            $query_params[0]['OR'][$this->primary_key_name()] = $fields_n_values[$this->primary_key_name()];
         }
         foreach ($this->unique_indexes() as $unique_index_name => $unique_index) {
             $uniqueness_where_params                              =
                 array_intersect_key($fields_n_values, $unique_index->fields());
-            $query_params[0]['OR'][ 'AND*' . $unique_index_name ] = $uniqueness_where_params;
+            $query_params[0]['OR']['AND*'.$unique_index_name] = $uniqueness_where_params;
         }
         // if there is nothing to base this search on, then we shouldn't find anything
         if (empty($query_params)) {
@@ -3056,16 +3056,16 @@ 
             $prepared_value = $this->_prepare_value_or_use_default($field_obj, $fields_n_values);
             // if the value we want to assign it to is NULL, just don't mention it for the insertion
             if ($prepared_value !== null) {
-                $insertion_col_n_values[ $field_obj->get_table_column() ] = $prepared_value;
+                $insertion_col_n_values[$field_obj->get_table_column()] = $prepared_value;
                 $format_for_insertion[]                                   = $field_obj->get_wpdb_data_type();
             }
         }
         if ($table instanceof EE_Secondary_Table && $new_id) {
             // its not the main table, so we should have already saved the main table's PK which we just inserted
             // so add the fk to the main table as a column
-            $insertion_col_n_values[ $table->get_fk_on_table() ] = $new_id;
+            $insertion_col_n_values[$table->get_fk_on_table()] = $new_id;
             $format_for_insertion[]                              =
-                '%d';// yes right now we're only allowing these foreign keys to be INTs
+                '%d'; // yes right now we're only allowing these foreign keys to be INTs
         }
 
         // insert the new entry
@@ -3083,7 +3083,7 @@ 
             }
             // it's not an auto-increment primary key, so
             // it must have been supplied
-            return $fields_n_values[ $this->get_primary_key_field()->get_name() ];
+            return $fields_n_values[$this->get_primary_key_field()->get_name()];
         }
         // we can't return a  primary key because there is none. instead return
         // a unique string indicating this model
@@ -3105,10 +3105,10 @@ 
     {
         $field_name = $field_obj->get_name();
         // if this field doesn't allow nullable, don't allow it
-        if (! $field_obj->is_nullable() && ! isset($fields_n_values[ $field_name ])) {
-            $fields_n_values[ $field_name ] = $field_obj->get_default_value();
+        if ( ! $field_obj->is_nullable() && ! isset($fields_n_values[$field_name])) {
+            $fields_n_values[$field_name] = $field_obj->get_default_value();
         }
-        $unprepared_value = $fields_n_values[ $field_name ] ?? null;
+        $unprepared_value = $fields_n_values[$field_name] ?? null;
         return $this->_prepare_value_for_use_in_db($unprepared_value, $field_obj);
     }
 
@@ -3209,7 +3209,7 @@ 
      */
     public function get_table_obj_by_alias($table_alias = '')
     {
-        return isset($this->_tables[ $table_alias ]) ? $this->_tables[ $table_alias ] : null;
+        return isset($this->_tables[$table_alias]) ? $this->_tables[$table_alias] : null;
     }
 
 
@@ -3223,7 +3223,7 @@ 
         $other_tables = [];
         foreach ($this->_tables as $table_alias => $table) {
             if ($table instanceof EE_Secondary_Table) {
-                $other_tables[ $table_alias ] = $table;
+                $other_tables[$table_alias] = $table;
             }
         }
         return $other_tables;
@@ -3238,7 +3238,7 @@ 
      */
     public function _get_fields_for_table($table_alias)
     {
-        return $this->_fields[ $table_alias ];
+        return $this->_fields[$table_alias];
     }
 
 
@@ -3267,7 +3267,7 @@ 
                     $query_info_carrier,
                     'group_by'
                 );
-            } elseif (! empty($query_params['group_by'])) {
+            } elseif ( ! empty($query_params['group_by'])) {
                 $this->_extract_related_model_info_from_query_param(
                     $query_params['group_by'],
                     $query_info_carrier,
@@ -3289,7 +3289,7 @@ 
                     $query_info_carrier,
                     'order_by'
                 );
-            } elseif (! empty($query_params['order_by'])) {
+            } elseif ( ! empty($query_params['order_by'])) {
                 $this->_extract_related_model_info_from_query_param(
                     $query_params['order_by'],
                     $query_info_carrier,
@@ -3324,7 +3324,7 @@ 
         EE_Model_Query_Info_Carrier $model_query_info_carrier,
         $query_param_type
     ) {
-        if (! empty($sub_query_params)) {
+        if ( ! empty($sub_query_params)) {
             $sub_query_params = (array) $sub_query_params;
             foreach ($sub_query_params as $param => $possibly_array_of_params) {
                 // $param could be simply 'EVT_ID', or it could be 'Registrations.REG_ID', or even 'Registrations.Transactions.Payments.PAY_amount'
@@ -3340,7 +3340,7 @@ 
                 $query_param_sans_stars =
                     $this->_remove_stars_and_anything_after_from_condition_query_param_key($param);
                 if (in_array($query_param_sans_stars, $this->_logic_query_param_keys, true)) {
-                    if (! is_array($possibly_array_of_params)) {
+                    if ( ! is_array($possibly_array_of_params)) {
                         throw new EE_Error(
                             sprintf(
                                 esc_html__(
@@ -3366,7 +3366,7 @@ 
                     // then $possible_array_of_params looks something like array('<','DTT_sold',true)
                     // indicating that $possible_array_of_params[1] is actually a field name,
                     // from which we should extract query parameters!
-                    if (! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
+                    if ( ! isset($possibly_array_of_params[0], $possibly_array_of_params[1])) {
                         throw new EE_Error(
                             sprintf(
                                 esc_html__(
@@ -3406,8 +3406,8 @@ 
         EE_Model_Query_Info_Carrier $model_query_info_carrier,
         $query_param_type
     ) {
-        if (! empty($sub_query_params)) {
-            if (! is_array($sub_query_params)) {
+        if ( ! empty($sub_query_params)) {
+            if ( ! is_array($sub_query_params)) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__("Query parameter %s should be an array, but it isn't.", "event_espresso"),
@@ -3445,7 +3445,7 @@ 
      */
     public function _create_model_query_info_carrier($query_params)
     {
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong(
                 'EEM_Base::_create_model_query_info_carrier',
                 sprintf(
@@ -3476,7 +3476,7 @@ 
             // only include if related to a cpt where no password has been set
             $query_params[0]['OR*nopassword'] = [
                 $where_param_key_for_password       => '',
-                $where_param_key_for_password . '*' => ['IS_NULL'],
+                $where_param_key_for_password.'*' => ['IS_NULL'],
             ];
         }
         $query_object = $this->_extract_related_models_from_query($query_params);
@@ -3530,7 +3530,7 @@ 
         // set limit
         if (array_key_exists('limit', $query_params)) {
             if (is_array($query_params['limit'])) {
-                if (! isset($query_params['limit'][0], $query_params['limit'][1])) {
+                if ( ! isset($query_params['limit'][0], $query_params['limit'][1])) {
                     $e = sprintf(
                         esc_html__(
                             "Invalid DB query. You passed '%s' for the LIMIT, but only the following are valid: an integer, string representing an integer, a string like 'int,int', or an array like array(int,int)",
@@ -3538,12 +3538,12 @@ 
                         ),
                         http_build_query($query_params['limit'])
                     );
-                    throw new EE_Error($e . "|" . $e);
+                    throw new EE_Error($e."|".$e);
                 }
                 // they passed us an array for the limit. Assume it's like array(50,25), meaning offset by 50, and get 25
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit'][0] . "," . $query_params['limit'][1]);
-            } elseif (! empty($query_params['limit'])) {
-                $query_object->set_limit_sql(" LIMIT " . $query_params['limit']);
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit'][0].",".$query_params['limit'][1]);
+            } elseif ( ! empty($query_params['limit'])) {
+                $query_object->set_limit_sql(" LIMIT ".$query_params['limit']);
             }
         }
         // set order by
@@ -3575,10 +3575,10 @@ 
                 $order_array = [];
                 foreach ($query_params['order_by'] as $field_name_to_order_by => $order) {
                     $order         = $this->_extract_order($order);
-                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by) . SP . $order;
+                    $order_array[] = $this->_deduce_column_name_from_query_param($field_name_to_order_by).SP.$order;
                 }
-                $query_object->set_order_by_sql(" ORDER BY " . implode(",", $order_array));
-            } elseif (! empty($query_params['order_by'])) {
+                $query_object->set_order_by_sql(" ORDER BY ".implode(",", $order_array));
+            } elseif ( ! empty($query_params['order_by'])) {
                 $this->_extract_related_model_info_from_query_param(
                     $query_params['order_by'],
                     $query_object,
@@ -3589,7 +3589,7 @@ 
                     ? $this->_extract_order($query_params['order'])
                     : 'DESC';
                 $query_object->set_order_by_sql(
-                    " ORDER BY " . $this->_deduce_column_name_from_query_param($query_params['order_by']) . SP . $order
+                    " ORDER BY ".$this->_deduce_column_name_from_query_param($query_params['order_by']).SP.$order
                 );
             }
         }
@@ -3601,7 +3601,7 @@ 
         ) {
             $pk_field = $this->get_primary_key_field();
             $order    = $this->_extract_order($query_params['order']);
-            $query_object->set_order_by_sql(" ORDER BY " . $pk_field->get_qualified_column() . SP . $order);
+            $query_object->set_order_by_sql(" ORDER BY ".$pk_field->get_qualified_column().SP.$order);
         }
         // set group by
         if (array_key_exists('group_by', $query_params)) {
@@ -3611,10 +3611,10 @@ 
                 foreach ($query_params['group_by'] as $field_name_to_group_by) {
                     $group_by_array[] = $this->_deduce_column_name_from_query_param($field_name_to_group_by);
                 }
-                $query_object->set_group_by_sql(" GROUP BY " . implode(", ", $group_by_array));
-            } elseif (! empty($query_params['group_by'])) {
+                $query_object->set_group_by_sql(" GROUP BY ".implode(", ", $group_by_array));
+            } elseif ( ! empty($query_params['group_by'])) {
                 $query_object->set_group_by_sql(
-                    " GROUP BY " . $this->_deduce_column_name_from_query_param($query_params['group_by'])
+                    " GROUP BY ".$this->_deduce_column_name_from_query_param($query_params['group_by'])
                 );
             }
         }
@@ -3624,7 +3624,7 @@ 
         }
         // now, just verify they didn't pass anything wack
         foreach ($query_params as $query_key => $query_value) {
-            if (! in_array($query_key, $this->_allowed_query_params, true)) {
+            if ( ! in_array($query_key, $this->_allowed_query_params, true)) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -3730,7 +3730,7 @@ 
         $where_query_params = []
     ) {
         $allowed_used_default_where_conditions_values = EEM_Base::valid_default_where_conditions();
-        if (! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
+        if ( ! in_array($use_default_where_conditions, $allowed_used_default_where_conditions_values)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3760,7 +3760,7 @@ 
                 // we don't want to add full or even minimum default where conditions from this model, so just continue
                 continue;
             }
-            $overrides              = $this->_override_defaults_or_make_null_friendly(
+            $overrides = $this->_override_defaults_or_make_null_friendly(
                 $related_model_universal_where_params,
                 $where_query_params,
                 $related_model,
@@ -3869,19 +3869,19 @@ 
     ) {
         $null_friendly_where_conditions = [];
         $none_overridden                = true;
-        $or_condition_key_for_defaults  = 'OR*' . get_class($model);
+        $or_condition_key_for_defaults  = 'OR*'.get_class($model);
         foreach ($default_where_conditions as $key => $val) {
-            if (isset($provided_where_conditions[ $key ])) {
+            if (isset($provided_where_conditions[$key])) {
                 $none_overridden = false;
             } else {
-                $null_friendly_where_conditions[ $or_condition_key_for_defaults ]['AND'][ $key ] = $val;
+                $null_friendly_where_conditions[$or_condition_key_for_defaults]['AND'][$key] = $val;
             }
         }
         if ($none_overridden && $default_where_conditions) {
             if ($model->has_primary_key_field()) {
-                $null_friendly_where_conditions[ $or_condition_key_for_defaults ][ $model_relation_path
+                $null_friendly_where_conditions[$or_condition_key_for_defaults][$model_relation_path
                                                                                    . "."
-                                                                                   . $model->primary_key_name() ] =
+                                                                                   . $model->primary_key_name()] =
                     ['IS NULL'];
             }/*else{
                 //@todo NO PK, use other defaults
@@ -3992,7 +3992,7 @@ 
             foreach ($tables as $table_obj) {
                 $qualified_pk_column = $table_alias_with_model_relation_chain_prefix
                                        . $table_obj->get_fully_qualified_pk_column();
-                if (! in_array($qualified_pk_column, $selects)) {
+                if ( ! in_array($qualified_pk_column, $selects)) {
                     $selects[] = "$qualified_pk_column AS '$qualified_pk_column'";
                 }
             }
@@ -4144,9 +4144,9 @@ 
         $query_parameter_type
     ) {
         foreach ($this->_model_relations as $valid_related_model_name => $relation_obj) {
-            if (strpos($possible_join_string, $valid_related_model_name . ".") === 0) {
+            if (strpos($possible_join_string, $valid_related_model_name.".") === 0) {
                 $this->_add_join_to_model($valid_related_model_name, $query_info_carrier, $original_query_param);
-                $possible_join_string = substr($possible_join_string, strlen($valid_related_model_name . "."));
+                $possible_join_string = substr($possible_join_string, strlen($valid_related_model_name."."));
                 if ($possible_join_string === '') {
                     // nothing left to $query_param
                     // we should actually end in a field name, not a model like this!
@@ -4279,7 +4279,7 @@ 
     {
         $SQL = $this->_construct_condition_clause_recursive($where_params, ' AND ');
         if ($SQL) {
-            return " WHERE " . $SQL;
+            return " WHERE ".$SQL;
         }
         return '';
     }
@@ -4297,7 +4297,7 @@ 
     {
         $SQL = $this->_construct_condition_clause_recursive($having_params, ' AND ');
         if ($SQL) {
-            return " HAVING " . $SQL;
+            return " HAVING ".$SQL;
         }
         return '';
     }
@@ -4351,7 +4351,7 @@ 
             } else {
                 $field_obj = $this->_deduce_field_from_query_param($query_param);
                 // if it's not a normal field, maybe it's a custom selection?
-                if (! $field_obj) {
+                if ( ! $field_obj) {
                     if ($this->_custom_selections instanceof CustomSelects) {
                         $field_obj = $this->_custom_selections->getDataTypeForAlias($query_param);
                     } else {
@@ -4367,7 +4367,7 @@ 
                     }
                 }
                 $op_and_value_sql = $this->_construct_op_and_value($op_and_value_or_sub_condition, $field_obj);
-                $where_clauses[]  = $this->_deduce_column_name_from_query_param($query_param) . SP . $op_and_value_sql;
+                $where_clauses[]  = $this->_deduce_column_name_from_query_param($query_param).SP.$op_and_value_sql;
             }
         }
         return $where_clauses ? implode($glue, $where_clauses) : '';
@@ -4389,7 +4389,7 @@ 
                 $field->get_model_name(),
                 $query_param
             );
-            return $table_alias_prefix . $field->get_qualified_column();
+            return $table_alias_prefix.$field->get_qualified_column();
         }
         if (
             $this->_custom_selections instanceof CustomSelects
@@ -4447,7 +4447,7 @@ 
     {
         if (is_array($op_and_value)) {
             $operator = isset($op_and_value[0]) ? $this->_prepare_operator_for_sql($op_and_value[0]) : null;
-            if (! $operator) {
+            if ( ! $operator) {
                 $php_array_like_string = [];
                 foreach ($op_and_value as $key => $value) {
                     $php_array_like_string[] = "$key=>$value";
@@ -4469,14 +4469,14 @@ 
         }
         // check to see if the value is actually another field
         if (is_array($op_and_value) && isset($op_and_value[2]) && $op_and_value[2] == true) {
-            return $operator . SP . $this->_deduce_column_name_from_query_param($value);
+            return $operator.SP.$this->_deduce_column_name_from_query_param($value);
         }
         if (in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
             // in this case, the value should be an array, or at least a comma-separated list
             // it will need to handle a little differently
             $cleaned_value = $this->_construct_in_value($value, $field_obj);
             // note: $cleaned_value has already been run through $wpdb->prepare()
-            return $operator . SP . $cleaned_value;
+            return $operator.SP.$cleaned_value;
         }
         if (in_array($operator, $this->valid_between_style_operators()) && is_array($value)) {
             // the value should be an array with count of two.
@@ -4492,7 +4492,7 @@ 
                 );
             }
             $cleaned_value = $this->_construct_between_value($value, $field_obj);
-            return $operator . SP . $cleaned_value;
+            return $operator.SP.$cleaned_value;
         }
         if (in_array($operator, $this->valid_null_style_operators())) {
             if ($value !== null) {
@@ -4512,10 +4512,10 @@ 
         if (in_array($operator, $this->valid_like_style_operators()) && ! is_array($value)) {
             // if the operator is 'LIKE', we want to allow percent signs (%) and not
             // remove other junk. So just treat it as a string.
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, '%s');
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, '%s');
         }
-        if (! in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
-            return $operator . SP . $this->_wpdb_prepare_using_field($value, $field_obj);
+        if ( ! in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
+            return $operator.SP.$this->_wpdb_prepare_using_field($value, $field_obj);
         }
         if (in_array($operator, $this->valid_in_style_operators()) && ! is_array($value)) {
             throw new EE_Error(
@@ -4529,7 +4529,7 @@ 
                 )
             );
         }
-        if (! in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
+        if ( ! in_array($operator, $this->valid_in_style_operators()) && is_array($value)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -4568,7 +4568,7 @@ 
         foreach ($values as $value) {
             $cleaned_values[] = $this->_wpdb_prepare_using_field($value, $field_obj);
         }
-        return $cleaned_values[0] . " AND " . $cleaned_values[1];
+        return $cleaned_values[0]." AND ".$cleaned_values[1];
     }
 
 
@@ -4606,7 +4606,7 @@ 
             $main_table  = $this->_get_main_table();
             $prepped[]   = "SELECT {$first_field->get_table_column()} FROM {$main_table->get_table_name()} WHERE FALSE";
         }
-        return '(' . implode(',', $prepped) . ')';
+        return '('.implode(',', $prepped).')';
     }
 
 
@@ -4626,7 +4626,7 @@ 
                 $this->_prepare_value_for_use_in_db($value, $field_obj)
             );
         } //$field_obj should really just be a data type
-        if (! in_array($field_obj, $this->_valid_wpdb_data_types)) {
+        if ( ! in_array($field_obj, $this->_valid_wpdb_data_types)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__("%s is not a valid wpdb datatype. Valid ones are %s", "event_espresso"),
@@ -4663,14 +4663,14 @@ 
             );
         }
         $number_of_parts       = count($query_param_parts);
-        $last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ];
+        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
         if ($number_of_parts === 1) {
             $field_name = $last_query_param_part;
             $model_obj  = $this;
         } else {// $number_of_parts >= 2
             // the last part is the column name, and there are only 2parts. therefore...
             $field_name = $last_query_param_part;
-            $model_obj  = $this->get_related_model_obj($query_param_parts[ $number_of_parts - 2 ]);
+            $model_obj  = $this->get_related_model_obj($query_param_parts[$number_of_parts - 2]);
         }
         try {
             return $model_obj->field_settings_for($field_name);
@@ -4691,7 +4691,7 @@ 
     public function _get_qualified_column_for_field($field_name)
     {
         $all_fields = $this->field_settings();
-        $field      = isset($all_fields[ $field_name ]) ? $all_fields[ $field_name ] : false;
+        $field      = isset($all_fields[$field_name]) ? $all_fields[$field_name] : false;
         if ($field) {
             return $field->get_qualified_column();
         }
@@ -4761,10 +4761,10 @@ 
      */
     public function get_qualified_columns_for_all_fields($model_relation_chain = '', $return_string = true)
     {
-        $table_prefix      = str_replace('.', '__', $model_relation_chain) . (empty($model_relation_chain) ? '' : '__');
+        $table_prefix      = str_replace('.', '__', $model_relation_chain).(empty($model_relation_chain) ? '' : '__');
         $qualified_columns = [];
         foreach ($this->field_settings() as $field_name => $field) {
-            $qualified_columns[] = $table_prefix . $field->get_qualified_column();
+            $qualified_columns[] = $table_prefix.$field->get_qualified_column();
         }
         return $return_string ? implode(', ', $qualified_columns) : $qualified_columns;
     }
@@ -4789,11 +4789,11 @@ 
             if ($table_obj instanceof EE_Primary_Table) {
                 $SQL .= $table_alias === $table_obj->get_table_alias()
                     ? $table_obj->get_select_join_limit($limit)
-                    : SP . $table_obj->get_table_name() . " AS " . $table_obj->get_table_alias() . SP;
+                    : SP.$table_obj->get_table_name()." AS ".$table_obj->get_table_alias().SP;
             } elseif ($table_obj instanceof EE_Secondary_Table) {
                 $SQL .= $table_alias === $table_obj->get_table_alias()
                     ? $table_obj->get_select_join_limit_join($limit)
-                    : SP . $table_obj->get_join_sql($table_alias) . SP;
+                    : SP.$table_obj->get_join_sql($table_alias).SP;
             }
         }
         return $SQL;
@@ -4864,7 +4864,7 @@ 
         foreach ($this->field_settings() as $field_obj) {
             // $data_types[$field_obj->get_table_column()] = $field_obj->get_wpdb_data_type();
             /** @var $field_obj EE_Model_Field_Base */
-            $data_types[ $field_obj->get_qualified_column() ] = $field_obj->get_wpdb_data_type();
+            $data_types[$field_obj->get_qualified_column()] = $field_obj->get_wpdb_data_type();
         }
         return $data_types;
     }
@@ -4879,8 +4879,8 @@ 
      */
     public function get_related_model_obj($model_name)
     {
-        $model_classname = "EEM_" . $model_name;
-        if (! class_exists($model_classname)) {
+        $model_classname = "EEM_".$model_name;
+        if ( ! class_exists($model_classname)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -4892,7 +4892,7 @@ 
                 )
             );
         }
-        return call_user_func($model_classname . "::instance");
+        return call_user_func($model_classname."::instance");
     }
 
 
@@ -4919,7 +4919,7 @@ 
         $belongs_to_relations = [];
         foreach ($this->relation_settings() as $model_name => $relation_obj) {
             if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $belongs_to_relations[ $model_name ] = $relation_obj;
+                $belongs_to_relations[$model_name] = $relation_obj;
             }
         }
         return $belongs_to_relations;
@@ -4936,7 +4936,7 @@ 
     public function related_settings_for($relation_name)
     {
         $relatedModels = $this->relation_settings();
-        if (! array_key_exists($relation_name, $relatedModels)) {
+        if ( ! array_key_exists($relation_name, $relatedModels)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -4949,7 +4949,7 @@ 
                 )
             );
         }
-        return $relatedModels[ $relation_name ];
+        return $relatedModels[$relation_name];
     }
 
 
@@ -4965,7 +4965,7 @@ 
     public function field_settings_for($fieldName, $include_db_only_fields = true)
     {
         $fieldSettings = $this->field_settings($include_db_only_fields);
-        if (! array_key_exists($fieldName, $fieldSettings)) {
+        if ( ! array_key_exists($fieldName, $fieldSettings)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__("There is no field/column '%s' on '%s'", 'event_espresso'),
@@ -4974,7 +4974,7 @@ 
                 )
             );
         }
-        return $fieldSettings[ $fieldName ];
+        return $fieldSettings[$fieldName];
     }
 
 
@@ -4987,7 +4987,7 @@ 
     public function has_field($fieldName)
     {
         $fieldSettings = $this->field_settings(true);
-        if (isset($fieldSettings[ $fieldName ])) {
+        if (isset($fieldSettings[$fieldName])) {
             return true;
         }
         return false;
@@ -5003,7 +5003,7 @@ 
     public function has_relation($relation_name)
     {
         $relations = $this->relation_settings();
-        if (isset($relations[ $relation_name ])) {
+        if (isset($relations[$relation_name])) {
             return true;
         }
         return false;
@@ -5039,7 +5039,7 @@ 
                     break;
                 }
             }
-            if (! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
+            if ( ! $this->_primary_key_field instanceof EE_Primary_Key_Field_Base) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__("There is no Primary Key defined on model %s", 'event_espresso'),
@@ -5099,17 +5099,17 @@ 
      */
     public function get_foreign_key_to($model_name)
     {
-        if (! isset($this->_cache_foreign_key_to_fields[ $model_name ])) {
+        if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
             foreach ($this->field_settings() as $field) {
                 if (
                     $field instanceof EE_Foreign_Key_Field_Base
                     && in_array($model_name, $field->get_model_names_pointed_to())
                 ) {
-                    $this->_cache_foreign_key_to_fields[ $model_name ] = $field;
+                    $this->_cache_foreign_key_to_fields[$model_name] = $field;
                     break;
                 }
             }
-            if (! isset($this->_cache_foreign_key_to_fields[ $model_name ])) {
+            if ( ! isset($this->_cache_foreign_key_to_fields[$model_name])) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -5122,7 +5122,7 @@ 
                 );
             }
         }
-        return $this->_cache_foreign_key_to_fields[ $model_name ];
+        return $this->_cache_foreign_key_to_fields[$model_name];
     }
 
 
@@ -5138,7 +5138,7 @@ 
     {
         $table_alias_sans_model_relation_chain_prefix =
             EE_Model_Parser::remove_table_alias_model_relation_chain_prefix($table_alias);
-        return $this->_tables[ $table_alias_sans_model_relation_chain_prefix ]->get_table_name();
+        return $this->_tables[$table_alias_sans_model_relation_chain_prefix]->get_table_name();
     }
 
 
@@ -5156,7 +5156,7 @@ 
                 $this->_cached_fields = [];
                 foreach ($this->_fields as $fields_corresponding_to_table) {
                     foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
-                        $this->_cached_fields[ $field_name ] = $field_obj;
+                        $this->_cached_fields[$field_name] = $field_obj;
                     }
                 }
             }
@@ -5167,8 +5167,8 @@ 
             foreach ($this->_fields as $fields_corresponding_to_table) {
                 foreach ($fields_corresponding_to_table as $field_name => $field_obj) {
                     /** @var $field_obj EE_Model_Field_Base */
-                    if (! $field_obj->is_db_only_field()) {
-                        $this->_cached_fields_non_db_only[ $field_name ] = $field_obj;
+                    if ( ! $field_obj->is_db_only_field()) {
+                        $this->_cached_fields_non_db_only[$field_name] = $field_obj;
                     }
                 }
             }
@@ -5209,12 +5209,12 @@ 
                     $primary_key_field->get_qualified_column(),
                     $primary_key_field->get_table_column()
                 );
-                if ($table_pk_value && isset($array_of_objects[ $table_pk_value ])) {
+                if ($table_pk_value && isset($array_of_objects[$table_pk_value])) {
                     continue;
                 }
             }
             $classInstance = $this->instantiate_class_from_array_or_object($row);
-            if (! $classInstance) {
+            if ( ! $classInstance) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__('Could not create instance of class %s from row %s', 'event_espresso'),
@@ -5227,7 +5227,7 @@ 
             $classInstance->set_timezone($this->_timezone);
             // make sure if there is any timezone setting present that we set the timezone for the object
             $key                      = $has_primary_key ? $classInstance->ID() : $count_if_model_has_no_primary_key++;
-            $array_of_objects[ $key ] = $classInstance;
+            $array_of_objects[$key] = $classInstance;
             // also, for all the relations of type BelongsTo, see if we can cache
             // those related models
             // (we could do this for other relations too, but if there are conditions
@@ -5271,9 +5271,9 @@ 
         $results = [];
         if ($this->_custom_selections instanceof CustomSelects) {
             foreach ($this->_custom_selections->columnAliases() as $alias) {
-                if (isset($db_results_row[ $alias ])) {
-                    $results[ $alias ] = $this->convertValueToDataType(
-                        $db_results_row[ $alias ],
+                if (isset($db_results_row[$alias])) {
+                    $results[$alias] = $this->convertValueToDataType(
+                        $db_results_row[$alias],
                         $this->_custom_selections->getDataTypeForAlias($alias)
                     );
                 }
@@ -5318,9 +5318,9 @@ 
         $this_model_fields_and_values = [];
         // setup the row using default values;
         foreach ($this->field_settings() as $field_name => $field_obj) {
-            $this_model_fields_and_values[ $field_name ] = $field_obj->get_default_value();
+            $this_model_fields_and_values[$field_name] = $field_obj->get_default_value();
         }
-        $className     = $this->_get_class_name();
+        $className = $this->_get_class_name();
         return EE_Registry::instance()->load_class($className, [$this_model_fields_and_values], false, false);
     }
 
@@ -5334,20 +5334,20 @@ 
      */
     public function instantiate_class_from_array_or_object($cols_n_values)
     {
-        if (! is_array($cols_n_values) && is_object($cols_n_values)) {
+        if ( ! is_array($cols_n_values) && is_object($cols_n_values)) {
             $cols_n_values = get_object_vars($cols_n_values);
         }
         $primary_key = null;
         // make sure the array only has keys that are fields/columns on this model
         $this_model_fields_n_values = $this->_deduce_fields_n_values_from_cols_n_values($cols_n_values);
-        if ($this->has_primary_key_field() && isset($this_model_fields_n_values[ $this->primary_key_name() ])) {
-            $primary_key = $this_model_fields_n_values[ $this->primary_key_name() ];
+        if ($this->has_primary_key_field() && isset($this_model_fields_n_values[$this->primary_key_name()])) {
+            $primary_key = $this_model_fields_n_values[$this->primary_key_name()];
         }
         $className = $this->_get_class_name();
         // check we actually found results that we can use to build our model object
         // if not, return null
         if ($this->has_primary_key_field()) {
-            if (empty($this_model_fields_n_values[ $this->primary_key_name() ])) {
+            if (empty($this_model_fields_n_values[$this->primary_key_name()])) {
                 return null;
             }
         } elseif ($this->unique_indexes()) {
@@ -5359,7 +5359,7 @@ 
         // if there is no primary key or the object doesn't already exist in the entity map, then create a new instance
         if ($primary_key) {
             $classInstance = $this->get_from_entity_map($primary_key);
-            if (! $classInstance) {
+            if ( ! $classInstance) {
                 $classInstance = EE_Registry::instance()
                                             ->load_class(
                                                 $className,
@@ -5391,8 +5391,8 @@ 
      */
     public function get_from_entity_map($id)
     {
-        return isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])
-            ? $this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ] : null;
+        return isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])
+            ? $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] : null;
     }
 
 
@@ -5415,7 +5415,7 @@ 
     public function add_to_entity_map(EE_Base_Class $object)
     {
         $className = $this->_get_class_name();
-        if (! $object instanceof $className) {
+        if ( ! $object instanceof $className) {
             throw new EE_Error(
                 sprintf(
                     esc_html__("You tried adding a %s to a mapping of %ss", "event_espresso"),
@@ -5425,7 +5425,7 @@ 
             );
         }
         /** @var $object EE_Base_Class */
-        if (! $object->ID()) {
+        if ( ! $object->ID()) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -5441,7 +5441,7 @@ 
         if ($classInstance) {
             return $classInstance;
         }
-        $this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $object->ID() ] = $object;
+        $this->_entity_map[EEM_Base::$_model_query_blog_id][$object->ID()] = $object;
         return $object;
     }
 
@@ -5456,11 +5456,11 @@ 
     public function clear_entity_map($id = null)
     {
         if (empty($id)) {
-            $this->_entity_map[ EEM_Base::$_model_query_blog_id ] = [];
+            $this->_entity_map[EEM_Base::$_model_query_blog_id] = [];
             return true;
         }
-        if (isset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ])) {
-            unset($this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ]);
+        if (isset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id])) {
+            unset($this->_entity_map[EEM_Base::$_model_query_blog_id][$id]);
             return true;
         }
         return false;
@@ -5508,18 +5508,18 @@ 
             // there is a primary key on this table and its not set. Use defaults for all its columns
             if ($table_pk_value === null && $table_obj->get_pk_column()) {
                 foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
-                    if (! $field_obj->is_db_only_field()) {
+                    if ( ! $field_obj->is_db_only_field()) {
                         // prepare field as if its coming from db
                         $prepared_value                            =
                             $field_obj->prepare_for_set($field_obj->get_default_value());
-                        $this_model_fields_n_values[ $field_name ] = $field_obj->prepare_for_use_in_db($prepared_value);
+                        $this_model_fields_n_values[$field_name] = $field_obj->prepare_for_use_in_db($prepared_value);
                     }
                 }
             } else {
                 // the table's rows existed. Use their values
                 foreach ($this->_get_fields_for_table($table_alias) as $field_name => $field_obj) {
-                    if (! $field_obj->is_db_only_field()) {
-                        $this_model_fields_n_values[ $field_name ] = $this->_get_column_value_with_table_alias_or_not(
+                    if ( ! $field_obj->is_db_only_field()) {
+                        $this_model_fields_n_values[$field_name] = $this->_get_column_value_with_table_alias_or_not(
                             $cols_n_values,
                             $field_obj->get_qualified_column(),
                             $field_obj->get_table_column()
@@ -5546,17 +5546,17 @@ 
         // ask the field what it think it's table_name.column_name should be, and call it the "qualified column"
         // does the field on the model relate to this column retrieved from the db?
         // or is it a db-only field? (not relating to the model)
-        if (isset($cols_n_values[ $qualified_column ])) {
-            $value = $cols_n_values[ $qualified_column ];
-        } elseif (isset($cols_n_values[ $regular_column ])) {
-            $value = $cols_n_values[ $regular_column ];
-        } elseif (! empty($this->foreign_key_aliases)) {
+        if (isset($cols_n_values[$qualified_column])) {
+            $value = $cols_n_values[$qualified_column];
+        } elseif (isset($cols_n_values[$regular_column])) {
+            $value = $cols_n_values[$regular_column];
+        } elseif ( ! empty($this->foreign_key_aliases)) {
             // no PK?  ok check if there is a foreign key alias set for this table
             // then check if that alias exists in the incoming data
             // AND that the actual PK the $FK_alias represents matches the $qualified_column (full PK)
             foreach ($this->foreign_key_aliases as $FK_alias => $PK_column) {
-                if ($PK_column === $qualified_column && isset($cols_n_values[ $FK_alias ])) {
-                    $value = $cols_n_values[ $FK_alias ];
+                if ($PK_column === $qualified_column && isset($cols_n_values[$FK_alias])) {
+                    $value = $cols_n_values[$FK_alias];
                     [$pk_class] = explode('.', $PK_column);
                     $pk_model_name = "EEM_{$pk_class}";
                     /** @var EEM_Base $pk_model */
@@ -5600,7 +5600,7 @@ 
                     $obj_in_map->clear_cache($relation_name, null, true);
                 }
             }
-            $this->_entity_map[ EEM_Base::$_model_query_blog_id ][ $id ] = $obj_in_map;
+            $this->_entity_map[EEM_Base::$_model_query_blog_id][$id] = $obj_in_map;
             return $obj_in_map;
         }
         return $this->get_one_by_ID($id);
@@ -5652,7 +5652,7 @@ 
      */
     private function _get_class_name()
     {
-        return "EE_" . $this->get_this_model_name();
+        return "EE_".$this->get_this_model_name();
     }
 
 
@@ -5704,7 +5704,7 @@ 
     {
         $className = get_class($this);
         $tagName   = "FHEE__{$className}__{$methodName}";
-        if (! has_filter($tagName)) {
+        if ( ! has_filter($tagName)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -5875,7 +5875,7 @@ 
         $unique_indexes = [];
         foreach ($this->_indexes as $name => $index) {
             if ($index instanceof EE_Unique_Index) {
-                $unique_indexes [ $name ] = $index;
+                $unique_indexes [$name] = $index;
             }
         }
         return $unique_indexes;
@@ -5939,7 +5939,7 @@ 
         $key_vals_in_combined_pk = [];
         parse_str($index_primary_key_string, $key_vals_in_combined_pk);
         foreach ($key_fields as $key_field_name => $field_obj) {
-            if (! isset($key_vals_in_combined_pk[ $key_field_name ])) {
+            if ( ! isset($key_vals_in_combined_pk[$key_field_name])) {
                 return null;
             }
         }
@@ -5959,7 +5959,7 @@ 
     {
         $keys_it_should_have = array_keys($this->get_combined_primary_key_fields());
         foreach ($keys_it_should_have as $key) {
-            if (! isset($key_vals[ $key ])) {
+            if ( ! isset($key_vals[$key])) {
                 return false;
             }
         }
@@ -5998,8 +5998,8 @@ 
         }
         // even copies obviously won't have the same ID, so remove the primary key
         // from the WHERE conditions for finding copies (if there is a primary key, of course)
-        if ($this->has_primary_key_field() && isset($attributes_array[ $this->primary_key_name() ])) {
-            unset($attributes_array[ $this->primary_key_name() ]);
+        if ($this->has_primary_key_field() && isset($attributes_array[$this->primary_key_name()])) {
+            unset($attributes_array[$this->primary_key_name()]);
         }
         if (isset($query_params[0])) {
             $query_params[0] = array_merge($attributes_array, $query_params);
@@ -6021,7 +6021,7 @@ 
      */
     public function get_one_copy($model_object_or_attributes_array, $query_params = [])
     {
-        if (! is_array($query_params)) {
+        if ( ! is_array($query_params)) {
             EE_Error::doing_it_wrong(
                 'EEM_Base::get_one_copy',
                 sprintf(
@@ -6070,7 +6070,7 @@ 
      */
     private function _prepare_operator_for_sql($operator_supplied)
     {
-        $sql_operator = $this->_valid_operators[ $operator_supplied ] ?? null;
+        $sql_operator = $this->_valid_operators[$operator_supplied] ?? null;
         if ($sql_operator) {
             return $sql_operator;
         }
@@ -6168,7 +6168,7 @@ 
         $objs  = $this->get_all($query_params);
         $names = [];
         foreach ($objs as $obj) {
-            $names[ $obj->ID() ] = $obj->name();
+            $names[$obj->ID()] = $obj->name();
         }
         return $names;
     }
@@ -6189,7 +6189,7 @@ 
      */
     public function get_IDs($model_objects, $filter_out_empty_ids = false)
     {
-        if (! $this->has_primary_key_field()) {
+        if ( ! $this->has_primary_key_field()) {
             if (WP_DEBUG) {
                 EE_Error::add_error(
                     esc_html__('Trying to get IDs from a model than has no primary key', 'event_espresso'),
@@ -6202,7 +6202,7 @@ 
         $IDs = [];
         foreach ($model_objects as $model_object) {
             $id = $model_object->ID();
-            if (! $id) {
+            if ( ! $id) {
                 if ($filter_out_empty_ids) {
                     continue;
                 }
@@ -6252,22 +6252,22 @@ 
         EEM_Base::verify_is_valid_cap_context($context);
         // check if we ought to run the restriction generator first
         if (
-            isset($this->_cap_restriction_generators[ $context ])
-            && $this->_cap_restriction_generators[ $context ] instanceof EE_Restriction_Generator_Base
-            && ! $this->_cap_restriction_generators[ $context ]->has_generated_cap_restrictions()
+            isset($this->_cap_restriction_generators[$context])
+            && $this->_cap_restriction_generators[$context] instanceof EE_Restriction_Generator_Base
+            && ! $this->_cap_restriction_generators[$context]->has_generated_cap_restrictions()
         ) {
-            $this->_cap_restrictions[ $context ] = array_merge(
-                $this->_cap_restrictions[ $context ],
-                $this->_cap_restriction_generators[ $context ]->generate_restrictions()
+            $this->_cap_restrictions[$context] = array_merge(
+                $this->_cap_restrictions[$context],
+                $this->_cap_restriction_generators[$context]->generate_restrictions()
             );
         }
         // and make sure we've finalized the construction of each restriction
-        foreach ($this->_cap_restrictions[ $context ] as $where_conditions_obj) {
+        foreach ($this->_cap_restrictions[$context] as $where_conditions_obj) {
             if ($where_conditions_obj instanceof EE_Default_Where_Conditions) {
                 $where_conditions_obj->_finalize_construct($this);
             }
         }
-        return $this->_cap_restrictions[ $context ];
+        return $this->_cap_restrictions[$context];
     }
 
 
@@ -6297,9 +6297,9 @@ 
         foreach ($cap_restrictions as $cap => $restriction_if_no_cap) {
             if (
                 ! EE_Capabilities::instance()
-                                 ->current_user_can($cap, $this->get_this_model_name() . '_model_applying_caps')
+                                 ->current_user_can($cap, $this->get_this_model_name().'_model_applying_caps')
             ) {
-                $missing_caps[ $cap ] = $restriction_if_no_cap;
+                $missing_caps[$cap] = $restriction_if_no_cap;
             }
         }
         return $missing_caps;
@@ -6332,8 +6332,8 @@ 
     public function cap_action_for_context($context)
     {
         $mapping = $this->cap_contexts_to_cap_action_map();
-        if (isset($mapping[ $context ])) {
-            return $mapping[ $context ];
+        if (isset($mapping[$context])) {
+            return $mapping[$context];
         }
         if ($action = apply_filters('FHEE__EEM_Base__cap_action_for_context', null, $this, $mapping, $context)) {
             return $action;
@@ -6451,7 +6451,7 @@ 
         foreach ($this->logic_query_param_keys() as $logic_query_param_key) {
             if (
                 $query_param_key === $logic_query_param_key
-                || strpos($query_param_key, $logic_query_param_key . '*') === 0
+                || strpos($query_param_key, $logic_query_param_key.'*') === 0
             ) {
                 return true;
             }
@@ -6509,7 +6509,7 @@ 
         if ($password_field instanceof EE_Password_Field) {
             $field_names = $password_field->protectedFields();
             foreach ($field_names as $field_name) {
-                $fields[ $field_name ] = $this->field_settings_for($field_name);
+                $fields[$field_name] = $this->field_settings_for($field_name);
             }
         }
         return $fields;
@@ -6535,7 +6535,7 @@ 
         if ($model_obj_or_fields_n_values instanceof EE_Base_Class) {
             $model_obj_or_fields_n_values = $model_obj_or_fields_n_values->model_field_array();
         }
-        if (! is_array($model_obj_or_fields_n_values)) {
+        if ( ! is_array($model_obj_or_fields_n_values)) {
             throw new UnexpectedEntityException(
                 $model_obj_or_fields_n_values,
                 'EE_Base_Class',
@@ -6615,7 +6615,7 @@ 
                 )
             );
         }
-        return ($this->model_chain_to_password ? $this->model_chain_to_password . '.' : '') . $password_field_name;
+        return ($this->model_chain_to_password ? $this->model_chain_to_password.'.' : '').$password_field_name;
     }